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

public sealed class VectorSearchServiceClientImpl : VectorSearchServiceClient

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

VectorSearchService client wrapper implementation, for convenient use.

Inheritance

object > VectorSearchServiceClient > VectorSearchServiceClientImpl

Namespace

Google.Cloud.VectorSearch.V1

Assembly

Google.Cloud.VectorSearch.V1.dll

Remarks

VectorSearchService provides methods for managing Collection resources, and Collection Index resources. The primary resources offered by this service are Collections which are a container for a set of related JSON data objects, and Collection Indexes which enable efficient ANN search across data objects within a Collection.

Constructors

VectorSearchServiceClientImpl(VectorSearchServiceClient, VectorSearchServiceSettings, ILogger)

public VectorSearchServiceClientImpl(VectorSearchService.VectorSearchServiceClient grpcClient, VectorSearchServiceSettings settings, ILogger logger)

Constructs a client wrapper for the VectorSearchService service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient VectorSearchServiceVectorSearchServiceClient

The underlying gRPC client.
settings VectorSearchServiceSettings

The base VectorSearchServiceSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

CreateCollectionOperationsClient

public override OperationsClient CreateCollectionOperationsClient { get; }

The long-running operations client for CreateCollection.

Property Value
Type Description
OperationsClient
Overrides

CreateIndexOperationsClient

public override OperationsClient CreateIndexOperationsClient { get; }

The long-running operations client for CreateIndex.

Property Value
Type Description
OperationsClient
Overrides

DeleteCollectionOperationsClient

public override OperationsClient DeleteCollectionOperationsClient { get; }

The long-running operations client for DeleteCollection.

Property Value
Type Description
OperationsClient
Overrides

DeleteIndexOperationsClient

public override OperationsClient DeleteIndexOperationsClient { get; }

The long-running operations client for DeleteIndex.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override VectorSearchService.VectorSearchServiceClient GrpcClient { get; }

The underlying gRPC VectorSearchService client

Property Value
Type Description
VectorSearchServiceVectorSearchServiceClient
Overrides

ImportDataObjectsOperationsClient

public override OperationsClient ImportDataObjectsOperationsClient { get; }

The long-running operations client for ImportDataObjects.

Property Value
Type Description
OperationsClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

UpdateCollectionOperationsClient

public override OperationsClient UpdateCollectionOperationsClient { get; }

The long-running operations client for UpdateCollection.

Property Value
Type Description
OperationsClient
Overrides

Methods

CreateCollection(CreateCollectionRequest, CallSettings)

public override Operation<Collection, OperationMetadata> CreateCollection(CreateCollectionRequest request, CallSettings callSettings = null)

Creates a new Collection in a given project and location.

Parameters
Name Description
request CreateCollectionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationCollectionOperationMetadata

The RPC response.
Overrides

CreateCollectionAsync(CreateCollectionRequest, CallSettings)

public override Task<Operation<Collection, OperationMetadata>> CreateCollectionAsync(CreateCollectionRequest request, CallSettings callSettings = null)

Creates a new Collection in a given project and location.

Parameters
Name Description
request CreateCollectionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationCollectionOperationMetadata

A Task containing the RPC response.
Overrides

CreateIndex(CreateIndexRequest, CallSettings)

public override Operation<Index, OperationMetadata> CreateIndex(CreateIndexRequest request, CallSettings callSettings = null)

Creates a new Index in a given project and location.

Parameters
Name Description
request CreateIndexRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationIndexOperationMetadata

The RPC response.
Overrides

CreateIndexAsync(CreateIndexRequest, CallSettings)

public override Task<Operation<Index, OperationMetadata>> CreateIndexAsync(CreateIndexRequest request, CallSettings callSettings = null)

Creates a new Index in a given project and location.

Parameters
Name Description
request CreateIndexRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationIndexOperationMetadata

A Task containing the RPC response.
Overrides

DeleteCollection(DeleteCollectionRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteCollection(DeleteCollectionRequest request, CallSettings callSettings = null)

Deletes a single Collection.

Parameters
Name Description
request DeleteCollectionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteCollectionAsync(DeleteCollectionRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteCollectionAsync(DeleteCollectionRequest request, CallSettings callSettings = null)

Deletes a single Collection.

Parameters
Name Description
request DeleteCollectionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

DeleteIndex(DeleteIndexRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteIndex(DeleteIndexRequest request, CallSettings callSettings = null)

Deletes a single Index.

Parameters
Name Description
request DeleteIndexRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteIndexAsync(DeleteIndexRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteIndexAsync(DeleteIndexRequest request, CallSettings callSettings = null)

Deletes a single Index.

Parameters
Name Description
request DeleteIndexRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

GetCollection(GetCollectionRequest, CallSettings)

public override Collection GetCollection(GetCollectionRequest request, CallSettings callSettings = null)

Gets details of a single Collection.

Parameters
Name Description
request GetCollectionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Collection

The RPC response.
Overrides

GetCollectionAsync(GetCollectionRequest, CallSettings)

public override Task<Collection> GetCollectionAsync(GetCollectionRequest request, CallSettings callSettings = null)

Gets details of a single Collection.

Parameters
Name Description
request GetCollectionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskCollection

A Task containing the RPC response.
Overrides

GetIndex(GetIndexRequest, CallSettings)

public override Index GetIndex(GetIndexRequest request, CallSettings callSettings = null)

Gets details of a single Index.

Parameters
Name Description
request GetIndexRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Index

The RPC response.
Overrides

GetIndexAsync(GetIndexRequest, CallSettings)

public override Task<Index> GetIndexAsync(GetIndexRequest request, CallSettings callSettings = null)

Gets details of a single Index.

Parameters
Name Description
request GetIndexRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskIndex

A Task containing the RPC response.
Overrides

ImportDataObjects(ImportDataObjectsRequest, CallSettings)

public override Operation<ImportDataObjectsResponse, ImportDataObjectsMetadata> ImportDataObjects(ImportDataObjectsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ImportDataObjectsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationImportDataObjectsResponseImportDataObjectsMetadata

The RPC response.
Overrides

ImportDataObjectsAsync(ImportDataObjectsRequest, CallSettings)

public override Task<Operation<ImportDataObjectsResponse, ImportDataObjectsMetadata>> ImportDataObjectsAsync(ImportDataObjectsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ImportDataObjectsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationImportDataObjectsResponseImportDataObjectsMetadata

A Task containing the RPC response.
Overrides

ListCollections(ListCollectionsRequest, CallSettings)

public override PagedEnumerable<ListCollectionsResponse, Collection> ListCollections(ListCollectionsRequest request, CallSettings callSettings = null)

Lists Collections in a given project and location.

Parameters
Name Description
request ListCollectionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListCollectionsResponseCollection

A pageable sequence of Collection resources.
Overrides

ListCollectionsAsync(ListCollectionsRequest, CallSettings)

public override PagedAsyncEnumerable<ListCollectionsResponse, Collection> ListCollectionsAsync(ListCollectionsRequest request, CallSettings callSettings = null)

Lists Collections in a given project and location.

Parameters
Name Description
request ListCollectionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListCollectionsResponseCollection

A pageable asynchronous sequence of Collection resources.
Overrides

ListIndexes(ListIndexesRequest, CallSettings)

public override PagedEnumerable<ListIndexesResponse, Index> ListIndexes(ListIndexesRequest request, CallSettings callSettings = null)

Lists Indexes in a given project and location.

Parameters
Name Description
request ListIndexesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListIndexesResponseIndex

A pageable sequence of Index resources.
Overrides

ListIndexesAsync(ListIndexesRequest, CallSettings)

public override PagedAsyncEnumerable<ListIndexesResponse, Index> ListIndexesAsync(ListIndexesRequest request, CallSettings callSettings = null)

Lists Indexes in a given project and location.

Parameters
Name Description
request ListIndexesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListIndexesResponseIndex

A pageable asynchronous sequence of Index resources.
Overrides

UpdateCollection(UpdateCollectionRequest, CallSettings)

public override Operation<Collection, OperationMetadata> UpdateCollection(UpdateCollectionRequest request, CallSettings callSettings = null)

Updates the parameters of a single Collection.

Parameters
Name Description
request UpdateCollectionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationCollectionOperationMetadata

The RPC response.
Overrides

UpdateCollectionAsync(UpdateCollectionRequest, CallSettings)

public override Task<Operation<Collection, OperationMetadata>> UpdateCollectionAsync(UpdateCollectionRequest request, CallSettings callSettings = null)

Updates the parameters of a single Collection.

Parameters
Name Description
request UpdateCollectionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationCollectionOperationMetadata

A Task containing the RPC response.
Overrides