Cloud AI Platform v1 API - Class IndexEndpointServiceClientImpl (2.7.0)

public sealed class IndexEndpointServiceClientImpl : IndexEndpointServiceClient

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

IndexEndpointService client wrapper implementation, for convenient use.

Inheritance

Object > IndexEndpointServiceClient > IndexEndpointServiceClientImpl

Inherited Members

IndexEndpointServiceClient.DefaultEndpoint

IndexEndpointServiceClient.DefaultScopes

IndexEndpointServiceClient.ServiceMetadata

IndexEndpointServiceClient.CreateAsync(CancellationToken)

IndexEndpointServiceClient.Create()

IndexEndpointServiceClient.ShutdownDefaultChannelsAsync()

IndexEndpointServiceClient.CreateIndexEndpointAsync(CreateIndexEndpointRequest, CancellationToken)

IndexEndpointServiceClient.PollOnceCreateIndexEndpoint(String, CallSettings)

IndexEndpointServiceClient.PollOnceCreateIndexEndpointAsync(String, CallSettings)

IndexEndpointServiceClient.CreateIndexEndpoint(String, IndexEndpoint, CallSettings)

IndexEndpointServiceClient.CreateIndexEndpointAsync(String, IndexEndpoint, CallSettings)

IndexEndpointServiceClient.CreateIndexEndpointAsync(String, IndexEndpoint, CancellationToken)

IndexEndpointServiceClient.CreateIndexEndpoint(LocationName, IndexEndpoint, CallSettings)

IndexEndpointServiceClient.CreateIndexEndpointAsync(LocationName, IndexEndpoint, CallSettings)

IndexEndpointServiceClient.CreateIndexEndpointAsync(LocationName, IndexEndpoint, CancellationToken)

IndexEndpointServiceClient.GetIndexEndpointAsync(GetIndexEndpointRequest, CancellationToken)

IndexEndpointServiceClient.GetIndexEndpoint(String, CallSettings)

IndexEndpointServiceClient.GetIndexEndpointAsync(String, CallSettings)

IndexEndpointServiceClient.GetIndexEndpointAsync(String, CancellationToken)

IndexEndpointServiceClient.GetIndexEndpoint(IndexEndpointName, CallSettings)

IndexEndpointServiceClient.GetIndexEndpointAsync(IndexEndpointName, CallSettings)

IndexEndpointServiceClient.GetIndexEndpointAsync(IndexEndpointName, CancellationToken)

IndexEndpointServiceClient.ListIndexEndpoints(String, String, Nullable<Int32>, CallSettings)

IndexEndpointServiceClient.ListIndexEndpointsAsync(String, String, Nullable<Int32>, CallSettings)

IndexEndpointServiceClient.ListIndexEndpoints(LocationName, String, Nullable<Int32>, CallSettings)

IndexEndpointServiceClient.ListIndexEndpointsAsync(LocationName, String, Nullable<Int32>, CallSettings)

IndexEndpointServiceClient.UpdateIndexEndpointAsync(UpdateIndexEndpointRequest, CancellationToken)

IndexEndpointServiceClient.UpdateIndexEndpoint(IndexEndpoint, FieldMask, CallSettings)

IndexEndpointServiceClient.UpdateIndexEndpointAsync(IndexEndpoint, FieldMask, CallSettings)

IndexEndpointServiceClient.UpdateIndexEndpointAsync(IndexEndpoint, FieldMask, CancellationToken)

IndexEndpointServiceClient.DeleteIndexEndpointAsync(DeleteIndexEndpointRequest, CancellationToken)

IndexEndpointServiceClient.PollOnceDeleteIndexEndpoint(String, CallSettings)

IndexEndpointServiceClient.PollOnceDeleteIndexEndpointAsync(String, CallSettings)

IndexEndpointServiceClient.DeleteIndexEndpoint(String, CallSettings)

IndexEndpointServiceClient.DeleteIndexEndpointAsync(String, CallSettings)

IndexEndpointServiceClient.DeleteIndexEndpointAsync(String, CancellationToken)

IndexEndpointServiceClient.DeleteIndexEndpoint(IndexEndpointName, CallSettings)

IndexEndpointServiceClient.DeleteIndexEndpointAsync(IndexEndpointName, CallSettings)

IndexEndpointServiceClient.DeleteIndexEndpointAsync(IndexEndpointName, CancellationToken)

IndexEndpointServiceClient.DeployIndexAsync(DeployIndexRequest, CancellationToken)

IndexEndpointServiceClient.PollOnceDeployIndex(String, CallSettings)

IndexEndpointServiceClient.PollOnceDeployIndexAsync(String, CallSettings)

IndexEndpointServiceClient.DeployIndex(String, DeployedIndex, CallSettings)

IndexEndpointServiceClient.DeployIndexAsync(String, DeployedIndex, CallSettings)

IndexEndpointServiceClient.DeployIndexAsync(String, DeployedIndex, CancellationToken)

IndexEndpointServiceClient.DeployIndex(IndexEndpointName, DeployedIndex, CallSettings)

IndexEndpointServiceClient.DeployIndexAsync(IndexEndpointName, DeployedIndex, CallSettings)

IndexEndpointServiceClient.DeployIndexAsync(IndexEndpointName, DeployedIndex, CancellationToken)

IndexEndpointServiceClient.UndeployIndexAsync(UndeployIndexRequest, CancellationToken)

IndexEndpointServiceClient.PollOnceUndeployIndex(String, CallSettings)

IndexEndpointServiceClient.PollOnceUndeployIndexAsync(String, CallSettings)

IndexEndpointServiceClient.UndeployIndex(String, String, CallSettings)

IndexEndpointServiceClient.UndeployIndexAsync(String, String, CallSettings)

IndexEndpointServiceClient.UndeployIndexAsync(String, String, CancellationToken)

IndexEndpointServiceClient.UndeployIndex(IndexEndpointName, String, CallSettings)

IndexEndpointServiceClient.UndeployIndexAsync(IndexEndpointName, String, CallSettings)

IndexEndpointServiceClient.UndeployIndexAsync(IndexEndpointName, String, CancellationToken)

IndexEndpointServiceClient.MutateDeployedIndexAsync(MutateDeployedIndexRequest, CancellationToken)

IndexEndpointServiceClient.PollOnceMutateDeployedIndex(String, CallSettings)

IndexEndpointServiceClient.PollOnceMutateDeployedIndexAsync(String, CallSettings)

IndexEndpointServiceClient.MutateDeployedIndex(String, DeployedIndex, CallSettings)

IndexEndpointServiceClient.MutateDeployedIndexAsync(String, DeployedIndex, CallSettings)

IndexEndpointServiceClient.MutateDeployedIndexAsync(String, DeployedIndex, CancellationToken)

IndexEndpointServiceClient.MutateDeployedIndex(IndexEndpointName, DeployedIndex, CallSettings)

IndexEndpointServiceClient.MutateDeployedIndexAsync(IndexEndpointName, DeployedIndex, CallSettings)

IndexEndpointServiceClient.MutateDeployedIndexAsync(IndexEndpointName, DeployedIndex, CancellationToken)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Remarks

A service for managing Vertex AI's IndexEndpoints.

Constructors

IndexEndpointServiceClientImpl(IndexEndpointService.IndexEndpointServiceClient, IndexEndpointServiceSettings, ILogger)

public IndexEndpointServiceClientImpl(IndexEndpointService.IndexEndpointServiceClient grpcClient, IndexEndpointServiceSettings settings, ILogger logger)

Constructs a client wrapper for the IndexEndpointService service, with the specified gRPC client and settings.

Parameters
Name	Description
`grpcClient`	`IndexEndpointService.IndexEndpointServiceClient` The underlying gRPC client.
`settings`	`IndexEndpointServiceSettings` The base IndexEndpointServiceSettings used within this client.
`logger`	`ILogger` Optional ILogger to use within this client.

Properties

CreateIndexEndpointOperationsClient

public override OperationsClient CreateIndexEndpointOperationsClient { get; }

The long-running operations client for CreateIndexEndpoint.

Property Value
Type	Description
`OperationsClient`

Overrides

IndexEndpointServiceClient.CreateIndexEndpointOperationsClient

DeleteIndexEndpointOperationsClient

public override OperationsClient DeleteIndexEndpointOperationsClient { get; }

The long-running operations client for DeleteIndexEndpoint.

Property Value
Type	Description
`OperationsClient`

Overrides

IndexEndpointServiceClient.DeleteIndexEndpointOperationsClient

DeployIndexOperationsClient

public override OperationsClient DeployIndexOperationsClient { get; }

The long-running operations client for DeployIndex.

Property Value
Type	Description
`OperationsClient`

Overrides

IndexEndpointServiceClient.DeployIndexOperationsClient

GrpcClient

public override IndexEndpointService.IndexEndpointServiceClient GrpcClient { get; }

The underlying gRPC IndexEndpointService client

Property Value
Type	Description
`IndexEndpointService.IndexEndpointServiceClient`

Overrides

IndexEndpointServiceClient.GrpcClient

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type	Description
`IAMPolicyClient`

Overrides

IndexEndpointServiceClient.IAMPolicyClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
`LocationsClient`

Overrides

IndexEndpointServiceClient.LocationsClient

MutateDeployedIndexOperationsClient

public override OperationsClient MutateDeployedIndexOperationsClient { get; }

The long-running operations client for MutateDeployedIndex.

Property Value
Type	Description
`OperationsClient`

Overrides

IndexEndpointServiceClient.MutateDeployedIndexOperationsClient

UndeployIndexOperationsClient

public override OperationsClient UndeployIndexOperationsClient { get; }

The long-running operations client for UndeployIndex.

Property Value
Type	Description
`OperationsClient`

Overrides

IndexEndpointServiceClient.UndeployIndexOperationsClient

Methods

CreateIndexEndpoint(CreateIndexEndpointRequest, CallSettings)

public override Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata> CreateIndexEndpoint(CreateIndexEndpointRequest request, CallSettings callSettings = null)

Creates an IndexEndpoint.

Parameters
Name	Description
`request`	`CreateIndexEndpointRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata>`	The RPC response.

Overrides

IndexEndpointServiceClient.CreateIndexEndpoint(CreateIndexEndpointRequest, CallSettings)

CreateIndexEndpointAsync(CreateIndexEndpointRequest, CallSettings)

public override async Task<Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata>> CreateIndexEndpointAsync(CreateIndexEndpointRequest request, CallSettings callSettings = null)

Creates an IndexEndpoint.

Parameters
Name	Description
`request`	`CreateIndexEndpointRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata>>`	A Task containing the RPC response.

Overrides

IndexEndpointServiceClient.CreateIndexEndpointAsync(CreateIndexEndpointRequest, CallSettings)

DeleteIndexEndpoint(DeleteIndexEndpointRequest, CallSettings)

public override Operation<Empty, DeleteOperationMetadata> DeleteIndexEndpoint(DeleteIndexEndpointRequest request, CallSettings callSettings = null)

Deletes an IndexEndpoint.

Parameters
Name	Description
`request`	`DeleteIndexEndpointRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<Empty, DeleteOperationMetadata>`	The RPC response.

Overrides

IndexEndpointServiceClient.DeleteIndexEndpoint(DeleteIndexEndpointRequest, CallSettings)

DeleteIndexEndpointAsync(DeleteIndexEndpointRequest, CallSettings)

public override async Task<Operation<Empty, DeleteOperationMetadata>> DeleteIndexEndpointAsync(DeleteIndexEndpointRequest request, CallSettings callSettings = null)

Deletes an IndexEndpoint.

Parameters
Name	Description
`request`	`DeleteIndexEndpointRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<Empty, DeleteOperationMetadata>>`	A Task containing the RPC response.

Overrides

IndexEndpointServiceClient.DeleteIndexEndpointAsync(DeleteIndexEndpointRequest, CallSettings)

DeployIndex(DeployIndexRequest, CallSettings)

public override Operation<DeployIndexResponse, DeployIndexOperationMetadata> DeployIndex(DeployIndexRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<DeployIndexResponse, DeployIndexOperationMetadata>`	The RPC response.

Overrides

IndexEndpointServiceClient.DeployIndex(DeployIndexRequest, CallSettings)

DeployIndexAsync(DeployIndexRequest, CallSettings)

public override async Task<Operation<DeployIndexResponse, DeployIndexOperationMetadata>> DeployIndexAsync(DeployIndexRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<DeployIndexResponse, DeployIndexOperationMetadata>>`	A Task containing the RPC response.

Overrides

IndexEndpointServiceClient.DeployIndexAsync(DeployIndexRequest, CallSettings)

GetIndexEndpoint(GetIndexEndpointRequest, CallSettings)

public override IndexEndpoint GetIndexEndpoint(GetIndexEndpointRequest request, CallSettings callSettings = null)

Gets an IndexEndpoint.

Parameters
Name	Description
`request`	`GetIndexEndpointRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`IndexEndpoint`	The RPC response.

Overrides

IndexEndpointServiceClient.GetIndexEndpoint(GetIndexEndpointRequest, CallSettings)

GetIndexEndpointAsync(GetIndexEndpointRequest, CallSettings)

public override Task<IndexEndpoint> GetIndexEndpointAsync(GetIndexEndpointRequest request, CallSettings callSettings = null)

Gets an IndexEndpoint.

Parameters
Name	Description
`request`	`GetIndexEndpointRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<IndexEndpoint>`	A Task containing the RPC response.

Overrides

IndexEndpointServiceClient.GetIndexEndpointAsync(GetIndexEndpointRequest, CallSettings)

ListIndexEndpoints(ListIndexEndpointsRequest, CallSettings)

public override PagedEnumerable<ListIndexEndpointsResponse, IndexEndpoint> ListIndexEndpoints(ListIndexEndpointsRequest request, CallSettings callSettings = null)

Lists IndexEndpoints in a Location.

Parameters
Name	Description
`request`	`ListIndexEndpointsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerable<ListIndexEndpointsResponse, IndexEndpoint>`	A pageable sequence of IndexEndpoint resources.

Overrides

IndexEndpointServiceClient.ListIndexEndpoints(ListIndexEndpointsRequest, CallSettings)

ListIndexEndpointsAsync(ListIndexEndpointsRequest, CallSettings)

public override PagedAsyncEnumerable<ListIndexEndpointsResponse, IndexEndpoint> ListIndexEndpointsAsync(ListIndexEndpointsRequest request, CallSettings callSettings = null)

Lists IndexEndpoints in a Location.

Parameters
Name	Description
`request`	`ListIndexEndpointsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerable<ListIndexEndpointsResponse, IndexEndpoint>`	A pageable asynchronous sequence of IndexEndpoint resources.

Overrides

IndexEndpointServiceClient.ListIndexEndpointsAsync(ListIndexEndpointsRequest, CallSettings)

MutateDeployedIndex(MutateDeployedIndexRequest, CallSettings)

public override Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata> MutateDeployedIndex(MutateDeployedIndexRequest request, CallSettings callSettings = null)

Update an existing DeployedIndex under an IndexEndpoint.

Parameters
Name	Description
`request`	`MutateDeployedIndexRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata>`	The RPC response.

Overrides

IndexEndpointServiceClient.MutateDeployedIndex(MutateDeployedIndexRequest, CallSettings)

MutateDeployedIndexAsync(MutateDeployedIndexRequest, CallSettings)

public override async Task<Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata>> MutateDeployedIndexAsync(MutateDeployedIndexRequest request, CallSettings callSettings = null)

Update an existing DeployedIndex under an IndexEndpoint.

Parameters
Name	Description
`request`	`MutateDeployedIndexRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata>>`	A Task containing the RPC response.

Overrides

IndexEndpointServiceClient.MutateDeployedIndexAsync(MutateDeployedIndexRequest, CallSettings)

UndeployIndex(UndeployIndexRequest, CallSettings)

public override Operation<UndeployIndexResponse, UndeployIndexOperationMetadata> UndeployIndex(UndeployIndexRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<UndeployIndexResponse, UndeployIndexOperationMetadata>`	The RPC response.

Overrides

IndexEndpointServiceClient.UndeployIndex(UndeployIndexRequest, CallSettings)

UndeployIndexAsync(UndeployIndexRequest, CallSettings)

public override async Task<Operation<UndeployIndexResponse, UndeployIndexOperationMetadata>> UndeployIndexAsync(UndeployIndexRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<UndeployIndexResponse, UndeployIndexOperationMetadata>>`	A Task containing the RPC response.

Overrides

IndexEndpointServiceClient.UndeployIndexAsync(UndeployIndexRequest, CallSettings)

UpdateIndexEndpoint(UpdateIndexEndpointRequest, CallSettings)

public override IndexEndpoint UpdateIndexEndpoint(UpdateIndexEndpointRequest request, CallSettings callSettings = null)

Updates an IndexEndpoint.

Parameters
Name	Description
`request`	`UpdateIndexEndpointRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`IndexEndpoint`	The RPC response.

Overrides

IndexEndpointServiceClient.UpdateIndexEndpoint(UpdateIndexEndpointRequest, CallSettings)

UpdateIndexEndpointAsync(UpdateIndexEndpointRequest, CallSettings)

public override Task<IndexEndpoint> UpdateIndexEndpointAsync(UpdateIndexEndpointRequest request, CallSettings callSettings = null)

Updates an IndexEndpoint.

Parameters
Name	Description
`request`	`UpdateIndexEndpointRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<IndexEndpoint>`	A Task containing the RPC response.

Overrides

IndexEndpointServiceClient.UpdateIndexEndpointAsync(UpdateIndexEndpointRequest, CallSettings)