Class IndexServiceClientImpl

public sealed class IndexServiceClientImpl : IndexServiceClient

IndexService client wrapper implementation, for convenient use.

Inheritance

Object > IndexServiceClient > IndexServiceClientImpl

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Remarks

A service for creating and managing Vertex AI's Index resources.

Constructors

IndexServiceClientImpl(IndexService.IndexServiceClient, IndexServiceSettings)

public IndexServiceClientImpl(IndexService.IndexServiceClient grpcClient, IndexServiceSettings settings)

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

Parameters
NameDescription
grpcClientIndexService.IndexServiceClient

The underlying gRPC client.

settingsIndexServiceSettings

The base IndexServiceSettings used within this client.

Properties

CreateIndexOperationsClient

public override OperationsClient CreateIndexOperationsClient { get; }

The long-running operations client for CreateIndex.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteIndexOperationsClient

public override OperationsClient DeleteIndexOperationsClient { get; }

The long-running operations client for DeleteIndex.

Property Value
TypeDescription
OperationsClient
Overrides

GrpcClient

public override IndexService.IndexServiceClient GrpcClient { get; }

The underlying gRPC IndexService client

Property Value
TypeDescription
IndexService.IndexServiceClient
Overrides

UpdateIndexOperationsClient

public override OperationsClient UpdateIndexOperationsClient { get; }

The long-running operations client for UpdateIndex.

Property Value
TypeDescription
OperationsClient
Overrides

Methods

CreateIndex(CreateIndexRequest, CallSettings)

public override Operation<Index, CreateIndexOperationMetadata> CreateIndex(CreateIndexRequest request, CallSettings callSettings = null)

Creates an Index.

Parameters
NameDescription
requestCreateIndexRequest

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<Index, CreateIndexOperationMetadata>

The RPC response.

Overrides

CreateIndexAsync(CreateIndexRequest, CallSettings)

public override Task<Operation<Index, CreateIndexOperationMetadata>> CreateIndexAsync(CreateIndexRequest request, CallSettings callSettings = null)

Creates an Index.

Parameters
NameDescription
requestCreateIndexRequest

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<Index, CreateIndexOperationMetadata>>

A Task containing the RPC response.

Overrides

DeleteIndex(DeleteIndexRequest, CallSettings)

public override Operation<Empty, DeleteOperationMetadata> DeleteIndex(DeleteIndexRequest request, CallSettings callSettings = null)

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

DeleteIndexAsync(DeleteIndexRequest, CallSettings)

public override Task<Operation<Empty, DeleteOperationMetadata>> DeleteIndexAsync(DeleteIndexRequest request, CallSettings callSettings = null)

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

GetIndex(GetIndexRequest, CallSettings)

public override Index GetIndex(GetIndexRequest request, CallSettings callSettings = null)

Gets an Index.

Parameters
NameDescription
requestGetIndexRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Index

The RPC response.

Overrides

GetIndexAsync(GetIndexRequest, CallSettings)

public override Task<Index> GetIndexAsync(GetIndexRequest request, CallSettings callSettings = null)

Gets an Index.

Parameters
NameDescription
requestGetIndexRequest

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

A Task containing the RPC response.

Overrides

ListIndexes(ListIndexesRequest, CallSettings)

public override PagedEnumerable<ListIndexesResponse, Index> ListIndexes(ListIndexesRequest request, CallSettings callSettings = null)

Lists Indexes in a Location.

Parameters
NameDescription
requestListIndexesRequest

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<ListIndexesResponse, Index>

A pageable sequence of Index resources.

Overrides

ListIndexesAsync(ListIndexesRequest, CallSettings)

public override PagedAsyncEnumerable<ListIndexesResponse, Index> ListIndexesAsync(ListIndexesRequest request, CallSettings callSettings = null)

Lists Indexes in a Location.

Parameters
NameDescription
requestListIndexesRequest

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<ListIndexesResponse, Index>

A pageable asynchronous sequence of Index resources.

Overrides

UpdateIndex(UpdateIndexRequest, CallSettings)

public override Operation<Index, UpdateIndexOperationMetadata> UpdateIndex(UpdateIndexRequest request, CallSettings callSettings = null)

Updates an Index.

Parameters
NameDescription
requestUpdateIndexRequest

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<Index, UpdateIndexOperationMetadata>

The RPC response.

Overrides

UpdateIndexAsync(UpdateIndexRequest, CallSettings)

public override Task<Operation<Index, UpdateIndexOperationMetadata>> UpdateIndexAsync(UpdateIndexRequest request, CallSettings callSettings = null)

Updates an Index.

Parameters
NameDescription
requestUpdateIndexRequest

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<Index, UpdateIndexOperationMetadata>>

A Task containing the RPC response.

Overrides