Anthos Multi-Cloud v1 API - Class AwsClusters.AwsClustersClient (2.5.0)

public class AwsClusters.AwsClustersClient : ClientBase<AwsClusters.AwsClustersClient>

Reference documentation and code samples for the Anthos Multi-Cloud v1 API class AwsClusters.AwsClustersClient.

Client for AwsClusters

Inheritance

object > ClientBase > ClientBaseAwsClustersAwsClustersClient > AwsClusters.AwsClustersClient

Namespace

Google.Cloud.GkeMultiCloud.V1

Assembly

Google.Cloud.GkeMultiCloud.V1.dll

Constructors

AwsClustersClient()

protected AwsClustersClient()

Protected parameterless constructor to allow creation of test doubles.

AwsClustersClient(CallInvoker)

public AwsClustersClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

AwsClustersClient(ChannelBase)

public AwsClustersClient(ChannelBase channel)

Creates a new client for AwsClusters

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

AwsClustersClient(ClientBaseConfiguration)

protected AwsClustersClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateAwsCluster(CreateAwsClusterRequest, CallOptions)

public virtual Operation CreateAwsCluster(CreateAwsClusterRequest request, CallOptions options)

Creates a new [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource on a given Google Cloud Platform 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 to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateAwsCluster(CreateAwsClusterRequest, Metadata, DateTime?, CancellationToken)

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

Creates a new [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource on a given Google Cloud Platform 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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateAwsClusterAsync(CreateAwsClusterRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateAwsClusterAsync(CreateAwsClusterRequest request, CallOptions options)

Creates a new [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource on a given Google Cloud Platform 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 to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateAwsClusterAsync(CreateAwsClusterRequest, Metadata, DateTime?, CancellationToken)

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

Creates a new [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource on a given Google Cloud Platform 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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateAwsNodePool(CreateAwsNodePoolRequest, CallOptions)

public virtual Operation CreateAwsNodePool(CreateAwsNodePoolRequest request, CallOptions options)

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 to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateAwsNodePool(CreateAwsNodePoolRequest, Metadata, DateTime?, CancellationToken)

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

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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateAwsNodePoolAsync(CreateAwsNodePoolRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateAwsNodePoolAsync(CreateAwsNodePoolRequest request, CallOptions options)

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 to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateAwsNodePoolAsync(CreateAwsNodePoolRequest, Metadata, DateTime?, CancellationToken)

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

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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

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

Returns
TypeDescription
OperationsOperationsClient

A new Operations client for the same target as this client.

DeleteAwsCluster(DeleteAwsClusterRequest, CallOptions)

public virtual Operation DeleteAwsCluster(DeleteAwsClusterRequest request, CallOptions options)

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 to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteAwsCluster(DeleteAwsClusterRequest, Metadata, DateTime?, CancellationToken)

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

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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteAwsClusterAsync(DeleteAwsClusterRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteAwsClusterAsync(DeleteAwsClusterRequest request, CallOptions options)

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 to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteAwsClusterAsync(DeleteAwsClusterRequest, Metadata, DateTime?, CancellationToken)

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

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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteAwsNodePool(DeleteAwsNodePoolRequest, CallOptions)

public virtual Operation DeleteAwsNodePool(DeleteAwsNodePoolRequest request, CallOptions options)

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 to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteAwsNodePool(DeleteAwsNodePoolRequest, Metadata, DateTime?, CancellationToken)

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

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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteAwsNodePoolAsync(DeleteAwsNodePoolRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteAwsNodePoolAsync(DeleteAwsNodePoolRequest request, CallOptions options)

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 to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteAwsNodePoolAsync(DeleteAwsNodePoolRequest, Metadata, DateTime?, CancellationToken)

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

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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

GenerateAwsAccessToken(GenerateAwsAccessTokenRequest, CallOptions)

public virtual GenerateAwsAccessTokenResponse GenerateAwsAccessToken(GenerateAwsAccessTokenRequest request, CallOptions options)

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

Parameters
NameDescription
requestGenerateAwsAccessTokenRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
GenerateAwsAccessTokenResponse

The response received from the server.

GenerateAwsAccessToken(GenerateAwsAccessTokenRequest, Metadata, DateTime?, CancellationToken)

public virtual GenerateAwsAccessTokenResponse GenerateAwsAccessToken(GenerateAwsAccessTokenRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestGenerateAwsAccessTokenRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
GenerateAwsAccessTokenResponse

The response received from the server.

GenerateAwsAccessTokenAsync(GenerateAwsAccessTokenRequest, CallOptions)

public virtual AsyncUnaryCall<GenerateAwsAccessTokenResponse> GenerateAwsAccessTokenAsync(GenerateAwsAccessTokenRequest request, CallOptions options)

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

Parameters
NameDescription
requestGenerateAwsAccessTokenRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallGenerateAwsAccessTokenResponse

The call object.

GenerateAwsAccessTokenAsync(GenerateAwsAccessTokenRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<GenerateAwsAccessTokenResponse> GenerateAwsAccessTokenAsync(GenerateAwsAccessTokenRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestGenerateAwsAccessTokenRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallGenerateAwsAccessTokenResponse

The call object.

GenerateAwsClusterAgentToken(GenerateAwsClusterAgentTokenRequest, CallOptions)

public virtual GenerateAwsClusterAgentTokenResponse GenerateAwsClusterAgentToken(GenerateAwsClusterAgentTokenRequest request, CallOptions options)

Generates an access token for a cluster agent.

Parameters
NameDescription
requestGenerateAwsClusterAgentTokenRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
GenerateAwsClusterAgentTokenResponse

The response received from the server.

GenerateAwsClusterAgentToken(GenerateAwsClusterAgentTokenRequest, Metadata, DateTime?, CancellationToken)

public virtual GenerateAwsClusterAgentTokenResponse GenerateAwsClusterAgentToken(GenerateAwsClusterAgentTokenRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Generates an access token for a cluster agent.

Parameters
NameDescription
requestGenerateAwsClusterAgentTokenRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
GenerateAwsClusterAgentTokenResponse

The response received from the server.

GenerateAwsClusterAgentTokenAsync(GenerateAwsClusterAgentTokenRequest, CallOptions)

public virtual AsyncUnaryCall<GenerateAwsClusterAgentTokenResponse> GenerateAwsClusterAgentTokenAsync(GenerateAwsClusterAgentTokenRequest request, CallOptions options)

Generates an access token for a cluster agent.

Parameters
NameDescription
requestGenerateAwsClusterAgentTokenRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallGenerateAwsClusterAgentTokenResponse

The call object.

GenerateAwsClusterAgentTokenAsync(GenerateAwsClusterAgentTokenRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<GenerateAwsClusterAgentTokenResponse> GenerateAwsClusterAgentTokenAsync(GenerateAwsClusterAgentTokenRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Generates an access token for a cluster agent.

Parameters
NameDescription
requestGenerateAwsClusterAgentTokenRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallGenerateAwsClusterAgentTokenResponse

The call object.

GetAwsCluster(GetAwsClusterRequest, CallOptions)

public virtual AwsCluster GetAwsCluster(GetAwsClusterRequest request, CallOptions options)

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

Parameters
NameDescription
requestGetAwsClusterRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AwsCluster

The response received from the server.

GetAwsCluster(GetAwsClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual AwsCluster GetAwsCluster(GetAwsClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestGetAwsClusterRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AwsCluster

The response received from the server.

GetAwsClusterAsync(GetAwsClusterRequest, CallOptions)

public virtual AsyncUnaryCall<AwsCluster> GetAwsClusterAsync(GetAwsClusterRequest request, CallOptions options)

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

Parameters
NameDescription
requestGetAwsClusterRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallAwsCluster

The call object.

GetAwsClusterAsync(GetAwsClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<AwsCluster> GetAwsClusterAsync(GetAwsClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestGetAwsClusterRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallAwsCluster

The call object.

GetAwsJsonWebKeys(GetAwsJsonWebKeysRequest, CallOptions)

public virtual AwsJsonWebKeys GetAwsJsonWebKeys(GetAwsJsonWebKeysRequest request, CallOptions options)

Gets the public component of the cluster signing keys in JSON Web Key format.

Parameters
NameDescription
requestGetAwsJsonWebKeysRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AwsJsonWebKeys

The response received from the server.

GetAwsJsonWebKeys(GetAwsJsonWebKeysRequest, Metadata, DateTime?, CancellationToken)

public virtual AwsJsonWebKeys GetAwsJsonWebKeys(GetAwsJsonWebKeysRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the public component of the cluster signing keys in JSON Web Key format.

Parameters
NameDescription
requestGetAwsJsonWebKeysRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AwsJsonWebKeys

The response received from the server.

GetAwsJsonWebKeysAsync(GetAwsJsonWebKeysRequest, CallOptions)

public virtual AsyncUnaryCall<AwsJsonWebKeys> GetAwsJsonWebKeysAsync(GetAwsJsonWebKeysRequest request, CallOptions options)

Gets the public component of the cluster signing keys in JSON Web Key format.

Parameters
NameDescription
requestGetAwsJsonWebKeysRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallAwsJsonWebKeys

The call object.

GetAwsJsonWebKeysAsync(GetAwsJsonWebKeysRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<AwsJsonWebKeys> GetAwsJsonWebKeysAsync(GetAwsJsonWebKeysRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the public component of the cluster signing keys in JSON Web Key format.

Parameters
NameDescription
requestGetAwsJsonWebKeysRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallAwsJsonWebKeys

The call object.

GetAwsNodePool(GetAwsNodePoolRequest, CallOptions)

public virtual AwsNodePool GetAwsNodePool(GetAwsNodePoolRequest request, CallOptions options)

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

Parameters
NameDescription
requestGetAwsNodePoolRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AwsNodePool

The response received from the server.

GetAwsNodePool(GetAwsNodePoolRequest, Metadata, DateTime?, CancellationToken)

public virtual AwsNodePool GetAwsNodePool(GetAwsNodePoolRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestGetAwsNodePoolRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AwsNodePool

The response received from the server.

GetAwsNodePoolAsync(GetAwsNodePoolRequest, CallOptions)

public virtual AsyncUnaryCall<AwsNodePool> GetAwsNodePoolAsync(GetAwsNodePoolRequest request, CallOptions options)

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

Parameters
NameDescription
requestGetAwsNodePoolRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallAwsNodePool

The call object.

GetAwsNodePoolAsync(GetAwsNodePoolRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<AwsNodePool> GetAwsNodePoolAsync(GetAwsNodePoolRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestGetAwsNodePoolRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallAwsNodePool

The call object.

GetAwsOpenIdConfig(GetAwsOpenIdConfigRequest, CallOptions)

public virtual AwsOpenIdConfig GetAwsOpenIdConfig(GetAwsOpenIdConfigRequest request, CallOptions options)

Gets the OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details.

Parameters
NameDescription
requestGetAwsOpenIdConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AwsOpenIdConfig

The response received from the server.

GetAwsOpenIdConfig(GetAwsOpenIdConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AwsOpenIdConfig GetAwsOpenIdConfig(GetAwsOpenIdConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details.

Parameters
NameDescription
requestGetAwsOpenIdConfigRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AwsOpenIdConfig

The response received from the server.

GetAwsOpenIdConfigAsync(GetAwsOpenIdConfigRequest, CallOptions)

public virtual AsyncUnaryCall<AwsOpenIdConfig> GetAwsOpenIdConfigAsync(GetAwsOpenIdConfigRequest request, CallOptions options)

Gets the OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details.

Parameters
NameDescription
requestGetAwsOpenIdConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallAwsOpenIdConfig

The call object.

GetAwsOpenIdConfigAsync(GetAwsOpenIdConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<AwsOpenIdConfig> GetAwsOpenIdConfigAsync(GetAwsOpenIdConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details.

Parameters
NameDescription
requestGetAwsOpenIdConfigRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallAwsOpenIdConfig

The call object.

GetAwsServerConfig(GetAwsServerConfigRequest, CallOptions)

public virtual AwsServerConfig GetAwsServerConfig(GetAwsServerConfigRequest request, CallOptions options)

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

Parameters
NameDescription
requestGetAwsServerConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AwsServerConfig

The response received from the server.

GetAwsServerConfig(GetAwsServerConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AwsServerConfig GetAwsServerConfig(GetAwsServerConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestGetAwsServerConfigRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AwsServerConfig

The response received from the server.

GetAwsServerConfigAsync(GetAwsServerConfigRequest, CallOptions)

public virtual AsyncUnaryCall<AwsServerConfig> GetAwsServerConfigAsync(GetAwsServerConfigRequest request, CallOptions options)

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

Parameters
NameDescription
requestGetAwsServerConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallAwsServerConfig

The call object.

GetAwsServerConfigAsync(GetAwsServerConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<AwsServerConfig> GetAwsServerConfigAsync(GetAwsServerConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestGetAwsServerConfigRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallAwsServerConfig

The call object.

ListAwsClusters(ListAwsClustersRequest, CallOptions)

public virtual ListAwsClustersResponse ListAwsClusters(ListAwsClustersRequest request, CallOptions options)

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

Parameters
NameDescription
requestListAwsClustersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListAwsClustersResponse

The response received from the server.

ListAwsClusters(ListAwsClustersRequest, Metadata, DateTime?, CancellationToken)

public virtual ListAwsClustersResponse ListAwsClusters(ListAwsClustersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestListAwsClustersRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListAwsClustersResponse

The response received from the server.

ListAwsClustersAsync(ListAwsClustersRequest, CallOptions)

public virtual AsyncUnaryCall<ListAwsClustersResponse> ListAwsClustersAsync(ListAwsClustersRequest request, CallOptions options)

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

Parameters
NameDescription
requestListAwsClustersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListAwsClustersResponse

The call object.

ListAwsClustersAsync(ListAwsClustersRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListAwsClustersResponse> ListAwsClustersAsync(ListAwsClustersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestListAwsClustersRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListAwsClustersResponse

The call object.

ListAwsNodePools(ListAwsNodePoolsRequest, CallOptions)

public virtual ListAwsNodePoolsResponse ListAwsNodePools(ListAwsNodePoolsRequest request, CallOptions options)

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

Parameters
NameDescription
requestListAwsNodePoolsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListAwsNodePoolsResponse

The response received from the server.

ListAwsNodePools(ListAwsNodePoolsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListAwsNodePoolsResponse ListAwsNodePools(ListAwsNodePoolsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestListAwsNodePoolsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListAwsNodePoolsResponse

The response received from the server.

ListAwsNodePoolsAsync(ListAwsNodePoolsRequest, CallOptions)

public virtual AsyncUnaryCall<ListAwsNodePoolsResponse> ListAwsNodePoolsAsync(ListAwsNodePoolsRequest request, CallOptions options)

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

Parameters
NameDescription
requestListAwsNodePoolsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListAwsNodePoolsResponse

The call object.

ListAwsNodePoolsAsync(ListAwsNodePoolsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListAwsNodePoolsResponse> ListAwsNodePoolsAsync(ListAwsNodePoolsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestListAwsNodePoolsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListAwsNodePoolsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override AwsClusters.AwsClustersClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration
Returns
TypeDescription
AwsClustersAwsClustersClient
Overrides

RollbackAwsNodePoolUpdate(RollbackAwsNodePoolUpdateRequest, CallOptions)

public virtual Operation RollbackAwsNodePoolUpdate(RollbackAwsNodePoolUpdateRequest request, CallOptions options)

Rolls back a previously aborted or failed [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] update request. Makes no changes if the last update request successfully finished. If an update request is in progress, you cannot rollback the update. You must first cancel or let it finish unsuccessfully before you can rollback.

Parameters
NameDescription
requestRollbackAwsNodePoolUpdateRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

RollbackAwsNodePoolUpdate(RollbackAwsNodePoolUpdateRequest, Metadata, DateTime?, CancellationToken)

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

Rolls back a previously aborted or failed [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] update request. Makes no changes if the last update request successfully finished. If an update request is in progress, you cannot rollback the update. You must first cancel or let it finish unsuccessfully before you can rollback.

Parameters
NameDescription
requestRollbackAwsNodePoolUpdateRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

RollbackAwsNodePoolUpdateAsync(RollbackAwsNodePoolUpdateRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> RollbackAwsNodePoolUpdateAsync(RollbackAwsNodePoolUpdateRequest request, CallOptions options)

Rolls back a previously aborted or failed [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] update request. Makes no changes if the last update request successfully finished. If an update request is in progress, you cannot rollback the update. You must first cancel or let it finish unsuccessfully before you can rollback.

Parameters
NameDescription
requestRollbackAwsNodePoolUpdateRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

RollbackAwsNodePoolUpdateAsync(RollbackAwsNodePoolUpdateRequest, Metadata, DateTime?, CancellationToken)

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

Rolls back a previously aborted or failed [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] update request. Makes no changes if the last update request successfully finished. If an update request is in progress, you cannot rollback the update. You must first cancel or let it finish unsuccessfully before you can rollback.

Parameters
NameDescription
requestRollbackAwsNodePoolUpdateRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UpdateAwsCluster(UpdateAwsClusterRequest, CallOptions)

public virtual Operation UpdateAwsCluster(UpdateAwsClusterRequest request, CallOptions options)

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

Parameters
NameDescription
requestUpdateAwsClusterRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateAwsCluster(UpdateAwsClusterRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
NameDescription
requestUpdateAwsClusterRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateAwsClusterAsync(UpdateAwsClusterRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateAwsClusterAsync(UpdateAwsClusterRequest request, CallOptions options)

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

Parameters
NameDescription
requestUpdateAwsClusterRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UpdateAwsClusterAsync(UpdateAwsClusterRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
NameDescription
requestUpdateAwsClusterRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UpdateAwsNodePool(UpdateAwsNodePoolRequest, CallOptions)

public virtual Operation UpdateAwsNodePool(UpdateAwsNodePoolRequest request, CallOptions options)

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

Parameters
NameDescription
requestUpdateAwsNodePoolRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateAwsNodePool(UpdateAwsNodePoolRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
NameDescription
requestUpdateAwsNodePoolRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateAwsNodePoolAsync(UpdateAwsNodePoolRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateAwsNodePoolAsync(UpdateAwsNodePoolRequest request, CallOptions options)

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

Parameters
NameDescription
requestUpdateAwsNodePoolRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UpdateAwsNodePoolAsync(UpdateAwsNodePoolRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
NameDescription
requestUpdateAwsNodePoolRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.