Cloud AI Platform v1 API - Class IndexServiceClientImpl (2.28.0) 

public sealed class IndexServiceClientImpl : IndexServiceClient

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

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(IndexServiceClient, IndexServiceSettings, ILogger)

public IndexServiceClientImpl(IndexService.IndexServiceClient grpcClient, IndexServiceSettings settings, ILogger logger)

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

Parameters
Name Description
grpcClient IndexServiceIndexServiceClient

The underlying gRPC client.
settings IndexServiceSettings

The base IndexServiceSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

CreateIndexOperationsClient

public override OperationsClient CreateIndexOperationsClient { get; }

The long-running operations client for CreateIndex.

Property Value
Type Description
OperationsClient
Overrides

DeleteIndexOperationsClient

public override OperationsClient DeleteIndexOperationsClient { get; }

The long-running operations client for DeleteIndex.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override IndexService.IndexServiceClient GrpcClient { get; }

The underlying gRPC IndexService client

Property Value
Type Description
IndexServiceIndexServiceClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

UpdateIndexOperationsClient

public override OperationsClient UpdateIndexOperationsClient { get; }

The long-running operations client for UpdateIndex.

Property Value
Type Description
OperationsClient
Overrides

Methods

CreateIndex(CreateIndexRequest, CallSettings)

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

Creates an Index.

Parameters
Name Description
request CreateIndexRequest

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
OperationIndexCreateIndexOperationMetadata

The RPC response.
Overrides

CreateIndexAsync(CreateIndexRequest, CallSettings)

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

Creates an Index.

Parameters
Name Description
request CreateIndexRequest

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
TaskOperationIndexCreateIndexOperationMetadata

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
Name Description
request DeleteIndexRequest

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
OperationEmptyDeleteOperationMetadata

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
Name Description
request DeleteIndexRequest

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
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.
Overrides

GetIndex(GetIndexRequest, CallSettings)

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

Gets an Index.

Parameters
Name Description
request GetIndexRequest

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
Index

The RPC response.
Overrides

GetIndexAsync(GetIndexRequest, CallSettings)

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

Gets an Index.

Parameters
Name Description
request GetIndexRequest

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
TaskIndex

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
Name Description
request ListIndexesRequest

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
PagedEnumerableListIndexesResponseIndex

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
Name Description
request ListIndexesRequest

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
PagedAsyncEnumerableListIndexesResponseIndex

A pageable asynchronous sequence of Index resources.
Overrides

RemoveDatapoints(RemoveDatapointsRequest, CallSettings)

public override RemoveDatapointsResponse RemoveDatapoints(RemoveDatapointsRequest request, CallSettings callSettings = null)

Remove Datapoints from an Index.

Parameters
Name Description
request RemoveDatapointsRequest

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
RemoveDatapointsResponse

The RPC response.
Overrides

RemoveDatapointsAsync(RemoveDatapointsRequest, CallSettings)

public override Task<RemoveDatapointsResponse> RemoveDatapointsAsync(RemoveDatapointsRequest request, CallSettings callSettings = null)

Remove Datapoints from an Index.

Parameters
Name Description
request RemoveDatapointsRequest

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
TaskRemoveDatapointsResponse

A Task containing the RPC response.
Overrides

UpdateIndex(UpdateIndexRequest, CallSettings)

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

Updates an Index.

Parameters
Name Description
request UpdateIndexRequest

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
OperationIndexUpdateIndexOperationMetadata

The RPC response.
Overrides

UpdateIndexAsync(UpdateIndexRequest, CallSettings)

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

Updates an Index.

Parameters
Name Description
request UpdateIndexRequest

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
TaskOperationIndexUpdateIndexOperationMetadata

A Task containing the RPC response.
Overrides

UpsertDatapoints(UpsertDatapointsRequest, CallSettings)

public override UpsertDatapointsResponse UpsertDatapoints(UpsertDatapointsRequest request, CallSettings callSettings = null)

Add/update Datapoints into an Index.

Parameters
Name Description
request UpsertDatapointsRequest

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
UpsertDatapointsResponse

The RPC response.
Overrides

UpsertDatapointsAsync(UpsertDatapointsRequest, CallSettings)

public override Task<UpsertDatapointsResponse> UpsertDatapointsAsync(UpsertDatapointsRequest request, CallSettings callSettings = null)

Add/update Datapoints into an Index.

Parameters
Name Description
request UpsertDatapointsRequest

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
TaskUpsertDatapointsResponse

A Task containing the RPC response.
Overrides