Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class IndexServiceClientImpl (1.0.0)

public sealed class IndexServiceClientImpl : IndexServiceClient

IndexService client wrapper implementation, for convenient use.

Inheritance

Object > IndexServiceClient > IndexServiceClientImpl

Inherited Members

IndexServiceClient.DefaultEndpoint

IndexServiceClient.DefaultScopes

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, Nullable<Int32>, CallSettings)

IndexServiceClient.ListIndexesAsync(String, String, Nullable<Int32>, CallSettings)

IndexServiceClient.ListIndexes(LocationName, String, Nullable<Int32>, CallSettings)

IndexServiceClient.ListIndexesAsync(LocationName, String, Nullable<Int32>, 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)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

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(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
Name	Description
`grpcClient`	`IndexService.IndexServiceClient` The underlying gRPC client.
`settings`	`IndexServiceSettings` The base IndexServiceSettings used 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
`IndexService.IndexServiceClient`

Overrides

IndexServiceClient.GrpcClient

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
`Operation<Index, CreateIndexOperationMetadata>`	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
`Task<Operation<Index, CreateIndexOperationMetadata>>`	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
`Operation<Empty, DeleteOperationMetadata>`	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
`Task<Operation<Empty, DeleteOperationMetadata>>`	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
`Task<Index>`	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
`PagedEnumerable<ListIndexesResponse, Index>`	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
`PagedAsyncEnumerable<ListIndexesResponse, Index>`	A pageable asynchronous sequence of Index resources.

Overrides

IndexServiceClient.ListIndexesAsync(ListIndexesRequest, 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
`Operation<Index, UpdateIndexOperationMetadata>`	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
`Task<Operation<Index, UpdateIndexOperationMetadata>>`	A Task containing the RPC response.

Overrides

IndexServiceClient.UpdateIndexAsync(UpdateIndexRequest, CallSettings)