Vector Search v1 API - Class DataObjectService.DataObjectServiceClient (1.0.0-beta01)

public class DataObjectService.DataObjectServiceClient : ClientBase<DataObjectService.DataObjectServiceClient>

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

Client for DataObjectService

Inheritance

object > ClientBase > ClientBaseDataObjectServiceDataObjectServiceClient > DataObjectService.DataObjectServiceClient

Inherited Members

ClientBase<DataObjectService.DataObjectServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.VectorSearch.V1

Assembly

Google.Cloud.VectorSearch.V1.dll

Constructors

DataObjectServiceClient()

protected DataObjectServiceClient()

Protected parameterless constructor to allow creation of test doubles.

DataObjectServiceClient(CallInvoker)

public DataObjectServiceClient(CallInvoker callInvoker)

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

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

DataObjectServiceClient(ChannelBase)

public DataObjectServiceClient(ChannelBase channel)

Creates a new client for DataObjectService

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

DataObjectServiceClient(ClientBaseConfiguration)

protected DataObjectServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

BatchCreateDataObjects(BatchCreateDataObjectsRequest, CallOptions)

public virtual BatchCreateDataObjectsResponse BatchCreateDataObjects(BatchCreateDataObjectsRequest request, CallOptions options)

Creates a batch of dataObjects.

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

Returns
Type	Description
BatchCreateDataObjectsResponse	The response received from the server.

BatchCreateDataObjects(BatchCreateDataObjectsRequest, Metadata, DateTime?, CancellationToken)

public virtual BatchCreateDataObjectsResponse BatchCreateDataObjects(BatchCreateDataObjectsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a batch of dataObjects.

Parameters
Name	Description
request	BatchCreateDataObjectsRequest 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
BatchCreateDataObjectsResponse	The response received from the server.

BatchCreateDataObjectsAsync(BatchCreateDataObjectsRequest, CallOptions)

public virtual AsyncUnaryCall<BatchCreateDataObjectsResponse> BatchCreateDataObjectsAsync(BatchCreateDataObjectsRequest request, CallOptions options)

Creates a batch of dataObjects.

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

Returns
Type	Description
AsyncUnaryCallBatchCreateDataObjectsResponse	The call object.

BatchCreateDataObjectsAsync(BatchCreateDataObjectsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<BatchCreateDataObjectsResponse> BatchCreateDataObjectsAsync(BatchCreateDataObjectsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a batch of dataObjects.

Parameters
Name	Description
request	BatchCreateDataObjectsRequest 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
AsyncUnaryCallBatchCreateDataObjectsResponse	The call object.

BatchDeleteDataObjects(BatchDeleteDataObjectsRequest, CallOptions)

public virtual Empty BatchDeleteDataObjects(BatchDeleteDataObjectsRequest request, CallOptions options)

Deletes dataObjects in a batch.

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

Returns
Type	Description
Empty	The response received from the server.

BatchDeleteDataObjects(BatchDeleteDataObjectsRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty BatchDeleteDataObjects(BatchDeleteDataObjectsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes dataObjects in a batch.

Parameters
Name	Description
request	BatchDeleteDataObjectsRequest 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
Empty	The response received from the server.

BatchDeleteDataObjectsAsync(BatchDeleteDataObjectsRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> BatchDeleteDataObjectsAsync(BatchDeleteDataObjectsRequest request, CallOptions options)

Deletes dataObjects in a batch.

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

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

BatchDeleteDataObjectsAsync(BatchDeleteDataObjectsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> BatchDeleteDataObjectsAsync(BatchDeleteDataObjectsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes dataObjects in a batch.

Parameters
Name	Description
request	BatchDeleteDataObjectsRequest 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
AsyncUnaryCallEmpty	The call object.

BatchUpdateDataObjects(BatchUpdateDataObjectsRequest, CallOptions)

public virtual BatchUpdateDataObjectsResponse BatchUpdateDataObjects(BatchUpdateDataObjectsRequest request, CallOptions options)

Updates dataObjects in a batch.

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

Returns
Type	Description
BatchUpdateDataObjectsResponse	The response received from the server.

BatchUpdateDataObjects(BatchUpdateDataObjectsRequest, Metadata, DateTime?, CancellationToken)

public virtual BatchUpdateDataObjectsResponse BatchUpdateDataObjects(BatchUpdateDataObjectsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates dataObjects in a batch.

Parameters
Name	Description
request	BatchUpdateDataObjectsRequest 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
BatchUpdateDataObjectsResponse	The response received from the server.

BatchUpdateDataObjectsAsync(BatchUpdateDataObjectsRequest, CallOptions)

public virtual AsyncUnaryCall<BatchUpdateDataObjectsResponse> BatchUpdateDataObjectsAsync(BatchUpdateDataObjectsRequest request, CallOptions options)

Updates dataObjects in a batch.

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

Returns
Type	Description
AsyncUnaryCallBatchUpdateDataObjectsResponse	The call object.

BatchUpdateDataObjectsAsync(BatchUpdateDataObjectsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<BatchUpdateDataObjectsResponse> BatchUpdateDataObjectsAsync(BatchUpdateDataObjectsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates dataObjects in a batch.

Parameters
Name	Description
request	BatchUpdateDataObjectsRequest 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
AsyncUnaryCallBatchUpdateDataObjectsResponse	The call object.

CreateDataObject(CreateDataObjectRequest, CallOptions)

public virtual DataObject CreateDataObject(CreateDataObjectRequest request, CallOptions options)

Creates a dataObject.

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

Returns
Type	Description
DataObject	The response received from the server.

CreateDataObject(CreateDataObjectRequest, Metadata, DateTime?, CancellationToken)

public virtual DataObject CreateDataObject(CreateDataObjectRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a dataObject.

Parameters
Name	Description
request	CreateDataObjectRequest 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
DataObject	The response received from the server.

CreateDataObjectAsync(CreateDataObjectRequest, CallOptions)

public virtual AsyncUnaryCall<DataObject> CreateDataObjectAsync(CreateDataObjectRequest request, CallOptions options)

Creates a dataObject.

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

Returns
Type	Description
AsyncUnaryCallDataObject	The call object.

CreateDataObjectAsync(CreateDataObjectRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<DataObject> CreateDataObjectAsync(CreateDataObjectRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a dataObject.

Parameters
Name	Description
request	CreateDataObjectRequest 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
AsyncUnaryCallDataObject	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.

DeleteDataObject(DeleteDataObjectRequest, CallOptions)

public virtual Empty DeleteDataObject(DeleteDataObjectRequest request, CallOptions options)

Deletes a dataObject.

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

Returns
Type	Description
Empty	The response received from the server.

DeleteDataObject(DeleteDataObjectRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteDataObject(DeleteDataObjectRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a dataObject.

Parameters
Name	Description
request	DeleteDataObjectRequest 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
Empty	The response received from the server.

DeleteDataObjectAsync(DeleteDataObjectRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteDataObjectAsync(DeleteDataObjectRequest request, CallOptions options)

Deletes a dataObject.

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

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteDataObjectAsync(DeleteDataObjectRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteDataObjectAsync(DeleteDataObjectRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a dataObject.

Parameters
Name	Description
request	DeleteDataObjectRequest 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
AsyncUnaryCallEmpty	The call object.

GetDataObject(GetDataObjectRequest, CallOptions)

public virtual DataObject GetDataObject(GetDataObjectRequest request, CallOptions options)

Gets a data object.

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

Returns
Type	Description
DataObject	The response received from the server.

GetDataObject(GetDataObjectRequest, Metadata, DateTime?, CancellationToken)

public virtual DataObject GetDataObject(GetDataObjectRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a data object.

Parameters
Name	Description
request	GetDataObjectRequest 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
DataObject	The response received from the server.

GetDataObjectAsync(GetDataObjectRequest, CallOptions)

public virtual AsyncUnaryCall<DataObject> GetDataObjectAsync(GetDataObjectRequest request, CallOptions options)

Gets a data object.

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

Returns
Type	Description
AsyncUnaryCallDataObject	The call object.

GetDataObjectAsync(GetDataObjectRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<DataObject> GetDataObjectAsync(GetDataObjectRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a data object.

Parameters
Name	Description
request	GetDataObjectRequest 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
AsyncUnaryCallDataObject	The call object.

NewInstance(ClientBaseConfiguration)

protected override DataObjectService.DataObjectServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
DataObjectServiceDataObjectServiceClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.VectorSearch.V1.DataObjectService.DataObjectServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateDataObject(UpdateDataObjectRequest, CallOptions)

public virtual DataObject UpdateDataObject(UpdateDataObjectRequest request, CallOptions options)

Updates a dataObject.

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

Returns
Type	Description
DataObject	The response received from the server.

UpdateDataObject(UpdateDataObjectRequest, Metadata, DateTime?, CancellationToken)

public virtual DataObject UpdateDataObject(UpdateDataObjectRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a dataObject.

Parameters
Name	Description
request	UpdateDataObjectRequest 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
DataObject	The response received from the server.

UpdateDataObjectAsync(UpdateDataObjectRequest, CallOptions)

public virtual AsyncUnaryCall<DataObject> UpdateDataObjectAsync(UpdateDataObjectRequest request, CallOptions options)

Updates a dataObject.

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

Returns
Type	Description
AsyncUnaryCallDataObject	The call object.

UpdateDataObjectAsync(UpdateDataObjectRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<DataObject> UpdateDataObjectAsync(UpdateDataObjectRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a dataObject.

Parameters
Name	Description
request	UpdateDataObjectRequest 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
AsyncUnaryCallDataObject	The call object.