public sealed class IndexEndpointServiceClientImpl : IndexEndpointServiceClientReference documentation and code samples for the Cloud AI Platform v1beta1 API class IndexEndpointServiceClientImpl.
IndexEndpointService client wrapper implementation, for convenient use.
Namespace
Google.Cloud.AIPlatform.V1Beta1Assembly
Google.Cloud.AIPlatform.V1Beta1.dll
Remarks
A service for managing Vertex AI's IndexEndpoints.
Constructors
IndexEndpointServiceClientImpl(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 | |
|---|---|
| Name | Description |
grpcClient |
IndexEndpointServiceIndexEndpointServiceClientThe underlying gRPC client. |
settings |
IndexEndpointServiceSettingsThe base IndexEndpointServiceSettings used within this client. |
logger |
ILoggerOptional ILogger to use within this client. |
Properties
CreateIndexEndpointOperationsClient
public override OperationsClient CreateIndexEndpointOperationsClient { get; }The long-running operations client for CreateIndexEndpoint.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
DeleteIndexEndpointOperationsClient
public override OperationsClient DeleteIndexEndpointOperationsClient { get; }The long-running operations client for DeleteIndexEndpoint.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
DeployIndexOperationsClient
public override OperationsClient DeployIndexOperationsClient { get; }The long-running operations client for DeployIndex.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
GrpcClient
public override IndexEndpointService.IndexEndpointServiceClient GrpcClient { get; }The underlying gRPC IndexEndpointService client
| Property Value | |
|---|---|
| Type | Description |
IndexEndpointServiceIndexEndpointServiceClient |
|
IAMPolicyClient
public override IAMPolicyClient IAMPolicyClient { get; }The IAMPolicyClient associated with this client.
| Property Value | |
|---|---|
| Type | Description |
IAMPolicyClient |
|
LocationsClient
public override LocationsClient LocationsClient { get; }The LocationsClient associated with this client.
| Property Value | |
|---|---|
| Type | Description |
LocationsClient |
|
MutateDeployedIndexOperationsClient
public override OperationsClient MutateDeployedIndexOperationsClient { get; }The long-running operations client for MutateDeployedIndex.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
UndeployIndexOperationsClient
public override OperationsClient UndeployIndexOperationsClient { get; }The long-running operations client for UndeployIndex.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
Methods
CreateIndexEndpoint(CreateIndexEndpointRequest, CallSettings)
public override Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata> CreateIndexEndpoint(CreateIndexEndpointRequest request, CallSettings callSettings = null)Creates an IndexEndpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateIndexEndpointRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationIndexEndpointCreateIndexEndpointOperationMetadata |
The RPC response. |
CreateIndexEndpointAsync(CreateIndexEndpointRequest, CallSettings)
public override Task<Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata>> CreateIndexEndpointAsync(CreateIndexEndpointRequest request, CallSettings callSettings = null)Creates an IndexEndpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateIndexEndpointRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationIndexEndpointCreateIndexEndpointOperationMetadata |
A Task containing the RPC response. |
DeleteIndexEndpoint(DeleteIndexEndpointRequest, CallSettings)
public override Operation<Empty, DeleteOperationMetadata> DeleteIndexEndpoint(DeleteIndexEndpointRequest request, CallSettings callSettings = null)Deletes an IndexEndpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteIndexEndpointRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyDeleteOperationMetadata |
The RPC response. |
DeleteIndexEndpointAsync(DeleteIndexEndpointRequest, CallSettings)
public override Task<Operation<Empty, DeleteOperationMetadata>> DeleteIndexEndpointAsync(DeleteIndexEndpointRequest request, CallSettings callSettings = null)Deletes an IndexEndpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteIndexEndpointRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyDeleteOperationMetadata |
A Task containing the RPC response. |
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 | |
|---|---|
| Name | Description |
request |
DeployIndexRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationDeployIndexResponseDeployIndexOperationMetadata |
The RPC response. |
DeployIndexAsync(DeployIndexRequest, CallSettings)
public override 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 | |
|---|---|
| Name | Description |
request |
DeployIndexRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationDeployIndexResponseDeployIndexOperationMetadata |
A Task containing the RPC response. |
GetIndexEndpoint(GetIndexEndpointRequest, CallSettings)
public override IndexEndpoint GetIndexEndpoint(GetIndexEndpointRequest request, CallSettings callSettings = null)Gets an IndexEndpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
GetIndexEndpointRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
IndexEndpoint |
The RPC response. |
GetIndexEndpointAsync(GetIndexEndpointRequest, CallSettings)
public override Task<IndexEndpoint> GetIndexEndpointAsync(GetIndexEndpointRequest request, CallSettings callSettings = null)Gets an IndexEndpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
GetIndexEndpointRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskIndexEndpoint |
A Task containing the RPC response. |
ListIndexEndpoints(ListIndexEndpointsRequest, CallSettings)
public override PagedEnumerable<ListIndexEndpointsResponse, IndexEndpoint> ListIndexEndpoints(ListIndexEndpointsRequest request, CallSettings callSettings = null)Lists IndexEndpoints in a Location.
| Parameters | |
|---|---|
| Name | Description |
request |
ListIndexEndpointsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListIndexEndpointsResponseIndexEndpoint |
A pageable sequence of IndexEndpoint resources. |
ListIndexEndpointsAsync(ListIndexEndpointsRequest, CallSettings)
public override PagedAsyncEnumerable<ListIndexEndpointsResponse, IndexEndpoint> ListIndexEndpointsAsync(ListIndexEndpointsRequest request, CallSettings callSettings = null)Lists IndexEndpoints in a Location.
| Parameters | |
|---|---|
| Name | Description |
request |
ListIndexEndpointsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListIndexEndpointsResponseIndexEndpoint |
A pageable asynchronous sequence of IndexEndpoint resources. |
MutateDeployedIndex(MutateDeployedIndexRequest, CallSettings)
public override Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata> MutateDeployedIndex(MutateDeployedIndexRequest request, CallSettings callSettings = null)Update an existing DeployedIndex under an IndexEndpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
MutateDeployedIndexRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationMutateDeployedIndexResponseMutateDeployedIndexOperationMetadata |
The RPC response. |
MutateDeployedIndexAsync(MutateDeployedIndexRequest, CallSettings)
public override Task<Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata>> MutateDeployedIndexAsync(MutateDeployedIndexRequest request, CallSettings callSettings = null)Update an existing DeployedIndex under an IndexEndpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
MutateDeployedIndexRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationMutateDeployedIndexResponseMutateDeployedIndexOperationMetadata |
A Task containing the RPC response. |
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 | |
|---|---|
| Name | Description |
request |
UndeployIndexRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationUndeployIndexResponseUndeployIndexOperationMetadata |
The RPC response. |
UndeployIndexAsync(UndeployIndexRequest, CallSettings)
public override 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 | |
|---|---|
| Name | Description |
request |
UndeployIndexRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationUndeployIndexResponseUndeployIndexOperationMetadata |
A Task containing the RPC response. |
UpdateIndexEndpoint(UpdateIndexEndpointRequest, CallSettings)
public override IndexEndpoint UpdateIndexEndpoint(UpdateIndexEndpointRequest request, CallSettings callSettings = null)Updates an IndexEndpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateIndexEndpointRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
IndexEndpoint |
The RPC response. |
UpdateIndexEndpointAsync(UpdateIndexEndpointRequest, CallSettings)
public override Task<IndexEndpoint> UpdateIndexEndpointAsync(UpdateIndexEndpointRequest request, CallSettings callSettings = null)Updates an IndexEndpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateIndexEndpointRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskIndexEndpoint |
A Task containing the RPC response. |