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

Version 2.5.0

• 2.7.0 (latest)
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.0.0-beta01

[BindServiceMethod(typeof(AwsClusters), "BindService")]
public abstract class AwsClusters.AwsClustersBase

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

Base class for server-side implementations of AwsClusters

Inheritance

object > AwsClusters.AwsClustersBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.GkeMultiCloud.V1

Assembly

Google.Cloud.GkeMultiCloud.V1.dll

Methods

CreateAwsCluster(CreateAwsClusterRequest, ServerCallContext)

public virtual Task<Operation> CreateAwsCluster(CreateAwsClusterRequest request, ServerCallContext context)

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
Name	Description
request	CreateAwsClusterRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateAwsNodePool(CreateAwsNodePoolRequest, ServerCallContext)

public virtual Task<Operation> CreateAwsNodePool(CreateAwsNodePoolRequest request, ServerCallContext context)

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
Name	Description
request	CreateAwsNodePoolRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteAwsCluster(DeleteAwsClusterRequest, ServerCallContext)

public virtual Task<Operation> DeleteAwsCluster(DeleteAwsClusterRequest request, ServerCallContext context)

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
Name	Description
request	DeleteAwsClusterRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteAwsNodePool(DeleteAwsNodePoolRequest, ServerCallContext)

public virtual Task<Operation> DeleteAwsNodePool(DeleteAwsNodePoolRequest request, ServerCallContext context)

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
Name	Description
request	DeleteAwsNodePoolRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

GenerateAwsAccessToken(GenerateAwsAccessTokenRequest, ServerCallContext)

public virtual Task<GenerateAwsAccessTokenResponse> GenerateAwsAccessToken(GenerateAwsAccessTokenRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	GenerateAwsAccessTokenRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskGenerateAwsAccessTokenResponse	The response to send back to the client (wrapped by a task).

GenerateAwsClusterAgentToken(GenerateAwsClusterAgentTokenRequest, ServerCallContext)

public virtual Task<GenerateAwsClusterAgentTokenResponse> GenerateAwsClusterAgentToken(GenerateAwsClusterAgentTokenRequest request, ServerCallContext context)

Generates an access token for a cluster agent.

Parameters
Name	Description
request	GenerateAwsClusterAgentTokenRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskGenerateAwsClusterAgentTokenResponse	The response to send back to the client (wrapped by a task).

GetAwsCluster(GetAwsClusterRequest, ServerCallContext)

public virtual Task<AwsCluster> GetAwsCluster(GetAwsClusterRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	GetAwsClusterRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskAwsCluster	The response to send back to the client (wrapped by a task).

GetAwsJsonWebKeys(GetAwsJsonWebKeysRequest, ServerCallContext)

public virtual Task<AwsJsonWebKeys> GetAwsJsonWebKeys(GetAwsJsonWebKeysRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	GetAwsJsonWebKeysRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskAwsJsonWebKeys	The response to send back to the client (wrapped by a task).

GetAwsNodePool(GetAwsNodePoolRequest, ServerCallContext)

public virtual Task<AwsNodePool> GetAwsNodePool(GetAwsNodePoolRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	GetAwsNodePoolRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskAwsNodePool	The response to send back to the client (wrapped by a task).

GetAwsOpenIdConfig(GetAwsOpenIdConfigRequest, ServerCallContext)

public virtual Task<AwsOpenIdConfig> GetAwsOpenIdConfig(GetAwsOpenIdConfigRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	GetAwsOpenIdConfigRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskAwsOpenIdConfig	The response to send back to the client (wrapped by a task).

GetAwsServerConfig(GetAwsServerConfigRequest, ServerCallContext)

public virtual Task<AwsServerConfig> GetAwsServerConfig(GetAwsServerConfigRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	GetAwsServerConfigRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskAwsServerConfig	The response to send back to the client (wrapped by a task).

ListAwsClusters(ListAwsClustersRequest, ServerCallContext)

public virtual Task<ListAwsClustersResponse> ListAwsClusters(ListAwsClustersRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	ListAwsClustersRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListAwsClustersResponse	The response to send back to the client (wrapped by a task).

ListAwsNodePools(ListAwsNodePoolsRequest, ServerCallContext)

public virtual Task<ListAwsNodePoolsResponse> ListAwsNodePools(ListAwsNodePoolsRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	ListAwsNodePoolsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListAwsNodePoolsResponse	The response to send back to the client (wrapped by a task).

RollbackAwsNodePoolUpdate(RollbackAwsNodePoolUpdateRequest, ServerCallContext)

public virtual Task<Operation> RollbackAwsNodePoolUpdate(RollbackAwsNodePoolUpdateRequest request, ServerCallContext context)

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
Name	Description
request	RollbackAwsNodePoolUpdateRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateAwsCluster(UpdateAwsClusterRequest, ServerCallContext)

public virtual Task<Operation> UpdateAwsCluster(UpdateAwsClusterRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	UpdateAwsClusterRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateAwsNodePool(UpdateAwsNodePoolRequest, ServerCallContext)

public virtual Task<Operation> UpdateAwsNodePool(UpdateAwsNodePoolRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	UpdateAwsNodePoolRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).