Cloud AI Platform v1 API - Class IndexServiceClient (3.7.0) 

public abstract class IndexServiceClient

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

IndexService client wrapper, for convenient use.

Inheritance

object > IndexServiceClient

Derived Types

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Remarks

A service for creating and managing Vertex AI's Index resources.

Properties

CreateIndexOperationsClient

public virtual OperationsClient CreateIndexOperationsClient { get; }

The long-running operations client for CreateIndex.

Property Value
Type Description
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the IndexService service, which is a host of "aiplatform.googleapis.com" and a port of 443.

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default IndexService scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

The default IndexService scopes are:

DeleteIndexOperationsClient

public virtual OperationsClient DeleteIndexOperationsClient { get; }

The long-running operations client for DeleteIndex.

Property Value
Type Description
OperationsClient

GrpcClient

public virtual IndexService.IndexServiceClient GrpcClient { get; }

The underlying gRPC IndexService client

Property Value
Type Description
IndexServiceIndexServiceClient

IAMPolicyClient

public virtual IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

UpdateIndexOperationsClient

public virtual OperationsClient UpdateIndexOperationsClient { get; }

The long-running operations client for UpdateIndex.

Property Value
Type Description
OperationsClient

Methods

Create()

public static IndexServiceClient Create()

Synchronously creates a IndexServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use IndexServiceClientBuilder.

Returns
Type Description
IndexServiceClient

The created IndexServiceClient.

CreateAsync(CancellationToken)

public static Task<IndexServiceClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a IndexServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use IndexServiceClientBuilder.

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.
Returns
Type Description
TaskIndexServiceClient

The task representing the created IndexServiceClient.

CreateIndex(LocationName, Index, CallSettings)

public virtual Operation<Index, CreateIndexOperationMetadata> CreateIndex(LocationName parent, Index index, CallSettings callSettings = null)

Creates an Index.

Parameters
Name Description
parent LocationName

Required. The resource name of the Location to create the Index in. Format: projects/{project}/locations/{location}
index Index

Required. The Index to create.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationIndexCreateIndexOperationMetadata

The RPC response.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = gcav::IndexServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
gcav::Index index = new gcav::Index();
// Make the request
Operation<gcav::Index, gcav::CreateIndexOperationMetadata> response = indexServiceClient.CreateIndex(parent, index);

// Poll until the returned long-running operation is complete
Operation<gcav::Index, gcav::CreateIndexOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcav::Index result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcav::Index, gcav::CreateIndexOperationMetadata> retrievedResponse = indexServiceClient.PollOnceCreateIndex(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcav::Index retrievedResult = retrievedResponse.Result;
}

CreateIndex(CreateIndexRequest, CallSettings)

public virtual 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.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = gcav::IndexServiceClient.Create();
// Initialize request argument(s)
gcav::CreateIndexRequest request = new gcav::CreateIndexRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Index = new gcav::Index(),
};
// Make the request
Operation<gcav::Index, gcav::CreateIndexOperationMetadata> response = indexServiceClient.CreateIndex(request);

// Poll until the returned long-running operation is complete
Operation<gcav::Index, gcav::CreateIndexOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcav::Index result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcav::Index, gcav::CreateIndexOperationMetadata> retrievedResponse = indexServiceClient.PollOnceCreateIndex(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcav::Index retrievedResult = retrievedResponse.Result;
}

CreateIndex(string, Index, CallSettings)

public virtual Operation<Index, CreateIndexOperationMetadata> CreateIndex(string parent, Index index, CallSettings callSettings = null)

Creates an Index.

Parameters
Name Description
parent string

Required. The resource name of the Location to create the Index in. Format: projects/{project}/locations/{location}
index Index

Required. The Index to create.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationIndexCreateIndexOperationMetadata

The RPC response.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = gcav::IndexServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
gcav::Index index = new gcav::Index();
// Make the request
Operation<gcav::Index, gcav::CreateIndexOperationMetadata> response = indexServiceClient.CreateIndex(parent, index);

// Poll until the returned long-running operation is complete
Operation<gcav::Index, gcav::CreateIndexOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcav::Index result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcav::Index, gcav::CreateIndexOperationMetadata> retrievedResponse = indexServiceClient.PollOnceCreateIndex(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcav::Index retrievedResult = retrievedResponse.Result;
}

CreateIndexAsync(LocationName, Index, CallSettings)

public virtual Task<Operation<Index, CreateIndexOperationMetadata>> CreateIndexAsync(LocationName parent, Index index, CallSettings callSettings = null)

Creates an Index.

Parameters
Name Description
parent LocationName

Required. The resource name of the Location to create the Index in. Format: projects/{project}/locations/{location}
index Index

Required. The Index to create.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationIndexCreateIndexOperationMetadata

A Task containing the RPC response.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = await gcav::IndexServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
gcav::Index index = new gcav::Index();
// Make the request
Operation<gcav::Index, gcav::CreateIndexOperationMetadata> response = await indexServiceClient.CreateIndexAsync(parent, index);

// Poll until the returned long-running operation is complete
Operation<gcav::Index, gcav::CreateIndexOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcav::Index result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcav::Index, gcav::CreateIndexOperationMetadata> retrievedResponse = await indexServiceClient.PollOnceCreateIndexAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcav::Index retrievedResult = retrievedResponse.Result;
}

CreateIndexAsync(LocationName, Index, CancellationToken)

public virtual Task<Operation<Index, CreateIndexOperationMetadata>> CreateIndexAsync(LocationName parent, Index index, CancellationToken cancellationToken)

Creates an Index.

Parameters
Name Description
parent LocationName

Required. The resource name of the Location to create the Index in. Format: projects/{project}/locations/{location}
index Index

Required. The Index to create.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskOperationIndexCreateIndexOperationMetadata

A Task containing the RPC response.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = await gcav::IndexServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
gcav::Index index = new gcav::Index();
// Make the request
Operation<gcav::Index, gcav::CreateIndexOperationMetadata> response = await indexServiceClient.CreateIndexAsync(parent, index);

// Poll until the returned long-running operation is complete
Operation<gcav::Index, gcav::CreateIndexOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcav::Index result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcav::Index, gcav::CreateIndexOperationMetadata> retrievedResponse = await indexServiceClient.PollOnceCreateIndexAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcav::Index retrievedResult = retrievedResponse.Result;
}

CreateIndexAsync(CreateIndexRequest, CallSettings)

public virtual 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.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = await gcav::IndexServiceClient.CreateAsync();
// Initialize request argument(s)
gcav::CreateIndexRequest request = new gcav::CreateIndexRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Index = new gcav::Index(),
};
// Make the request
Operation<gcav::Index, gcav::CreateIndexOperationMetadata> response = await indexServiceClient.CreateIndexAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcav::Index, gcav::CreateIndexOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcav::Index result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcav::Index, gcav::CreateIndexOperationMetadata> retrievedResponse = await indexServiceClient.PollOnceCreateIndexAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcav::Index retrievedResult = retrievedResponse.Result;
}

CreateIndexAsync(CreateIndexRequest, CancellationToken)

public virtual Task<Operation<Index, CreateIndexOperationMetadata>> CreateIndexAsync(CreateIndexRequest request, CancellationToken cancellationToken)

Creates an Index.

Parameters
Name Description
request CreateIndexRequest

The request object containing all of the parameters for the API call.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskOperationIndexCreateIndexOperationMetadata

A Task containing the RPC response.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = await gcav::IndexServiceClient.CreateAsync();
// Initialize request argument(s)
gcav::CreateIndexRequest request = new gcav::CreateIndexRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Index = new gcav::Index(),
};
// Make the request
Operation<gcav::Index, gcav::CreateIndexOperationMetadata> response = await indexServiceClient.CreateIndexAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcav::Index, gcav::CreateIndexOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcav::Index result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcav::Index, gcav::CreateIndexOperationMetadata> retrievedResponse = await indexServiceClient.PollOnceCreateIndexAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcav::Index retrievedResult = retrievedResponse.Result;
}

CreateIndexAsync(string, Index, CallSettings)

public virtual Task<Operation<Index, CreateIndexOperationMetadata>> CreateIndexAsync(string parent, Index index, CallSettings callSettings = null)

Creates an Index.

Parameters
Name Description
parent string

Required. The resource name of the Location to create the Index in. Format: projects/{project}/locations/{location}
index Index

Required. The Index to create.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationIndexCreateIndexOperationMetadata

A Task containing the RPC response.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = await gcav::IndexServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
gcav::Index index = new gcav::Index();
// Make the request
Operation<gcav::Index, gcav::CreateIndexOperationMetadata> response = await indexServiceClient.CreateIndexAsync(parent, index);

// Poll until the returned long-running operation is complete
Operation<gcav::Index, gcav::CreateIndexOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcav::Index result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcav::Index, gcav::CreateIndexOperationMetadata> retrievedResponse = await indexServiceClient.PollOnceCreateIndexAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcav::Index retrievedResult = retrievedResponse.Result;
}

CreateIndexAsync(string, Index, CancellationToken)

public virtual Task<Operation<Index, CreateIndexOperationMetadata>> CreateIndexAsync(string parent, Index index, CancellationToken cancellationToken)

Creates an Index.

Parameters
Name Description
parent string

Required. The resource name of the Location to create the Index in. Format: projects/{project}/locations/{location}
index Index

Required. The Index to create.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskOperationIndexCreateIndexOperationMetadata

A Task containing the RPC response.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = await gcav::IndexServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
gcav::Index index = new gcav::Index();
// Make the request
Operation<gcav::Index, gcav::CreateIndexOperationMetadata> response = await indexServiceClient.CreateIndexAsync(parent, index);

// Poll until the returned long-running operation is complete
Operation<gcav::Index, gcav::CreateIndexOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcav::Index result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcav::Index, gcav::CreateIndexOperationMetadata> retrievedResponse = await indexServiceClient.PollOnceCreateIndexAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcav::Index retrievedResult = retrievedResponse.Result;
}

DeleteIndex(DeleteIndexRequest, CallSettings)

public virtual 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.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = gcav::IndexServiceClient.Create();
// Initialize request argument(s)
gcav::DeleteIndexRequest request = new gcav::DeleteIndexRequest
{
    IndexName = gcav::IndexName.FromProjectLocationIndex("[PROJECT]", "[LOCATION]", "[INDEX]"),
};
// Make the request
Operation<Empty, gcav::DeleteOperationMetadata> response = indexServiceClient.DeleteIndex(request);

// Poll until the returned long-running operation is complete
Operation<Empty, gcav::DeleteOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcav::DeleteOperationMetadata> retrievedResponse = indexServiceClient.PollOnceDeleteIndex(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteIndex(IndexName, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> DeleteIndex(IndexName name, 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
name IndexName

Required. The name of the Index resource to be deleted. Format: projects/{project}/locations/{location}/indexes/{index}
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyDeleteOperationMetadata

The RPC response.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = gcav::IndexServiceClient.Create();
// Initialize request argument(s)
gcav::IndexName name = gcav::IndexName.FromProjectLocationIndex("[PROJECT]", "[LOCATION]", "[INDEX]");
// Make the request
Operation<Empty, gcav::DeleteOperationMetadata> response = indexServiceClient.DeleteIndex(name);

// Poll until the returned long-running operation is complete
Operation<Empty, gcav::DeleteOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcav::DeleteOperationMetadata> retrievedResponse = indexServiceClient.PollOnceDeleteIndex(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteIndex(string, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> DeleteIndex(string name, 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
name string

Required. The name of the Index resource to be deleted. Format: projects/{project}/locations/{location}/indexes/{index}
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyDeleteOperationMetadata

The RPC response.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = gcav::IndexServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/indexes/[INDEX]";
// Make the request
Operation<Empty, gcav::DeleteOperationMetadata> response = indexServiceClient.DeleteIndex(name);

// Poll until the returned long-running operation is complete
Operation<Empty, gcav::DeleteOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcav::DeleteOperationMetadata> retrievedResponse = indexServiceClient.PollOnceDeleteIndex(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteIndexAsync(DeleteIndexRequest, CallSettings)

public virtual 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.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = await gcav::IndexServiceClient.CreateAsync();
// Initialize request argument(s)
gcav::DeleteIndexRequest request = new gcav::DeleteIndexRequest
{
    IndexName = gcav::IndexName.FromProjectLocationIndex("[PROJECT]", "[LOCATION]", "[INDEX]"),
};
// Make the request
Operation<Empty, gcav::DeleteOperationMetadata> response = await indexServiceClient.DeleteIndexAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, gcav::DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcav::DeleteOperationMetadata> retrievedResponse = await indexServiceClient.PollOnceDeleteIndexAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteIndexAsync(DeleteIndexRequest, CancellationToken)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteIndexAsync(DeleteIndexRequest request, CancellationToken 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 object containing all of the parameters for the API call.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = await gcav::IndexServiceClient.CreateAsync();
// Initialize request argument(s)
gcav::DeleteIndexRequest request = new gcav::DeleteIndexRequest
{
    IndexName = gcav::IndexName.FromProjectLocationIndex("[PROJECT]", "[LOCATION]", "[INDEX]"),
};
// Make the request
Operation<Empty, gcav::DeleteOperationMetadata> response = await indexServiceClient.DeleteIndexAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, gcav::DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcav::DeleteOperationMetadata> retrievedResponse = await indexServiceClient.PollOnceDeleteIndexAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteIndexAsync(IndexName, CallSettings)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteIndexAsync(IndexName name, 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
name IndexName

Required. The name of the Index resource to be deleted. Format: projects/{project}/locations/{location}/indexes/{index}
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = await gcav::IndexServiceClient.CreateAsync();
// Initialize request argument(s)
gcav::IndexName name = gcav::IndexName.FromProjectLocationIndex("[PROJECT]", "[LOCATION]", "[INDEX]");
// Make the request
Operation<Empty, gcav::DeleteOperationMetadata> response = await indexServiceClient.DeleteIndexAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, gcav::DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcav::DeleteOperationMetadata> retrievedResponse = await indexServiceClient.PollOnceDeleteIndexAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteIndexAsync(IndexName, CancellationToken)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteIndexAsync(IndexName name, CancellationToken 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
name IndexName

Required. The name of the Index resource to be deleted. Format: projects/{project}/locations/{location}/indexes/{index}
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = await gcav::IndexServiceClient.CreateAsync();
// Initialize request argument(s)
gcav::IndexName name = gcav::IndexName.FromProjectLocationIndex("[PROJECT]", "[LOCATION]", "[INDEX]");
// Make the request
Operation<Empty, gcav::DeleteOperationMetadata> response = await indexServiceClient.DeleteIndexAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, gcav::DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcav::DeleteOperationMetadata> retrievedResponse = await indexServiceClient.PollOnceDeleteIndexAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteIndexAsync(string, CallSettings)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteIndexAsync(string name, 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
name string

Required. The name of the Index resource to be deleted. Format: projects/{project}/locations/{location}/indexes/{index}
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = await gcav::IndexServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/indexes/[INDEX]";
// Make the request
Operation<Empty, gcav::DeleteOperationMetadata> response = await indexServiceClient.DeleteIndexAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, gcav::DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcav::DeleteOperationMetadata> retrievedResponse = await indexServiceClient.PollOnceDeleteIndexAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteIndexAsync(string, CancellationToken)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteIndexAsync(string name, CancellationToken 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
name string

Required. The name of the Index resource to be deleted. Format: projects/{project}/locations/{location}/indexes/{index}
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = await gcav::IndexServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/indexes/[INDEX]";
// Make the request
Operation<Empty, gcav::DeleteOperationMetadata> response = await indexServiceClient.DeleteIndexAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, gcav::DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, gcav::DeleteOperationMetadata> retrievedResponse = await indexServiceClient.PollOnceDeleteIndexAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

GetIndex(GetIndexRequest, CallSettings)

public virtual 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.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = gcav::IndexServiceClient.Create();
// Initialize request argument(s)
gcav::GetIndexRequest request = new gcav::GetIndexRequest
{
    IndexName = gcav::IndexName.FromProjectLocationIndex("[PROJECT]", "[LOCATION]", "[INDEX]"),
};
// Make the request
gcav::Index response = indexServiceClient.GetIndex(request);

GetIndex(IndexName, CallSettings)

public virtual Index GetIndex(IndexName name, CallSettings callSettings = null)

Gets an Index.

Parameters
Name Description
name IndexName

Required. The name of the Index resource. Format: projects/{project}/locations/{location}/indexes/{index}
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Index

The RPC response.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = gcav::IndexServiceClient.Create();
// Initialize request argument(s)
gcav::IndexName name = gcav::IndexName.FromProjectLocationIndex("[PROJECT]", "[LOCATION]", "[INDEX]");
// Make the request
gcav::Index response = indexServiceClient.GetIndex(name);

GetIndex(string, CallSettings)

public virtual Index GetIndex(string name, CallSettings callSettings = null)

Gets an Index.

Parameters
Name Description
name string

Required. The name of the Index resource. Format: projects/{project}/locations/{location}/indexes/{index}
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Index

The RPC response.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = gcav::IndexServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/indexes/[INDEX]";
// Make the request
gcav::Index response = indexServiceClient.GetIndex(name);

GetIndexAsync(GetIndexRequest, CallSettings)

public virtual 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.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = await gcav::IndexServiceClient.CreateAsync();
// Initialize request argument(s)
gcav::GetIndexRequest request = new gcav::GetIndexRequest
{
    IndexName = gcav::IndexName.FromProjectLocationIndex("[PROJECT]", "[LOCATION]", "[INDEX]"),
};
// Make the request
gcav::Index response = await indexServiceClient.GetIndexAsync(request);

GetIndexAsync(GetIndexRequest, CancellationToken)

public virtual Task<Index> GetIndexAsync(GetIndexRequest request, CancellationToken cancellationToken)

Gets an Index.

Parameters
Name Description
request GetIndexRequest

The request object containing all of the parameters for the API call.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskIndex

A Task containing the RPC response.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = await gcav::IndexServiceClient.CreateAsync();
// Initialize request argument(s)
gcav::GetIndexRequest request = new gcav::GetIndexRequest
{
    IndexName = gcav::IndexName.FromProjectLocationIndex("[PROJECT]", "[LOCATION]", "[INDEX]"),
};
// Make the request
gcav::Index response = await indexServiceClient.GetIndexAsync(request);

GetIndexAsync(IndexName, CallSettings)

public virtual Task<Index> GetIndexAsync(IndexName name, CallSettings callSettings = null)

Gets an Index.

Parameters
Name Description
name IndexName

Required. The name of the Index resource. Format: projects/{project}/locations/{location}/indexes/{index}
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskIndex

A Task containing the RPC response.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = await gcav::IndexServiceClient.CreateAsync();
// Initialize request argument(s)
gcav::IndexName name = gcav::IndexName.FromProjectLocationIndex("[PROJECT]", "[LOCATION]", "[INDEX]");
// Make the request
gcav::Index response = await indexServiceClient.GetIndexAsync(name);

GetIndexAsync(IndexName, CancellationToken)

public virtual Task<Index> GetIndexAsync(IndexName name, CancellationToken cancellationToken)

Gets an Index.

Parameters
Name Description
name IndexName

Required. The name of the Index resource. Format: projects/{project}/locations/{location}/indexes/{index}
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskIndex

A Task containing the RPC response.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = await gcav::IndexServiceClient.CreateAsync();
// Initialize request argument(s)
gcav::IndexName name = gcav::IndexName.FromProjectLocationIndex("[PROJECT]", "[LOCATION]", "[INDEX]");
// Make the request
gcav::Index response = await indexServiceClient.GetIndexAsync(name);

GetIndexAsync(string, CallSettings)

public virtual Task<Index> GetIndexAsync(string name, CallSettings callSettings = null)

Gets an Index.

Parameters
Name Description
name string

Required. The name of the Index resource. Format: projects/{project}/locations/{location}/indexes/{index}
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskIndex

A Task containing the RPC response.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = await gcav::IndexServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/indexes/[INDEX]";
// Make the request
gcav::Index response = await indexServiceClient.GetIndexAsync(name);

GetIndexAsync(string, CancellationToken)

public virtual Task<Index> GetIndexAsync(string name, CancellationToken cancellationToken)

Gets an Index.

Parameters
Name Description
name string

Required. The name of the Index resource. Format: projects/{project}/locations/{location}/indexes/{index}
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskIndex

A Task containing the RPC response.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = await gcav::IndexServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/indexes/[INDEX]";
// Make the request
gcav::Index response = await indexServiceClient.GetIndexAsync(name);

ListIndexes(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListIndexesResponse, Index> ListIndexes(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Indexes in a Location.

Parameters
Name Description
parent LocationName

Required. The resource name of the Location from which to list the Indexes. Format: projects/{project}/locations/{location}
pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListIndexesResponseIndex

A pageable sequence of Index resources.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = gcav::IndexServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<gcav::ListIndexesResponse, gcav::Index> response = indexServiceClient.ListIndexes(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (gcav::Index item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcav::ListIndexesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcav::Index item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Index> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Index item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListIndexes(ListIndexesRequest, CallSettings)

public virtual 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.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = gcav::IndexServiceClient.Create();
// Initialize request argument(s)
gcav::ListIndexesRequest request = new gcav::ListIndexesRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    ReadMask = new FieldMask(),
};
// Make the request
PagedEnumerable<gcav::ListIndexesResponse, gcav::Index> response = indexServiceClient.ListIndexes(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (gcav::Index item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcav::ListIndexesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcav::Index item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Index> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Index item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListIndexes(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListIndexesResponse, Index> ListIndexes(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Indexes in a Location.

Parameters
Name Description
parent string

Required. The resource name of the Location from which to list the Indexes. Format: projects/{project}/locations/{location}
pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListIndexesResponseIndex

A pageable sequence of Index resources.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = gcav::IndexServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<gcav::ListIndexesResponse, gcav::Index> response = indexServiceClient.ListIndexes(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (gcav::Index item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (gcav::ListIndexesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcav::Index item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Index> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Index item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListIndexesAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListIndexesResponse, Index> ListIndexesAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Indexes in a Location.

Parameters
Name Description
parent LocationName

Required. The resource name of the Location from which to list the Indexes. Format: projects/{project}/locations/{location}
pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListIndexesResponseIndex

A pageable asynchronous sequence of Index resources.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = await gcav::IndexServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<gcav::ListIndexesResponse, gcav::Index> response = indexServiceClient.ListIndexesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcav::Index item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcav::ListIndexesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcav::Index item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Index> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Index item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListIndexesAsync(ListIndexesRequest, CallSettings)

public virtual 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.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = await gcav::IndexServiceClient.CreateAsync();
// Initialize request argument(s)
gcav::ListIndexesRequest request = new gcav::ListIndexesRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    ReadMask = new FieldMask(),
};
// Make the request
PagedAsyncEnumerable<gcav::ListIndexesResponse, gcav::Index> response = indexServiceClient.ListIndexesAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcav::Index item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcav::ListIndexesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcav::Index item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Index> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Index item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListIndexesAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListIndexesResponse, Index> ListIndexesAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Indexes in a Location.

Parameters
Name Description
parent string

Required. The resource name of the Location from which to list the Indexes. Format: projects/{project}/locations/{location}
pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListIndexesResponseIndex

A pageable asynchronous sequence of Index resources.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = await gcav::IndexServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<gcav::ListIndexesResponse, gcav::Index> response = indexServiceClient.ListIndexesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((gcav::Index item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((gcav::ListIndexesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (gcav::Index item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<gcav::Index> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (gcav::Index item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

PollOnceCreateIndex(string, CallSettings)

public virtual Operation<Index, CreateIndexOperationMetadata> PollOnceCreateIndex(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of CreateIndex.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationIndexCreateIndexOperationMetadata

The result of polling the operation.

PollOnceCreateIndexAsync(string, CallSettings)

public virtual Task<Operation<Index, CreateIndexOperationMetadata>> PollOnceCreateIndexAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of CreateIndex.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationIndexCreateIndexOperationMetadata

A task representing the result of polling the operation.

PollOnceDeleteIndex(string, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> PollOnceDeleteIndex(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of DeleteIndex.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyDeleteOperationMetadata

The result of polling the operation.

PollOnceDeleteIndexAsync(string, CallSettings)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> PollOnceDeleteIndexAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of DeleteIndex.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A task representing the result of polling the operation.

PollOnceUpdateIndex(string, CallSettings)

public virtual Operation<Index, UpdateIndexOperationMetadata> PollOnceUpdateIndex(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of UpdateIndex.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationIndexUpdateIndexOperationMetadata

The result of polling the operation.

PollOnceUpdateIndexAsync(string, CallSettings)

public virtual Task<Operation<Index, UpdateIndexOperationMetadata>> PollOnceUpdateIndexAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of UpdateIndex.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationIndexUpdateIndexOperationMetadata

A task representing the result of polling the operation.

RemoveDatapoints(RemoveDatapointsRequest, CallSettings)

public virtual 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.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = gcav::IndexServiceClient.Create();
// Initialize request argument(s)
gcav::RemoveDatapointsRequest request = new gcav::RemoveDatapointsRequest
{
    IndexAsIndexName = gcav::IndexName.FromProjectLocationIndex("[PROJECT]", "[LOCATION]", "[INDEX]"),
    DatapointIds = { "", },
};
// Make the request
gcav::RemoveDatapointsResponse response = indexServiceClient.RemoveDatapoints(request);

RemoveDatapointsAsync(RemoveDatapointsRequest, CallSettings)

public virtual 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.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = await gcav::IndexServiceClient.CreateAsync();
// Initialize request argument(s)
gcav::RemoveDatapointsRequest request = new gcav::RemoveDatapointsRequest
{
    IndexAsIndexName = gcav::IndexName.FromProjectLocationIndex("[PROJECT]", "[LOCATION]", "[INDEX]"),
    DatapointIds = { "", },
};
// Make the request
gcav::RemoveDatapointsResponse response = await indexServiceClient.RemoveDatapointsAsync(request);

RemoveDatapointsAsync(RemoveDatapointsRequest, CancellationToken)

public virtual Task<RemoveDatapointsResponse> RemoveDatapointsAsync(RemoveDatapointsRequest request, CancellationToken cancellationToken)

Remove Datapoints from an Index.

Parameters
Name Description
request RemoveDatapointsRequest

The request object containing all of the parameters for the API call.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskRemoveDatapointsResponse

A Task containing the RPC response.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = await gcav::IndexServiceClient.CreateAsync();
// Initialize request argument(s)
gcav::RemoveDatapointsRequest request = new gcav::RemoveDatapointsRequest
{
    IndexAsIndexName = gcav::IndexName.FromProjectLocationIndex("[PROJECT]", "[LOCATION]", "[INDEX]"),
    DatapointIds = { "", },
};
// Make the request
gcav::RemoveDatapointsResponse response = await indexServiceClient.RemoveDatapointsAsync(request);

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type Description
Task

A task representing the asynchronous shutdown operation.
Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

UpdateIndex(Index, FieldMask, CallSettings)

public virtual Operation<Index, UpdateIndexOperationMetadata> UpdateIndex(Index index, FieldMask updateMask, CallSettings callSettings = null)

Updates an Index.

Parameters
Name Description
index Index

Required. The Index which updates the resource on the server.
updateMask FieldMask

The update mask applies to the resource. For the FieldMask definition, see [google.protobuf.FieldMask][google.protobuf.FieldMask].
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationIndexUpdateIndexOperationMetadata

The RPC response.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = gcav::IndexServiceClient.Create();
// Initialize request argument(s)
gcav::Index index = new gcav::Index();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<gcav::Index, gcav::UpdateIndexOperationMetadata> response = indexServiceClient.UpdateIndex(index, updateMask);

// Poll until the returned long-running operation is complete
Operation<gcav::Index, gcav::UpdateIndexOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcav::Index result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcav::Index, gcav::UpdateIndexOperationMetadata> retrievedResponse = indexServiceClient.PollOnceUpdateIndex(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcav::Index retrievedResult = retrievedResponse.Result;
}

UpdateIndex(UpdateIndexRequest, CallSettings)

public virtual 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.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = gcav::IndexServiceClient.Create();
// Initialize request argument(s)
gcav::UpdateIndexRequest request = new gcav::UpdateIndexRequest
{
    Index = new gcav::Index(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<gcav::Index, gcav::UpdateIndexOperationMetadata> response = indexServiceClient.UpdateIndex(request);

// Poll until the returned long-running operation is complete
Operation<gcav::Index, gcav::UpdateIndexOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
gcav::Index result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcav::Index, gcav::UpdateIndexOperationMetadata> retrievedResponse = indexServiceClient.PollOnceUpdateIndex(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcav::Index retrievedResult = retrievedResponse.Result;
}

UpdateIndexAsync(Index, FieldMask, CallSettings)

public virtual Task<Operation<Index, UpdateIndexOperationMetadata>> UpdateIndexAsync(Index index, FieldMask updateMask, CallSettings callSettings = null)

Updates an Index.

Parameters
Name Description
index Index

Required. The Index which updates the resource on the server.
updateMask FieldMask

The update mask applies to the resource. For the FieldMask definition, see [google.protobuf.FieldMask][google.protobuf.FieldMask].
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationIndexUpdateIndexOperationMetadata

A Task containing the RPC response.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = await gcav::IndexServiceClient.CreateAsync();
// Initialize request argument(s)
gcav::Index index = new gcav::Index();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<gcav::Index, gcav::UpdateIndexOperationMetadata> response = await indexServiceClient.UpdateIndexAsync(index, updateMask);

// Poll until the returned long-running operation is complete
Operation<gcav::Index, gcav::UpdateIndexOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcav::Index result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcav::Index, gcav::UpdateIndexOperationMetadata> retrievedResponse = await indexServiceClient.PollOnceUpdateIndexAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcav::Index retrievedResult = retrievedResponse.Result;
}

UpdateIndexAsync(Index, FieldMask, CancellationToken)

public virtual Task<Operation<Index, UpdateIndexOperationMetadata>> UpdateIndexAsync(Index index, FieldMask updateMask, CancellationToken cancellationToken)

Updates an Index.

Parameters
Name Description
index Index

Required. The Index which updates the resource on the server.
updateMask FieldMask

The update mask applies to the resource. For the FieldMask definition, see [google.protobuf.FieldMask][google.protobuf.FieldMask].
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskOperationIndexUpdateIndexOperationMetadata

A Task containing the RPC response.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = await gcav::IndexServiceClient.CreateAsync();
// Initialize request argument(s)
gcav::Index index = new gcav::Index();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<gcav::Index, gcav::UpdateIndexOperationMetadata> response = await indexServiceClient.UpdateIndexAsync(index, updateMask);

// Poll until the returned long-running operation is complete
Operation<gcav::Index, gcav::UpdateIndexOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcav::Index result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcav::Index, gcav::UpdateIndexOperationMetadata> retrievedResponse = await indexServiceClient.PollOnceUpdateIndexAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcav::Index retrievedResult = retrievedResponse.Result;
}

UpdateIndexAsync(UpdateIndexRequest, CallSettings)

public virtual 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.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = await gcav::IndexServiceClient.CreateAsync();
// Initialize request argument(s)
gcav::UpdateIndexRequest request = new gcav::UpdateIndexRequest
{
    Index = new gcav::Index(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<gcav::Index, gcav::UpdateIndexOperationMetadata> response = await indexServiceClient.UpdateIndexAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcav::Index, gcav::UpdateIndexOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcav::Index result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcav::Index, gcav::UpdateIndexOperationMetadata> retrievedResponse = await indexServiceClient.PollOnceUpdateIndexAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcav::Index retrievedResult = retrievedResponse.Result;
}

UpdateIndexAsync(UpdateIndexRequest, CancellationToken)

public virtual Task<Operation<Index, UpdateIndexOperationMetadata>> UpdateIndexAsync(UpdateIndexRequest request, CancellationToken cancellationToken)

Updates an Index.

Parameters
Name Description
request UpdateIndexRequest

The request object containing all of the parameters for the API call.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskOperationIndexUpdateIndexOperationMetadata

A Task containing the RPC response.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = await gcav::IndexServiceClient.CreateAsync();
// Initialize request argument(s)
gcav::UpdateIndexRequest request = new gcav::UpdateIndexRequest
{
    Index = new gcav::Index(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<gcav::Index, gcav::UpdateIndexOperationMetadata> response = await indexServiceClient.UpdateIndexAsync(request);

// Poll until the returned long-running operation is complete
Operation<gcav::Index, gcav::UpdateIndexOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
gcav::Index result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<gcav::Index, gcav::UpdateIndexOperationMetadata> retrievedResponse = await indexServiceClient.PollOnceUpdateIndexAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    gcav::Index retrievedResult = retrievedResponse.Result;
}

UpsertDatapoints(UpsertDatapointsRequest, CallSettings)

public virtual 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.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = gcav::IndexServiceClient.Create();
// Initialize request argument(s)
gcav::UpsertDatapointsRequest request = new gcav::UpsertDatapointsRequest
{
    IndexAsIndexName = gcav::IndexName.FromProjectLocationIndex("[PROJECT]", "[LOCATION]", "[INDEX]"),
    Datapoints =
    {
        new gcav::IndexDatapoint(),
    },
    UpdateMask = new FieldMask(),
};
// Make the request
gcav::UpsertDatapointsResponse response = indexServiceClient.UpsertDatapoints(request);

UpsertDatapointsAsync(UpsertDatapointsRequest, CallSettings)

public virtual 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.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = await gcav::IndexServiceClient.CreateAsync();
// Initialize request argument(s)
gcav::UpsertDatapointsRequest request = new gcav::UpsertDatapointsRequest
{
    IndexAsIndexName = gcav::IndexName.FromProjectLocationIndex("[PROJECT]", "[LOCATION]", "[INDEX]"),
    Datapoints =
    {
        new gcav::IndexDatapoint(),
    },
    UpdateMask = new FieldMask(),
};
// Make the request
gcav::UpsertDatapointsResponse response = await indexServiceClient.UpsertDatapointsAsync(request);

UpsertDatapointsAsync(UpsertDatapointsRequest, CancellationToken)

public virtual Task<UpsertDatapointsResponse> UpsertDatapointsAsync(UpsertDatapointsRequest request, CancellationToken cancellationToken)

Add/update Datapoints into an Index.

Parameters
Name Description
request UpsertDatapointsRequest

The request object containing all of the parameters for the API call.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskUpsertDatapointsResponse

A Task containing the RPC response.
Example 
// Create client
gcav::IndexServiceClient indexServiceClient = await gcav::IndexServiceClient.CreateAsync();
// Initialize request argument(s)
gcav::UpsertDatapointsRequest request = new gcav::UpsertDatapointsRequest
{
    IndexAsIndexName = gcav::IndexName.FromProjectLocationIndex("[PROJECT]", "[LOCATION]", "[INDEX]"),
    Datapoints =
    {
        new gcav::IndexDatapoint(),
    },
    UpdateMask = new FieldMask(),
};
// Make the request
gcav::UpsertDatapointsResponse response = await indexServiceClient.UpsertDatapointsAsync(request);