Cloud AI Platform v1 API - Class IndexService.IndexServiceBase (3.1.0)

[BindServiceMethod(typeof(IndexService), "BindService")]
public abstract class IndexService.IndexServiceBase

Reference documentation and code samples for the Cloud AI Platform v1 API class IndexService.IndexServiceBase.

Base class for server-side implementations of IndexService

Inheritance

object > IndexService.IndexServiceBase

Google.Cloud.AIPlatform.V1.dll

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

Creates an Index.

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).

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

Deletes an Index. An Index can only be deleted when all its [DeployedIndexes][google.cloud.aiplatform.v1.Index.deployed_indexes] had been undeployed.

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).

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

Gets an 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).

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

Lists Indexes in a 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).

public virtual Task<RemoveDatapointsResponse> RemoveDatapoints(RemoveDatapointsRequest request, ServerCallContext context)

Remove Datapoints from an Index.

Parameters
Name	Description
`request`	`RemoveDatapointsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskRemoveDatapointsResponse`	The response to send back to the client (wrapped by a task).

public virtual Task<Operation> UpdateIndex(UpdateIndexRequest request, ServerCallContext context)

Updates an Index.

Parameters
Name	Description
`request`	`UpdateIndexRequest` 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).

public virtual Task<UpsertDatapointsResponse> UpsertDatapoints(UpsertDatapointsRequest request, ServerCallContext context)

Add/update Datapoints into an Index.

Parameters
Name	Description
`request`	`UpsertDatapointsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskUpsertDatapointsResponse`	The response to send back to the client (wrapped by a task).