Viam SDK
    Preparing search index...

    Class Filter

    Filter defines the fields over which we can filter data using a logic AND. For example, if component_type and robot_id are specified, only data from that robot_id of type component_type is returned. However, we logical OR over the specified tags and bounding box labels, such that if component_type, robot_id, tagA, tagB are specified, we return data from that robot_id of type component_type with tagA or tagB.

    from message viam.app.data.v1.Filter

    Hierarchy

    Index

    Constructors

    constructor

    Properties

    bboxLabels componentName componentType datasetId interval? locationIds method mimeType organizationIds partId partName robotId robotName tagsFilter? fields runtime typeName

    Methods

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

    Constructors

    • Parameters

      • Optionaldata: PartialMessage<Filter>

      Returns Filter

    Properties

    bboxLabels: string[]

    bbox_labels are used to match documents with the specified bounding box labels (using logical OR).

    from field: repeated string bbox_labels = 15;

    componentName: string

    from field: string component_name = 1;

    componentType: string

    from field: string component_type = 2;

    datasetId: string

    from field: string dataset_id = 16;

    interval?: CaptureInterval

    from field: viam.app.data.v1.CaptureInterval interval = 13;

    locationIds: string[]

    from field: repeated string location_ids = 10;

    method: string

    from field: string method = 4;

    mimeType: string[]

    from field: repeated string mime_type = 12;

    organizationIds: string[]

    from field: repeated string organization_ids = 11;

    partId: string

    from field: string part_id = 9;

    partName: string

    from field: string part_name = 8;

    robotId: string

    from field: string robot_id = 7;

    robotName: string

    from field: string robot_name = 6;

    tagsFilter?: TagsFilter

    from field: viam.app.data.v1.TagsFilter tags_filter = 14;

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

    Methods

    • Create a deep copy.

      Returns Filter

    • Compare with a message of the same type. Note that this function disregards extensions and unknown fields.

      Parameters

      Returns boolean

    • 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<Filter>

    • 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

    • Parameters

      • bytes: Uint8Array
      • Optionaloptions: Partial<BinaryReadOptions>

      Returns Filter

    • Parameters

      • jsonValue: JsonValue
      • Optionaloptions: Partial<JsonReadOptions>

      Returns Filter

    • Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns Filter

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods