Cloud AI Platform v1 API - Class IndexEndpointService.IndexEndpointServiceBase (2.4.0)

Stay organized with collections Save and categorize content based on your preferences.
[BindServiceMethod(typeof(IndexEndpointService), "BindService")]
public abstract class IndexEndpointServiceBase

Reference documentation and code samples for the Cloud AI Platform v1 API class IndexEndpointService.IndexEndpointServiceBase.

Base class for server-side implementations of IndexEndpointService

Inheritance

Object > IndexEndpointService.IndexEndpointServiceBase

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Methods

CreateIndexEndpoint(CreateIndexEndpointRequest, ServerCallContext)

public virtual Task<Operation> CreateIndexEndpoint(CreateIndexEndpointRequest request, ServerCallContext context)

Creates an IndexEndpoint.

Parameters
NameDescription
requestCreateIndexEndpointRequest

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

DeleteIndexEndpoint(DeleteIndexEndpointRequest, ServerCallContext)

public virtual Task<Operation> DeleteIndexEndpoint(DeleteIndexEndpointRequest request, ServerCallContext context)

Deletes an IndexEndpoint.

Parameters
NameDescription
requestDeleteIndexEndpointRequest

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

DeployIndex(DeployIndexRequest, ServerCallContext)

public virtual Task<Operation> DeployIndex(DeployIndexRequest request, ServerCallContext context)

Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed.

Parameters
NameDescription
requestDeployIndexRequest

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

GetIndexEndpoint(GetIndexEndpointRequest, ServerCallContext)

public virtual Task<IndexEndpoint> GetIndexEndpoint(GetIndexEndpointRequest request, ServerCallContext context)

Gets an IndexEndpoint.

Parameters
NameDescription
requestGetIndexEndpointRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
Task<IndexEndpoint>

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

ListIndexEndpoints(ListIndexEndpointsRequest, ServerCallContext)

public virtual Task<ListIndexEndpointsResponse> ListIndexEndpoints(ListIndexEndpointsRequest request, ServerCallContext context)

Lists IndexEndpoints in a Location.

Parameters
NameDescription
requestListIndexEndpointsRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
Task<ListIndexEndpointsResponse>

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

MutateDeployedIndex(MutateDeployedIndexRequest, ServerCallContext)

public virtual Task<Operation> MutateDeployedIndex(MutateDeployedIndexRequest request, ServerCallContext context)

Update an existing DeployedIndex under an IndexEndpoint.

Parameters
NameDescription
requestMutateDeployedIndexRequest

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

UndeployIndex(UndeployIndexRequest, ServerCallContext)

public virtual Task<Operation> UndeployIndex(UndeployIndexRequest request, ServerCallContext context)

Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.

Parameters
NameDescription
requestUndeployIndexRequest

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

UpdateIndexEndpoint(UpdateIndexEndpointRequest, ServerCallContext)

public virtual Task<IndexEndpoint> UpdateIndexEndpoint(UpdateIndexEndpointRequest request, ServerCallContext context)

Updates an IndexEndpoint.

Parameters
NameDescription
requestUpdateIndexEndpointRequest

The request received from the client.

contextServerCallContext

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

Returns
TypeDescription
Task<IndexEndpoint>

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