Cloud AI Platform v1 API - Class IndexService.IndexServiceClient (2.9.0)

Version 2.9.0

• 3.11.0 (latest)
• 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 class IndexServiceClient : ClientBase<IndexService.IndexServiceClient>

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

Client for IndexService

Inheritance

Object > ClientBase > ClientBase<IndexService.IndexServiceClient> > IndexService.IndexServiceClient

Inherited Members

ClientBase<IndexService.IndexServiceClient>.WithHost(String)

ClientBase.CallInvoker

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

IndexServiceClient()

protected IndexServiceClient()

Protected parameterless constructor to allow creation of test doubles.

IndexServiceClient(CallInvoker)

public IndexServiceClient(CallInvoker callInvoker)

Creates a new client for IndexService that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

IndexServiceClient(ChannelBase)

public IndexServiceClient(ChannelBase channel)

Creates a new client for IndexService

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

IndexServiceClient(ClientBase.ClientBaseConfiguration)

protected IndexServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBase.ClientBaseConfiguration The client configuration.

Methods

CreateIAMPolicyClient()

public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()

Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.

Returns
Type	Description
IAMPolicy.IAMPolicyClient	A new IAMPolicy.IAMPolicyClient for the same target as this client.

CreateIndex(CreateIndexRequest, CallOptions)

public virtual Operation CreateIndex(CreateIndexRequest request, CallOptions options)

Creates an Index.

Parameters
Name	Description
request	CreateIndexRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

CreateIndex(CreateIndexRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation CreateIndex(CreateIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates an Index.

Parameters
Name	Description
request	CreateIndexRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

CreateIndexAsync(CreateIndexRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateIndexAsync(CreateIndexRequest request, CallOptions options)

Creates an Index.

Parameters
Name	Description
request	CreateIndexRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<Operation>	The call object.

CreateIndexAsync(CreateIndexRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateIndexAsync(CreateIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates an Index.

Parameters
Name	Description
request	CreateIndexRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCall<Operation>	The call object.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type	Description
Locations.LocationsClient	A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
Operations.OperationsClient	A new Operations client for the same target as this client.

DeleteIndex(DeleteIndexRequest, CallOptions)

public virtual Operation DeleteIndex(DeleteIndexRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteIndex(DeleteIndexRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation DeleteIndex(DeleteIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteIndexAsync(DeleteIndexRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteIndexAsync(DeleteIndexRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<Operation>	The call object.

DeleteIndexAsync(DeleteIndexRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteIndexAsync(DeleteIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCall<Operation>	The call object.

GetIndex(GetIndexRequest, CallOptions)

public virtual Index GetIndex(GetIndexRequest request, CallOptions options)

Gets an Index.

Parameters
Name	Description
request	GetIndexRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Index	The response received from the server.

GetIndex(GetIndexRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Index GetIndex(GetIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets an Index.

Parameters
Name	Description
request	GetIndexRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Index	The response received from the server.

GetIndexAsync(GetIndexRequest, CallOptions)

public virtual AsyncUnaryCall<Index> GetIndexAsync(GetIndexRequest request, CallOptions options)

Gets an Index.

Parameters
Name	Description
request	GetIndexRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<Index>	The call object.

GetIndexAsync(GetIndexRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Index> GetIndexAsync(GetIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets an Index.

Parameters
Name	Description
request	GetIndexRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCall<Index>	The call object.

ListIndexes(ListIndexesRequest, CallOptions)

public virtual ListIndexesResponse ListIndexes(ListIndexesRequest request, CallOptions options)

Lists Indexes in a Location.

Parameters
Name	Description
request	ListIndexesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListIndexesResponse	The response received from the server.

ListIndexes(ListIndexesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListIndexesResponse ListIndexes(ListIndexesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists Indexes in a Location.

Parameters
Name	Description
request	ListIndexesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListIndexesResponse	The response received from the server.

ListIndexesAsync(ListIndexesRequest, CallOptions)

public virtual AsyncUnaryCall<ListIndexesResponse> ListIndexesAsync(ListIndexesRequest request, CallOptions options)

Lists Indexes in a Location.

Parameters
Name	Description
request	ListIndexesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<ListIndexesResponse>	The call object.

ListIndexesAsync(ListIndexesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListIndexesResponse> ListIndexesAsync(ListIndexesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists Indexes in a Location.

Parameters
Name	Description
request	ListIndexesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCall<ListIndexesResponse>	The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override IndexService.IndexServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBase.ClientBaseConfiguration

Returns
Type	Description
IndexService.IndexServiceClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.AIPlatform.V1.IndexService.IndexServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

RemoveDatapoints(RemoveDatapointsRequest, CallOptions)

public virtual RemoveDatapointsResponse RemoveDatapoints(RemoveDatapointsRequest request, CallOptions options)

Remove Datapoints from an Index.

Parameters
Name	Description
request	RemoveDatapointsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
RemoveDatapointsResponse	The response received from the server.

RemoveDatapoints(RemoveDatapointsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual RemoveDatapointsResponse RemoveDatapoints(RemoveDatapointsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Remove Datapoints from an Index.

Parameters
Name	Description
request	RemoveDatapointsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
RemoveDatapointsResponse	The response received from the server.

RemoveDatapointsAsync(RemoveDatapointsRequest, CallOptions)

public virtual AsyncUnaryCall<RemoveDatapointsResponse> RemoveDatapointsAsync(RemoveDatapointsRequest request, CallOptions options)

Remove Datapoints from an Index.

Parameters
Name	Description
request	RemoveDatapointsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<RemoveDatapointsResponse>	The call object.

RemoveDatapointsAsync(RemoveDatapointsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<RemoveDatapointsResponse> RemoveDatapointsAsync(RemoveDatapointsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Remove Datapoints from an Index.

Parameters
Name	Description
request	RemoveDatapointsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCall<RemoveDatapointsResponse>	The call object.

UpdateIndex(UpdateIndexRequest, CallOptions)

public virtual Operation UpdateIndex(UpdateIndexRequest request, CallOptions options)

Updates an Index.

Parameters
Name	Description
request	UpdateIndexRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

UpdateIndex(UpdateIndexRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation UpdateIndex(UpdateIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Updates an Index.

Parameters
Name	Description
request	UpdateIndexRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

UpdateIndexAsync(UpdateIndexRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateIndexAsync(UpdateIndexRequest request, CallOptions options)

Updates an Index.

Parameters
Name	Description
request	UpdateIndexRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<Operation>	The call object.

UpdateIndexAsync(UpdateIndexRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateIndexAsync(UpdateIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Updates an Index.

Parameters
Name	Description
request	UpdateIndexRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCall<Operation>	The call object.

UpsertDatapoints(UpsertDatapointsRequest, CallOptions)

public virtual UpsertDatapointsResponse UpsertDatapoints(UpsertDatapointsRequest request, CallOptions options)

Add/update Datapoints into an Index.

Parameters
Name	Description
request	UpsertDatapointsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
UpsertDatapointsResponse	The response received from the server.

UpsertDatapoints(UpsertDatapointsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual UpsertDatapointsResponse UpsertDatapoints(UpsertDatapointsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Add/update Datapoints into an Index.

Parameters
Name	Description
request	UpsertDatapointsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
UpsertDatapointsResponse	The response received from the server.

UpsertDatapointsAsync(UpsertDatapointsRequest, CallOptions)

public virtual AsyncUnaryCall<UpsertDatapointsResponse> UpsertDatapointsAsync(UpsertDatapointsRequest request, CallOptions options)

Add/update Datapoints into an Index.

Parameters
Name	Description
request	UpsertDatapointsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<UpsertDatapointsResponse>	The call object.

UpsertDatapointsAsync(UpsertDatapointsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<UpsertDatapointsResponse> UpsertDatapointsAsync(UpsertDatapointsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Add/update Datapoints into an Index.

Parameters
Name	Description
request	UpsertDatapointsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCall<UpsertDatapointsResponse>	The call object.