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.

Generated

from message viam.app.data.v1.Filter

Hierarchy

Constructors

  • Parameters

    • Optional data: PartialMessage<Filter>

    Returns Filter

Properties

bboxLabels: string[]

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

Generated

from field: repeated string bbox_labels = 15;

componentName: string

Generated

from field: string component_name = 1;

componentType: string

Generated

from field: string component_type = 2;

datasetId: string

Generated

from field: string dataset_id = 16;

interval?: CaptureInterval

Generated

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

locationIds: string[]

Generated

from field: repeated string location_ids = 10;

method: string

Generated

from field: string method = 4;

mimeType: string[]

Generated

from field: repeated string mime_type = 12;

organizationIds: string[]

Generated

from field: repeated string organization_ids = 11;

partId: string

Generated

from field: string part_id = 9;

partName: string

Generated

from field: string part_name = 8;

robotId: string

Generated

from field: string robot_id = 7;

robotName: string

Generated

from field: string robot_name = 6;

tagsFilter?: TagsFilter

Generated

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

fields: FieldList
runtime: ProtoRuntime
typeName: "viam.app.data.v1.Filter" = "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
    • Optional options: Partial<BinaryReadOptions>

    Returns this

  • Parse a message from a JSON value.

    Parameters

    • jsonValue: JsonValue
    • Optional options: Partial<JsonReadOptions>

    Returns this

  • Parse a message from a JSON string.

    Parameters

    • jsonString: string
    • Optional options: 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

    • Optional options: Partial<BinaryWriteOptions>

    Returns Uint8Array

  • 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 value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

  • Serialize the message to a JSON string.

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

  • Parameters

    • bytes: Uint8Array
    • Optional options: Partial<BinaryReadOptions>

    Returns Filter

  • Parameters

    • jsonValue: JsonValue
    • Optional options: Partial<JsonReadOptions>

    Returns Filter

  • Parameters

    • jsonString: string
    • Optional options: Partial<JsonReadOptions>

    Returns Filter