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

[BindServiceMethod(typeof(VectorSearchService), "BindService")]
public abstract class VectorSearchService.VectorSearchServiceBase

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

Base class for server-side implementations of VectorSearchService

Inheritance

object > VectorSearchService.VectorSearchServiceBase

Namespace

Google.Cloud.VectorSearch.V1

Assembly

Google.Cloud.VectorSearch.V1.dll

Methods

CreateCollection(CreateCollectionRequest, ServerCallContext)

public virtual Task<Operation> CreateCollection(CreateCollectionRequest request, ServerCallContext context)

Creates a new Collection in a given project and location.

Parameters
Name Description
request CreateCollectionRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

CreateIndex(CreateIndexRequest, ServerCallContext)

public virtual Task<Operation> CreateIndex(CreateIndexRequest request, ServerCallContext context)

Creates a new Index in a given project and location.

Parameters
Name Description
request CreateIndexRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteCollection(DeleteCollectionRequest, ServerCallContext)

public virtual Task<Operation> DeleteCollection(DeleteCollectionRequest request, ServerCallContext context)

Deletes a single Collection.

Parameters
Name Description
request DeleteCollectionRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteIndex(DeleteIndexRequest, ServerCallContext)

public virtual Task<Operation> DeleteIndex(DeleteIndexRequest request, ServerCallContext context)

Deletes a single Index.

Parameters
Name Description
request DeleteIndexRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

GetCollection(GetCollectionRequest, ServerCallContext)

public virtual Task<Collection> GetCollection(GetCollectionRequest request, ServerCallContext context)

Gets details of a single Collection.

Parameters
Name Description
request GetCollectionRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskCollection

The response to send back to the client (wrapped by a task).

GetIndex(GetIndexRequest, ServerCallContext)

public virtual Task<Index> GetIndex(GetIndexRequest request, ServerCallContext context)

Gets details of a single Index.

Parameters
Name Description
request GetIndexRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskIndex

The response to send back to the client (wrapped by a task).

ImportDataObjects(ImportDataObjectsRequest, ServerCallContext)

public virtual Task<Operation> ImportDataObjects(ImportDataObjectsRequest request, ServerCallContext context)

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

Parameters
Name Description
request ImportDataObjectsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

ListCollections(ListCollectionsRequest, ServerCallContext)

public virtual Task<ListCollectionsResponse> ListCollections(ListCollectionsRequest request, ServerCallContext context)

Lists Collections in a given project and location.

Parameters
Name Description
request ListCollectionsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListCollectionsResponse

The response to send back to the client (wrapped by a task).

ListIndexes(ListIndexesRequest, ServerCallContext)

public virtual Task<ListIndexesResponse> ListIndexes(ListIndexesRequest request, ServerCallContext context)

Lists Indexes in a given project and location.

Parameters
Name Description
request ListIndexesRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListIndexesResponse

The response to send back to the client (wrapped by a task).

UpdateCollection(UpdateCollectionRequest, ServerCallContext)

public virtual Task<Operation> UpdateCollection(UpdateCollectionRequest request, ServerCallContext context)

Updates the parameters of a single Collection.

Parameters
Name Description
request UpdateCollectionRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).