Vector Search v1 API - Class VectorSearchService.VectorSearchServiceClient (1.0.0-beta01)

public class VectorSearchService.VectorSearchServiceClient : ClientBase<VectorSearchService.VectorSearchServiceClient>

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

Client for VectorSearchService

Inheritance

object > ClientBase > ClientBaseVectorSearchServiceVectorSearchServiceClient > VectorSearchService.VectorSearchServiceClient

Inherited Members

ClientBase<VectorSearchService.VectorSearchServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.VectorSearch.V1

Assembly

Google.Cloud.VectorSearch.V1.dll

Constructors

VectorSearchServiceClient()

protected VectorSearchServiceClient()

Protected parameterless constructor to allow creation of test doubles.

VectorSearchServiceClient(CallInvoker)

public VectorSearchServiceClient(CallInvoker callInvoker)

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

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

VectorSearchServiceClient(ChannelBase)

public VectorSearchServiceClient(ChannelBase channel)

Creates a new client for VectorSearchService

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

VectorSearchServiceClient(ClientBaseConfiguration)

protected VectorSearchServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateCollection(CreateCollectionRequest, CallOptions)

public virtual Operation CreateCollection(CreateCollectionRequest request, CallOptions options)

Creates a new Collection in a given project and location.

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

Returns
Type	Description
Operation	The response received from the server.

CreateCollection(CreateCollectionRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateCollection(CreateCollectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new Collection in a given project and location.

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

CreateCollectionAsync(CreateCollectionRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateCollectionAsync(CreateCollectionRequest request, CallOptions options)

Creates a new Collection in a given project and location.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateCollectionAsync(CreateCollectionRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateCollectionAsync(CreateCollectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new Collection in a given project and location.

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

CreateIndex(CreateIndexRequest, CallOptions)

public virtual Operation CreateIndex(CreateIndexRequest request, CallOptions options)

Creates a new Index in a given project and location.

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

Returns
Type	Description
Operation	The response received from the server.

CreateIndex(CreateIndexRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateIndex(CreateIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new Index in a given project and location.

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

CreateIndexAsync(CreateIndexRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateIndexAsync(CreateIndexRequest request, CallOptions options)

Creates a new Index in a given project and location.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateIndexAsync(CreateIndexRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateIndexAsync(CreateIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new Index in a given project and location.

Parameters
Name	Description
request	CreateIndexRequest 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
AsyncUnaryCallOperation	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.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

DeleteCollection(DeleteCollectionRequest, CallOptions)

public virtual Operation DeleteCollection(DeleteCollectionRequest request, CallOptions options)

Deletes a single Collection.

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

Returns
Type	Description
Operation	The response received from the server.

DeleteCollection(DeleteCollectionRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteCollection(DeleteCollectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a single Collection.

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

DeleteCollectionAsync(DeleteCollectionRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteCollectionAsync(DeleteCollectionRequest request, CallOptions options)

Deletes a single Collection.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteCollectionAsync(DeleteCollectionRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteCollectionAsync(DeleteCollectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a single Collection.

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

DeleteIndex(DeleteIndexRequest, CallOptions)

public virtual Operation DeleteIndex(DeleteIndexRequest request, CallOptions options)

Deletes a single Index.

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

Returns
Type	Description
Operation	The response received from the server.

DeleteIndex(DeleteIndexRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteIndex(DeleteIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a single Index.

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

DeleteIndexAsync(DeleteIndexRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteIndexAsync(DeleteIndexRequest request, CallOptions options)

Deletes a single Index.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteIndexAsync(DeleteIndexRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteIndexAsync(DeleteIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a single Index.

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

GetCollection(GetCollectionRequest, CallOptions)

public virtual Collection GetCollection(GetCollectionRequest request, CallOptions options)

Gets details of a single Collection.

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

Returns
Type	Description
Collection	The response received from the server.

GetCollection(GetCollectionRequest, Metadata, DateTime?, CancellationToken)

public virtual Collection GetCollection(GetCollectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single Collection.

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

GetCollectionAsync(GetCollectionRequest, CallOptions)

public virtual AsyncUnaryCall<Collection> GetCollectionAsync(GetCollectionRequest request, CallOptions options)

Gets details of a single Collection.

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

Returns
Type	Description
AsyncUnaryCallCollection	The call object.

GetCollectionAsync(GetCollectionRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Collection> GetCollectionAsync(GetCollectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single Collection.

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

GetIndex(GetIndexRequest, CallOptions)

public virtual Index GetIndex(GetIndexRequest request, CallOptions options)

Gets details of a single Index.

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

Returns
Type	Description
Index	The response received from the server.

GetIndex(GetIndexRequest, Metadata, DateTime?, CancellationToken)

public virtual Index GetIndex(GetIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single Index.

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

GetIndexAsync(GetIndexRequest, CallOptions)

public virtual AsyncUnaryCall<Index> GetIndexAsync(GetIndexRequest request, CallOptions options)

Gets details of a single Index.

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

Returns
Type	Description
AsyncUnaryCallIndex	The call object.

GetIndexAsync(GetIndexRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Index> GetIndexAsync(GetIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single Index.

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

ImportDataObjects(ImportDataObjectsRequest, CallOptions)

public virtual Operation ImportDataObjects(ImportDataObjectsRequest request, CallOptions options)

Initiates a Long-Running Operation to import DataObjects into a Collection.

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

Returns
Type	Description
Operation	The response received from the server.

ImportDataObjects(ImportDataObjectsRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation ImportDataObjects(ImportDataObjectsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Initiates a Long-Running Operation to import DataObjects into a Collection.

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

ImportDataObjectsAsync(ImportDataObjectsRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ImportDataObjectsAsync(ImportDataObjectsRequest request, CallOptions options)

Initiates a Long-Running Operation to import DataObjects into a Collection.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

ImportDataObjectsAsync(ImportDataObjectsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> ImportDataObjectsAsync(ImportDataObjectsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Initiates a Long-Running Operation to import DataObjects into a Collection.

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

ListCollections(ListCollectionsRequest, CallOptions)

public virtual ListCollectionsResponse ListCollections(ListCollectionsRequest request, CallOptions options)

Lists Collections in a given project and location.

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

Returns
Type	Description
ListCollectionsResponse	The response received from the server.

ListCollections(ListCollectionsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListCollectionsResponse ListCollections(ListCollectionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Collections in a given project and location.

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

ListCollectionsAsync(ListCollectionsRequest, CallOptions)

public virtual AsyncUnaryCall<ListCollectionsResponse> ListCollectionsAsync(ListCollectionsRequest request, CallOptions options)

Lists Collections in a given project and location.

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

Returns
Type	Description
AsyncUnaryCallListCollectionsResponse	The call object.

ListCollectionsAsync(ListCollectionsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListCollectionsResponse> ListCollectionsAsync(ListCollectionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Collections in a given project and location.

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

ListIndexes(ListIndexesRequest, CallOptions)

public virtual ListIndexesResponse ListIndexes(ListIndexesRequest request, CallOptions options)

Lists Indexes in a given project and location.

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

Returns
Type	Description
ListIndexesResponse	The response received from the server.

ListIndexes(ListIndexesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListIndexesResponse ListIndexes(ListIndexesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Indexes in a given project and location.

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

ListIndexesAsync(ListIndexesRequest, CallOptions)

public virtual AsyncUnaryCall<ListIndexesResponse> ListIndexesAsync(ListIndexesRequest request, CallOptions options)

Lists Indexes in a given project and location.

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

Returns
Type	Description
AsyncUnaryCallListIndexesResponse	The call object.

ListIndexesAsync(ListIndexesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListIndexesResponse> ListIndexesAsync(ListIndexesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Indexes in a given project and location.

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

NewInstance(ClientBaseConfiguration)

protected override VectorSearchService.VectorSearchServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
VectorSearchServiceVectorSearchServiceClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.VectorSearch.V1.VectorSearchService.VectorSearchServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateCollection(UpdateCollectionRequest, CallOptions)

public virtual Operation UpdateCollection(UpdateCollectionRequest request, CallOptions options)

Updates the parameters of a single Collection.

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

Returns
Type	Description
Operation	The response received from the server.

UpdateCollection(UpdateCollectionRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateCollection(UpdateCollectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the parameters of a single Collection.

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

UpdateCollectionAsync(UpdateCollectionRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateCollectionAsync(UpdateCollectionRequest request, CallOptions options)

Updates the parameters of a single Collection.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateCollectionAsync(UpdateCollectionRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateCollectionAsync(UpdateCollectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the parameters of a single Collection.

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