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

[BindServiceMethod(typeof(IndexService), "BindService")]
public abstract class 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

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Methods

CreateIndex(CreateIndexRequest, ServerCallContext)

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

Creates an Index.

Parameters
NameDescription
requestCreateIndexRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
Task<Operation>

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 an Index. An Index can only be deleted when all its [DeployedIndexes][google.cloud.aiplatform.v1.Index.deployed_indexes] had been undeployed.

Parameters
NameDescription
requestDeleteIndexRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
Task<Operation>

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 an Index.

Parameters
NameDescription
requestGetIndexRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
Task<Index>

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

Parameters
NameDescription
requestListIndexesRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
Task<ListIndexesResponse>

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

RemoveDatapoints(RemoveDatapointsRequest, ServerCallContext)

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

Remove Datapoints from an Index.

Parameters
NameDescription
requestRemoveDatapointsRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
Task<RemoveDatapointsResponse>

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

UpdateIndex(UpdateIndexRequest, ServerCallContext)

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

Updates an Index.

Parameters
NameDescription
requestUpdateIndexRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
Task<Operation>

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

UpsertDatapoints(UpsertDatapointsRequest, ServerCallContext)

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

Add/update Datapoints into an Index.

Parameters
NameDescription
requestUpsertDatapointsRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
Task<UpsertDatapointsResponse>

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