Class AwsClustersClient (1.0.0-beta01)

public abstract class AwsClustersClient

AwsClusters client wrapper, for convenient use.

Inheritance

Object > AwsClustersClient

Derived Types

Namespace

Google.Cloud.GkeMultiCloud.V1

Assembly

Google.Cloud.GkeMultiCloud.V1.dll

Remarks

The AwsClusters API provides a single centrally managed service to create and manage Anthos clusters that run on AWS infrastructure.

Properties

CreateAwsClusterOperationsClient

public virtual OperationsClient CreateAwsClusterOperationsClient { get; }

The long-running operations client for CreateAwsCluster.

Property Value
TypeDescription
OperationsClient

CreateAwsNodePoolOperationsClient

public virtual OperationsClient CreateAwsNodePoolOperationsClient { get; }

The long-running operations client for CreateAwsNodePool.

Property Value
TypeDescription
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
TypeDescription
String

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default AwsClusters scopes.

Property Value
TypeDescription
IReadOnlyList<String>
Remarks

The default AwsClusters scopes are:

DeleteAwsClusterOperationsClient

public virtual OperationsClient DeleteAwsClusterOperationsClient { get; }

The long-running operations client for DeleteAwsCluster.

Property Value
TypeDescription
OperationsClient

DeleteAwsNodePoolOperationsClient

public virtual OperationsClient DeleteAwsNodePoolOperationsClient { get; }

The long-running operations client for DeleteAwsNodePool.

Property Value
TypeDescription
OperationsClient

GrpcClient

public virtual AwsClusters.AwsClustersClient GrpcClient { get; }

The underlying gRPC AwsClusters client

Property Value
TypeDescription
AwsClusters.AwsClustersClient

UpdateAwsClusterOperationsClient

public virtual OperationsClient UpdateAwsClusterOperationsClient { get; }

The long-running operations client for UpdateAwsCluster.

Property Value
TypeDescription
OperationsClient

UpdateAwsNodePoolOperationsClient

public virtual OperationsClient UpdateAwsNodePoolOperationsClient { get; }

The long-running operations client for UpdateAwsNodePool.

Property Value
TypeDescription
OperationsClient

Methods

Create()

public static AwsClustersClient Create()

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

Returns
TypeDescription
AwsClustersClient

The created AwsClustersClient.

CreateAsync(CancellationToken)

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

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

Parameter
NameDescription
cancellationTokenCancellationToken

The CancellationToken to use while creating the client.

Returns
TypeDescription
Task<AwsClustersClient>

The task representing the created AwsClustersClient.

CreateAwsCluster(LocationName, AwsCluster, String, CallSettings)

public virtual Operation<AwsCluster, OperationMetadata> CreateAwsCluster(LocationName parent, AwsCluster awsCluster, string awsClusterId, CallSettings callSettings = null)

Creates a new [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource on a given GCP project and region.

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
parentLocationName

Required. The parent location where this [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource will be created.

Location names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;.

See Resource Names for more details on Google Cloud resource names.

awsClusterAwsCluster

Required. The specification of the [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] to create.

awsClusterIdString

Required. A client provided ID the resource. Must be unique within the parent resource.

The provided ID will be part of the [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource name formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;.

Valid characters are /[a-z][0-9]-/. Cannot be longer than 40 characters.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<AwsCluster, OperationMetadata>

The RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = AwsClustersClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
AwsCluster awsCluster = new AwsCluster();
string awsClusterId = "";
// Make the request
Operation<AwsCluster, OperationMetadata> response = awsClustersClient.CreateAwsCluster(parent, awsCluster, awsClusterId);

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

CreateAwsCluster(CreateAwsClusterRequest, CallSettings)

public virtual Operation<AwsCluster, OperationMetadata> CreateAwsCluster(CreateAwsClusterRequest request, CallSettings callSettings = null)

Creates a new [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource on a given GCP project and region.

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
requestCreateAwsClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<AwsCluster, OperationMetadata>

The RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = AwsClustersClient.Create();
// Initialize request argument(s)
CreateAwsClusterRequest request = new CreateAwsClusterRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    AwsCluster = new AwsCluster(),
    AwsClusterId = "",
    ValidateOnly = false,
};
// Make the request
Operation<AwsCluster, OperationMetadata> response = awsClustersClient.CreateAwsCluster(request);

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

CreateAwsCluster(String, AwsCluster, String, CallSettings)

public virtual Operation<AwsCluster, OperationMetadata> CreateAwsCluster(string parent, AwsCluster awsCluster, string awsClusterId, CallSettings callSettings = null)

Creates a new [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource on a given GCP project and region.

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
parentString

Required. The parent location where this [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource will be created.

Location names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;.

See Resource Names for more details on Google Cloud resource names.

awsClusterAwsCluster

Required. The specification of the [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] to create.

awsClusterIdString

Required. A client provided ID the resource. Must be unique within the parent resource.

The provided ID will be part of the [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource name formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;.

Valid characters are /[a-z][0-9]-/. Cannot be longer than 40 characters.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<AwsCluster, OperationMetadata>

The RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = AwsClustersClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
AwsCluster awsCluster = new AwsCluster();
string awsClusterId = "";
// Make the request
Operation<AwsCluster, OperationMetadata> response = awsClustersClient.CreateAwsCluster(parent, awsCluster, awsClusterId);

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

CreateAwsClusterAsync(LocationName, AwsCluster, String, CallSettings)

public virtual Task<Operation<AwsCluster, OperationMetadata>> CreateAwsClusterAsync(LocationName parent, AwsCluster awsCluster, string awsClusterId, CallSettings callSettings = null)

Creates a new [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource on a given GCP project and region.

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
parentLocationName

Required. The parent location where this [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource will be created.

Location names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;.

See Resource Names for more details on Google Cloud resource names.

awsClusterAwsCluster

Required. The specification of the [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] to create.

awsClusterIdString

Required. A client provided ID the resource. Must be unique within the parent resource.

The provided ID will be part of the [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource name formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;.

Valid characters are /[a-z][0-9]-/. Cannot be longer than 40 characters.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<AwsCluster, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
AwsCluster awsCluster = new AwsCluster();
string awsClusterId = "";
// Make the request
Operation<AwsCluster, OperationMetadata> response = await awsClustersClient.CreateAwsClusterAsync(parent, awsCluster, awsClusterId);

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

CreateAwsClusterAsync(LocationName, AwsCluster, String, CancellationToken)

public virtual Task<Operation<AwsCluster, OperationMetadata>> CreateAwsClusterAsync(LocationName parent, AwsCluster awsCluster, string awsClusterId, CancellationToken cancellationToken)

Creates a new [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource on a given GCP project and region.

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
parentLocationName

Required. The parent location where this [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource will be created.

Location names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;.

See Resource Names for more details on Google Cloud resource names.

awsClusterAwsCluster

Required. The specification of the [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] to create.

awsClusterIdString

Required. A client provided ID the resource. Must be unique within the parent resource.

The provided ID will be part of the [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource name formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;.

Valid characters are /[a-z][0-9]-/. Cannot be longer than 40 characters.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<AwsCluster, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
AwsCluster awsCluster = new AwsCluster();
string awsClusterId = "";
// Make the request
Operation<AwsCluster, OperationMetadata> response = await awsClustersClient.CreateAwsClusterAsync(parent, awsCluster, awsClusterId);

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

CreateAwsClusterAsync(CreateAwsClusterRequest, CallSettings)

public virtual Task<Operation<AwsCluster, OperationMetadata>> CreateAwsClusterAsync(CreateAwsClusterRequest request, CallSettings callSettings = null)

Creates a new [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource on a given GCP project and region.

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
requestCreateAwsClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<AwsCluster, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
CreateAwsClusterRequest request = new CreateAwsClusterRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    AwsCluster = new AwsCluster(),
    AwsClusterId = "",
    ValidateOnly = false,
};
// Make the request
Operation<AwsCluster, OperationMetadata> response = await awsClustersClient.CreateAwsClusterAsync(request);

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

CreateAwsClusterAsync(CreateAwsClusterRequest, CancellationToken)

public virtual Task<Operation<AwsCluster, OperationMetadata>> CreateAwsClusterAsync(CreateAwsClusterRequest request, CancellationToken cancellationToken)

Creates a new [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource on a given GCP project and region.

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
requestCreateAwsClusterRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<AwsCluster, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
CreateAwsClusterRequest request = new CreateAwsClusterRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    AwsCluster = new AwsCluster(),
    AwsClusterId = "",
    ValidateOnly = false,
};
// Make the request
Operation<AwsCluster, OperationMetadata> response = await awsClustersClient.CreateAwsClusterAsync(request);

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

CreateAwsClusterAsync(String, AwsCluster, String, CallSettings)

public virtual Task<Operation<AwsCluster, OperationMetadata>> CreateAwsClusterAsync(string parent, AwsCluster awsCluster, string awsClusterId, CallSettings callSettings = null)

Creates a new [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource on a given GCP project and region.

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
parentString

Required. The parent location where this [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource will be created.

Location names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;.

See Resource Names for more details on Google Cloud resource names.

awsClusterAwsCluster

Required. The specification of the [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] to create.

awsClusterIdString

Required. A client provided ID the resource. Must be unique within the parent resource.

The provided ID will be part of the [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource name formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;.

Valid characters are /[a-z][0-9]-/. Cannot be longer than 40 characters.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<AwsCluster, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
AwsCluster awsCluster = new AwsCluster();
string awsClusterId = "";
// Make the request
Operation<AwsCluster, OperationMetadata> response = await awsClustersClient.CreateAwsClusterAsync(parent, awsCluster, awsClusterId);

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

CreateAwsClusterAsync(String, AwsCluster, String, CancellationToken)

public virtual Task<Operation<AwsCluster, OperationMetadata>> CreateAwsClusterAsync(string parent, AwsCluster awsCluster, string awsClusterId, CancellationToken cancellationToken)

Creates a new [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource on a given GCP project and region.

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
parentString

Required. The parent location where this [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource will be created.

Location names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;.

See Resource Names for more details on Google Cloud resource names.

awsClusterAwsCluster

Required. The specification of the [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] to create.

awsClusterIdString

Required. A client provided ID the resource. Must be unique within the parent resource.

The provided ID will be part of the [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource name formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;.

Valid characters are /[a-z][0-9]-/. Cannot be longer than 40 characters.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<AwsCluster, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
AwsCluster awsCluster = new AwsCluster();
string awsClusterId = "";
// Make the request
Operation<AwsCluster, OperationMetadata> response = await awsClustersClient.CreateAwsClusterAsync(parent, awsCluster, awsClusterId);

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

CreateAwsNodePool(AwsClusterName, AwsNodePool, String, CallSettings)

public virtual Operation<AwsNodePool, OperationMetadata> CreateAwsNodePool(AwsClusterName parent, AwsNodePool awsNodePool, string awsNodePoolId, CallSettings callSettings = null)

Creates a new [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool], attached to a given [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster].

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
parentAwsClusterName

Required. The [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource where this node pool will be created.

AwsCluster names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;.

See Resource Names for more details on Google Cloud resource names.

awsNodePoolAwsNodePool

Required. The specification of the [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] to create.

awsNodePoolIdString

Required. A client provided ID the resource. Must be unique within the parent resource.

The provided ID will be part of the [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource name formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;/awsNodePools/&amp;lt;node-pool-id&amp;gt;.

Valid characters are /[a-z][0-9]-/. Cannot be longer than 40 characters.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<AwsNodePool, OperationMetadata>

The RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = AwsClustersClient.Create();
// Initialize request argument(s)
AwsClusterName parent = AwsClusterName.FromProjectLocationAwsCluster("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]");
AwsNodePool awsNodePool = new AwsNodePool();
string awsNodePoolId = "";
// Make the request
Operation<AwsNodePool, OperationMetadata> response = awsClustersClient.CreateAwsNodePool(parent, awsNodePool, awsNodePoolId);

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

CreateAwsNodePool(CreateAwsNodePoolRequest, CallSettings)

public virtual Operation<AwsNodePool, OperationMetadata> CreateAwsNodePool(CreateAwsNodePoolRequest request, CallSettings callSettings = null)

Creates a new [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool], attached to a given [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster].

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
requestCreateAwsNodePoolRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<AwsNodePool, OperationMetadata>

The RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = AwsClustersClient.Create();
// Initialize request argument(s)
CreateAwsNodePoolRequest request = new CreateAwsNodePoolRequest
{
    ParentAsAwsClusterName = AwsClusterName.FromProjectLocationAwsCluster("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]"),
    AwsNodePool = new AwsNodePool(),
    AwsNodePoolId = "",
    ValidateOnly = false,
};
// Make the request
Operation<AwsNodePool, OperationMetadata> response = awsClustersClient.CreateAwsNodePool(request);

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

CreateAwsNodePool(String, AwsNodePool, String, CallSettings)

public virtual Operation<AwsNodePool, OperationMetadata> CreateAwsNodePool(string parent, AwsNodePool awsNodePool, string awsNodePoolId, CallSettings callSettings = null)

Creates a new [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool], attached to a given [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster].

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
parentString

Required. The [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource where this node pool will be created.

AwsCluster names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;.

See Resource Names for more details on Google Cloud resource names.

awsNodePoolAwsNodePool

Required. The specification of the [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] to create.

awsNodePoolIdString

Required. A client provided ID the resource. Must be unique within the parent resource.

The provided ID will be part of the [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource name formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;/awsNodePools/&amp;lt;node-pool-id&amp;gt;.

Valid characters are /[a-z][0-9]-/. Cannot be longer than 40 characters.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<AwsNodePool, OperationMetadata>

The RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = AwsClustersClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/awsClusters/[AWS_CLUSTER]";
AwsNodePool awsNodePool = new AwsNodePool();
string awsNodePoolId = "";
// Make the request
Operation<AwsNodePool, OperationMetadata> response = awsClustersClient.CreateAwsNodePool(parent, awsNodePool, awsNodePoolId);

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

CreateAwsNodePoolAsync(AwsClusterName, AwsNodePool, String, CallSettings)

public virtual Task<Operation<AwsNodePool, OperationMetadata>> CreateAwsNodePoolAsync(AwsClusterName parent, AwsNodePool awsNodePool, string awsNodePoolId, CallSettings callSettings = null)

Creates a new [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool], attached to a given [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster].

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
parentAwsClusterName

Required. The [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource where this node pool will be created.

AwsCluster names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;.

See Resource Names for more details on Google Cloud resource names.

awsNodePoolAwsNodePool

Required. The specification of the [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] to create.

awsNodePoolIdString

Required. A client provided ID the resource. Must be unique within the parent resource.

The provided ID will be part of the [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource name formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;/awsNodePools/&amp;lt;node-pool-id&amp;gt;.

Valid characters are /[a-z][0-9]-/. Cannot be longer than 40 characters.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<AwsNodePool, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
AwsClusterName parent = AwsClusterName.FromProjectLocationAwsCluster("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]");
AwsNodePool awsNodePool = new AwsNodePool();
string awsNodePoolId = "";
// Make the request
Operation<AwsNodePool, OperationMetadata> response = await awsClustersClient.CreateAwsNodePoolAsync(parent, awsNodePool, awsNodePoolId);

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

CreateAwsNodePoolAsync(AwsClusterName, AwsNodePool, String, CancellationToken)

public virtual Task<Operation<AwsNodePool, OperationMetadata>> CreateAwsNodePoolAsync(AwsClusterName parent, AwsNodePool awsNodePool, string awsNodePoolId, CancellationToken cancellationToken)

Creates a new [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool], attached to a given [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster].

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
parentAwsClusterName

Required. The [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource where this node pool will be created.

AwsCluster names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;.

See Resource Names for more details on Google Cloud resource names.

awsNodePoolAwsNodePool

Required. The specification of the [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] to create.

awsNodePoolIdString

Required. A client provided ID the resource. Must be unique within the parent resource.

The provided ID will be part of the [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource name formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;/awsNodePools/&amp;lt;node-pool-id&amp;gt;.

Valid characters are /[a-z][0-9]-/. Cannot be longer than 40 characters.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<AwsNodePool, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
AwsClusterName parent = AwsClusterName.FromProjectLocationAwsCluster("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]");
AwsNodePool awsNodePool = new AwsNodePool();
string awsNodePoolId = "";
// Make the request
Operation<AwsNodePool, OperationMetadata> response = await awsClustersClient.CreateAwsNodePoolAsync(parent, awsNodePool, awsNodePoolId);

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

CreateAwsNodePoolAsync(CreateAwsNodePoolRequest, CallSettings)

public virtual Task<Operation<AwsNodePool, OperationMetadata>> CreateAwsNodePoolAsync(CreateAwsNodePoolRequest request, CallSettings callSettings = null)

Creates a new [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool], attached to a given [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster].

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
requestCreateAwsNodePoolRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<AwsNodePool, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
CreateAwsNodePoolRequest request = new CreateAwsNodePoolRequest
{
    ParentAsAwsClusterName = AwsClusterName.FromProjectLocationAwsCluster("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]"),
    AwsNodePool = new AwsNodePool(),
    AwsNodePoolId = "",
    ValidateOnly = false,
};
// Make the request
Operation<AwsNodePool, OperationMetadata> response = await awsClustersClient.CreateAwsNodePoolAsync(request);

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

CreateAwsNodePoolAsync(CreateAwsNodePoolRequest, CancellationToken)

public virtual Task<Operation<AwsNodePool, OperationMetadata>> CreateAwsNodePoolAsync(CreateAwsNodePoolRequest request, CancellationToken cancellationToken)

Creates a new [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool], attached to a given [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster].

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
requestCreateAwsNodePoolRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<AwsNodePool, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
CreateAwsNodePoolRequest request = new CreateAwsNodePoolRequest
{
    ParentAsAwsClusterName = AwsClusterName.FromProjectLocationAwsCluster("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]"),
    AwsNodePool = new AwsNodePool(),
    AwsNodePoolId = "",
    ValidateOnly = false,
};
// Make the request
Operation<AwsNodePool, OperationMetadata> response = await awsClustersClient.CreateAwsNodePoolAsync(request);

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

CreateAwsNodePoolAsync(String, AwsNodePool, String, CallSettings)

public virtual Task<Operation<AwsNodePool, OperationMetadata>> CreateAwsNodePoolAsync(string parent, AwsNodePool awsNodePool, string awsNodePoolId, CallSettings callSettings = null)

Creates a new [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool], attached to a given [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster].

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
parentString

Required. The [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource where this node pool will be created.

AwsCluster names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;.

See Resource Names for more details on Google Cloud resource names.

awsNodePoolAwsNodePool

Required. The specification of the [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] to create.

awsNodePoolIdString

Required. A client provided ID the resource. Must be unique within the parent resource.

The provided ID will be part of the [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource name formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;/awsNodePools/&amp;lt;node-pool-id&amp;gt;.

Valid characters are /[a-z][0-9]-/. Cannot be longer than 40 characters.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<AwsNodePool, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/awsClusters/[AWS_CLUSTER]";
AwsNodePool awsNodePool = new AwsNodePool();
string awsNodePoolId = "";
// Make the request
Operation<AwsNodePool, OperationMetadata> response = await awsClustersClient.CreateAwsNodePoolAsync(parent, awsNodePool, awsNodePoolId);

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

CreateAwsNodePoolAsync(String, AwsNodePool, String, CancellationToken)

public virtual Task<Operation<AwsNodePool, OperationMetadata>> CreateAwsNodePoolAsync(string parent, AwsNodePool awsNodePool, string awsNodePoolId, CancellationToken cancellationToken)

Creates a new [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool], attached to a given [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster].

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
parentString

Required. The [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource where this node pool will be created.

AwsCluster names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;.

See Resource Names for more details on Google Cloud resource names.

awsNodePoolAwsNodePool

Required. The specification of the [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] to create.

awsNodePoolIdString

Required. A client provided ID the resource. Must be unique within the parent resource.

The provided ID will be part of the [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource name formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;/awsNodePools/&amp;lt;node-pool-id&amp;gt;.

Valid characters are /[a-z][0-9]-/. Cannot be longer than 40 characters.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<AwsNodePool, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/awsClusters/[AWS_CLUSTER]";
AwsNodePool awsNodePool = new AwsNodePool();
string awsNodePoolId = "";
// Make the request
Operation<AwsNodePool, OperationMetadata> response = await awsClustersClient.CreateAwsNodePoolAsync(parent, awsNodePool, awsNodePoolId);

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

DeleteAwsCluster(AwsClusterName, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteAwsCluster(AwsClusterName name, CallSettings callSettings = null)

Deletes a specific [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource.

Fails if the cluster has one or more associated [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resources.

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
nameAwsClusterName

Required. The resource name the [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] to delete.

AwsCluster names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;.

See Resource Names for more details on GCP resource names.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Empty, OperationMetadata>

The RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = AwsClustersClient.Create();
// Initialize request argument(s)
AwsClusterName name = AwsClusterName.FromProjectLocationAwsCluster("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]");
// Make the request
Operation<Empty, OperationMetadata> response = awsClustersClient.DeleteAwsCluster(name);

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

DeleteAwsCluster(DeleteAwsClusterRequest, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteAwsCluster(DeleteAwsClusterRequest request, CallSettings callSettings = null)

Deletes a specific [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource.

Fails if the cluster has one or more associated [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resources.

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
requestDeleteAwsClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Empty, OperationMetadata>

The RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = AwsClustersClient.Create();
// Initialize request argument(s)
DeleteAwsClusterRequest request = new DeleteAwsClusterRequest
{
    AwsClusterName = AwsClusterName.FromProjectLocationAwsCluster("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]"),
    ValidateOnly = false,
    AllowMissing = false,
    Etag = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = awsClustersClient.DeleteAwsCluster(request);

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

DeleteAwsCluster(String, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteAwsCluster(string name, CallSettings callSettings = null)

Deletes a specific [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource.

Fails if the cluster has one or more associated [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resources.

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
nameString

Required. The resource name the [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] to delete.

AwsCluster names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;.

See Resource Names for more details on GCP resource names.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Empty, OperationMetadata>

The RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = AwsClustersClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/awsClusters/[AWS_CLUSTER]";
// Make the request
Operation<Empty, OperationMetadata> response = awsClustersClient.DeleteAwsCluster(name);

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

DeleteAwsClusterAsync(AwsClusterName, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteAwsClusterAsync(AwsClusterName name, CallSettings callSettings = null)

Deletes a specific [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource.

Fails if the cluster has one or more associated [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resources.

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
nameAwsClusterName

Required. The resource name the [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] to delete.

AwsCluster names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;.

See Resource Names for more details on GCP resource names.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Empty, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
AwsClusterName name = AwsClusterName.FromProjectLocationAwsCluster("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]");
// Make the request
Operation<Empty, OperationMetadata> response = await awsClustersClient.DeleteAwsClusterAsync(name);

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

DeleteAwsClusterAsync(AwsClusterName, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteAwsClusterAsync(AwsClusterName name, CancellationToken cancellationToken)

Deletes a specific [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource.

Fails if the cluster has one or more associated [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resources.

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
nameAwsClusterName

Required. The resource name the [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] to delete.

AwsCluster names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;.

See Resource Names for more details on GCP resource names.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<Empty, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
AwsClusterName name = AwsClusterName.FromProjectLocationAwsCluster("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]");
// Make the request
Operation<Empty, OperationMetadata> response = await awsClustersClient.DeleteAwsClusterAsync(name);

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

DeleteAwsClusterAsync(DeleteAwsClusterRequest, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteAwsClusterAsync(DeleteAwsClusterRequest request, CallSettings callSettings = null)

Deletes a specific [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource.

Fails if the cluster has one or more associated [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resources.

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
requestDeleteAwsClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Empty, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
DeleteAwsClusterRequest request = new DeleteAwsClusterRequest
{
    AwsClusterName = AwsClusterName.FromProjectLocationAwsCluster("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]"),
    ValidateOnly = false,
    AllowMissing = false,
    Etag = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = await awsClustersClient.DeleteAwsClusterAsync(request);

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

DeleteAwsClusterAsync(DeleteAwsClusterRequest, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteAwsClusterAsync(DeleteAwsClusterRequest request, CancellationToken cancellationToken)

Deletes a specific [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource.

Fails if the cluster has one or more associated [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resources.

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
requestDeleteAwsClusterRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<Empty, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
DeleteAwsClusterRequest request = new DeleteAwsClusterRequest
{
    AwsClusterName = AwsClusterName.FromProjectLocationAwsCluster("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]"),
    ValidateOnly = false,
    AllowMissing = false,
    Etag = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = await awsClustersClient.DeleteAwsClusterAsync(request);

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

DeleteAwsClusterAsync(String, CallSettings)

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

Deletes a specific [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource.

Fails if the cluster has one or more associated [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resources.

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
nameString

Required. The resource name the [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] to delete.

AwsCluster names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;.

See Resource Names for more details on GCP resource names.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Empty, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/awsClusters/[AWS_CLUSTER]";
// Make the request
Operation<Empty, OperationMetadata> response = await awsClustersClient.DeleteAwsClusterAsync(name);

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

DeleteAwsClusterAsync(String, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteAwsClusterAsync(string name, CancellationToken cancellationToken)

Deletes a specific [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource.

Fails if the cluster has one or more associated [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resources.

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
nameString

Required. The resource name the [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] to delete.

AwsCluster names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;.

See Resource Names for more details on GCP resource names.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<Empty, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/awsClusters/[AWS_CLUSTER]";
// Make the request
Operation<Empty, OperationMetadata> response = await awsClustersClient.DeleteAwsClusterAsync(name);

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

DeleteAwsNodePool(AwsNodePoolName, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteAwsNodePool(AwsNodePoolName name, CallSettings callSettings = null)

Deletes a specific [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource.

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
nameAwsNodePoolName

Required. The resource name the [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] to delete.

AwsNodePool names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;/awsNodePools/&amp;lt;node-pool-id&amp;gt;.

See Resource Names for more details on Google Cloud resource names.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Empty, OperationMetadata>

The RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = AwsClustersClient.Create();
// Initialize request argument(s)
AwsNodePoolName name = AwsNodePoolName.FromProjectLocationAwsClusterAwsNodePool("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]", "[AWS_NODE_POOL]");
// Make the request
Operation<Empty, OperationMetadata> response = awsClustersClient.DeleteAwsNodePool(name);

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

DeleteAwsNodePool(DeleteAwsNodePoolRequest, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteAwsNodePool(DeleteAwsNodePoolRequest request, CallSettings callSettings = null)

Deletes a specific [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource.

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
requestDeleteAwsNodePoolRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Empty, OperationMetadata>

The RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = AwsClustersClient.Create();
// Initialize request argument(s)
DeleteAwsNodePoolRequest request = new DeleteAwsNodePoolRequest
{
    AwsNodePoolName = AwsNodePoolName.FromProjectLocationAwsClusterAwsNodePool("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]", "[AWS_NODE_POOL]"),
    ValidateOnly = false,
    AllowMissing = false,
    Etag = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = awsClustersClient.DeleteAwsNodePool(request);

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

DeleteAwsNodePool(String, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteAwsNodePool(string name, CallSettings callSettings = null)

Deletes a specific [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource.

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
nameString

Required. The resource name the [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] to delete.

AwsNodePool names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;/awsNodePools/&amp;lt;node-pool-id&amp;gt;.

See Resource Names for more details on Google Cloud resource names.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Empty, OperationMetadata>

The RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = AwsClustersClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/awsClusters/[AWS_CLUSTER]/awsNodePools/[AWS_NODE_POOL]";
// Make the request
Operation<Empty, OperationMetadata> response = awsClustersClient.DeleteAwsNodePool(name);

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

DeleteAwsNodePoolAsync(AwsNodePoolName, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteAwsNodePoolAsync(AwsNodePoolName name, CallSettings callSettings = null)

Deletes a specific [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource.

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
nameAwsNodePoolName

Required. The resource name the [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] to delete.

AwsNodePool names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;/awsNodePools/&amp;lt;node-pool-id&amp;gt;.

See Resource Names for more details on Google Cloud resource names.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Empty, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
AwsNodePoolName name = AwsNodePoolName.FromProjectLocationAwsClusterAwsNodePool("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]", "[AWS_NODE_POOL]");
// Make the request
Operation<Empty, OperationMetadata> response = await awsClustersClient.DeleteAwsNodePoolAsync(name);

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

DeleteAwsNodePoolAsync(AwsNodePoolName, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteAwsNodePoolAsync(AwsNodePoolName name, CancellationToken cancellationToken)

Deletes a specific [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource.

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
nameAwsNodePoolName

Required. The resource name the [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] to delete.

AwsNodePool names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;/awsNodePools/&amp;lt;node-pool-id&amp;gt;.

See Resource Names for more details on Google Cloud resource names.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<Empty, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
AwsNodePoolName name = AwsNodePoolName.FromProjectLocationAwsClusterAwsNodePool("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]", "[AWS_NODE_POOL]");
// Make the request
Operation<Empty, OperationMetadata> response = await awsClustersClient.DeleteAwsNodePoolAsync(name);

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

DeleteAwsNodePoolAsync(DeleteAwsNodePoolRequest, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteAwsNodePoolAsync(DeleteAwsNodePoolRequest request, CallSettings callSettings = null)

Deletes a specific [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource.

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
requestDeleteAwsNodePoolRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Empty, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
DeleteAwsNodePoolRequest request = new DeleteAwsNodePoolRequest
{
    AwsNodePoolName = AwsNodePoolName.FromProjectLocationAwsClusterAwsNodePool("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]", "[AWS_NODE_POOL]"),
    ValidateOnly = false,
    AllowMissing = false,
    Etag = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = await awsClustersClient.DeleteAwsNodePoolAsync(request);

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

DeleteAwsNodePoolAsync(DeleteAwsNodePoolRequest, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteAwsNodePoolAsync(DeleteAwsNodePoolRequest request, CancellationToken cancellationToken)

Deletes a specific [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource.

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
requestDeleteAwsNodePoolRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<Empty, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
DeleteAwsNodePoolRequest request = new DeleteAwsNodePoolRequest
{
    AwsNodePoolName = AwsNodePoolName.FromProjectLocationAwsClusterAwsNodePool("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]", "[AWS_NODE_POOL]"),
    ValidateOnly = false,
    AllowMissing = false,
    Etag = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = await awsClustersClient.DeleteAwsNodePoolAsync(request);

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

DeleteAwsNodePoolAsync(String, CallSettings)

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

Deletes a specific [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource.

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
nameString

Required. The resource name the [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] to delete.

AwsNodePool names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;/awsNodePools/&amp;lt;node-pool-id&amp;gt;.

See Resource Names for more details on Google Cloud resource names.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Empty, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/awsClusters/[AWS_CLUSTER]/awsNodePools/[AWS_NODE_POOL]";
// Make the request
Operation<Empty, OperationMetadata> response = await awsClustersClient.DeleteAwsNodePoolAsync(name);

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

DeleteAwsNodePoolAsync(String, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteAwsNodePoolAsync(string name, CancellationToken cancellationToken)

Deletes a specific [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource.

If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.

Parameters
NameDescription
nameString

Required. The resource name the [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] to delete.

AwsNodePool names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;/awsNodePools/&amp;lt;node-pool-id&amp;gt;.

See Resource Names for more details on Google Cloud resource names.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<Empty, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/awsClusters/[AWS_CLUSTER]/awsNodePools/[AWS_NODE_POOL]";
// Make the request
Operation<Empty, OperationMetadata> response = await awsClustersClient.DeleteAwsNodePoolAsync(name);

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

GenerateAwsAccessToken(GenerateAwsAccessTokenRequest, CallSettings)

public virtual GenerateAwsAccessTokenResponse GenerateAwsAccessToken(GenerateAwsAccessTokenRequest request, CallSettings callSettings = null)

Generates a short-lived access token to authenticate to a given [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource.

Parameters
NameDescription
requestGenerateAwsAccessTokenRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
GenerateAwsAccessTokenResponse

The RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = AwsClustersClient.Create();
// Initialize request argument(s)
GenerateAwsAccessTokenRequest request = new GenerateAwsAccessTokenRequest
{
    AwsClusterAsAwsClusterName = AwsClusterName.FromProjectLocationAwsCluster("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]"),
};
// Make the request
GenerateAwsAccessTokenResponse response = awsClustersClient.GenerateAwsAccessToken(request);

GenerateAwsAccessTokenAsync(GenerateAwsAccessTokenRequest, CallSettings)

public virtual Task<GenerateAwsAccessTokenResponse> GenerateAwsAccessTokenAsync(GenerateAwsAccessTokenRequest request, CallSettings callSettings = null)

Generates a short-lived access token to authenticate to a given [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource.

Parameters
NameDescription
requestGenerateAwsAccessTokenRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<GenerateAwsAccessTokenResponse>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
GenerateAwsAccessTokenRequest request = new GenerateAwsAccessTokenRequest
{
    AwsClusterAsAwsClusterName = AwsClusterName.FromProjectLocationAwsCluster("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]"),
};
// Make the request
GenerateAwsAccessTokenResponse response = await awsClustersClient.GenerateAwsAccessTokenAsync(request);

GenerateAwsAccessTokenAsync(GenerateAwsAccessTokenRequest, CancellationToken)

public virtual Task<GenerateAwsAccessTokenResponse> GenerateAwsAccessTokenAsync(GenerateAwsAccessTokenRequest request, CancellationToken cancellationToken)

Generates a short-lived access token to authenticate to a given [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource.

Parameters
NameDescription
requestGenerateAwsAccessTokenRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<GenerateAwsAccessTokenResponse>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
GenerateAwsAccessTokenRequest request = new GenerateAwsAccessTokenRequest
{
    AwsClusterAsAwsClusterName = AwsClusterName.FromProjectLocationAwsCluster("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]"),
};
// Make the request
GenerateAwsAccessTokenResponse response = await awsClustersClient.GenerateAwsAccessTokenAsync(request);

GetAwsCluster(AwsClusterName, CallSettings)

public virtual AwsCluster GetAwsCluster(AwsClusterName name, CallSettings callSettings = null)

Describes a specific [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource.

Parameters
NameDescription
nameAwsClusterName

Required. The name of the [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource to describe.

AwsCluster names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;.

See Resource Names for more details on GCP resource names.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
AwsCluster

The RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = AwsClustersClient.Create();
// Initialize request argument(s)
AwsClusterName name = AwsClusterName.FromProjectLocationAwsCluster("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]");
// Make the request
AwsCluster response = awsClustersClient.GetAwsCluster(name);

GetAwsCluster(GetAwsClusterRequest, CallSettings)

public virtual AwsCluster GetAwsCluster(GetAwsClusterRequest request, CallSettings callSettings = null)

Describes a specific [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource.

Parameters
NameDescription
requestGetAwsClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
AwsCluster

The RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = AwsClustersClient.Create();
// Initialize request argument(s)
GetAwsClusterRequest request = new GetAwsClusterRequest
{
    AwsClusterName = AwsClusterName.FromProjectLocationAwsCluster("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]"),
};
// Make the request
AwsCluster response = awsClustersClient.GetAwsCluster(request);

GetAwsCluster(String, CallSettings)

public virtual AwsCluster GetAwsCluster(string name, CallSettings callSettings = null)

Describes a specific [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource.

Parameters
NameDescription
nameString

Required. The name of the [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource to describe.

AwsCluster names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;.

See Resource Names for more details on GCP resource names.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
AwsCluster

The RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = AwsClustersClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/awsClusters/[AWS_CLUSTER]";
// Make the request
AwsCluster response = awsClustersClient.GetAwsCluster(name);

GetAwsClusterAsync(AwsClusterName, CallSettings)

public virtual Task<AwsCluster> GetAwsClusterAsync(AwsClusterName name, CallSettings callSettings = null)

Describes a specific [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource.

Parameters
NameDescription
nameAwsClusterName

Required. The name of the [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource to describe.

AwsCluster names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;.

See Resource Names for more details on GCP resource names.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<AwsCluster>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
AwsClusterName name = AwsClusterName.FromProjectLocationAwsCluster("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]");
// Make the request
AwsCluster response = await awsClustersClient.GetAwsClusterAsync(name);

GetAwsClusterAsync(AwsClusterName, CancellationToken)

public virtual Task<AwsCluster> GetAwsClusterAsync(AwsClusterName name, CancellationToken cancellationToken)

Describes a specific [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource.

Parameters
NameDescription
nameAwsClusterName

Required. The name of the [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource to describe.

AwsCluster names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;.

See Resource Names for more details on GCP resource names.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<AwsCluster>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
AwsClusterName name = AwsClusterName.FromProjectLocationAwsCluster("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]");
// Make the request
AwsCluster response = await awsClustersClient.GetAwsClusterAsync(name);

GetAwsClusterAsync(GetAwsClusterRequest, CallSettings)

public virtual Task<AwsCluster> GetAwsClusterAsync(GetAwsClusterRequest request, CallSettings callSettings = null)

Describes a specific [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource.

Parameters
NameDescription
requestGetAwsClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<AwsCluster>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
GetAwsClusterRequest request = new GetAwsClusterRequest
{
    AwsClusterName = AwsClusterName.FromProjectLocationAwsCluster("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]"),
};
// Make the request
AwsCluster response = await awsClustersClient.GetAwsClusterAsync(request);

GetAwsClusterAsync(GetAwsClusterRequest, CancellationToken)

public virtual Task<AwsCluster> GetAwsClusterAsync(GetAwsClusterRequest request, CancellationToken cancellationToken)

Describes a specific [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource.

Parameters
NameDescription
requestGetAwsClusterRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<AwsCluster>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
GetAwsClusterRequest request = new GetAwsClusterRequest
{
    AwsClusterName = AwsClusterName.FromProjectLocationAwsCluster("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]"),
};
// Make the request
AwsCluster response = await awsClustersClient.GetAwsClusterAsync(request);

GetAwsClusterAsync(String, CallSettings)

public virtual Task<AwsCluster> GetAwsClusterAsync(string name, CallSettings callSettings = null)

Describes a specific [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource.

Parameters
NameDescription
nameString

Required. The name of the [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource to describe.

AwsCluster names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;.

See Resource Names for more details on GCP resource names.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<AwsCluster>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/awsClusters/[AWS_CLUSTER]";
// Make the request
AwsCluster response = await awsClustersClient.GetAwsClusterAsync(name);

GetAwsClusterAsync(String, CancellationToken)

public virtual Task<AwsCluster> GetAwsClusterAsync(string name, CancellationToken cancellationToken)

Describes a specific [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource.

Parameters
NameDescription
nameString

Required. The name of the [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource to describe.

AwsCluster names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;.

See Resource Names for more details on GCP resource names.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<AwsCluster>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/awsClusters/[AWS_CLUSTER]";
// Make the request
AwsCluster response = await awsClustersClient.GetAwsClusterAsync(name);

GetAwsNodePool(AwsNodePoolName, CallSettings)

public virtual AwsNodePool GetAwsNodePool(AwsNodePoolName name, CallSettings callSettings = null)

Describes a specific [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource.

Parameters
NameDescription
nameAwsNodePoolName

Required. The name of the [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource to describe.

AwsNodePool names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;/awsNodePools/&amp;lt;node-pool-id&amp;gt;.

See Resource Names for more details on Google Cloud resource names.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
AwsNodePool

The RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = AwsClustersClient.Create();
// Initialize request argument(s)
AwsNodePoolName name = AwsNodePoolName.FromProjectLocationAwsClusterAwsNodePool("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]", "[AWS_NODE_POOL]");
// Make the request
AwsNodePool response = awsClustersClient.GetAwsNodePool(name);

GetAwsNodePool(GetAwsNodePoolRequest, CallSettings)

public virtual AwsNodePool GetAwsNodePool(GetAwsNodePoolRequest request, CallSettings callSettings = null)

Describes a specific [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource.

Parameters
NameDescription
requestGetAwsNodePoolRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
AwsNodePool

The RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = AwsClustersClient.Create();
// Initialize request argument(s)
GetAwsNodePoolRequest request = new GetAwsNodePoolRequest
{
    AwsNodePoolName = AwsNodePoolName.FromProjectLocationAwsClusterAwsNodePool("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]", "[AWS_NODE_POOL]"),
};
// Make the request
AwsNodePool response = awsClustersClient.GetAwsNodePool(request);

GetAwsNodePool(String, CallSettings)

public virtual AwsNodePool GetAwsNodePool(string name, CallSettings callSettings = null)

Describes a specific [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource.

Parameters
NameDescription
nameString

Required. The name of the [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource to describe.

AwsNodePool names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;/awsNodePools/&amp;lt;node-pool-id&amp;gt;.

See Resource Names for more details on Google Cloud resource names.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
AwsNodePool

The RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = AwsClustersClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/awsClusters/[AWS_CLUSTER]/awsNodePools/[AWS_NODE_POOL]";
// Make the request
AwsNodePool response = awsClustersClient.GetAwsNodePool(name);

GetAwsNodePoolAsync(AwsNodePoolName, CallSettings)

public virtual Task<AwsNodePool> GetAwsNodePoolAsync(AwsNodePoolName name, CallSettings callSettings = null)

Describes a specific [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource.

Parameters
NameDescription
nameAwsNodePoolName

Required. The name of the [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource to describe.

AwsNodePool names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;/awsNodePools/&amp;lt;node-pool-id&amp;gt;.

See Resource Names for more details on Google Cloud resource names.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<AwsNodePool>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
AwsNodePoolName name = AwsNodePoolName.FromProjectLocationAwsClusterAwsNodePool("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]", "[AWS_NODE_POOL]");
// Make the request
AwsNodePool response = await awsClustersClient.GetAwsNodePoolAsync(name);

GetAwsNodePoolAsync(AwsNodePoolName, CancellationToken)

public virtual Task<AwsNodePool> GetAwsNodePoolAsync(AwsNodePoolName name, CancellationToken cancellationToken)

Describes a specific [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource.

Parameters
NameDescription
nameAwsNodePoolName

Required. The name of the [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource to describe.

AwsNodePool names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;/awsNodePools/&amp;lt;node-pool-id&amp;gt;.

See Resource Names for more details on Google Cloud resource names.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<AwsNodePool>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
AwsNodePoolName name = AwsNodePoolName.FromProjectLocationAwsClusterAwsNodePool("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]", "[AWS_NODE_POOL]");
// Make the request
AwsNodePool response = await awsClustersClient.GetAwsNodePoolAsync(name);

GetAwsNodePoolAsync(GetAwsNodePoolRequest, CallSettings)

public virtual Task<AwsNodePool> GetAwsNodePoolAsync(GetAwsNodePoolRequest request, CallSettings callSettings = null)

Describes a specific [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource.

Parameters
NameDescription
requestGetAwsNodePoolRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<AwsNodePool>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
GetAwsNodePoolRequest request = new GetAwsNodePoolRequest
{
    AwsNodePoolName = AwsNodePoolName.FromProjectLocationAwsClusterAwsNodePool("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]", "[AWS_NODE_POOL]"),
};
// Make the request
AwsNodePool response = await awsClustersClient.GetAwsNodePoolAsync(request);

GetAwsNodePoolAsync(GetAwsNodePoolRequest, CancellationToken)

public virtual Task<AwsNodePool> GetAwsNodePoolAsync(GetAwsNodePoolRequest request, CancellationToken cancellationToken)

Describes a specific [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource.

Parameters
NameDescription
requestGetAwsNodePoolRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<AwsNodePool>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
GetAwsNodePoolRequest request = new GetAwsNodePoolRequest
{
    AwsNodePoolName = AwsNodePoolName.FromProjectLocationAwsClusterAwsNodePool("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]", "[AWS_NODE_POOL]"),
};
// Make the request
AwsNodePool response = await awsClustersClient.GetAwsNodePoolAsync(request);

GetAwsNodePoolAsync(String, CallSettings)

public virtual Task<AwsNodePool> GetAwsNodePoolAsync(string name, CallSettings callSettings = null)

Describes a specific [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource.

Parameters
NameDescription
nameString

Required. The name of the [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource to describe.

AwsNodePool names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;/awsNodePools/&amp;lt;node-pool-id&amp;gt;.

See Resource Names for more details on Google Cloud resource names.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<AwsNodePool>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/awsClusters/[AWS_CLUSTER]/awsNodePools/[AWS_NODE_POOL]";
// Make the request
AwsNodePool response = await awsClustersClient.GetAwsNodePoolAsync(name);

GetAwsNodePoolAsync(String, CancellationToken)

public virtual Task<AwsNodePool> GetAwsNodePoolAsync(string name, CancellationToken cancellationToken)

Describes a specific [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource.

Parameters
NameDescription
nameString

Required. The name of the [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource to describe.

AwsNodePool names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;/awsNodePools/&amp;lt;node-pool-id&amp;gt;.

See Resource Names for more details on Google Cloud resource names.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<AwsNodePool>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/awsClusters/[AWS_CLUSTER]/awsNodePools/[AWS_NODE_POOL]";
// Make the request
AwsNodePool response = await awsClustersClient.GetAwsNodePoolAsync(name);

GetAwsServerConfig(AwsServerConfigName, CallSettings)

public virtual AwsServerConfig GetAwsServerConfig(AwsServerConfigName name, CallSettings callSettings = null)

Returns information, such as supported AWS regions and Kubernetes versions, on a given Google Cloud location.

Parameters
NameDescription
nameAwsServerConfigName

Required. The name of the [AwsServerConfig][google.cloud.gkemulticloud.v1.AwsServerConfig] resource to describe.

AwsServerConfig names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsServerConfig.

See Resource Names for more details on Google Cloud resource names.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
AwsServerConfig

The RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = AwsClustersClient.Create();
// Initialize request argument(s)
AwsServerConfigName name = AwsServerConfigName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
AwsServerConfig response = awsClustersClient.GetAwsServerConfig(name);

GetAwsServerConfig(GetAwsServerConfigRequest, CallSettings)

public virtual AwsServerConfig GetAwsServerConfig(GetAwsServerConfigRequest request, CallSettings callSettings = null)

Returns information, such as supported AWS regions and Kubernetes versions, on a given Google Cloud location.

Parameters
NameDescription
requestGetAwsServerConfigRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
AwsServerConfig

The RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = AwsClustersClient.Create();
// Initialize request argument(s)
GetAwsServerConfigRequest request = new GetAwsServerConfigRequest
{
    AwsServerConfigName = AwsServerConfigName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
AwsServerConfig response = awsClustersClient.GetAwsServerConfig(request);

GetAwsServerConfig(String, CallSettings)

public virtual AwsServerConfig GetAwsServerConfig(string name, CallSettings callSettings = null)

Returns information, such as supported AWS regions and Kubernetes versions, on a given Google Cloud location.

Parameters
NameDescription
nameString

Required. The name of the [AwsServerConfig][google.cloud.gkemulticloud.v1.AwsServerConfig] resource to describe.

AwsServerConfig names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsServerConfig.

See Resource Names for more details on Google Cloud resource names.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
AwsServerConfig

The RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = AwsClustersClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/awsServerConfig";
// Make the request
AwsServerConfig response = awsClustersClient.GetAwsServerConfig(name);

GetAwsServerConfigAsync(AwsServerConfigName, CallSettings)

public virtual Task<AwsServerConfig> GetAwsServerConfigAsync(AwsServerConfigName name, CallSettings callSettings = null)

Returns information, such as supported AWS regions and Kubernetes versions, on a given Google Cloud location.

Parameters
NameDescription
nameAwsServerConfigName

Required. The name of the [AwsServerConfig][google.cloud.gkemulticloud.v1.AwsServerConfig] resource to describe.

AwsServerConfig names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsServerConfig.

See Resource Names for more details on Google Cloud resource names.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<AwsServerConfig>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
AwsServerConfigName name = AwsServerConfigName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
AwsServerConfig response = await awsClustersClient.GetAwsServerConfigAsync(name);

GetAwsServerConfigAsync(AwsServerConfigName, CancellationToken)

public virtual Task<AwsServerConfig> GetAwsServerConfigAsync(AwsServerConfigName name, CancellationToken cancellationToken)

Returns information, such as supported AWS regions and Kubernetes versions, on a given Google Cloud location.

Parameters
NameDescription
nameAwsServerConfigName

Required. The name of the [AwsServerConfig][google.cloud.gkemulticloud.v1.AwsServerConfig] resource to describe.

AwsServerConfig names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsServerConfig.

See Resource Names for more details on Google Cloud resource names.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<AwsServerConfig>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
AwsServerConfigName name = AwsServerConfigName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
AwsServerConfig response = await awsClustersClient.GetAwsServerConfigAsync(name);

GetAwsServerConfigAsync(GetAwsServerConfigRequest, CallSettings)

public virtual Task<AwsServerConfig> GetAwsServerConfigAsync(GetAwsServerConfigRequest request, CallSettings callSettings = null)

Returns information, such as supported AWS regions and Kubernetes versions, on a given Google Cloud location.

Parameters
NameDescription
requestGetAwsServerConfigRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<AwsServerConfig>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
GetAwsServerConfigRequest request = new GetAwsServerConfigRequest
{
    AwsServerConfigName = AwsServerConfigName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
AwsServerConfig response = await awsClustersClient.GetAwsServerConfigAsync(request);

GetAwsServerConfigAsync(GetAwsServerConfigRequest, CancellationToken)

public virtual Task<AwsServerConfig> GetAwsServerConfigAsync(GetAwsServerConfigRequest request, CancellationToken cancellationToken)

Returns information, such as supported AWS regions and Kubernetes versions, on a given Google Cloud location.

Parameters
NameDescription
requestGetAwsServerConfigRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<AwsServerConfig>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
GetAwsServerConfigRequest request = new GetAwsServerConfigRequest
{
    AwsServerConfigName = AwsServerConfigName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
AwsServerConfig response = await awsClustersClient.GetAwsServerConfigAsync(request);

GetAwsServerConfigAsync(String, CallSettings)

public virtual Task<AwsServerConfig> GetAwsServerConfigAsync(string name, CallSettings callSettings = null)

Returns information, such as supported AWS regions and Kubernetes versions, on a given Google Cloud location.

Parameters
NameDescription
nameString

Required. The name of the [AwsServerConfig][google.cloud.gkemulticloud.v1.AwsServerConfig] resource to describe.

AwsServerConfig names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsServerConfig.

See Resource Names for more details on Google Cloud resource names.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<AwsServerConfig>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/awsServerConfig";
// Make the request
AwsServerConfig response = await awsClustersClient.GetAwsServerConfigAsync(name);

GetAwsServerConfigAsync(String, CancellationToken)

public virtual Task<AwsServerConfig> GetAwsServerConfigAsync(string name, CancellationToken cancellationToken)

Returns information, such as supported AWS regions and Kubernetes versions, on a given Google Cloud location.

Parameters
NameDescription
nameString

Required. The name of the [AwsServerConfig][google.cloud.gkemulticloud.v1.AwsServerConfig] resource to describe.

AwsServerConfig names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsServerConfig.

See Resource Names for more details on Google Cloud resource names.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<AwsServerConfig>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/awsServerConfig";
// Make the request
AwsServerConfig response = await awsClustersClient.GetAwsServerConfigAsync(name);

ListAwsClusters(LocationName, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListAwsClustersResponse, AwsCluster> ListAwsClusters(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resources on a given Google Cloud project and region.

Parameters
NameDescription
parentLocationName

Required. The parent location which owns this collection of [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resources.

Location names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;.

See Resource Names for more details on GCP resource names.

pageTokenString

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

pageSizeNullable<Int32>

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListAwsClustersResponse, AwsCluster>

A pageable sequence of AwsCluster resources.

Example
// Create client
AwsClustersClient awsClustersClient = AwsClustersClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListAwsClustersResponse, AwsCluster> response = awsClustersClient.ListAwsClusters(parent);

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

ListAwsClusters(ListAwsClustersRequest, CallSettings)

public virtual PagedEnumerable<ListAwsClustersResponse, AwsCluster> ListAwsClusters(ListAwsClustersRequest request, CallSettings callSettings = null)

Lists all [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resources on a given Google Cloud project and region.

Parameters
NameDescription
requestListAwsClustersRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListAwsClustersResponse, AwsCluster>

A pageable sequence of AwsCluster resources.

Example
// Create client
AwsClustersClient awsClustersClient = AwsClustersClient.Create();
// Initialize request argument(s)
ListAwsClustersRequest request = new ListAwsClustersRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedEnumerable<ListAwsClustersResponse, AwsCluster> response = awsClustersClient.ListAwsClusters(request);

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

ListAwsClusters(String, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListAwsClustersResponse, AwsCluster> ListAwsClusters(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resources on a given Google Cloud project and region.

Parameters
NameDescription
parentString

Required. The parent location which owns this collection of [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resources.

Location names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;.

See Resource Names for more details on GCP resource names.

pageTokenString

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

pageSizeNullable<Int32>

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListAwsClustersResponse, AwsCluster>

A pageable sequence of AwsCluster resources.

Example
// Create client
AwsClustersClient awsClustersClient = AwsClustersClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListAwsClustersResponse, AwsCluster> response = awsClustersClient.ListAwsClusters(parent);

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

ListAwsClustersAsync(LocationName, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListAwsClustersResponse, AwsCluster> ListAwsClustersAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resources on a given Google Cloud project and region.

Parameters
NameDescription
parentLocationName

Required. The parent location which owns this collection of [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resources.

Location names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;.

See Resource Names for more details on GCP resource names.

pageTokenString

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

pageSizeNullable<Int32>

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListAwsClustersResponse, AwsCluster>

A pageable asynchronous sequence of AwsCluster resources.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListAwsClustersResponse, AwsCluster> response = awsClustersClient.ListAwsClustersAsync(parent);

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

ListAwsClustersAsync(ListAwsClustersRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListAwsClustersResponse, AwsCluster> ListAwsClustersAsync(ListAwsClustersRequest request, CallSettings callSettings = null)

Lists all [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resources on a given Google Cloud project and region.

Parameters
NameDescription
requestListAwsClustersRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListAwsClustersResponse, AwsCluster>

A pageable asynchronous sequence of AwsCluster resources.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
ListAwsClustersRequest request = new ListAwsClustersRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedAsyncEnumerable<ListAwsClustersResponse, AwsCluster> response = awsClustersClient.ListAwsClustersAsync(request);

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

ListAwsClustersAsync(String, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListAwsClustersResponse, AwsCluster> ListAwsClustersAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resources on a given Google Cloud project and region.

Parameters
NameDescription
parentString

Required. The parent location which owns this collection of [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resources.

Location names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;.

See Resource Names for more details on GCP resource names.

pageTokenString

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

pageSizeNullable<Int32>

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListAwsClustersResponse, AwsCluster>

A pageable asynchronous sequence of AwsCluster resources.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListAwsClustersResponse, AwsCluster> response = awsClustersClient.ListAwsClustersAsync(parent);

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

ListAwsNodePools(AwsClusterName, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListAwsNodePoolsResponse, AwsNodePool> ListAwsNodePools(AwsClusterName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resources on a given [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster].

Parameters
NameDescription
parentAwsClusterName

Required. The parent AwsCluster which owns this collection of [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resources.

AwsCluster names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;.

See Resource Names for more details on Google Cloud resource names.

pageTokenString

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

pageSizeNullable<Int32>

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListAwsNodePoolsResponse, AwsNodePool>

A pageable sequence of AwsNodePool resources.

Example
// Create client
AwsClustersClient awsClustersClient = AwsClustersClient.Create();
// Initialize request argument(s)
AwsClusterName parent = AwsClusterName.FromProjectLocationAwsCluster("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]");
// Make the request
PagedEnumerable<ListAwsNodePoolsResponse, AwsNodePool> response = awsClustersClient.ListAwsNodePools(parent);

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

ListAwsNodePools(ListAwsNodePoolsRequest, CallSettings)

public virtual PagedEnumerable<ListAwsNodePoolsResponse, AwsNodePool> ListAwsNodePools(ListAwsNodePoolsRequest request, CallSettings callSettings = null)

Lists all [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resources on a given [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster].

Parameters
NameDescription
requestListAwsNodePoolsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListAwsNodePoolsResponse, AwsNodePool>

A pageable sequence of AwsNodePool resources.

Example
// Create client
AwsClustersClient awsClustersClient = AwsClustersClient.Create();
// Initialize request argument(s)
ListAwsNodePoolsRequest request = new ListAwsNodePoolsRequest
{
    ParentAsAwsClusterName = AwsClusterName.FromProjectLocationAwsCluster("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]"),
};
// Make the request
PagedEnumerable<ListAwsNodePoolsResponse, AwsNodePool> response = awsClustersClient.ListAwsNodePools(request);

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

ListAwsNodePools(String, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListAwsNodePoolsResponse, AwsNodePool> ListAwsNodePools(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resources on a given [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster].

Parameters
NameDescription
parentString

Required. The parent AwsCluster which owns this collection of [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resources.

AwsCluster names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;.

See Resource Names for more details on Google Cloud resource names.

pageTokenString

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

pageSizeNullable<Int32>

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListAwsNodePoolsResponse, AwsNodePool>

A pageable sequence of AwsNodePool resources.

Example
// Create client
AwsClustersClient awsClustersClient = AwsClustersClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/awsClusters/[AWS_CLUSTER]";
// Make the request
PagedEnumerable<ListAwsNodePoolsResponse, AwsNodePool> response = awsClustersClient.ListAwsNodePools(parent);

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

ListAwsNodePoolsAsync(AwsClusterName, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListAwsNodePoolsResponse, AwsNodePool> ListAwsNodePoolsAsync(AwsClusterName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resources on a given [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster].

Parameters
NameDescription
parentAwsClusterName

Required. The parent AwsCluster which owns this collection of [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resources.

AwsCluster names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;.

See Resource Names for more details on Google Cloud resource names.

pageTokenString

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

pageSizeNullable<Int32>

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListAwsNodePoolsResponse, AwsNodePool>

A pageable asynchronous sequence of AwsNodePool resources.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
AwsClusterName parent = AwsClusterName.FromProjectLocationAwsCluster("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]");
// Make the request
PagedAsyncEnumerable<ListAwsNodePoolsResponse, AwsNodePool> response = awsClustersClient.ListAwsNodePoolsAsync(parent);

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

ListAwsNodePoolsAsync(ListAwsNodePoolsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListAwsNodePoolsResponse, AwsNodePool> ListAwsNodePoolsAsync(ListAwsNodePoolsRequest request, CallSettings callSettings = null)

Lists all [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resources on a given [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster].

Parameters
NameDescription
requestListAwsNodePoolsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListAwsNodePoolsResponse, AwsNodePool>

A pageable asynchronous sequence of AwsNodePool resources.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
ListAwsNodePoolsRequest request = new ListAwsNodePoolsRequest
{
    ParentAsAwsClusterName = AwsClusterName.FromProjectLocationAwsCluster("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]"),
};
// Make the request
PagedAsyncEnumerable<ListAwsNodePoolsResponse, AwsNodePool> response = awsClustersClient.ListAwsNodePoolsAsync(request);

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

ListAwsNodePoolsAsync(String, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListAwsNodePoolsResponse, AwsNodePool> ListAwsNodePoolsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resources on a given [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster].

Parameters
NameDescription
parentString

Required. The parent AwsCluster which owns this collection of [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resources.

AwsCluster names are formatted as projects/&amp;lt;project-id&amp;gt;/locations/&amp;lt;region&amp;gt;/awsClusters/&amp;lt;cluster-id&amp;gt;.

See Resource Names for more details on Google Cloud resource names.

pageTokenString

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

pageSizeNullable<Int32>

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListAwsNodePoolsResponse, AwsNodePool>

A pageable asynchronous sequence of AwsNodePool resources.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/awsClusters/[AWS_CLUSTER]";
// Make the request
PagedAsyncEnumerable<ListAwsNodePoolsResponse, AwsNodePool> response = awsClustersClient.ListAwsNodePoolsAsync(parent);

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

PollOnceCreateAwsCluster(String, CallSettings)

public virtual Operation<AwsCluster, OperationMetadata> PollOnceCreateAwsCluster(string operationName, CallSettings callSettings = null)

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

Parameters
NameDescription
operationNameString

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<AwsCluster, OperationMetadata>

The result of polling the operation.

PollOnceCreateAwsClusterAsync(String, CallSettings)

public virtual Task<Operation<AwsCluster, OperationMetadata>> PollOnceCreateAwsClusterAsync(string operationName, CallSettings callSettings = null)

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

Parameters
NameDescription
operationNameString

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<AwsCluster, OperationMetadata>>

A task representing the result of polling the operation.

PollOnceCreateAwsNodePool(String, CallSettings)

public virtual Operation<AwsNodePool, OperationMetadata> PollOnceCreateAwsNodePool(string operationName, CallSettings callSettings = null)

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

Parameters
NameDescription
operationNameString

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<AwsNodePool, OperationMetadata>

The result of polling the operation.

PollOnceCreateAwsNodePoolAsync(String, CallSettings)

public virtual Task<Operation<AwsNodePool, OperationMetadata>> PollOnceCreateAwsNodePoolAsync(string operationName, CallSettings callSettings = null)

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

Parameters
NameDescription
operationNameString

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<AwsNodePool, OperationMetadata>>

A task representing the result of polling the operation.

PollOnceDeleteAwsCluster(String, CallSettings)

public virtual Operation<Empty, OperationMetadata> PollOnceDeleteAwsCluster(string operationName, CallSettings callSettings = null)

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

Parameters
NameDescription
operationNameString

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Empty, OperationMetadata>

The result of polling the operation.

PollOnceDeleteAwsClusterAsync(String, CallSettings)

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

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

Parameters
NameDescription
operationNameString

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Empty, OperationMetadata>>

A task representing the result of polling the operation.

PollOnceDeleteAwsNodePool(String, CallSettings)

public virtual Operation<Empty, OperationMetadata> PollOnceDeleteAwsNodePool(string operationName, CallSettings callSettings = null)

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

Parameters
NameDescription
operationNameString

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Empty, OperationMetadata>

The result of polling the operation.

PollOnceDeleteAwsNodePoolAsync(String, CallSettings)

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

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

Parameters
NameDescription
operationNameString

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Empty, OperationMetadata>>

A task representing the result of polling the operation.

PollOnceUpdateAwsCluster(String, CallSettings)

public virtual Operation<AwsCluster, OperationMetadata> PollOnceUpdateAwsCluster(string operationName, CallSettings callSettings = null)

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

Parameters
NameDescription
operationNameString

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<AwsCluster, OperationMetadata>

The result of polling the operation.

PollOnceUpdateAwsClusterAsync(String, CallSettings)

public virtual Task<Operation<AwsCluster, OperationMetadata>> PollOnceUpdateAwsClusterAsync(string operationName, CallSettings callSettings = null)

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

Parameters
NameDescription
operationNameString

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<AwsCluster, OperationMetadata>>

A task representing the result of polling the operation.

PollOnceUpdateAwsNodePool(String, CallSettings)

public virtual Operation<AwsNodePool, OperationMetadata> PollOnceUpdateAwsNodePool(string operationName, CallSettings callSettings = null)

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

Parameters
NameDescription
operationNameString

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<AwsNodePool, OperationMetadata>

The result of polling the operation.

PollOnceUpdateAwsNodePoolAsync(String, CallSettings)

public virtual Task<Operation<AwsNodePool, OperationMetadata>> PollOnceUpdateAwsNodePoolAsync(string operationName, CallSettings callSettings = null)

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

Parameters
NameDescription
operationNameString

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<AwsNodePool, OperationMetadata>>

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
TypeDescription
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.

UpdateAwsCluster(AwsCluster, FieldMask, CallSettings)

public virtual Operation<AwsCluster, OperationMetadata> UpdateAwsCluster(AwsCluster awsCluster, FieldMask updateMask, CallSettings callSettings = null)

Updates an [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster].

Parameters
NameDescription
awsClusterAwsCluster

Required. The [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource to update.

updateMaskFieldMask

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field can only include these fields from [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster]:

  • description.
  • annotations.
  • control_plane.version.
  • authorization.admin_users.
  • control_plane.aws_services_authentication.role_arn.
  • control_plane.aws_services_authentication.role_session_name.
  • control_plane.config_encryption.kms_key_arn.
  • control_plane.instance_type.
  • control_plane.security_group_ids.
  • control_plane.proxy_config.
  • control_plane.proxy_config.secret_arn.
  • control_plane.proxy_config.secret_version.
  • control_plane.root_volume.iops.
  • control_plane.root_volume.kms_key_arn.
  • control_plane.root_volume.volume_type.
  • control_plane.root_volume.size_gib.
  • control_plane.ssh_config.
  • control_plane.ssh_config.ec2_key_pair.
  • control_plane.instance_placement.tenancy.
  • logging_config.
callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<AwsCluster, OperationMetadata>

The RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = AwsClustersClient.Create();
// Initialize request argument(s)
AwsCluster awsCluster = new AwsCluster();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<AwsCluster, OperationMetadata> response = awsClustersClient.UpdateAwsCluster(awsCluster, updateMask);

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

UpdateAwsCluster(UpdateAwsClusterRequest, CallSettings)

public virtual Operation<AwsCluster, OperationMetadata> UpdateAwsCluster(UpdateAwsClusterRequest request, CallSettings callSettings = null)

Updates an [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster].

Parameters
NameDescription
requestUpdateAwsClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<AwsCluster, OperationMetadata>

The RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = AwsClustersClient.Create();
// Initialize request argument(s)
UpdateAwsClusterRequest request = new UpdateAwsClusterRequest
{
    AwsCluster = new AwsCluster(),
    ValidateOnly = false,
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<AwsCluster, OperationMetadata> response = awsClustersClient.UpdateAwsCluster(request);

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

UpdateAwsClusterAsync(AwsCluster, FieldMask, CallSettings)

public virtual Task<Operation<AwsCluster, OperationMetadata>> UpdateAwsClusterAsync(AwsCluster awsCluster, FieldMask updateMask, CallSettings callSettings = null)

Updates an [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster].

Parameters
NameDescription
awsClusterAwsCluster

Required. The [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource to update.

updateMaskFieldMask

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field can only include these fields from [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster]:

  • description.
  • annotations.
  • control_plane.version.
  • authorization.admin_users.
  • control_plane.aws_services_authentication.role_arn.
  • control_plane.aws_services_authentication.role_session_name.
  • control_plane.config_encryption.kms_key_arn.
  • control_plane.instance_type.
  • control_plane.security_group_ids.
  • control_plane.proxy_config.
  • control_plane.proxy_config.secret_arn.
  • control_plane.proxy_config.secret_version.
  • control_plane.root_volume.iops.
  • control_plane.root_volume.kms_key_arn.
  • control_plane.root_volume.volume_type.
  • control_plane.root_volume.size_gib.
  • control_plane.ssh_config.
  • control_plane.ssh_config.ec2_key_pair.
  • control_plane.instance_placement.tenancy.
  • logging_config.
callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<AwsCluster, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
AwsCluster awsCluster = new AwsCluster();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<AwsCluster, OperationMetadata> response = await awsClustersClient.UpdateAwsClusterAsync(awsCluster, updateMask);

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

UpdateAwsClusterAsync(AwsCluster, FieldMask, CancellationToken)

public virtual Task<Operation<AwsCluster, OperationMetadata>> UpdateAwsClusterAsync(AwsCluster awsCluster, FieldMask updateMask, CancellationToken cancellationToken)

Updates an [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster].

Parameters
NameDescription
awsClusterAwsCluster

Required. The [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource to update.

updateMaskFieldMask

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field can only include these fields from [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster]:

  • description.
  • annotations.
  • control_plane.version.
  • authorization.admin_users.
  • control_plane.aws_services_authentication.role_arn.
  • control_plane.aws_services_authentication.role_session_name.
  • control_plane.config_encryption.kms_key_arn.
  • control_plane.instance_type.
  • control_plane.security_group_ids.
  • control_plane.proxy_config.
  • control_plane.proxy_config.secret_arn.
  • control_plane.proxy_config.secret_version.
  • control_plane.root_volume.iops.
  • control_plane.root_volume.kms_key_arn.
  • control_plane.root_volume.volume_type.
  • control_plane.root_volume.size_gib.
  • control_plane.ssh_config.
  • control_plane.ssh_config.ec2_key_pair.
  • control_plane.instance_placement.tenancy.
  • logging_config.
cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<AwsCluster, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
AwsCluster awsCluster = new AwsCluster();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<AwsCluster, OperationMetadata> response = await awsClustersClient.UpdateAwsClusterAsync(awsCluster, updateMask);

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

UpdateAwsClusterAsync(UpdateAwsClusterRequest, CallSettings)

public virtual Task<Operation<AwsCluster, OperationMetadata>> UpdateAwsClusterAsync(UpdateAwsClusterRequest request, CallSettings callSettings = null)

Updates an [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster].

Parameters
NameDescription
requestUpdateAwsClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<AwsCluster, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
UpdateAwsClusterRequest request = new UpdateAwsClusterRequest
{
    AwsCluster = new AwsCluster(),
    ValidateOnly = false,
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<AwsCluster, OperationMetadata> response = await awsClustersClient.UpdateAwsClusterAsync(request);

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

UpdateAwsClusterAsync(UpdateAwsClusterRequest, CancellationToken)

public virtual Task<Operation<AwsCluster, OperationMetadata>> UpdateAwsClusterAsync(UpdateAwsClusterRequest request, CancellationToken cancellationToken)

Updates an [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster].

Parameters
NameDescription
requestUpdateAwsClusterRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<AwsCluster, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
UpdateAwsClusterRequest request = new UpdateAwsClusterRequest
{
    AwsCluster = new AwsCluster(),
    ValidateOnly = false,
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<AwsCluster, OperationMetadata> response = await awsClustersClient.UpdateAwsClusterAsync(request);

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

UpdateAwsNodePool(AwsNodePool, FieldMask, CallSettings)

public virtual Operation<AwsNodePool, OperationMetadata> UpdateAwsNodePool(AwsNodePool awsNodePool, FieldMask updateMask, CallSettings callSettings = null)

Updates an [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool].

Parameters
NameDescription
awsNodePoolAwsNodePool

Required. The [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource to update.

updateMaskFieldMask

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field can only include these fields from [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool]:

  • annotations.
  • version.
  • autoscaling.min_node_count.
  • autoscaling.max_node_count.
  • config.config_encryption.kms_key_arn.
  • config.security_group_ids.
  • config.root_volume.iops.
  • config.root_volume.kms_key_arn.
  • config.root_volume.volume_type.
  • config.root_volume.size_gib.
  • config.proxy_config.
  • config.proxy_config.secret_arn.
  • config.proxy_config.secret_version.
  • config.ssh_config.
  • config.ssh_config.ec2_key_pair.
callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<AwsNodePool, OperationMetadata>

The RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = AwsClustersClient.Create();
// Initialize request argument(s)
AwsNodePool awsNodePool = new AwsNodePool();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<AwsNodePool, OperationMetadata> response = awsClustersClient.UpdateAwsNodePool(awsNodePool, updateMask);

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

UpdateAwsNodePool(UpdateAwsNodePoolRequest, CallSettings)

public virtual Operation<AwsNodePool, OperationMetadata> UpdateAwsNodePool(UpdateAwsNodePoolRequest request, CallSettings callSettings = null)

Updates an [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool].

Parameters
NameDescription
requestUpdateAwsNodePoolRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<AwsNodePool, OperationMetadata>

The RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = AwsClustersClient.Create();
// Initialize request argument(s)
UpdateAwsNodePoolRequest request = new UpdateAwsNodePoolRequest
{
    AwsNodePool = new AwsNodePool(),
    ValidateOnly = false,
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<AwsNodePool, OperationMetadata> response = awsClustersClient.UpdateAwsNodePool(request);

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

UpdateAwsNodePoolAsync(AwsNodePool, FieldMask, CallSettings)

public virtual Task<Operation<AwsNodePool, OperationMetadata>> UpdateAwsNodePoolAsync(AwsNodePool awsNodePool, FieldMask updateMask, CallSettings callSettings = null)

Updates an [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool].

Parameters
NameDescription
awsNodePoolAwsNodePool

Required. The [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource to update.

updateMaskFieldMask

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field can only include these fields from [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool]:

  • annotations.
  • version.
  • autoscaling.min_node_count.
  • autoscaling.max_node_count.
  • config.config_encryption.kms_key_arn.
  • config.security_group_ids.
  • config.root_volume.iops.
  • config.root_volume.kms_key_arn.
  • config.root_volume.volume_type.
  • config.root_volume.size_gib.
  • config.proxy_config.
  • config.proxy_config.secret_arn.
  • config.proxy_config.secret_version.
  • config.ssh_config.
  • config.ssh_config.ec2_key_pair.
callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<AwsNodePool, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
AwsNodePool awsNodePool = new AwsNodePool();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<AwsNodePool, OperationMetadata> response = await awsClustersClient.UpdateAwsNodePoolAsync(awsNodePool, updateMask);

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

UpdateAwsNodePoolAsync(AwsNodePool, FieldMask, CancellationToken)

public virtual Task<Operation<AwsNodePool, OperationMetadata>> UpdateAwsNodePoolAsync(AwsNodePool awsNodePool, FieldMask updateMask, CancellationToken cancellationToken)

Updates an [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool].

Parameters
NameDescription
awsNodePoolAwsNodePool

Required. The [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource to update.

updateMaskFieldMask

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field can only include these fields from [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool]:

  • annotations.
  • version.
  • autoscaling.min_node_count.
  • autoscaling.max_node_count.
  • config.config_encryption.kms_key_arn.
  • config.security_group_ids.
  • config.root_volume.iops.
  • config.root_volume.kms_key_arn.
  • config.root_volume.volume_type.
  • config.root_volume.size_gib.
  • config.proxy_config.
  • config.proxy_config.secret_arn.
  • config.proxy_config.secret_version.
  • config.ssh_config.
  • config.ssh_config.ec2_key_pair.
cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<AwsNodePool, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
AwsNodePool awsNodePool = new AwsNodePool();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<AwsNodePool, OperationMetadata> response = await awsClustersClient.UpdateAwsNodePoolAsync(awsNodePool, updateMask);

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

UpdateAwsNodePoolAsync(UpdateAwsNodePoolRequest, CallSettings)

public virtual Task<Operation<AwsNodePool, OperationMetadata>> UpdateAwsNodePoolAsync(UpdateAwsNodePoolRequest request, CallSettings callSettings = null)

Updates an [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool].

Parameters
NameDescription
requestUpdateAwsNodePoolRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<AwsNodePool, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
UpdateAwsNodePoolRequest request = new UpdateAwsNodePoolRequest
{
    AwsNodePool = new AwsNodePool(),
    ValidateOnly = false,
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<AwsNodePool, OperationMetadata> response = await awsClustersClient.UpdateAwsNodePoolAsync(request);

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

UpdateAwsNodePoolAsync(UpdateAwsNodePoolRequest, CancellationToken)

public virtual Task<Operation<AwsNodePool, OperationMetadata>> UpdateAwsNodePoolAsync(UpdateAwsNodePoolRequest request, CancellationToken cancellationToken)

Updates an [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool].

Parameters
NameDescription
requestUpdateAwsNodePoolRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<AwsNodePool, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
AwsClustersClient awsClustersClient = await AwsClustersClient.CreateAsync();
// Initialize request argument(s)
UpdateAwsNodePoolRequest request = new UpdateAwsNodePoolRequest
{
    AwsNodePool = new AwsNodePool(),
    ValidateOnly = false,
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<AwsNodePool, OperationMetadata> response = await awsClustersClient.UpdateAwsNodePoolAsync(request);

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