Cloud AI Platform v1 API - Class IndexServiceClientImpl (2.24.0)

Version 2.24.0

• 3.13.0 (latest)
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.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

Inherited Members

IndexServiceClient.DefaultEndpoint

IndexServiceClient.DefaultScopes

IndexServiceClient.ServiceMetadata

IndexServiceClient.CreateAsync(CancellationToken)

IndexServiceClient.Create()

IndexServiceClient.ShutdownDefaultChannelsAsync()

IndexServiceClient.CreateIndexAsync(CreateIndexRequest, CancellationToken)

IndexServiceClient.PollOnceCreateIndex(string, CallSettings)

IndexServiceClient.PollOnceCreateIndexAsync(string, CallSettings)

IndexServiceClient.CreateIndex(string, Index, CallSettings)

IndexServiceClient.CreateIndexAsync(string, Index, CallSettings)

IndexServiceClient.CreateIndexAsync(string, Index, CancellationToken)

IndexServiceClient.CreateIndex(LocationName, Index, CallSettings)

IndexServiceClient.CreateIndexAsync(LocationName, Index, CallSettings)

IndexServiceClient.CreateIndexAsync(LocationName, Index, CancellationToken)

IndexServiceClient.GetIndexAsync(GetIndexRequest, CancellationToken)

IndexServiceClient.GetIndex(string, CallSettings)

IndexServiceClient.GetIndexAsync(string, CallSettings)

IndexServiceClient.GetIndexAsync(string, CancellationToken)

IndexServiceClient.GetIndex(IndexName, CallSettings)

IndexServiceClient.GetIndexAsync(IndexName, CallSettings)

IndexServiceClient.GetIndexAsync(IndexName, CancellationToken)

IndexServiceClient.ListIndexes(string, string, int?, CallSettings)

IndexServiceClient.ListIndexesAsync(string, string, int?, CallSettings)

IndexServiceClient.ListIndexes(LocationName, string, int?, CallSettings)

IndexServiceClient.ListIndexesAsync(LocationName, string, int?, CallSettings)

IndexServiceClient.UpdateIndexAsync(UpdateIndexRequest, CancellationToken)

IndexServiceClient.PollOnceUpdateIndex(string, CallSettings)

IndexServiceClient.PollOnceUpdateIndexAsync(string, CallSettings)

IndexServiceClient.UpdateIndex(Index, FieldMask, CallSettings)

IndexServiceClient.UpdateIndexAsync(Index, FieldMask, CallSettings)

IndexServiceClient.UpdateIndexAsync(Index, FieldMask, CancellationToken)

IndexServiceClient.DeleteIndexAsync(DeleteIndexRequest, CancellationToken)

IndexServiceClient.PollOnceDeleteIndex(string, CallSettings)

IndexServiceClient.PollOnceDeleteIndexAsync(string, CallSettings)

IndexServiceClient.DeleteIndex(string, CallSettings)

IndexServiceClient.DeleteIndexAsync(string, CallSettings)

IndexServiceClient.DeleteIndexAsync(string, CancellationToken)

IndexServiceClient.DeleteIndex(IndexName, CallSettings)

IndexServiceClient.DeleteIndexAsync(IndexName, CallSettings)

IndexServiceClient.DeleteIndexAsync(IndexName, CancellationToken)

IndexServiceClient.UpsertDatapointsAsync(UpsertDatapointsRequest, CancellationToken)

IndexServiceClient.RemoveDatapointsAsync(RemoveDatapointsRequest, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

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

IndexServiceClient.CreateIndexOperationsClient

DeleteIndexOperationsClient

public override OperationsClient DeleteIndexOperationsClient { get; }

The long-running operations client for DeleteIndex.

Property Value
Type	Description
OperationsClient

Overrides

IndexServiceClient.DeleteIndexOperationsClient

GrpcClient

public override IndexService.IndexServiceClient GrpcClient { get; }

The underlying gRPC IndexService client

Property Value
Type	Description
IndexServiceIndexServiceClient

Overrides

IndexServiceClient.GrpcClient

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type	Description
IAMPolicyClient

Overrides

IndexServiceClient.IAMPolicyClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

Overrides

IndexServiceClient.LocationsClient

UpdateIndexOperationsClient

public override OperationsClient UpdateIndexOperationsClient { get; }

The long-running operations client for UpdateIndex.

Property Value
Type	Description
OperationsClient

Overrides

IndexServiceClient.UpdateIndexOperationsClient

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

IndexServiceClient.CreateIndex(CreateIndexRequest, CallSettings)

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

IndexServiceClient.CreateIndexAsync(CreateIndexRequest, CallSettings)

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

IndexServiceClient.DeleteIndex(DeleteIndexRequest, CallSettings)

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

IndexServiceClient.DeleteIndexAsync(DeleteIndexRequest, CallSettings)

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

IndexServiceClient.GetIndex(GetIndexRequest, CallSettings)

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

IndexServiceClient.GetIndexAsync(GetIndexRequest, CallSettings)

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

IndexServiceClient.ListIndexes(ListIndexesRequest, CallSettings)

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

IndexServiceClient.ListIndexesAsync(ListIndexesRequest, CallSettings)

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

IndexServiceClient.RemoveDatapoints(RemoveDatapointsRequest, CallSettings)

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

IndexServiceClient.RemoveDatapointsAsync(RemoveDatapointsRequest, CallSettings)

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

IndexServiceClient.UpdateIndex(UpdateIndexRequest, CallSettings)

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

IndexServiceClient.UpdateIndexAsync(UpdateIndexRequest, CallSettings)

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

IndexServiceClient.UpsertDatapoints(UpsertDatapointsRequest, CallSettings)

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

IndexServiceClient.UpsertDatapointsAsync(UpsertDatapointsRequest, CallSettings)