Viam SDK
    Preparing search index...

    Class UpdateBoundingBoxRequest

    UpdateBoundingBoxRequest updates the bounding box with specified bounding box ID for the file represented by the binary ID.

    from message viam.app.data.v1.UpdateBoundingBoxRequest

    Hierarchy

    Index

    Constructors

    constructor

    Properties

    bboxId binaryDataId binaryId? confidence? label? xMaxNormalized? xMinNormalized? yMaxNormalized? yMinNormalized? fields runtime typeName

    Methods

    clone equals fromBinary fromJson fromJsonString getType toBinary toJson toJSON toJsonString equals fromBinary fromJson fromJsonString

    Constructors

    Properties

    bboxId: string

    from field: string bbox_id = 2;

    binaryDataId: string

    from field: string binary_data_id = 8;

    binaryId?: BinaryID

    from field: viam.app.data.v1.BinaryID binary_id = 1 [deprecated = true];

    confidence?: number

    from field: optional double confidence = 9;

    label?: string

    from field: optional string label = 3;

    xMaxNormalized?: number

    from field: optional double x_max_normalized = 6;

    xMinNormalized?: number

    from field: optional double x_min_normalized = 4;

    yMaxNormalized?: number

    from field: optional double y_max_normalized = 7;

    yMinNormalized?: number

    from field: optional double y_min_normalized = 5;

    fields: FieldList
    runtime: ProtoRuntime
    typeName: "viam.app.data.v1.UpdateBoundingBoxRequest"

    Methods

    • Parse from binary data, merging fields.

      Repeated fields are appended. Map entries are added, overwriting existing keys.

      If a message field is already present, it will be merged with the new data.

      Parameters

      • bytes: Uint8Array
      • Optionaloptions: Partial<BinaryReadOptions>

      Returns this

    • Parse a message from a JSON value.

      Parameters

      • jsonValue: JsonValue
      • Optionaloptions: Partial<JsonReadOptions>

      Returns this

    • Parse a message from a JSON string.

      Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns this

    • Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.

      Returns MessageType<UpdateBoundingBoxRequest>

    • Serialize the message to binary data.

      Parameters

      • Optionaloptions: Partial<BinaryWriteOptions>

      Returns Uint8Array

    • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

      Parameters

      • Optionaloptions: Partial<JsonWriteOptions>

      Returns JsonValue

    • Override for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).

      Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.

      This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.

      Returns JsonValue

    • Serialize the message to a JSON string.

      Parameters

      • Optionaloptions: Partial<JsonWriteStringOptions>

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods