Vector Search v1 API - Class DataObjectSearchService.DataObjectSearchServiceClient (1.0.0-beta01)

public class DataObjectSearchService.DataObjectSearchServiceClient : ClientBase<DataObjectSearchService.DataObjectSearchServiceClient>

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

Client for DataObjectSearchService

Inheritance

object > ClientBase > ClientBaseDataObjectSearchServiceDataObjectSearchServiceClient > DataObjectSearchService.DataObjectSearchServiceClient

Inherited Members

ClientBase<DataObjectSearchService.DataObjectSearchServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.VectorSearch.V1

Assembly

Google.Cloud.VectorSearch.V1.dll

Constructors

DataObjectSearchServiceClient()

protected DataObjectSearchServiceClient()

Protected parameterless constructor to allow creation of test doubles.

DataObjectSearchServiceClient(CallInvoker)

public DataObjectSearchServiceClient(CallInvoker callInvoker)

Creates a new client for DataObjectSearchService that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

DataObjectSearchServiceClient(ChannelBase)

public DataObjectSearchServiceClient(ChannelBase channel)

Creates a new client for DataObjectSearchService

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

DataObjectSearchServiceClient(ClientBaseConfiguration)

protected DataObjectSearchServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

AggregateDataObjects(AggregateDataObjectsRequest, CallOptions)

public virtual AggregateDataObjectsResponse AggregateDataObjects(AggregateDataObjectsRequest request, CallOptions options)

Aggregates data objects.

Parameters
Name	Description
request	AggregateDataObjectsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AggregateDataObjectsResponse	The response received from the server.

AggregateDataObjects(AggregateDataObjectsRequest, Metadata, DateTime?, CancellationToken)

public virtual AggregateDataObjectsResponse AggregateDataObjects(AggregateDataObjectsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Aggregates data objects.

Parameters
Name	Description
request	AggregateDataObjectsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AggregateDataObjectsResponse	The response received from the server.

AggregateDataObjectsAsync(AggregateDataObjectsRequest, CallOptions)

public virtual AsyncUnaryCall<AggregateDataObjectsResponse> AggregateDataObjectsAsync(AggregateDataObjectsRequest request, CallOptions options)

Aggregates data objects.

Parameters
Name	Description
request	AggregateDataObjectsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallAggregateDataObjectsResponse	The call object.

AggregateDataObjectsAsync(AggregateDataObjectsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<AggregateDataObjectsResponse> AggregateDataObjectsAsync(AggregateDataObjectsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Aggregates data objects.

Parameters
Name	Description
request	AggregateDataObjectsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallAggregateDataObjectsResponse	The call object.

BatchSearchDataObjects(BatchSearchDataObjectsRequest, CallOptions)

public virtual BatchSearchDataObjectsResponse BatchSearchDataObjects(BatchSearchDataObjectsRequest request, CallOptions options)

Batch searches data objects.

Parameters
Name	Description
request	BatchSearchDataObjectsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
BatchSearchDataObjectsResponse	The response received from the server.

BatchSearchDataObjects(BatchSearchDataObjectsRequest, Metadata, DateTime?, CancellationToken)

public virtual BatchSearchDataObjectsResponse BatchSearchDataObjects(BatchSearchDataObjectsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Batch searches data objects.

Parameters
Name	Description
request	BatchSearchDataObjectsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
BatchSearchDataObjectsResponse	The response received from the server.

BatchSearchDataObjectsAsync(BatchSearchDataObjectsRequest, CallOptions)

public virtual AsyncUnaryCall<BatchSearchDataObjectsResponse> BatchSearchDataObjectsAsync(BatchSearchDataObjectsRequest request, CallOptions options)

Batch searches data objects.

Parameters
Name	Description
request	BatchSearchDataObjectsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallBatchSearchDataObjectsResponse	The call object.

BatchSearchDataObjectsAsync(BatchSearchDataObjectsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<BatchSearchDataObjectsResponse> BatchSearchDataObjectsAsync(BatchSearchDataObjectsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Batch searches data objects.

Parameters
Name	Description
request	BatchSearchDataObjectsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallBatchSearchDataObjectsResponse	The call object.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type	Description
LocationsLocationsClient	A new Locations.LocationsClient for the same target as this client.

NewInstance(ClientBaseConfiguration)

protected override DataObjectSearchService.DataObjectSearchServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
DataObjectSearchServiceDataObjectSearchServiceClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.VectorSearch.V1.DataObjectSearchService.DataObjectSearchServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

QueryDataObjects(QueryDataObjectsRequest, CallOptions)

public virtual QueryDataObjectsResponse QueryDataObjects(QueryDataObjectsRequest request, CallOptions options)

Queries data objects.

Parameters
Name	Description
request	QueryDataObjectsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
QueryDataObjectsResponse	The response received from the server.

QueryDataObjects(QueryDataObjectsRequest, Metadata, DateTime?, CancellationToken)

public virtual QueryDataObjectsResponse QueryDataObjects(QueryDataObjectsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Queries data objects.

Parameters
Name	Description
request	QueryDataObjectsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
QueryDataObjectsResponse	The response received from the server.

QueryDataObjectsAsync(QueryDataObjectsRequest, CallOptions)

public virtual AsyncUnaryCall<QueryDataObjectsResponse> QueryDataObjectsAsync(QueryDataObjectsRequest request, CallOptions options)

Queries data objects.

Parameters
Name	Description
request	QueryDataObjectsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallQueryDataObjectsResponse	The call object.

QueryDataObjectsAsync(QueryDataObjectsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<QueryDataObjectsResponse> QueryDataObjectsAsync(QueryDataObjectsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Queries data objects.

Parameters
Name	Description
request	QueryDataObjectsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallQueryDataObjectsResponse	The call object.

SearchDataObjects(SearchDataObjectsRequest, CallOptions)

public virtual SearchDataObjectsResponse SearchDataObjects(SearchDataObjectsRequest request, CallOptions options)

Searches data objects.

Parameters
Name	Description
request	SearchDataObjectsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
SearchDataObjectsResponse	The response received from the server.

SearchDataObjects(SearchDataObjectsRequest, Metadata, DateTime?, CancellationToken)

public virtual SearchDataObjectsResponse SearchDataObjects(SearchDataObjectsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Searches data objects.

Parameters
Name	Description
request	SearchDataObjectsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
SearchDataObjectsResponse	The response received from the server.

SearchDataObjectsAsync(SearchDataObjectsRequest, CallOptions)

public virtual AsyncUnaryCall<SearchDataObjectsResponse> SearchDataObjectsAsync(SearchDataObjectsRequest request, CallOptions options)

Searches data objects.

Parameters
Name	Description
request	SearchDataObjectsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallSearchDataObjectsResponse	The call object.

SearchDataObjectsAsync(SearchDataObjectsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SearchDataObjectsResponse> SearchDataObjectsAsync(SearchDataObjectsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Searches data objects.

Parameters
Name	Description
request	SearchDataObjectsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallSearchDataObjectsResponse	The call object.