public sealed class AwsClustersClientImpl : AwsClustersClientReference documentation and code samples for the Anthos Multi-Cloud v1 API class AwsClustersClientImpl.
AwsClusters client wrapper implementation, for convenient use.
Namespace
GoogleCloudGoogle.Cloud.GkeMultiCloudV1Assembly
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.
Constructors
AwsClustersClientImpl(AwsClustersClient, AwsClustersSettings, ILogger)
public AwsClustersClientImpl(AwsClusters.AwsClustersClient grpcClient, AwsClustersSettings settings, ILogger logger)Constructs a client wrapper for the AwsClusters service, with the specified gRPC client and settings.
| Parameters | |
|---|---|
| Name | Description |
grpcClient | AwsClustersAwsClustersClientThe underlying gRPC client. |
settings | AwsClustersSettingsThe base AwsClustersSettings used within this client. |
logger | ILoggerOptional ILogger to use within this client. |
Properties
CreateAwsClusterOperationsClient
public override OperationsClient CreateAwsClusterOperationsClient { get; }The long-running operations client for CreateAwsCluster.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
CreateAwsNodePoolOperationsClient
public override OperationsClient CreateAwsNodePoolOperationsClient { get; }The long-running operations client for CreateAwsNodePool.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
DeleteAwsClusterOperationsClient
public override OperationsClient DeleteAwsClusterOperationsClient { get; }The long-running operations client for DeleteAwsCluster.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
DeleteAwsNodePoolOperationsClient
public override OperationsClient DeleteAwsNodePoolOperationsClient { get; }The long-running operations client for DeleteAwsNodePool.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
GrpcClient
public override AwsClusters.AwsClustersClient GrpcClient { get; }The underlying gRPC AwsClusters client
| Property Value | |
|---|---|
| Type | Description |
AwsClustersAwsClustersClient | |
UpdateAwsClusterOperationsClient
public override OperationsClient UpdateAwsClusterOperationsClient { get; }The long-running operations client for UpdateAwsCluster.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
UpdateAwsNodePoolOperationsClient
public override OperationsClient UpdateAwsNodePoolOperationsClient { get; }The long-running operations client for UpdateAwsNodePool.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
Methods
CreateAwsCluster(CreateAwsClusterRequest, CallSettings)
public override Operation<AwsCluster, OperationMetadata> CreateAwsCluster(CreateAwsClusterRequest request, CallSettings callSettings = null)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 | CreateAwsClusterRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationAwsClusterOperationMetadata | The RPC response. |
CreateAwsClusterAsync(CreateAwsClusterRequest, CallSettings)
public override Task<Operation<AwsCluster, OperationMetadata>> CreateAwsClusterAsync(CreateAwsClusterRequest request, CallSettings callSettings = null)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 | CreateAwsClusterRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationAwsClusterOperationMetadata | A Task containing the RPC response. |
CreateAwsNodePool(CreateAwsNodePoolRequest, CallSettings)
public override 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 | |
|---|---|
| Name | Description |
request | CreateAwsNodePoolRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationAwsNodePoolOperationMetadata | The RPC response. |
CreateAwsNodePoolAsync(CreateAwsNodePoolRequest, CallSettings)
public override 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 | |
|---|---|
| Name | Description |
request | CreateAwsNodePoolRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationAwsNodePoolOperationMetadata | A Task containing the RPC response. |
DeleteAwsCluster(DeleteAwsClusterRequest, CallSettings)
public override 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 | |
|---|---|
| Name | Description |
request | DeleteAwsClusterRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyOperationMetadata | The RPC response. |
DeleteAwsClusterAsync(DeleteAwsClusterRequest, CallSettings)
public override 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 | |
|---|---|
| Name | Description |
request | DeleteAwsClusterRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata | A Task containing the RPC response. |
DeleteAwsNodePool(DeleteAwsNodePoolRequest, CallSettings)
public override 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 | |
|---|---|
| Name | Description |
request | DeleteAwsNodePoolRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyOperationMetadata | The RPC response. |
DeleteAwsNodePoolAsync(DeleteAwsNodePoolRequest, CallSettings)
public override 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 | |
|---|---|
| Name | Description |
request | DeleteAwsNodePoolRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata | A Task containing the RPC response. |
GenerateAwsAccessToken(GenerateAwsAccessTokenRequest, CallSettings)
public override 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 | |
|---|---|
| Name | Description |
request | GenerateAwsAccessTokenRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
GenerateAwsAccessTokenResponse | The RPC response. |
GenerateAwsAccessTokenAsync(GenerateAwsAccessTokenRequest, CallSettings)
public override 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 | |
|---|---|
| Name | Description |
request | GenerateAwsAccessTokenRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskGenerateAwsAccessTokenResponse | A Task containing the RPC response. |
GetAwsCluster(GetAwsClusterRequest, CallSettings)
public override AwsCluster GetAwsCluster(GetAwsClusterRequest request, CallSettings callSettings = null)Describes a specific [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource.
| Parameters | |
|---|---|
| Name | Description |
request | GetAwsClusterRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
AwsCluster | The RPC response. |
GetAwsClusterAsync(GetAwsClusterRequest, CallSettings)
public override Task<AwsCluster> GetAwsClusterAsync(GetAwsClusterRequest request, CallSettings callSettings = null)Describes a specific [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource.
| Parameters | |
|---|---|
| Name | Description |
request | GetAwsClusterRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskAwsCluster | A Task containing the RPC response. |
GetAwsNodePool(GetAwsNodePoolRequest, CallSettings)
public override AwsNodePool GetAwsNodePool(GetAwsNodePoolRequest request, CallSettings callSettings = null)Describes a specific [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource.
| Parameters | |
|---|---|
| Name | Description |
request | GetAwsNodePoolRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
AwsNodePool | The RPC response. |
GetAwsNodePoolAsync(GetAwsNodePoolRequest, CallSettings)
public override Task<AwsNodePool> GetAwsNodePoolAsync(GetAwsNodePoolRequest request, CallSettings callSettings = null)Describes a specific [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource.
| Parameters | |
|---|---|
| Name | Description |
request | GetAwsNodePoolRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskAwsNodePool | A Task containing the RPC response. |
GetAwsServerConfig(GetAwsServerConfigRequest, CallSettings)
public override AwsServerConfig GetAwsServerConfig(GetAwsServerConfigRequest request, CallSettings callSettings = null)Returns information, such as supported AWS regions and Kubernetes versions, on a given Google Cloud location.
| Parameters | |
|---|---|
| Name | Description |
request | GetAwsServerConfigRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
AwsServerConfig | The RPC response. |
GetAwsServerConfigAsync(GetAwsServerConfigRequest, CallSettings)
public override 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 | |
|---|---|
| Name | Description |
request | GetAwsServerConfigRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskAwsServerConfig | A Task containing the RPC response. |
ListAwsClusters(ListAwsClustersRequest, CallSettings)
public override 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 | |
|---|---|
| Name | Description |
request | ListAwsClustersRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListAwsClustersResponseAwsCluster | A pageable sequence of AwsCluster resources. |
ListAwsClustersAsync(ListAwsClustersRequest, CallSettings)
public override 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 | |
|---|---|
| Name | Description |
request | ListAwsClustersRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListAwsClustersResponseAwsCluster | A pageable asynchronous sequence of AwsCluster resources. |
ListAwsNodePools(ListAwsNodePoolsRequest, CallSettings)
public override 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 | |
|---|---|
| Name | Description |
request | ListAwsNodePoolsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListAwsNodePoolsResponseAwsNodePool | A pageable sequence of AwsNodePool resources. |
ListAwsNodePoolsAsync(ListAwsNodePoolsRequest, CallSettings)
public override 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 | |
|---|---|
| Name | Description |
request | ListAwsNodePoolsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListAwsNodePoolsResponseAwsNodePool | A pageable asynchronous sequence of AwsNodePool resources. |
UpdateAwsCluster(UpdateAwsClusterRequest, CallSettings)
public override Operation<AwsCluster, OperationMetadata> UpdateAwsCluster(UpdateAwsClusterRequest request, CallSettings callSettings = null)Updates an [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster].
| Parameters | |
|---|---|
| Name | Description |
request | UpdateAwsClusterRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationAwsClusterOperationMetadata | The RPC response. |
UpdateAwsClusterAsync(UpdateAwsClusterRequest, CallSettings)
public override Task<Operation<AwsCluster, OperationMetadata>> UpdateAwsClusterAsync(UpdateAwsClusterRequest request, CallSettings callSettings = null)Updates an [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster].
| Parameters | |
|---|---|
| Name | Description |
request | UpdateAwsClusterRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationAwsClusterOperationMetadata | A Task containing the RPC response. |
UpdateAwsNodePool(UpdateAwsNodePoolRequest, CallSettings)
public override Operation<AwsNodePool, OperationMetadata> UpdateAwsNodePool(UpdateAwsNodePoolRequest request, CallSettings callSettings = null)Updates an [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool].
| Parameters | |
|---|---|
| Name | Description |
request | UpdateAwsNodePoolRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationAwsNodePoolOperationMetadata | The RPC response. |
UpdateAwsNodePoolAsync(UpdateAwsNodePoolRequest, CallSettings)
public override Task<Operation<AwsNodePool, OperationMetadata>> UpdateAwsNodePoolAsync(UpdateAwsNodePoolRequest request, CallSettings callSettings = null)Updates an [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool].
| Parameters | |
|---|---|
| Name | Description |
request | UpdateAwsNodePoolRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationAwsNodePoolOperationMetadata | A Task containing the RPC response. |