Vector Search v1 API - Class QueryDataObjectsRequest (1.0.0-beta01)

public sealed class QueryDataObjectsRequest : IMessage<QueryDataObjectsRequest>, IEquatable<QueryDataObjectsRequest>, IDeepCloneable<QueryDataObjectsRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Vector Search v1 API class QueryDataObjectsRequest.

Request message for [DataObjectSearchService.QueryDataObjects][google.cloud.vectorsearch.v1.DataObjectSearchService.QueryDataObjects].

Inheritance

object > QueryDataObjectsRequest

Namespace

Google.Cloud.VectorSearch.V1

Assembly

Google.Cloud.VectorSearch.V1.dll

Constructors

QueryDataObjectsRequest()

public QueryDataObjectsRequest()

QueryDataObjectsRequest(QueryDataObjectsRequest)

public QueryDataObjectsRequest(QueryDataObjectsRequest other)
Parameter
Name Description
other QueryDataObjectsRequest

Properties

Filter

public Struct Filter { get; set; }

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

Property Value
Type Description
Struct

OutputFields

public OutputFields OutputFields { get; set; }

Optional. Mask specifying which fields to return.

Property Value
Type Description
OutputFields

PageSize

public int PageSize { get; set; }

Optional. The standard list page size. Default is 100. The maximum value is 1000; values above 1000 will be coerced to 1000.

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

Optional. The standard list page token. Typically obtained via [QueryDataObjectsResponse.next_page_token][google.cloud.vectorsearch.v1.QueryDataObjectsResponse.next_page_token] of the previous [DataObjectSearchService.QueryDataObjects][google.cloud.vectorsearch.v1.DataObjectSearchService.QueryDataObjects] call.

Property Value
Type Description
string

Parent

public string Parent { get; set; }

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

Property Value
Type Description
string

ParentAsCollectionName

public CollectionName ParentAsCollectionName { get; set; }

CollectionName-typed view over the Parent resource name property.

Property Value
Type Description
CollectionName