Vector Search V1 API - Class Google::Cloud::VectorSearch::V1::QueryDataObjectsRequest (v0.1.0)

Reference documentation and code samples for the Vector Search V1 API class Google::Cloud::VectorSearch::V1::QueryDataObjectsRequest.

Request message for DataObjectSearchService.QueryDataObjects.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::Google::Protobuf::Struct

Returns

• (::Google::Protobuf::Struct) — Optional. A JSON filter expression, e.g. {"genre": \{"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

#filter=

def filter=(value) -> ::Google::Protobuf::Struct

Parameter

• value (::Google::Protobuf::Struct) — Optional. A JSON filter expression, e.g. {"genre": \{"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

Returns

• (::Google::Protobuf::Struct) — Optional. A JSON filter expression, e.g. {"genre": \{"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

#output_fields

def output_fields() -> ::Google::Cloud::VectorSearch::V1::OutputFields

Returns

• (::Google::Cloud::VectorSearch::V1::OutputFields) — Optional. Mask specifying which fields to return.

#output_fields=

def output_fields=(value) -> ::Google::Cloud::VectorSearch::V1::OutputFields

Parameter

• value (::Google::Cloud::VectorSearch::V1::OutputFields) — Optional. Mask specifying which fields to return.

Returns

• (::Google::Cloud::VectorSearch::V1::OutputFields) — Optional. Mask specifying which fields to return.

#page_size

def page_size() -> ::Integer

Returns

• (::Integer) — Optional. The standard list page size. Default is 100. The maximum value is 1000; values above 1000 will be coerced to 1000.

#page_size=

def page_size=(value) -> ::Integer

Parameter

• value (::Integer) — Optional. The standard list page size. Default is 100. The maximum value is 1000; values above 1000 will be coerced to 1000.

Returns

• (::Integer) — Optional. The standard list page size. Default is 100. The maximum value is 1000; values above 1000 will be coerced to 1000.

#page_token

def page_token() -> ::String

Returns

• (::String) — Optional. The standard list page token. Typically obtained via QueryDataObjectsResponse.next_page_token of the previous DataObjectSearchService.QueryDataObjects call.

#page_token=

def page_token=(value) -> ::String

Parameter

• value (::String) — Optional. The standard list page token. Typically obtained via QueryDataObjectsResponse.next_page_token of the previous DataObjectSearchService.QueryDataObjects call.

Returns

• (::String) — Optional. The standard list page token. Typically obtained via QueryDataObjectsResponse.next_page_token of the previous DataObjectSearchService.QueryDataObjects call.

#parent

def parent() -> ::String

Returns

• (::String) — Required. The resource name of the Collection for which to query. Format: projects/{project}/locations/{location}/collections/{collection}

#parent=

def parent=(value) -> ::String

Parameter

• value (::String) — Required. The resource name of the Collection for which to query. Format: projects/{project}/locations/{location}/collections/{collection}

Returns

• (::String) — Required. The resource name of the Collection for which to query. Format: projects/{project}/locations/{location}/collections/{collection}