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-
(::Google::Protobuf::Struct) — Optional. A JSON filter expression, e.g.
{"genre": {"$eq": "sci-fi"}}, represented as agoogle.protobuf.Struct.An empty filter (
{}) matches all data objects. Otherwise, each JSON object in the filter must have exactly one key: either a field name mapped to one operator ({"price": {"$lt": 100}}), or a logical operator:$andor$orwith a list of filters, or$notwith one filter. Field operators and their values:$eqand$netake a string, number or bool;$lt,$lte,$gtand$gtetake a number;$in,$ninand$alltake a list of strings;$existstakes a bool. Several keys in one object (implicit AND) and implicit equality ({"genre": "sci-fi"}) are rejected; use$andand$eqinstead.Logical operators can be nested at most 2 levels deep, e.g.
{"$and": [{"$or": [{"a": {"$eq": 1}}, {"b": {"$eq": 2}}]}]}. Deeper filters are rejected withINVALID_ARGUMENT.
#filter=
def filter=(value) -> ::Google::Protobuf::Struct-
value (::Google::Protobuf::Struct) — Optional. A JSON filter expression, e.g.
{"genre": {"$eq": "sci-fi"}}, represented as agoogle.protobuf.Struct.An empty filter (
{}) matches all data objects. Otherwise, each JSON object in the filter must have exactly one key: either a field name mapped to one operator ({"price": {"$lt": 100}}), or a logical operator:$andor$orwith a list of filters, or$notwith one filter. Field operators and their values:$eqand$netake a string, number or bool;$lt,$lte,$gtand$gtetake a number;$in,$ninand$alltake a list of strings;$existstakes a bool. Several keys in one object (implicit AND) and implicit equality ({"genre": "sci-fi"}) are rejected; use$andand$eqinstead.Logical operators can be nested at most 2 levels deep, e.g.
{"$and": [{"$or": [{"a": {"$eq": 1}}, {"b": {"$eq": 2}}]}]}. Deeper filters are rejected withINVALID_ARGUMENT.
-
(::Google::Protobuf::Struct) — Optional. A JSON filter expression, e.g.
{"genre": {"$eq": "sci-fi"}}, represented as agoogle.protobuf.Struct.An empty filter (
{}) matches all data objects. Otherwise, each JSON object in the filter must have exactly one key: either a field name mapped to one operator ({"price": {"$lt": 100}}), or a logical operator:$andor$orwith a list of filters, or$notwith one filter. Field operators and their values:$eqand$netake a string, number or bool;$lt,$lte,$gtand$gtetake a number;$in,$ninand$alltake a list of strings;$existstakes a bool. Several keys in one object (implicit AND) and implicit equality ({"genre": "sci-fi"}) are rejected; use$andand$eqinstead.Logical operators can be nested at most 2 levels deep, e.g.
{"$and": [{"$or": [{"a": {"$eq": 1}}, {"b": {"$eq": 2}}]}]}. Deeper filters are rejected withINVALID_ARGUMENT.
#output_fields
def output_fields() -> ::Google::Cloud::VectorSearch::V1::OutputFields- (::Google::Cloud::VectorSearch::V1::OutputFields) — Optional. Mask specifying which fields to return.
#output_fields=
def output_fields=(value) -> ::Google::Cloud::VectorSearch::V1::OutputFields- value (::Google::Cloud::VectorSearch::V1::OutputFields) — Optional. Mask specifying which fields to return.
- (::Google::Cloud::VectorSearch::V1::OutputFields) — Optional. Mask specifying which fields to return.
#page_size
def page_size() -> ::Integer- (::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- value (::Integer) — Optional. The standard list page size. Default is 100. The maximum value is 1000; values above 1000 will be coerced to 1000.
- (::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- (::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- value (::String) — Optional. The standard list page token. Typically obtained via QueryDataObjectsResponse.next_page_token of the previous DataObjectSearchService.QueryDataObjects call.
- (::String) — Optional. The standard list page token. Typically obtained via QueryDataObjectsResponse.next_page_token of the previous DataObjectSearchService.QueryDataObjects call.
#parent
def parent() -> ::String-
(::String) — Required. The resource name of the Collection for which to query.
Format:
projects/{project}/locations/{location}/collections/{collection}
#parent=
def parent=(value) -> ::String-
value (::String) — Required. The resource name of the Collection for which to query.
Format:
projects/{project}/locations/{location}/collections/{collection}
-
(::String) — Required. The resource name of the Collection for which to query.
Format:
projects/{project}/locations/{location}/collections/{collection}