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

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
NameDescription
grpcClientIndexEndpointService.IndexEndpointServiceClient

The underlying gRPC client.

settingsIndexEndpointServiceSettings

The base IndexEndpointServiceSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

CreateIndexEndpointOperationsClient

public override OperationsClient CreateIndexEndpointOperationsClient { get; }

The long-running operations client for CreateIndexEndpoint.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteIndexEndpointOperationsClient

public override OperationsClient DeleteIndexEndpointOperationsClient { get; }

The long-running operations client for DeleteIndexEndpoint.

Property Value
TypeDescription
OperationsClient
Overrides

DeployIndexOperationsClient

public override OperationsClient DeployIndexOperationsClient { get; }

The long-running operations client for DeployIndex.

Property Value
TypeDescription
OperationsClient
Overrides

GrpcClient

public override IndexEndpointService.IndexEndpointServiceClient GrpcClient { get; }

The underlying gRPC IndexEndpointService client

Property Value
TypeDescription
IndexEndpointService.IndexEndpointServiceClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
TypeDescription
IAMPolicyClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
TypeDescription
LocationsClient
Overrides

MutateDeployedIndexOperationsClient

public override OperationsClient MutateDeployedIndexOperationsClient { get; }

The long-running operations client for MutateDeployedIndex.

Property Value
TypeDescription
OperationsClient
Overrides

UndeployIndexOperationsClient

public override OperationsClient UndeployIndexOperationsClient { get; }

The long-running operations client for UndeployIndex.

Property Value
TypeDescription
OperationsClient
Overrides

Methods

CreateIndexEndpoint(CreateIndexEndpointRequest, CallSettings)

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

Creates an IndexEndpoint.

Parameters
NameDescription
requestCreateIndexEndpointRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata>

The RPC response.

Overrides

CreateIndexEndpointAsync(CreateIndexEndpointRequest, CallSettings)

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

Creates an IndexEndpoint.

Parameters
NameDescription
requestCreateIndexEndpointRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata>>

A Task containing the RPC response.

Overrides

DeleteIndexEndpoint(DeleteIndexEndpointRequest, CallSettings)

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

Deletes an IndexEndpoint.

Parameters
NameDescription
requestDeleteIndexEndpointRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Empty, DeleteOperationMetadata>

The RPC response.

Overrides

DeleteIndexEndpointAsync(DeleteIndexEndpointRequest, CallSettings)

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

Deletes an IndexEndpoint.

Parameters
NameDescription
requestDeleteIndexEndpointRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Empty, DeleteOperationMetadata>>

A Task containing the RPC response.

Overrides

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
NameDescription
requestDeployIndexRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<DeployIndexResponse, DeployIndexOperationMetadata>

The RPC response.

Overrides

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
NameDescription
requestDeployIndexRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<DeployIndexResponse, DeployIndexOperationMetadata>>

A Task containing the RPC response.

Overrides

GetIndexEndpoint(GetIndexEndpointRequest, CallSettings)

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

Gets an IndexEndpoint.

Parameters
NameDescription
requestGetIndexEndpointRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
IndexEndpoint

The RPC response.

Overrides

GetIndexEndpointAsync(GetIndexEndpointRequest, CallSettings)

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

Gets an IndexEndpoint.

Parameters
NameDescription
requestGetIndexEndpointRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<IndexEndpoint>

A Task containing the RPC response.

Overrides

ListIndexEndpoints(ListIndexEndpointsRequest, CallSettings)

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

Lists IndexEndpoints in a Location.

Parameters
NameDescription
requestListIndexEndpointsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListIndexEndpointsResponse, IndexEndpoint>

A pageable sequence of IndexEndpoint resources.

Overrides

ListIndexEndpointsAsync(ListIndexEndpointsRequest, CallSettings)

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

Lists IndexEndpoints in a Location.

Parameters
NameDescription
requestListIndexEndpointsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListIndexEndpointsResponse, IndexEndpoint>

A pageable asynchronous sequence of IndexEndpoint resources.

Overrides

MutateDeployedIndex(MutateDeployedIndexRequest, CallSettings)

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

Update an existing DeployedIndex under an IndexEndpoint.

Parameters
NameDescription
requestMutateDeployedIndexRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata>

The RPC response.

Overrides

MutateDeployedIndexAsync(MutateDeployedIndexRequest, CallSettings)

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

Update an existing DeployedIndex under an IndexEndpoint.

Parameters
NameDescription
requestMutateDeployedIndexRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata>>

A Task containing the RPC response.

Overrides

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
NameDescription
requestUndeployIndexRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<UndeployIndexResponse, UndeployIndexOperationMetadata>

The RPC response.

Overrides

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
NameDescription
requestUndeployIndexRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<UndeployIndexResponse, UndeployIndexOperationMetadata>>

A Task containing the RPC response.

Overrides

UpdateIndexEndpoint(UpdateIndexEndpointRequest, CallSettings)

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

Updates an IndexEndpoint.

Parameters
NameDescription
requestUpdateIndexEndpointRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
IndexEndpoint

The RPC response.

Overrides

UpdateIndexEndpointAsync(UpdateIndexEndpointRequest, CallSettings)

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

Updates an IndexEndpoint.

Parameters
NameDescription
requestUpdateIndexEndpointRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<IndexEndpoint>

A Task containing the RPC response.

Overrides