Cloud AI Platform v1beta1 API - Class IndexEndpointServiceClient (1.0.0-beta05)

Version 1.0.0-beta05

• 1.0.0-beta11 (latest)
• 1.0.0-beta10

public abstract class IndexEndpointServiceClient

Reference documentation and code samples for the Cloud AI Platform v1beta1 API class IndexEndpointServiceClient.

IndexEndpointService client wrapper, for convenient use.

Inheritance

object > IndexEndpointServiceClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

IndexEndpointServiceClientImpl

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Remarks

A service for managing Vertex AI's IndexEndpoints.

Properties

CreateIndexEndpointOperationsClient

public virtual OperationsClient CreateIndexEndpointOperationsClient { get; }

The long-running operations client for CreateIndexEndpoint.

Property Value
Type	Description
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the IndexEndpointService 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 IndexEndpointService scopes.

Property Value
Type	Description
IReadOnlyListstring

Remarks

The default IndexEndpointService scopes are:

• https://www.googleapis.com/auth/cloud-platform

DeleteIndexEndpointOperationsClient

public virtual OperationsClient DeleteIndexEndpointOperationsClient { get; }

The long-running operations client for DeleteIndexEndpoint.

Property Value
Type	Description
OperationsClient

DeployIndexOperationsClient

public virtual OperationsClient DeployIndexOperationsClient { get; }

The long-running operations client for DeployIndex.

Property Value
Type	Description
OperationsClient

GrpcClient

public virtual IndexEndpointService.IndexEndpointServiceClient GrpcClient { get; }

The underlying gRPC IndexEndpointService client

Property Value
Type	Description
IndexEndpointServiceIndexEndpointServiceClient

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

MutateDeployedIndexOperationsClient

public virtual OperationsClient MutateDeployedIndexOperationsClient { get; }

The long-running operations client for MutateDeployedIndex.

Property Value
Type	Description
OperationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
ServiceMetadata

UndeployIndexOperationsClient

public virtual OperationsClient UndeployIndexOperationsClient { get; }

The long-running operations client for UndeployIndex.

Property Value
Type	Description
OperationsClient

Methods

Create()

public static IndexEndpointServiceClient Create()

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

Returns
Type	Description
IndexEndpointServiceClient	The created IndexEndpointServiceClient.

CreateAsync(CancellationToken)

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

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

Parameter
Name	Description
cancellationToken	CancellationToken The CancellationToken to use while creating the client.

Returns
Type	Description
TaskIndexEndpointServiceClient	The task representing the created IndexEndpointServiceClient.

CreateIndexEndpoint(LocationName, IndexEndpoint, CallSettings)

public virtual Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata> CreateIndexEndpoint(LocationName parent, IndexEndpoint indexEndpoint, CallSettings callSettings = null)

Creates an IndexEndpoint.

Parameters
Name	Description
parent	LocationName Required. The resource name of the Location to create the IndexEndpoint in. Format: projects/{project}/locations/{location}
indexEndpoint	IndexEndpoint Required. The IndexEndpoint to create.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationIndexEndpointCreateIndexEndpointOperationMetadata	The RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = IndexEndpointServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
IndexEndpoint indexEndpoint = new IndexEndpoint();
// Make the request
Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata> response = indexEndpointServiceClient.CreateIndexEndpoint(parent, indexEndpoint);

// Poll until the returned long-running operation is complete
Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
IndexEndpoint 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<IndexEndpoint, CreateIndexEndpointOperationMetadata> retrievedResponse = indexEndpointServiceClient.PollOnceCreateIndexEndpoint(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    IndexEndpoint retrievedResult = retrievedResponse.Result;
}

CreateIndexEndpoint(CreateIndexEndpointRequest, CallSettings)

public virtual Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata> CreateIndexEndpoint(CreateIndexEndpointRequest request, CallSettings callSettings = null)

Creates an IndexEndpoint.

Parameters
Name	Description
request	CreateIndexEndpointRequest 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
OperationIndexEndpointCreateIndexEndpointOperationMetadata	The RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = IndexEndpointServiceClient.Create();
// Initialize request argument(s)
CreateIndexEndpointRequest request = new CreateIndexEndpointRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    IndexEndpoint = new IndexEndpoint(),
};
// Make the request
Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata> response = indexEndpointServiceClient.CreateIndexEndpoint(request);

// Poll until the returned long-running operation is complete
Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
IndexEndpoint 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<IndexEndpoint, CreateIndexEndpointOperationMetadata> retrievedResponse = indexEndpointServiceClient.PollOnceCreateIndexEndpoint(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    IndexEndpoint retrievedResult = retrievedResponse.Result;
}

CreateIndexEndpoint(string, IndexEndpoint, CallSettings)

public virtual Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata> CreateIndexEndpoint(string parent, IndexEndpoint indexEndpoint, CallSettings callSettings = null)

Creates an IndexEndpoint.

Parameters
Name	Description
parent	string Required. The resource name of the Location to create the IndexEndpoint in. Format: projects/{project}/locations/{location}
indexEndpoint	IndexEndpoint Required. The IndexEndpoint to create.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationIndexEndpointCreateIndexEndpointOperationMetadata	The RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = IndexEndpointServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
IndexEndpoint indexEndpoint = new IndexEndpoint();
// Make the request
Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata> response = indexEndpointServiceClient.CreateIndexEndpoint(parent, indexEndpoint);

// Poll until the returned long-running operation is complete
Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
IndexEndpoint 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<IndexEndpoint, CreateIndexEndpointOperationMetadata> retrievedResponse = indexEndpointServiceClient.PollOnceCreateIndexEndpoint(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    IndexEndpoint retrievedResult = retrievedResponse.Result;
}

CreateIndexEndpointAsync(LocationName, IndexEndpoint, CallSettings)

public virtual Task<Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata>> CreateIndexEndpointAsync(LocationName parent, IndexEndpoint indexEndpoint, CallSettings callSettings = null)

Creates an IndexEndpoint.

Parameters
Name	Description
parent	LocationName Required. The resource name of the Location to create the IndexEndpoint in. Format: projects/{project}/locations/{location}
indexEndpoint	IndexEndpoint Required. The IndexEndpoint to create.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationIndexEndpointCreateIndexEndpointOperationMetadata	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
IndexEndpoint indexEndpoint = new IndexEndpoint();
// Make the request
Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata> response = await indexEndpointServiceClient.CreateIndexEndpointAsync(parent, indexEndpoint);

// Poll until the returned long-running operation is complete
Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
IndexEndpoint 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<IndexEndpoint, CreateIndexEndpointOperationMetadata> retrievedResponse = await indexEndpointServiceClient.PollOnceCreateIndexEndpointAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    IndexEndpoint retrievedResult = retrievedResponse.Result;
}

CreateIndexEndpointAsync(LocationName, IndexEndpoint, CancellationToken)

public virtual Task<Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata>> CreateIndexEndpointAsync(LocationName parent, IndexEndpoint indexEndpoint, CancellationToken cancellationToken)

Creates an IndexEndpoint.

Parameters
Name	Description
parent	LocationName Required. The resource name of the Location to create the IndexEndpoint in. Format: projects/{project}/locations/{location}
indexEndpoint	IndexEndpoint Required. The IndexEndpoint to create.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationIndexEndpointCreateIndexEndpointOperationMetadata	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
IndexEndpoint indexEndpoint = new IndexEndpoint();
// Make the request
Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata> response = await indexEndpointServiceClient.CreateIndexEndpointAsync(parent, indexEndpoint);

// Poll until the returned long-running operation is complete
Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
IndexEndpoint 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<IndexEndpoint, CreateIndexEndpointOperationMetadata> retrievedResponse = await indexEndpointServiceClient.PollOnceCreateIndexEndpointAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    IndexEndpoint retrievedResult = retrievedResponse.Result;
}

CreateIndexEndpointAsync(CreateIndexEndpointRequest, CallSettings)

public virtual Task<Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata>> CreateIndexEndpointAsync(CreateIndexEndpointRequest request, CallSettings callSettings = null)

Creates an IndexEndpoint.

Parameters
Name	Description
request	CreateIndexEndpointRequest 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
TaskOperationIndexEndpointCreateIndexEndpointOperationMetadata	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
CreateIndexEndpointRequest request = new CreateIndexEndpointRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    IndexEndpoint = new IndexEndpoint(),
};
// Make the request
Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata> response = await indexEndpointServiceClient.CreateIndexEndpointAsync(request);

// Poll until the returned long-running operation is complete
Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
IndexEndpoint 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<IndexEndpoint, CreateIndexEndpointOperationMetadata> retrievedResponse = await indexEndpointServiceClient.PollOnceCreateIndexEndpointAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    IndexEndpoint retrievedResult = retrievedResponse.Result;
}

CreateIndexEndpointAsync(CreateIndexEndpointRequest, CancellationToken)

public virtual Task<Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata>> CreateIndexEndpointAsync(CreateIndexEndpointRequest request, CancellationToken cancellationToken)

Creates an IndexEndpoint.

Parameters
Name	Description
request	CreateIndexEndpointRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationIndexEndpointCreateIndexEndpointOperationMetadata	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
CreateIndexEndpointRequest request = new CreateIndexEndpointRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    IndexEndpoint = new IndexEndpoint(),
};
// Make the request
Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata> response = await indexEndpointServiceClient.CreateIndexEndpointAsync(request);

// Poll until the returned long-running operation is complete
Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
IndexEndpoint 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<IndexEndpoint, CreateIndexEndpointOperationMetadata> retrievedResponse = await indexEndpointServiceClient.PollOnceCreateIndexEndpointAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    IndexEndpoint retrievedResult = retrievedResponse.Result;
}

CreateIndexEndpointAsync(string, IndexEndpoint, CallSettings)

public virtual Task<Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata>> CreateIndexEndpointAsync(string parent, IndexEndpoint indexEndpoint, CallSettings callSettings = null)

Creates an IndexEndpoint.

Parameters
Name	Description
parent	string Required. The resource name of the Location to create the IndexEndpoint in. Format: projects/{project}/locations/{location}
indexEndpoint	IndexEndpoint Required. The IndexEndpoint to create.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationIndexEndpointCreateIndexEndpointOperationMetadata	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
IndexEndpoint indexEndpoint = new IndexEndpoint();
// Make the request
Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata> response = await indexEndpointServiceClient.CreateIndexEndpointAsync(parent, indexEndpoint);

// Poll until the returned long-running operation is complete
Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
IndexEndpoint 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<IndexEndpoint, CreateIndexEndpointOperationMetadata> retrievedResponse = await indexEndpointServiceClient.PollOnceCreateIndexEndpointAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    IndexEndpoint retrievedResult = retrievedResponse.Result;
}

CreateIndexEndpointAsync(string, IndexEndpoint, CancellationToken)

public virtual Task<Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata>> CreateIndexEndpointAsync(string parent, IndexEndpoint indexEndpoint, CancellationToken cancellationToken)

Creates an IndexEndpoint.

Parameters
Name	Description
parent	string Required. The resource name of the Location to create the IndexEndpoint in. Format: projects/{project}/locations/{location}
indexEndpoint	IndexEndpoint Required. The IndexEndpoint to create.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationIndexEndpointCreateIndexEndpointOperationMetadata	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
IndexEndpoint indexEndpoint = new IndexEndpoint();
// Make the request
Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata> response = await indexEndpointServiceClient.CreateIndexEndpointAsync(parent, indexEndpoint);

// Poll until the returned long-running operation is complete
Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
IndexEndpoint 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<IndexEndpoint, CreateIndexEndpointOperationMetadata> retrievedResponse = await indexEndpointServiceClient.PollOnceCreateIndexEndpointAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    IndexEndpoint retrievedResult = retrievedResponse.Result;
}

DeleteIndexEndpoint(DeleteIndexEndpointRequest, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> DeleteIndexEndpoint(DeleteIndexEndpointRequest request, CallSettings callSettings = null)

Deletes an IndexEndpoint.

Parameters
Name	Description
request	DeleteIndexEndpointRequest 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
IndexEndpointServiceClient indexEndpointServiceClient = IndexEndpointServiceClient.Create();
// Initialize request argument(s)
DeleteIndexEndpointRequest request = new DeleteIndexEndpointRequest
{
    IndexEndpointName = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]"),
};
// Make the request
Operation<Empty, DeleteOperationMetadata> response = indexEndpointServiceClient.DeleteIndexEndpoint(request);

// Poll until the returned long-running operation is complete
Operation<Empty, 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, DeleteOperationMetadata> retrievedResponse = indexEndpointServiceClient.PollOnceDeleteIndexEndpoint(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;
}

DeleteIndexEndpoint(IndexEndpointName, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> DeleteIndexEndpoint(IndexEndpointName name, CallSettings callSettings = null)

Deletes an IndexEndpoint.

Parameters
Name	Description
name	IndexEndpointName Required. The name of the IndexEndpoint resource to be deleted. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationEmptyDeleteOperationMetadata	The RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = IndexEndpointServiceClient.Create();
// Initialize request argument(s)
IndexEndpointName name = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]");
// Make the request
Operation<Empty, DeleteOperationMetadata> response = indexEndpointServiceClient.DeleteIndexEndpoint(name);

// Poll until the returned long-running operation is complete
Operation<Empty, 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, DeleteOperationMetadata> retrievedResponse = indexEndpointServiceClient.PollOnceDeleteIndexEndpoint(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;
}

DeleteIndexEndpoint(string, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> DeleteIndexEndpoint(string name, CallSettings callSettings = null)

Deletes an IndexEndpoint.

Parameters
Name	Description
name	string Required. The name of the IndexEndpoint resource to be deleted. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationEmptyDeleteOperationMetadata	The RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = IndexEndpointServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/indexEndpoints/[INDEX_ENDPOINT]";
// Make the request
Operation<Empty, DeleteOperationMetadata> response = indexEndpointServiceClient.DeleteIndexEndpoint(name);

// Poll until the returned long-running operation is complete
Operation<Empty, 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, DeleteOperationMetadata> retrievedResponse = indexEndpointServiceClient.PollOnceDeleteIndexEndpoint(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;
}

DeleteIndexEndpointAsync(DeleteIndexEndpointRequest, CallSettings)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteIndexEndpointAsync(DeleteIndexEndpointRequest request, CallSettings callSettings = null)

Deletes an IndexEndpoint.

Parameters
Name	Description
request	DeleteIndexEndpointRequest 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
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteIndexEndpointRequest request = new DeleteIndexEndpointRequest
{
    IndexEndpointName = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]"),
};
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await indexEndpointServiceClient.DeleteIndexEndpointAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, 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, DeleteOperationMetadata> retrievedResponse = await indexEndpointServiceClient.PollOnceDeleteIndexEndpointAsync(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;
}

DeleteIndexEndpointAsync(DeleteIndexEndpointRequest, CancellationToken)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteIndexEndpointAsync(DeleteIndexEndpointRequest request, CancellationToken cancellationToken)

Deletes an IndexEndpoint.

Parameters
Name	Description
request	DeleteIndexEndpointRequest 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
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteIndexEndpointRequest request = new DeleteIndexEndpointRequest
{
    IndexEndpointName = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]"),
};
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await indexEndpointServiceClient.DeleteIndexEndpointAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, 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, DeleteOperationMetadata> retrievedResponse = await indexEndpointServiceClient.PollOnceDeleteIndexEndpointAsync(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;
}

DeleteIndexEndpointAsync(IndexEndpointName, CallSettings)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteIndexEndpointAsync(IndexEndpointName name, CallSettings callSettings = null)

Deletes an IndexEndpoint.

Parameters
Name	Description
name	IndexEndpointName Required. The name of the IndexEndpoint resource to be deleted. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationEmptyDeleteOperationMetadata	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
IndexEndpointName name = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]");
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await indexEndpointServiceClient.DeleteIndexEndpointAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, 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, DeleteOperationMetadata> retrievedResponse = await indexEndpointServiceClient.PollOnceDeleteIndexEndpointAsync(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;
}

DeleteIndexEndpointAsync(IndexEndpointName, CancellationToken)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteIndexEndpointAsync(IndexEndpointName name, CancellationToken cancellationToken)

Deletes an IndexEndpoint.

Parameters
Name	Description
name	IndexEndpointName Required. The name of the IndexEndpoint resource to be deleted. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationEmptyDeleteOperationMetadata	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
IndexEndpointName name = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]");
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await indexEndpointServiceClient.DeleteIndexEndpointAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, 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, DeleteOperationMetadata> retrievedResponse = await indexEndpointServiceClient.PollOnceDeleteIndexEndpointAsync(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;
}

DeleteIndexEndpointAsync(string, CallSettings)

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

Deletes an IndexEndpoint.

Parameters
Name	Description
name	string Required. The name of the IndexEndpoint resource to be deleted. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationEmptyDeleteOperationMetadata	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/indexEndpoints/[INDEX_ENDPOINT]";
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await indexEndpointServiceClient.DeleteIndexEndpointAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, 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, DeleteOperationMetadata> retrievedResponse = await indexEndpointServiceClient.PollOnceDeleteIndexEndpointAsync(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;
}

DeleteIndexEndpointAsync(string, CancellationToken)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteIndexEndpointAsync(string name, CancellationToken cancellationToken)

Deletes an IndexEndpoint.

Parameters
Name	Description
name	string Required. The name of the IndexEndpoint resource to be deleted. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationEmptyDeleteOperationMetadata	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/indexEndpoints/[INDEX_ENDPOINT]";
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await indexEndpointServiceClient.DeleteIndexEndpointAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, 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, DeleteOperationMetadata> retrievedResponse = await indexEndpointServiceClient.PollOnceDeleteIndexEndpointAsync(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;
}

DeployIndex(DeployIndexRequest, CallSettings)

public virtual Operation<DeployIndexResponse, DeployIndexOperationMetadata> DeployIndex(DeployIndexRequest request, CallSettings callSettings = null)

Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed.

Parameters
Name	Description
request	DeployIndexRequest 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
OperationDeployIndexResponseDeployIndexOperationMetadata	The RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = IndexEndpointServiceClient.Create();
// Initialize request argument(s)
DeployIndexRequest request = new DeployIndexRequest
{
    IndexEndpointAsIndexEndpointName = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]"),
    DeployedIndex = new DeployedIndex(),
};
// Make the request
Operation<DeployIndexResponse, DeployIndexOperationMetadata> response = indexEndpointServiceClient.DeployIndex(request);

// Poll until the returned long-running operation is complete
Operation<DeployIndexResponse, DeployIndexOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
DeployIndexResponse 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<DeployIndexResponse, DeployIndexOperationMetadata> retrievedResponse = indexEndpointServiceClient.PollOnceDeployIndex(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DeployIndexResponse retrievedResult = retrievedResponse.Result;
}

DeployIndex(IndexEndpointName, DeployedIndex, CallSettings)

public virtual Operation<DeployIndexResponse, DeployIndexOperationMetadata> DeployIndex(IndexEndpointName indexEndpoint, DeployedIndex deployedIndex, CallSettings callSettings = null)

Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed.

Parameters
Name	Description
indexEndpoint	IndexEndpointName Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
deployedIndex	DeployedIndex Required. The DeployedIndex to be created within the IndexEndpoint.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationDeployIndexResponseDeployIndexOperationMetadata	The RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = IndexEndpointServiceClient.Create();
// Initialize request argument(s)
IndexEndpointName indexEndpoint = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]");
DeployedIndex deployedIndex = new DeployedIndex();
// Make the request
Operation<DeployIndexResponse, DeployIndexOperationMetadata> response = indexEndpointServiceClient.DeployIndex(indexEndpoint, deployedIndex);

// Poll until the returned long-running operation is complete
Operation<DeployIndexResponse, DeployIndexOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
DeployIndexResponse 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<DeployIndexResponse, DeployIndexOperationMetadata> retrievedResponse = indexEndpointServiceClient.PollOnceDeployIndex(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DeployIndexResponse retrievedResult = retrievedResponse.Result;
}

DeployIndex(string, DeployedIndex, CallSettings)

public virtual Operation<DeployIndexResponse, DeployIndexOperationMetadata> DeployIndex(string indexEndpoint, DeployedIndex deployedIndex, CallSettings callSettings = null)

Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed.

Parameters
Name	Description
indexEndpoint	string Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
deployedIndex	DeployedIndex Required. The DeployedIndex to be created within the IndexEndpoint.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationDeployIndexResponseDeployIndexOperationMetadata	The RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = IndexEndpointServiceClient.Create();
// Initialize request argument(s)
string indexEndpoint = "projects/[PROJECT]/locations/[LOCATION]/indexEndpoints/[INDEX_ENDPOINT]";
DeployedIndex deployedIndex = new DeployedIndex();
// Make the request
Operation<DeployIndexResponse, DeployIndexOperationMetadata> response = indexEndpointServiceClient.DeployIndex(indexEndpoint, deployedIndex);

// Poll until the returned long-running operation is complete
Operation<DeployIndexResponse, DeployIndexOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
DeployIndexResponse 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<DeployIndexResponse, DeployIndexOperationMetadata> retrievedResponse = indexEndpointServiceClient.PollOnceDeployIndex(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DeployIndexResponse retrievedResult = retrievedResponse.Result;
}

DeployIndexAsync(DeployIndexRequest, CallSettings)

public virtual Task<Operation<DeployIndexResponse, DeployIndexOperationMetadata>> DeployIndexAsync(DeployIndexRequest request, CallSettings callSettings = null)

Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed.

Parameters
Name	Description
request	DeployIndexRequest 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
TaskOperationDeployIndexResponseDeployIndexOperationMetadata	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
DeployIndexRequest request = new DeployIndexRequest
{
    IndexEndpointAsIndexEndpointName = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]"),
    DeployedIndex = new DeployedIndex(),
};
// Make the request
Operation<DeployIndexResponse, DeployIndexOperationMetadata> response = await indexEndpointServiceClient.DeployIndexAsync(request);

// Poll until the returned long-running operation is complete
Operation<DeployIndexResponse, DeployIndexOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
DeployIndexResponse 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<DeployIndexResponse, DeployIndexOperationMetadata> retrievedResponse = await indexEndpointServiceClient.PollOnceDeployIndexAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DeployIndexResponse retrievedResult = retrievedResponse.Result;
}

DeployIndexAsync(DeployIndexRequest, CancellationToken)

public virtual Task<Operation<DeployIndexResponse, DeployIndexOperationMetadata>> DeployIndexAsync(DeployIndexRequest request, CancellationToken cancellationToken)

Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed.

Parameters
Name	Description
request	DeployIndexRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationDeployIndexResponseDeployIndexOperationMetadata	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
DeployIndexRequest request = new DeployIndexRequest
{
    IndexEndpointAsIndexEndpointName = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]"),
    DeployedIndex = new DeployedIndex(),
};
// Make the request
Operation<DeployIndexResponse, DeployIndexOperationMetadata> response = await indexEndpointServiceClient.DeployIndexAsync(request);

// Poll until the returned long-running operation is complete
Operation<DeployIndexResponse, DeployIndexOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
DeployIndexResponse 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<DeployIndexResponse, DeployIndexOperationMetadata> retrievedResponse = await indexEndpointServiceClient.PollOnceDeployIndexAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DeployIndexResponse retrievedResult = retrievedResponse.Result;
}

DeployIndexAsync(IndexEndpointName, DeployedIndex, CallSettings)

public virtual Task<Operation<DeployIndexResponse, DeployIndexOperationMetadata>> DeployIndexAsync(IndexEndpointName indexEndpoint, DeployedIndex deployedIndex, CallSettings callSettings = null)

Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed.

Parameters
Name	Description
indexEndpoint	IndexEndpointName Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
deployedIndex	DeployedIndex Required. The DeployedIndex to be created within the IndexEndpoint.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationDeployIndexResponseDeployIndexOperationMetadata	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
IndexEndpointName indexEndpoint = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]");
DeployedIndex deployedIndex = new DeployedIndex();
// Make the request
Operation<DeployIndexResponse, DeployIndexOperationMetadata> response = await indexEndpointServiceClient.DeployIndexAsync(indexEndpoint, deployedIndex);

// Poll until the returned long-running operation is complete
Operation<DeployIndexResponse, DeployIndexOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
DeployIndexResponse 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<DeployIndexResponse, DeployIndexOperationMetadata> retrievedResponse = await indexEndpointServiceClient.PollOnceDeployIndexAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DeployIndexResponse retrievedResult = retrievedResponse.Result;
}

DeployIndexAsync(IndexEndpointName, DeployedIndex, CancellationToken)

public virtual Task<Operation<DeployIndexResponse, DeployIndexOperationMetadata>> DeployIndexAsync(IndexEndpointName indexEndpoint, DeployedIndex deployedIndex, CancellationToken cancellationToken)

Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed.

Parameters
Name	Description
indexEndpoint	IndexEndpointName Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
deployedIndex	DeployedIndex Required. The DeployedIndex to be created within the IndexEndpoint.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationDeployIndexResponseDeployIndexOperationMetadata	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
IndexEndpointName indexEndpoint = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]");
DeployedIndex deployedIndex = new DeployedIndex();
// Make the request
Operation<DeployIndexResponse, DeployIndexOperationMetadata> response = await indexEndpointServiceClient.DeployIndexAsync(indexEndpoint, deployedIndex);

// Poll until the returned long-running operation is complete
Operation<DeployIndexResponse, DeployIndexOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
DeployIndexResponse 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<DeployIndexResponse, DeployIndexOperationMetadata> retrievedResponse = await indexEndpointServiceClient.PollOnceDeployIndexAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DeployIndexResponse retrievedResult = retrievedResponse.Result;
}

DeployIndexAsync(string, DeployedIndex, CallSettings)

public virtual Task<Operation<DeployIndexResponse, DeployIndexOperationMetadata>> DeployIndexAsync(string indexEndpoint, DeployedIndex deployedIndex, CallSettings callSettings = null)

Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed.

Parameters
Name	Description
indexEndpoint	string Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
deployedIndex	DeployedIndex Required. The DeployedIndex to be created within the IndexEndpoint.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationDeployIndexResponseDeployIndexOperationMetadata	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
string indexEndpoint = "projects/[PROJECT]/locations/[LOCATION]/indexEndpoints/[INDEX_ENDPOINT]";
DeployedIndex deployedIndex = new DeployedIndex();
// Make the request
Operation<DeployIndexResponse, DeployIndexOperationMetadata> response = await indexEndpointServiceClient.DeployIndexAsync(indexEndpoint, deployedIndex);

// Poll until the returned long-running operation is complete
Operation<DeployIndexResponse, DeployIndexOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
DeployIndexResponse 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<DeployIndexResponse, DeployIndexOperationMetadata> retrievedResponse = await indexEndpointServiceClient.PollOnceDeployIndexAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DeployIndexResponse retrievedResult = retrievedResponse.Result;
}

DeployIndexAsync(string, DeployedIndex, CancellationToken)

public virtual Task<Operation<DeployIndexResponse, DeployIndexOperationMetadata>> DeployIndexAsync(string indexEndpoint, DeployedIndex deployedIndex, CancellationToken cancellationToken)

Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed.

Parameters
Name	Description
indexEndpoint	string Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
deployedIndex	DeployedIndex Required. The DeployedIndex to be created within the IndexEndpoint.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationDeployIndexResponseDeployIndexOperationMetadata	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
string indexEndpoint = "projects/[PROJECT]/locations/[LOCATION]/indexEndpoints/[INDEX_ENDPOINT]";
DeployedIndex deployedIndex = new DeployedIndex();
// Make the request
Operation<DeployIndexResponse, DeployIndexOperationMetadata> response = await indexEndpointServiceClient.DeployIndexAsync(indexEndpoint, deployedIndex);

// Poll until the returned long-running operation is complete
Operation<DeployIndexResponse, DeployIndexOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
DeployIndexResponse 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<DeployIndexResponse, DeployIndexOperationMetadata> retrievedResponse = await indexEndpointServiceClient.PollOnceDeployIndexAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DeployIndexResponse retrievedResult = retrievedResponse.Result;
}

GetIndexEndpoint(GetIndexEndpointRequest, CallSettings)

public virtual IndexEndpoint GetIndexEndpoint(GetIndexEndpointRequest request, CallSettings callSettings = null)

Gets an IndexEndpoint.

Parameters
Name	Description
request	GetIndexEndpointRequest 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
IndexEndpoint	The RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = IndexEndpointServiceClient.Create();
// Initialize request argument(s)
GetIndexEndpointRequest request = new GetIndexEndpointRequest
{
    IndexEndpointName = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]"),
};
// Make the request
IndexEndpoint response = indexEndpointServiceClient.GetIndexEndpoint(request);

GetIndexEndpoint(IndexEndpointName, CallSettings)

public virtual IndexEndpoint GetIndexEndpoint(IndexEndpointName name, CallSettings callSettings = null)

Gets an IndexEndpoint.

Parameters
Name	Description
name	IndexEndpointName Required. The name of the IndexEndpoint resource. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
IndexEndpoint	The RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = IndexEndpointServiceClient.Create();
// Initialize request argument(s)
IndexEndpointName name = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]");
// Make the request
IndexEndpoint response = indexEndpointServiceClient.GetIndexEndpoint(name);

GetIndexEndpoint(string, CallSettings)

public virtual IndexEndpoint GetIndexEndpoint(string name, CallSettings callSettings = null)

Gets an IndexEndpoint.

Parameters
Name	Description
name	string Required. The name of the IndexEndpoint resource. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
IndexEndpoint	The RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = IndexEndpointServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/indexEndpoints/[INDEX_ENDPOINT]";
// Make the request
IndexEndpoint response = indexEndpointServiceClient.GetIndexEndpoint(name);

GetIndexEndpointAsync(GetIndexEndpointRequest, CallSettings)

public virtual Task<IndexEndpoint> GetIndexEndpointAsync(GetIndexEndpointRequest request, CallSettings callSettings = null)

Gets an IndexEndpoint.

Parameters
Name	Description
request	GetIndexEndpointRequest 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
TaskIndexEndpoint	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
GetIndexEndpointRequest request = new GetIndexEndpointRequest
{
    IndexEndpointName = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]"),
};
// Make the request
IndexEndpoint response = await indexEndpointServiceClient.GetIndexEndpointAsync(request);

GetIndexEndpointAsync(GetIndexEndpointRequest, CancellationToken)

public virtual Task<IndexEndpoint> GetIndexEndpointAsync(GetIndexEndpointRequest request, CancellationToken cancellationToken)

Gets an IndexEndpoint.

Parameters
Name	Description
request	GetIndexEndpointRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskIndexEndpoint	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
GetIndexEndpointRequest request = new GetIndexEndpointRequest
{
    IndexEndpointName = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]"),
};
// Make the request
IndexEndpoint response = await indexEndpointServiceClient.GetIndexEndpointAsync(request);

GetIndexEndpointAsync(IndexEndpointName, CallSettings)

public virtual Task<IndexEndpoint> GetIndexEndpointAsync(IndexEndpointName name, CallSettings callSettings = null)

Gets an IndexEndpoint.

Parameters
Name	Description
name	IndexEndpointName Required. The name of the IndexEndpoint resource. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskIndexEndpoint	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
IndexEndpointName name = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]");
// Make the request
IndexEndpoint response = await indexEndpointServiceClient.GetIndexEndpointAsync(name);

GetIndexEndpointAsync(IndexEndpointName, CancellationToken)

public virtual Task<IndexEndpoint> GetIndexEndpointAsync(IndexEndpointName name, CancellationToken cancellationToken)

Gets an IndexEndpoint.

Parameters
Name	Description
name	IndexEndpointName Required. The name of the IndexEndpoint resource. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskIndexEndpoint	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
IndexEndpointName name = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]");
// Make the request
IndexEndpoint response = await indexEndpointServiceClient.GetIndexEndpointAsync(name);

GetIndexEndpointAsync(string, CallSettings)

public virtual Task<IndexEndpoint> GetIndexEndpointAsync(string name, CallSettings callSettings = null)

Gets an IndexEndpoint.

Parameters
Name	Description
name	string Required. The name of the IndexEndpoint resource. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskIndexEndpoint	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/indexEndpoints/[INDEX_ENDPOINT]";
// Make the request
IndexEndpoint response = await indexEndpointServiceClient.GetIndexEndpointAsync(name);

GetIndexEndpointAsync(string, CancellationToken)

public virtual Task<IndexEndpoint> GetIndexEndpointAsync(string name, CancellationToken cancellationToken)

Gets an IndexEndpoint.

Parameters
Name	Description
name	string Required. The name of the IndexEndpoint resource. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskIndexEndpoint	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/indexEndpoints/[INDEX_ENDPOINT]";
// Make the request
IndexEndpoint response = await indexEndpointServiceClient.GetIndexEndpointAsync(name);

ListIndexEndpoints(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListIndexEndpointsResponse, IndexEndpoint> ListIndexEndpoints(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists IndexEndpoints in a Location.

Parameters
Name	Description
parent	LocationName Required. The resource name of the Location from which to list the IndexEndpoints. 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
PagedEnumerableListIndexEndpointsResponseIndexEndpoint	A pageable sequence of IndexEndpoint resources.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = IndexEndpointServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListIndexEndpointsResponse, IndexEndpoint> response = indexEndpointServiceClient.ListIndexEndpoints(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (IndexEndpoint 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 (ListIndexEndpointsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (IndexEndpoint 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<IndexEndpoint> 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 (IndexEndpoint 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;

ListIndexEndpoints(ListIndexEndpointsRequest, CallSettings)

public virtual PagedEnumerable<ListIndexEndpointsResponse, IndexEndpoint> ListIndexEndpoints(ListIndexEndpointsRequest request, CallSettings callSettings = null)

Lists IndexEndpoints in a Location.

Parameters
Name	Description
request	ListIndexEndpointsRequest 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
PagedEnumerableListIndexEndpointsResponseIndexEndpoint	A pageable sequence of IndexEndpoint resources.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = IndexEndpointServiceClient.Create();
// Initialize request argument(s)
ListIndexEndpointsRequest request = new ListIndexEndpointsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    ReadMask = new FieldMask(),
};
// Make the request
PagedEnumerable<ListIndexEndpointsResponse, IndexEndpoint> response = indexEndpointServiceClient.ListIndexEndpoints(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (IndexEndpoint 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 (ListIndexEndpointsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (IndexEndpoint 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<IndexEndpoint> 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 (IndexEndpoint 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;

ListIndexEndpoints(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListIndexEndpointsResponse, IndexEndpoint> ListIndexEndpoints(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists IndexEndpoints in a Location.

Parameters
Name	Description
parent	string Required. The resource name of the Location from which to list the IndexEndpoints. 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
PagedEnumerableListIndexEndpointsResponseIndexEndpoint	A pageable sequence of IndexEndpoint resources.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = IndexEndpointServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListIndexEndpointsResponse, IndexEndpoint> response = indexEndpointServiceClient.ListIndexEndpoints(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (IndexEndpoint 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 (ListIndexEndpointsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (IndexEndpoint 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<IndexEndpoint> 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 (IndexEndpoint 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;

ListIndexEndpointsAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListIndexEndpointsResponse, IndexEndpoint> ListIndexEndpointsAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists IndexEndpoints in a Location.

Parameters
Name	Description
parent	LocationName Required. The resource name of the Location from which to list the IndexEndpoints. 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
PagedAsyncEnumerableListIndexEndpointsResponseIndexEndpoint	A pageable asynchronous sequence of IndexEndpoint resources.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListIndexEndpointsResponse, IndexEndpoint> response = indexEndpointServiceClient.ListIndexEndpointsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((IndexEndpoint 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((ListIndexEndpointsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (IndexEndpoint 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<IndexEndpoint> 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 (IndexEndpoint 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;

ListIndexEndpointsAsync(ListIndexEndpointsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListIndexEndpointsResponse, IndexEndpoint> ListIndexEndpointsAsync(ListIndexEndpointsRequest request, CallSettings callSettings = null)

Lists IndexEndpoints in a Location.

Parameters
Name	Description
request	ListIndexEndpointsRequest 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
PagedAsyncEnumerableListIndexEndpointsResponseIndexEndpoint	A pageable asynchronous sequence of IndexEndpoint resources.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
ListIndexEndpointsRequest request = new ListIndexEndpointsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    ReadMask = new FieldMask(),
};
// Make the request
PagedAsyncEnumerable<ListIndexEndpointsResponse, IndexEndpoint> response = indexEndpointServiceClient.ListIndexEndpointsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((IndexEndpoint 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((ListIndexEndpointsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (IndexEndpoint 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<IndexEndpoint> 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 (IndexEndpoint 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;

ListIndexEndpointsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListIndexEndpointsResponse, IndexEndpoint> ListIndexEndpointsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists IndexEndpoints in a Location.

Parameters
Name	Description
parent	string Required. The resource name of the Location from which to list the IndexEndpoints. 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
PagedAsyncEnumerableListIndexEndpointsResponseIndexEndpoint	A pageable asynchronous sequence of IndexEndpoint resources.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListIndexEndpointsResponse, IndexEndpoint> response = indexEndpointServiceClient.ListIndexEndpointsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((IndexEndpoint 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((ListIndexEndpointsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (IndexEndpoint 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<IndexEndpoint> 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 (IndexEndpoint 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;

MutateDeployedIndex(IndexEndpointName, DeployedIndex, CallSettings)

public virtual Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata> MutateDeployedIndex(IndexEndpointName indexEndpoint, DeployedIndex deployedIndex, CallSettings callSettings = null)

Update an existing DeployedIndex under an IndexEndpoint.

Parameters
Name	Description
indexEndpoint	IndexEndpointName Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
deployedIndex	DeployedIndex Required. The DeployedIndex to be updated within the IndexEndpoint. Currently, the updatable fields are [DeployedIndex][automatic_resources] and [DeployedIndex][dedicated_resources]
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationMutateDeployedIndexResponseMutateDeployedIndexOperationMetadata	The RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = IndexEndpointServiceClient.Create();
// Initialize request argument(s)
IndexEndpointName indexEndpoint = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]");
DeployedIndex deployedIndex = new DeployedIndex();
// Make the request
Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata> response = indexEndpointServiceClient.MutateDeployedIndex(indexEndpoint, deployedIndex);

// Poll until the returned long-running operation is complete
Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
MutateDeployedIndexResponse 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<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata> retrievedResponse = indexEndpointServiceClient.PollOnceMutateDeployedIndex(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    MutateDeployedIndexResponse retrievedResult = retrievedResponse.Result;
}

MutateDeployedIndex(MutateDeployedIndexRequest, CallSettings)

public virtual Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata> MutateDeployedIndex(MutateDeployedIndexRequest request, CallSettings callSettings = null)

Update an existing DeployedIndex under an IndexEndpoint.

Parameters
Name	Description
request	MutateDeployedIndexRequest 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
OperationMutateDeployedIndexResponseMutateDeployedIndexOperationMetadata	The RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = IndexEndpointServiceClient.Create();
// Initialize request argument(s)
MutateDeployedIndexRequest request = new MutateDeployedIndexRequest
{
    IndexEndpointAsIndexEndpointName = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]"),
    DeployedIndex = new DeployedIndex(),
};
// Make the request
Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata> response = indexEndpointServiceClient.MutateDeployedIndex(request);

// Poll until the returned long-running operation is complete
Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
MutateDeployedIndexResponse 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<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata> retrievedResponse = indexEndpointServiceClient.PollOnceMutateDeployedIndex(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    MutateDeployedIndexResponse retrievedResult = retrievedResponse.Result;
}

MutateDeployedIndex(string, DeployedIndex, CallSettings)

public virtual Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata> MutateDeployedIndex(string indexEndpoint, DeployedIndex deployedIndex, CallSettings callSettings = null)

Update an existing DeployedIndex under an IndexEndpoint.

Parameters
Name	Description
indexEndpoint	string Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
deployedIndex	DeployedIndex Required. The DeployedIndex to be updated within the IndexEndpoint. Currently, the updatable fields are [DeployedIndex][automatic_resources] and [DeployedIndex][dedicated_resources]
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationMutateDeployedIndexResponseMutateDeployedIndexOperationMetadata	The RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = IndexEndpointServiceClient.Create();
// Initialize request argument(s)
string indexEndpoint = "projects/[PROJECT]/locations/[LOCATION]/indexEndpoints/[INDEX_ENDPOINT]";
DeployedIndex deployedIndex = new DeployedIndex();
// Make the request
Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata> response = indexEndpointServiceClient.MutateDeployedIndex(indexEndpoint, deployedIndex);

// Poll until the returned long-running operation is complete
Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
MutateDeployedIndexResponse 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<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata> retrievedResponse = indexEndpointServiceClient.PollOnceMutateDeployedIndex(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    MutateDeployedIndexResponse retrievedResult = retrievedResponse.Result;
}

MutateDeployedIndexAsync(IndexEndpointName, DeployedIndex, CallSettings)

public virtual Task<Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata>> MutateDeployedIndexAsync(IndexEndpointName indexEndpoint, DeployedIndex deployedIndex, CallSettings callSettings = null)

Update an existing DeployedIndex under an IndexEndpoint.

Parameters
Name	Description
indexEndpoint	IndexEndpointName Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
deployedIndex	DeployedIndex Required. The DeployedIndex to be updated within the IndexEndpoint. Currently, the updatable fields are [DeployedIndex][automatic_resources] and [DeployedIndex][dedicated_resources]
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationMutateDeployedIndexResponseMutateDeployedIndexOperationMetadata	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
IndexEndpointName indexEndpoint = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]");
DeployedIndex deployedIndex = new DeployedIndex();
// Make the request
Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata> response = await indexEndpointServiceClient.MutateDeployedIndexAsync(indexEndpoint, deployedIndex);

// Poll until the returned long-running operation is complete
Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
MutateDeployedIndexResponse 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<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata> retrievedResponse = await indexEndpointServiceClient.PollOnceMutateDeployedIndexAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    MutateDeployedIndexResponse retrievedResult = retrievedResponse.Result;
}

MutateDeployedIndexAsync(IndexEndpointName, DeployedIndex, CancellationToken)

public virtual Task<Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata>> MutateDeployedIndexAsync(IndexEndpointName indexEndpoint, DeployedIndex deployedIndex, CancellationToken cancellationToken)

Update an existing DeployedIndex under an IndexEndpoint.

Parameters
Name	Description
indexEndpoint	IndexEndpointName Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
deployedIndex	DeployedIndex Required. The DeployedIndex to be updated within the IndexEndpoint. Currently, the updatable fields are [DeployedIndex][automatic_resources] and [DeployedIndex][dedicated_resources]
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationMutateDeployedIndexResponseMutateDeployedIndexOperationMetadata	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
IndexEndpointName indexEndpoint = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]");
DeployedIndex deployedIndex = new DeployedIndex();
// Make the request
Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata> response = await indexEndpointServiceClient.MutateDeployedIndexAsync(indexEndpoint, deployedIndex);

// Poll until the returned long-running operation is complete
Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
MutateDeployedIndexResponse 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<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata> retrievedResponse = await indexEndpointServiceClient.PollOnceMutateDeployedIndexAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    MutateDeployedIndexResponse retrievedResult = retrievedResponse.Result;
}

MutateDeployedIndexAsync(MutateDeployedIndexRequest, CallSettings)

public virtual Task<Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata>> MutateDeployedIndexAsync(MutateDeployedIndexRequest request, CallSettings callSettings = null)

Update an existing DeployedIndex under an IndexEndpoint.

Parameters
Name	Description
request	MutateDeployedIndexRequest 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
TaskOperationMutateDeployedIndexResponseMutateDeployedIndexOperationMetadata	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
MutateDeployedIndexRequest request = new MutateDeployedIndexRequest
{
    IndexEndpointAsIndexEndpointName = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]"),
    DeployedIndex = new DeployedIndex(),
};
// Make the request
Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata> response = await indexEndpointServiceClient.MutateDeployedIndexAsync(request);

// Poll until the returned long-running operation is complete
Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
MutateDeployedIndexResponse 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<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata> retrievedResponse = await indexEndpointServiceClient.PollOnceMutateDeployedIndexAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    MutateDeployedIndexResponse retrievedResult = retrievedResponse.Result;
}

MutateDeployedIndexAsync(MutateDeployedIndexRequest, CancellationToken)

public virtual Task<Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata>> MutateDeployedIndexAsync(MutateDeployedIndexRequest request, CancellationToken cancellationToken)

Update an existing DeployedIndex under an IndexEndpoint.

Parameters
Name	Description
request	MutateDeployedIndexRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationMutateDeployedIndexResponseMutateDeployedIndexOperationMetadata	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
MutateDeployedIndexRequest request = new MutateDeployedIndexRequest
{
    IndexEndpointAsIndexEndpointName = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]"),
    DeployedIndex = new DeployedIndex(),
};
// Make the request
Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata> response = await indexEndpointServiceClient.MutateDeployedIndexAsync(request);

// Poll until the returned long-running operation is complete
Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
MutateDeployedIndexResponse 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<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata> retrievedResponse = await indexEndpointServiceClient.PollOnceMutateDeployedIndexAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    MutateDeployedIndexResponse retrievedResult = retrievedResponse.Result;
}

MutateDeployedIndexAsync(string, DeployedIndex, CallSettings)

public virtual Task<Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata>> MutateDeployedIndexAsync(string indexEndpoint, DeployedIndex deployedIndex, CallSettings callSettings = null)

Update an existing DeployedIndex under an IndexEndpoint.

Parameters
Name	Description
indexEndpoint	string Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
deployedIndex	DeployedIndex Required. The DeployedIndex to be updated within the IndexEndpoint. Currently, the updatable fields are [DeployedIndex][automatic_resources] and [DeployedIndex][dedicated_resources]
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationMutateDeployedIndexResponseMutateDeployedIndexOperationMetadata	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
string indexEndpoint = "projects/[PROJECT]/locations/[LOCATION]/indexEndpoints/[INDEX_ENDPOINT]";
DeployedIndex deployedIndex = new DeployedIndex();
// Make the request
Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata> response = await indexEndpointServiceClient.MutateDeployedIndexAsync(indexEndpoint, deployedIndex);

// Poll until the returned long-running operation is complete
Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
MutateDeployedIndexResponse 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<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata> retrievedResponse = await indexEndpointServiceClient.PollOnceMutateDeployedIndexAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    MutateDeployedIndexResponse retrievedResult = retrievedResponse.Result;
}

MutateDeployedIndexAsync(string, DeployedIndex, CancellationToken)

public virtual Task<Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata>> MutateDeployedIndexAsync(string indexEndpoint, DeployedIndex deployedIndex, CancellationToken cancellationToken)

Update an existing DeployedIndex under an IndexEndpoint.

Parameters
Name	Description
indexEndpoint	string Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
deployedIndex	DeployedIndex Required. The DeployedIndex to be updated within the IndexEndpoint. Currently, the updatable fields are [DeployedIndex][automatic_resources] and [DeployedIndex][dedicated_resources]
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationMutateDeployedIndexResponseMutateDeployedIndexOperationMetadata	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
string indexEndpoint = "projects/[PROJECT]/locations/[LOCATION]/indexEndpoints/[INDEX_ENDPOINT]";
DeployedIndex deployedIndex = new DeployedIndex();
// Make the request
Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata> response = await indexEndpointServiceClient.MutateDeployedIndexAsync(indexEndpoint, deployedIndex);

// Poll until the returned long-running operation is complete
Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
MutateDeployedIndexResponse 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<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata> retrievedResponse = await indexEndpointServiceClient.PollOnceMutateDeployedIndexAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    MutateDeployedIndexResponse retrievedResult = retrievedResponse.Result;
}

PollOnceCreateIndexEndpoint(string, CallSettings)

public virtual Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata> PollOnceCreateIndexEndpoint(string operationName, CallSettings callSettings = null)

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

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
OperationIndexEndpointCreateIndexEndpointOperationMetadata	The result of polling the operation.

PollOnceCreateIndexEndpointAsync(string, CallSettings)

public virtual Task<Operation<IndexEndpoint, CreateIndexEndpointOperationMetadata>> PollOnceCreateIndexEndpointAsync(string operationName, CallSettings callSettings = null)

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

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
TaskOperationIndexEndpointCreateIndexEndpointOperationMetadata	A task representing the result of polling the operation.

PollOnceDeleteIndexEndpoint(string, CallSettings)

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

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

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.

PollOnceDeleteIndexEndpointAsync(string, CallSettings)

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

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

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.

PollOnceDeployIndex(string, CallSettings)

public virtual Operation<DeployIndexResponse, DeployIndexOperationMetadata> PollOnceDeployIndex(string operationName, CallSettings callSettings = null)

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

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
OperationDeployIndexResponseDeployIndexOperationMetadata	The result of polling the operation.

PollOnceDeployIndexAsync(string, CallSettings)

public virtual Task<Operation<DeployIndexResponse, DeployIndexOperationMetadata>> PollOnceDeployIndexAsync(string operationName, CallSettings callSettings = null)

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

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
TaskOperationDeployIndexResponseDeployIndexOperationMetadata	A task representing the result of polling the operation.

PollOnceMutateDeployedIndex(string, CallSettings)

public virtual Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata> PollOnceMutateDeployedIndex(string operationName, CallSettings callSettings = null)

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

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
OperationMutateDeployedIndexResponseMutateDeployedIndexOperationMetadata	The result of polling the operation.

PollOnceMutateDeployedIndexAsync(string, CallSettings)

public virtual Task<Operation<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata>> PollOnceMutateDeployedIndexAsync(string operationName, CallSettings callSettings = null)

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

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
TaskOperationMutateDeployedIndexResponseMutateDeployedIndexOperationMetadata	A task representing the result of polling the operation.

PollOnceUndeployIndex(string, CallSettings)

public virtual Operation<UndeployIndexResponse, UndeployIndexOperationMetadata> PollOnceUndeployIndex(string operationName, CallSettings callSettings = null)

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

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
OperationUndeployIndexResponseUndeployIndexOperationMetadata	The result of polling the operation.

PollOnceUndeployIndexAsync(string, CallSettings)

public virtual Task<Operation<UndeployIndexResponse, UndeployIndexOperationMetadata>> PollOnceUndeployIndexAsync(string operationName, CallSettings callSettings = null)

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

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
TaskOperationUndeployIndexResponseUndeployIndexOperationMetadata	A task representing the result of polling the operation.

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.

UndeployIndex(IndexEndpointName, string, CallSettings)

public virtual Operation<UndeployIndexResponse, UndeployIndexOperationMetadata> UndeployIndex(IndexEndpointName indexEndpoint, string deployedIndexId, CallSettings callSettings = null)

Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.

Parameters
Name	Description
indexEndpoint	IndexEndpointName Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
deployedIndexId	string Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationUndeployIndexResponseUndeployIndexOperationMetadata	The RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = IndexEndpointServiceClient.Create();
// Initialize request argument(s)
IndexEndpointName indexEndpoint = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]");
string deployedIndexId = "";
// Make the request
Operation<UndeployIndexResponse, UndeployIndexOperationMetadata> response = indexEndpointServiceClient.UndeployIndex(indexEndpoint, deployedIndexId);

// Poll until the returned long-running operation is complete
Operation<UndeployIndexResponse, UndeployIndexOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
UndeployIndexResponse 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<UndeployIndexResponse, UndeployIndexOperationMetadata> retrievedResponse = indexEndpointServiceClient.PollOnceUndeployIndex(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    UndeployIndexResponse retrievedResult = retrievedResponse.Result;
}

UndeployIndex(UndeployIndexRequest, CallSettings)

public virtual Operation<UndeployIndexResponse, UndeployIndexOperationMetadata> UndeployIndex(UndeployIndexRequest request, CallSettings callSettings = null)

Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.

Parameters
Name	Description
request	UndeployIndexRequest 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
OperationUndeployIndexResponseUndeployIndexOperationMetadata	The RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = IndexEndpointServiceClient.Create();
// Initialize request argument(s)
UndeployIndexRequest request = new UndeployIndexRequest
{
    IndexEndpointAsIndexEndpointName = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]"),
    DeployedIndexId = "",
};
// Make the request
Operation<UndeployIndexResponse, UndeployIndexOperationMetadata> response = indexEndpointServiceClient.UndeployIndex(request);

// Poll until the returned long-running operation is complete
Operation<UndeployIndexResponse, UndeployIndexOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
UndeployIndexResponse 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<UndeployIndexResponse, UndeployIndexOperationMetadata> retrievedResponse = indexEndpointServiceClient.PollOnceUndeployIndex(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    UndeployIndexResponse retrievedResult = retrievedResponse.Result;
}

UndeployIndex(string, string, CallSettings)

public virtual Operation<UndeployIndexResponse, UndeployIndexOperationMetadata> UndeployIndex(string indexEndpoint, string deployedIndexId, CallSettings callSettings = null)

Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.

Parameters
Name	Description
indexEndpoint	string Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
deployedIndexId	string Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationUndeployIndexResponseUndeployIndexOperationMetadata	The RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = IndexEndpointServiceClient.Create();
// Initialize request argument(s)
string indexEndpoint = "projects/[PROJECT]/locations/[LOCATION]/indexEndpoints/[INDEX_ENDPOINT]";
string deployedIndexId = "";
// Make the request
Operation<UndeployIndexResponse, UndeployIndexOperationMetadata> response = indexEndpointServiceClient.UndeployIndex(indexEndpoint, deployedIndexId);

// Poll until the returned long-running operation is complete
Operation<UndeployIndexResponse, UndeployIndexOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
UndeployIndexResponse 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<UndeployIndexResponse, UndeployIndexOperationMetadata> retrievedResponse = indexEndpointServiceClient.PollOnceUndeployIndex(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    UndeployIndexResponse retrievedResult = retrievedResponse.Result;
}

UndeployIndexAsync(IndexEndpointName, string, CallSettings)

public virtual Task<Operation<UndeployIndexResponse, UndeployIndexOperationMetadata>> UndeployIndexAsync(IndexEndpointName indexEndpoint, string deployedIndexId, CallSettings callSettings = null)

Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.

Parameters
Name	Description
indexEndpoint	IndexEndpointName Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
deployedIndexId	string Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationUndeployIndexResponseUndeployIndexOperationMetadata	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
IndexEndpointName indexEndpoint = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]");
string deployedIndexId = "";
// Make the request
Operation<UndeployIndexResponse, UndeployIndexOperationMetadata> response = await indexEndpointServiceClient.UndeployIndexAsync(indexEndpoint, deployedIndexId);

// Poll until the returned long-running operation is complete
Operation<UndeployIndexResponse, UndeployIndexOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
UndeployIndexResponse 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<UndeployIndexResponse, UndeployIndexOperationMetadata> retrievedResponse = await indexEndpointServiceClient.PollOnceUndeployIndexAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    UndeployIndexResponse retrievedResult = retrievedResponse.Result;
}

UndeployIndexAsync(IndexEndpointName, string, CancellationToken)

public virtual Task<Operation<UndeployIndexResponse, UndeployIndexOperationMetadata>> UndeployIndexAsync(IndexEndpointName indexEndpoint, string deployedIndexId, CancellationToken cancellationToken)

Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.

Parameters
Name	Description
indexEndpoint	IndexEndpointName Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
deployedIndexId	string Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationUndeployIndexResponseUndeployIndexOperationMetadata	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
IndexEndpointName indexEndpoint = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]");
string deployedIndexId = "";
// Make the request
Operation<UndeployIndexResponse, UndeployIndexOperationMetadata> response = await indexEndpointServiceClient.UndeployIndexAsync(indexEndpoint, deployedIndexId);

// Poll until the returned long-running operation is complete
Operation<UndeployIndexResponse, UndeployIndexOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
UndeployIndexResponse 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<UndeployIndexResponse, UndeployIndexOperationMetadata> retrievedResponse = await indexEndpointServiceClient.PollOnceUndeployIndexAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    UndeployIndexResponse retrievedResult = retrievedResponse.Result;
}

UndeployIndexAsync(UndeployIndexRequest, CallSettings)

public virtual Task<Operation<UndeployIndexResponse, UndeployIndexOperationMetadata>> UndeployIndexAsync(UndeployIndexRequest request, CallSettings callSettings = null)

Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.

Parameters
Name	Description
request	UndeployIndexRequest 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
TaskOperationUndeployIndexResponseUndeployIndexOperationMetadata	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
UndeployIndexRequest request = new UndeployIndexRequest
{
    IndexEndpointAsIndexEndpointName = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]"),
    DeployedIndexId = "",
};
// Make the request
Operation<UndeployIndexResponse, UndeployIndexOperationMetadata> response = await indexEndpointServiceClient.UndeployIndexAsync(request);

// Poll until the returned long-running operation is complete
Operation<UndeployIndexResponse, UndeployIndexOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
UndeployIndexResponse 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<UndeployIndexResponse, UndeployIndexOperationMetadata> retrievedResponse = await indexEndpointServiceClient.PollOnceUndeployIndexAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    UndeployIndexResponse retrievedResult = retrievedResponse.Result;
}

UndeployIndexAsync(UndeployIndexRequest, CancellationToken)

public virtual Task<Operation<UndeployIndexResponse, UndeployIndexOperationMetadata>> UndeployIndexAsync(UndeployIndexRequest request, CancellationToken cancellationToken)

Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.

Parameters
Name	Description
request	UndeployIndexRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationUndeployIndexResponseUndeployIndexOperationMetadata	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
UndeployIndexRequest request = new UndeployIndexRequest
{
    IndexEndpointAsIndexEndpointName = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]"),
    DeployedIndexId = "",
};
// Make the request
Operation<UndeployIndexResponse, UndeployIndexOperationMetadata> response = await indexEndpointServiceClient.UndeployIndexAsync(request);

// Poll until the returned long-running operation is complete
Operation<UndeployIndexResponse, UndeployIndexOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
UndeployIndexResponse 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<UndeployIndexResponse, UndeployIndexOperationMetadata> retrievedResponse = await indexEndpointServiceClient.PollOnceUndeployIndexAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    UndeployIndexResponse retrievedResult = retrievedResponse.Result;
}

UndeployIndexAsync(string, string, CallSettings)

public virtual Task<Operation<UndeployIndexResponse, UndeployIndexOperationMetadata>> UndeployIndexAsync(string indexEndpoint, string deployedIndexId, CallSettings callSettings = null)

Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.

Parameters
Name	Description
indexEndpoint	string Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
deployedIndexId	string Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationUndeployIndexResponseUndeployIndexOperationMetadata	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
string indexEndpoint = "projects/[PROJECT]/locations/[LOCATION]/indexEndpoints/[INDEX_ENDPOINT]";
string deployedIndexId = "";
// Make the request
Operation<UndeployIndexResponse, UndeployIndexOperationMetadata> response = await indexEndpointServiceClient.UndeployIndexAsync(indexEndpoint, deployedIndexId);

// Poll until the returned long-running operation is complete
Operation<UndeployIndexResponse, UndeployIndexOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
UndeployIndexResponse 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<UndeployIndexResponse, UndeployIndexOperationMetadata> retrievedResponse = await indexEndpointServiceClient.PollOnceUndeployIndexAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    UndeployIndexResponse retrievedResult = retrievedResponse.Result;
}

UndeployIndexAsync(string, string, CancellationToken)

public virtual Task<Operation<UndeployIndexResponse, UndeployIndexOperationMetadata>> UndeployIndexAsync(string indexEndpoint, string deployedIndexId, CancellationToken cancellationToken)

Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.

Parameters
Name	Description
indexEndpoint	string Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
deployedIndexId	string Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationUndeployIndexResponseUndeployIndexOperationMetadata	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
string indexEndpoint = "projects/[PROJECT]/locations/[LOCATION]/indexEndpoints/[INDEX_ENDPOINT]";
string deployedIndexId = "";
// Make the request
Operation<UndeployIndexResponse, UndeployIndexOperationMetadata> response = await indexEndpointServiceClient.UndeployIndexAsync(indexEndpoint, deployedIndexId);

// Poll until the returned long-running operation is complete
Operation<UndeployIndexResponse, UndeployIndexOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
UndeployIndexResponse 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<UndeployIndexResponse, UndeployIndexOperationMetadata> retrievedResponse = await indexEndpointServiceClient.PollOnceUndeployIndexAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    UndeployIndexResponse retrievedResult = retrievedResponse.Result;
}

UpdateIndexEndpoint(IndexEndpoint, FieldMask, CallSettings)

public virtual IndexEndpoint UpdateIndexEndpoint(IndexEndpoint indexEndpoint, FieldMask updateMask, CallSettings callSettings = null)

Updates an IndexEndpoint.

Parameters
Name	Description
indexEndpoint	IndexEndpoint Required. The IndexEndpoint which replaces the resource on the server.
updateMask	FieldMask Required. The update mask applies to the resource. See [google.protobuf.FieldMask][google.protobuf.FieldMask].
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
IndexEndpoint	The RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = IndexEndpointServiceClient.Create();
// Initialize request argument(s)
IndexEndpoint indexEndpoint = new IndexEndpoint();
FieldMask updateMask = new FieldMask();
// Make the request
IndexEndpoint response = indexEndpointServiceClient.UpdateIndexEndpoint(indexEndpoint, updateMask);

UpdateIndexEndpoint(UpdateIndexEndpointRequest, CallSettings)

public virtual IndexEndpoint UpdateIndexEndpoint(UpdateIndexEndpointRequest request, CallSettings callSettings = null)

Updates an IndexEndpoint.

Parameters
Name	Description
request	UpdateIndexEndpointRequest 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
IndexEndpoint	The RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = IndexEndpointServiceClient.Create();
// Initialize request argument(s)
UpdateIndexEndpointRequest request = new UpdateIndexEndpointRequest
{
    IndexEndpoint = new IndexEndpoint(),
    UpdateMask = new FieldMask(),
};
// Make the request
IndexEndpoint response = indexEndpointServiceClient.UpdateIndexEndpoint(request);

UpdateIndexEndpointAsync(IndexEndpoint, FieldMask, CallSettings)

public virtual Task<IndexEndpoint> UpdateIndexEndpointAsync(IndexEndpoint indexEndpoint, FieldMask updateMask, CallSettings callSettings = null)

Updates an IndexEndpoint.

Parameters
Name	Description
indexEndpoint	IndexEndpoint Required. The IndexEndpoint which replaces the resource on the server.
updateMask	FieldMask Required. The update mask applies to the resource. See [google.protobuf.FieldMask][google.protobuf.FieldMask].
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskIndexEndpoint	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
IndexEndpoint indexEndpoint = new IndexEndpoint();
FieldMask updateMask = new FieldMask();
// Make the request
IndexEndpoint response = await indexEndpointServiceClient.UpdateIndexEndpointAsync(indexEndpoint, updateMask);

UpdateIndexEndpointAsync(IndexEndpoint, FieldMask, CancellationToken)

public virtual Task<IndexEndpoint> UpdateIndexEndpointAsync(IndexEndpoint indexEndpoint, FieldMask updateMask, CancellationToken cancellationToken)

Updates an IndexEndpoint.

Parameters
Name	Description
indexEndpoint	IndexEndpoint Required. The IndexEndpoint which replaces the resource on the server.
updateMask	FieldMask Required. The update mask applies to the resource. See [google.protobuf.FieldMask][google.protobuf.FieldMask].
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskIndexEndpoint	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
IndexEndpoint indexEndpoint = new IndexEndpoint();
FieldMask updateMask = new FieldMask();
// Make the request
IndexEndpoint response = await indexEndpointServiceClient.UpdateIndexEndpointAsync(indexEndpoint, updateMask);

UpdateIndexEndpointAsync(UpdateIndexEndpointRequest, CallSettings)

public virtual Task<IndexEndpoint> UpdateIndexEndpointAsync(UpdateIndexEndpointRequest request, CallSettings callSettings = null)

Updates an IndexEndpoint.

Parameters
Name	Description
request	UpdateIndexEndpointRequest 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
TaskIndexEndpoint	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateIndexEndpointRequest request = new UpdateIndexEndpointRequest
{
    IndexEndpoint = new IndexEndpoint(),
    UpdateMask = new FieldMask(),
};
// Make the request
IndexEndpoint response = await indexEndpointServiceClient.UpdateIndexEndpointAsync(request);

UpdateIndexEndpointAsync(UpdateIndexEndpointRequest, CancellationToken)

public virtual Task<IndexEndpoint> UpdateIndexEndpointAsync(UpdateIndexEndpointRequest request, CancellationToken cancellationToken)

Updates an IndexEndpoint.

Parameters
Name	Description
request	UpdateIndexEndpointRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskIndexEndpoint	A Task containing the RPC response.

Example

// Create client
IndexEndpointServiceClient indexEndpointServiceClient = await IndexEndpointServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateIndexEndpointRequest request = new UpdateIndexEndpointRequest
{
    IndexEndpoint = new IndexEndpoint(),
    UpdateMask = new FieldMask(),
};
// Make the request
IndexEndpoint response = await indexEndpointServiceClient.UpdateIndexEndpointAsync(request);