Cloud AI Platform v1 API - Class IndexEndpointService.IndexEndpointServiceClient (3.11.0)

public class IndexEndpointService.IndexEndpointServiceClient : ClientBase<IndexEndpointService.IndexEndpointServiceClient>

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

Client for IndexEndpointService

Inheritance

object > ClientBase > ClientBase IndexEndpointService IndexEndpointServiceClient > IndexEndpointService.IndexEndpointServiceClient

Inherited Members

ClientBase<IndexEndpointService.IndexEndpointServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

IndexEndpointServiceClient()

protected IndexEndpointServiceClient()

Protected parameterless constructor to allow creation of test doubles.

IndexEndpointServiceClient(CallInvoker)

public IndexEndpointServiceClient(CallInvoker callInvoker)

Creates a new client for IndexEndpointService that uses a custom CallInvoker.

Parameter
Name	Description
`callInvoker`	`CallInvoker` The callInvoker to use to make remote calls.

IndexEndpointServiceClient(ChannelBase)

public IndexEndpointServiceClient(ChannelBase channel)

Creates a new client for IndexEndpointService

Parameter
Name	Description
`channel`	`ChannelBase` The channel to use to make remote calls.

IndexEndpointServiceClient(ClientBaseConfiguration)

protected IndexEndpointServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
`configuration`	`ClientBaseClientBaseConfiguration` The client configuration.

Methods

CreateIAMPolicyClient()

public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()

Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.

Returns
Type	Description
`IAMPolicyIAMPolicyClient`	A new IAMPolicy.IAMPolicyClient for the same target as this client.

CreateIndexEndpoint(CreateIndexEndpointRequest, CallOptions)

public virtual Operation CreateIndexEndpoint(CreateIndexEndpointRequest request, CallOptions options)

Creates an IndexEndpoint.

Parameters
Name	Description
`request`	`CreateIndexEndpointRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

CreateIndexEndpoint(CreateIndexEndpointRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateIndexEndpoint(CreateIndexEndpointRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an IndexEndpoint.

Parameters
Name	Description
`request`	`CreateIndexEndpointRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Operation`	The response received from the server.

CreateIndexEndpointAsync(CreateIndexEndpointRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateIndexEndpointAsync(CreateIndexEndpointRequest request, CallOptions options)

Creates an IndexEndpoint.

Parameters
Name	Description
`request`	`CreateIndexEndpointRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

CreateIndexEndpointAsync(CreateIndexEndpointRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateIndexEndpointAsync(CreateIndexEndpointRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an IndexEndpoint.

Parameters
Name	Description
`request`	`CreateIndexEndpointRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type	Description
`LocationsLocationsClient`	A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
`OperationsOperationsClient`	A new Operations client for the same target as this client.

DeleteIndexEndpoint(DeleteIndexEndpointRequest, CallOptions)

public virtual Operation DeleteIndexEndpoint(DeleteIndexEndpointRequest request, CallOptions options)

Deletes an IndexEndpoint.

Parameters
Name	Description
`request`	`DeleteIndexEndpointRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

DeleteIndexEndpoint(DeleteIndexEndpointRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteIndexEndpoint(DeleteIndexEndpointRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes an IndexEndpoint.

Parameters
Name	Description
`request`	`DeleteIndexEndpointRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Operation`	The response received from the server.

DeleteIndexEndpointAsync(DeleteIndexEndpointRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteIndexEndpointAsync(DeleteIndexEndpointRequest request, CallOptions options)

Deletes an IndexEndpoint.

Parameters
Name	Description
`request`	`DeleteIndexEndpointRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

DeleteIndexEndpointAsync(DeleteIndexEndpointRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteIndexEndpointAsync(DeleteIndexEndpointRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes an IndexEndpoint.

Parameters
Name	Description
`request`	`DeleteIndexEndpointRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

DeployIndex(DeployIndexRequest, CallOptions)

public virtual Operation DeployIndex(DeployIndexRequest request, CallOptions options)

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

Parameters
Name	Description
`request`	`DeployIndexRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

DeployIndex(DeployIndexRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeployIndex(DeployIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
`request`	`DeployIndexRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Operation`	The response received from the server.

DeployIndexAsync(DeployIndexRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeployIndexAsync(DeployIndexRequest request, CallOptions options)

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

Parameters
Name	Description
`request`	`DeployIndexRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

DeployIndexAsync(DeployIndexRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeployIndexAsync(DeployIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
`request`	`DeployIndexRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

GetIndexEndpoint(GetIndexEndpointRequest, CallOptions)

public virtual IndexEndpoint GetIndexEndpoint(GetIndexEndpointRequest request, CallOptions options)

Gets an IndexEndpoint.

Parameters
Name	Description
`request`	`GetIndexEndpointRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`IndexEndpoint`	The response received from the server.

GetIndexEndpoint(GetIndexEndpointRequest, Metadata, DateTime?, CancellationToken)

public virtual IndexEndpoint GetIndexEndpoint(GetIndexEndpointRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets an IndexEndpoint.

Parameters
Name	Description
`request`	`GetIndexEndpointRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`IndexEndpoint`	The response received from the server.

GetIndexEndpointAsync(GetIndexEndpointRequest, CallOptions)

public virtual AsyncUnaryCall<IndexEndpoint> GetIndexEndpointAsync(GetIndexEndpointRequest request, CallOptions options)

Gets an IndexEndpoint.

Parameters
Name	Description
`request`	`GetIndexEndpointRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallIndexEndpoint`	The call object.

GetIndexEndpointAsync(GetIndexEndpointRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<IndexEndpoint> GetIndexEndpointAsync(GetIndexEndpointRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets an IndexEndpoint.

Parameters
Name	Description
`request`	`GetIndexEndpointRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallIndexEndpoint`	The call object.

ListIndexEndpoints(ListIndexEndpointsRequest, CallOptions)

public virtual ListIndexEndpointsResponse ListIndexEndpoints(ListIndexEndpointsRequest request, CallOptions options)

Lists IndexEndpoints in a Location.

Parameters
Name	Description
`request`	`ListIndexEndpointsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`ListIndexEndpointsResponse`	The response received from the server.

ListIndexEndpoints(ListIndexEndpointsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListIndexEndpointsResponse ListIndexEndpoints(ListIndexEndpointsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists IndexEndpoints in a Location.

Parameters
Name	Description
`request`	`ListIndexEndpointsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`ListIndexEndpointsResponse`	The response received from the server.

ListIndexEndpointsAsync(ListIndexEndpointsRequest, CallOptions)

public virtual AsyncUnaryCall<ListIndexEndpointsResponse> ListIndexEndpointsAsync(ListIndexEndpointsRequest request, CallOptions options)

Lists IndexEndpoints in a Location.

Parameters
Name	Description
`request`	`ListIndexEndpointsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallListIndexEndpointsResponse`	The call object.

ListIndexEndpointsAsync(ListIndexEndpointsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListIndexEndpointsResponse> ListIndexEndpointsAsync(ListIndexEndpointsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists IndexEndpoints in a Location.

Parameters
Name	Description
`request`	`ListIndexEndpointsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallListIndexEndpointsResponse`	The call object.

MutateDeployedIndex(MutateDeployedIndexRequest, CallOptions)

public virtual Operation MutateDeployedIndex(MutateDeployedIndexRequest request, CallOptions options)

Update an existing DeployedIndex under an IndexEndpoint.

Parameters
Name	Description
`request`	`MutateDeployedIndexRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

MutateDeployedIndex(MutateDeployedIndexRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation MutateDeployedIndex(MutateDeployedIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Update an existing DeployedIndex under an IndexEndpoint.

Parameters
Name	Description
`request`	`MutateDeployedIndexRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Operation`	The response received from the server.

MutateDeployedIndexAsync(MutateDeployedIndexRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> MutateDeployedIndexAsync(MutateDeployedIndexRequest request, CallOptions options)

Update an existing DeployedIndex under an IndexEndpoint.

Parameters
Name	Description
`request`	`MutateDeployedIndexRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

MutateDeployedIndexAsync(MutateDeployedIndexRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> MutateDeployedIndexAsync(MutateDeployedIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Update an existing DeployedIndex under an IndexEndpoint.

Parameters
Name	Description
`request`	`MutateDeployedIndexRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

NewInstance(ClientBaseConfiguration)

protected override IndexEndpointService.IndexEndpointServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
`configuration`	`ClientBaseClientBaseConfiguration`

Returns
Type	Description
`IndexEndpointServiceIndexEndpointServiceClient`

Overrides

Grpc.Core.ClientBase<Google.Cloud.AIPlatform.V1.IndexEndpointService.IndexEndpointServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UndeployIndex(UndeployIndexRequest, CallOptions)

public virtual Operation UndeployIndex(UndeployIndexRequest request, CallOptions options)

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

Parameters
Name	Description
`request`	`UndeployIndexRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

UndeployIndex(UndeployIndexRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UndeployIndex(UndeployIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
`request`	`UndeployIndexRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Operation`	The response received from the server.

UndeployIndexAsync(UndeployIndexRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UndeployIndexAsync(UndeployIndexRequest request, CallOptions options)

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

Parameters
Name	Description
`request`	`UndeployIndexRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

UndeployIndexAsync(UndeployIndexRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UndeployIndexAsync(UndeployIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
`request`	`UndeployIndexRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

UpdateIndexEndpoint(UpdateIndexEndpointRequest, CallOptions)

public virtual IndexEndpoint UpdateIndexEndpoint(UpdateIndexEndpointRequest request, CallOptions options)

Updates an IndexEndpoint.

Parameters
Name	Description
`request`	`UpdateIndexEndpointRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`IndexEndpoint`	The response received from the server.

UpdateIndexEndpoint(UpdateIndexEndpointRequest, Metadata, DateTime?, CancellationToken)

public virtual IndexEndpoint UpdateIndexEndpoint(UpdateIndexEndpointRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an IndexEndpoint.

Parameters
Name	Description
`request`	`UpdateIndexEndpointRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`IndexEndpoint`	The response received from the server.

UpdateIndexEndpointAsync(UpdateIndexEndpointRequest, CallOptions)

public virtual AsyncUnaryCall<IndexEndpoint> UpdateIndexEndpointAsync(UpdateIndexEndpointRequest request, CallOptions options)

Updates an IndexEndpoint.

Parameters
Name	Description
`request`	`UpdateIndexEndpointRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallIndexEndpoint`	The call object.

UpdateIndexEndpointAsync(UpdateIndexEndpointRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<IndexEndpoint> UpdateIndexEndpointAsync(UpdateIndexEndpointRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an IndexEndpoint.

Parameters
Name	Description
`request`	`UpdateIndexEndpointRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallIndexEndpoint`	The call object.