| GitHub Repository | Product Reference |
Service Description: The AwsClusters API provides a single centrally managed service to create and manage Anthos clusters that run on AWS infrastructure.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
AwsClusterName name = AwsClusterName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]");
AwsCluster response = awsClustersClient.getAwsCluster(name);
}
Note: close() needs to be called on the AwsClustersClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
| Method | Description | Method Variants |
|---|---|---|
CreateAwsCluster | Creates a new AwsCluster resource on a given Google Cloud Platform project and region. If successful, the response contains a newly created Operation resource that can be described to track the status of the operation. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateAwsCluster | Updates an AwsCluster. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetAwsCluster | Describes a specific AwsCluster resource. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListAwsClusters | Lists all AwsCluster resources on a given Google Cloud project and region. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteAwsCluster | Deletes a specific AwsCluster resource. Fails if the cluster has one or more associated AwsNodePool resources. If successful, the response contains a newly created Operation resource that can be described to track the status of the operation. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GenerateAwsClusterAgentToken | Generates an access token for a cluster agent. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GenerateAwsAccessToken | Generates a short-lived access token to authenticate to a given AwsCluster resource. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateAwsNodePool | Creates a new AwsNodePool, attached to a given AwsCluster. If successful, the response contains a newly created Operation resource that can be described to track the status of the operation. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateAwsNodePool | Updates an AwsNodePool. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
RollbackAwsNodePoolUpdate | Rolls back a previously aborted or failed 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. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetAwsNodePool | Describes a specific AwsNodePool resource. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListAwsNodePools | Lists all AwsNodePool resources on a given AwsCluster. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteAwsNodePool | Deletes a specific AwsNodePool resource. If successful, the response contains a newly created Operation resource that can be described to track the status of the operation. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetAwsOpenIdConfig | Gets the OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetAwsJsonWebKeys | Gets the public component of the cluster signing keys in JSON Web Key format. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetAwsServerConfig | Returns information, such as supported AWS regions and Kubernetes versions, on a given Google Cloud location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of AwsClustersSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
AwsClustersSettings awsClustersSettings =
AwsClustersSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
AwsClustersClient awsClustersClient = AwsClustersClient.create(awsClustersSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
AwsClustersSettings awsClustersSettings =
AwsClustersSettings.newBuilder().setEndpoint(myEndpoint).build();
AwsClustersClient awsClustersClient = AwsClustersClient.create(awsClustersSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
AwsClustersSettings awsClustersSettings = AwsClustersSettings.newHttpJsonBuilder().build();
AwsClustersClient awsClustersClient = AwsClustersClient.create(awsClustersSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final AwsClustersClient create()Constructs an instance of AwsClustersClient with default settings.
| Returns | |
|---|---|
| Type | Description |
AwsClustersClient | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
create(AwsClustersSettings settings)
public static final AwsClustersClient create(AwsClustersSettings settings)Constructs an instance of AwsClustersClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
| Parameter | |
|---|---|
| Name | Description |
settings | AwsClustersSettings |
| Returns | |
|---|---|
| Type | Description |
AwsClustersClient | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
create(AwsClustersStub stub)
public static final AwsClustersClient create(AwsClustersStub stub)Constructs an instance of AwsClustersClient, using the given stub for making calls. This is for advanced usage - prefer using create(AwsClustersSettings).
| Parameter | |
|---|---|
| Name | Description |
stub | AwsClustersStub |
| Returns | |
|---|---|
| Type | Description |
AwsClustersClient | |
Constructors
AwsClustersClient(AwsClustersSettings settings)
protected AwsClustersClient(AwsClustersSettings settings)Constructs an instance of AwsClustersClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
| Parameter | |
|---|---|
| Name | Description |
settings | AwsClustersSettings |
AwsClustersClient(AwsClustersStub stub)
protected AwsClustersClient(AwsClustersStub stub)| Parameter | |
|---|---|
| Name | Description |
stub | AwsClustersStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)| Parameters | |
|---|---|
| Name | Description |
duration | long |
unit | TimeUnit |
| Returns | |
|---|---|
| Type | Description |
boolean | |
| Exceptions | |
|---|---|
| Type | Description |
InterruptedException | |
close()
public final void close()createAwsClusterAsync(CreateAwsClusterRequest request)
public final OperationFuture<AwsCluster,OperationMetadata> createAwsClusterAsync(CreateAwsClusterRequest request)Creates a new AwsCluster resource on a given Google Cloud Platform project and region.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
CreateAwsClusterRequest request =
CreateAwsClusterRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setAwsCluster(AwsCluster.newBuilder().build())
.setAwsClusterId("awsClusterId1988965944")
.setValidateOnly(true)
.build();
AwsCluster response = awsClustersClient.createAwsClusterAsync(request).get();
}
| Parameter | |
|---|---|
| Name | Description |
request | CreateAwsClusterRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<AwsCluster,OperationMetadata> | |
createAwsClusterAsync(LocationName parent, AwsCluster awsCluster, String awsClusterId)
public final OperationFuture<AwsCluster,OperationMetadata> createAwsClusterAsync(LocationName parent, AwsCluster awsCluster, String awsClusterId)Creates a new AwsCluster resource on a given Google Cloud Platform project and region.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
AwsCluster awsCluster = AwsCluster.newBuilder().build();
String awsClusterId = "awsClusterId1988965944";
AwsCluster response =
awsClustersClient.createAwsClusterAsync(parent, awsCluster, awsClusterId).get();
}
| Parameters | |
|---|---|
| Name | Description |
parent | LocationNameRequired. The parent location where this AwsCluster resource will be created. Location names are formatted as See Resource Names for more details on Google Cloud resource names. |
awsCluster | AwsClusterRequired. The specification of the AwsCluster to create. |
awsClusterId | StringRequired. A client provided ID the resource. Must be unique within the parent resource. The provided ID will be part of the
AwsCluster resource name formatted as
Valid characters are |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<AwsCluster,OperationMetadata> | |
createAwsClusterAsync(String parent, AwsCluster awsCluster, String awsClusterId)
public final OperationFuture<AwsCluster,OperationMetadata> createAwsClusterAsync(String parent, AwsCluster awsCluster, String awsClusterId)Creates a new AwsCluster resource on a given Google Cloud Platform project and region.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
AwsCluster awsCluster = AwsCluster.newBuilder().build();
String awsClusterId = "awsClusterId1988965944";
AwsCluster response =
awsClustersClient.createAwsClusterAsync(parent, awsCluster, awsClusterId).get();
}
| Parameters | |
|---|---|
| Name | Description |
parent | StringRequired. The parent location where this AwsCluster resource will be created. Location names are formatted as See Resource Names for more details on Google Cloud resource names. |
awsCluster | AwsClusterRequired. The specification of the AwsCluster to create. |
awsClusterId | StringRequired. A client provided ID the resource. Must be unique within the parent resource. The provided ID will be part of the
AwsCluster resource name formatted as
Valid characters are |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<AwsCluster,OperationMetadata> | |
createAwsClusterCallable()
public final UnaryCallable<CreateAwsClusterRequest,Operation> createAwsClusterCallable()Creates a new AwsCluster resource on a given Google Cloud Platform project and region.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
CreateAwsClusterRequest request =
CreateAwsClusterRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setAwsCluster(AwsCluster.newBuilder().build())
.setAwsClusterId("awsClusterId1988965944")
.setValidateOnly(true)
.build();
ApiFuture<Operation> future =
awsClustersClient.createAwsClusterCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<CreateAwsClusterRequest,Operation> | |
createAwsClusterOperationCallable()
public final OperationCallable<CreateAwsClusterRequest,AwsCluster,OperationMetadata> createAwsClusterOperationCallable()Creates a new AwsCluster resource on a given Google Cloud Platform project and region.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
CreateAwsClusterRequest request =
CreateAwsClusterRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setAwsCluster(AwsCluster.newBuilder().build())
.setAwsClusterId("awsClusterId1988965944")
.setValidateOnly(true)
.build();
OperationFuture<AwsCluster, OperationMetadata> future =
awsClustersClient.createAwsClusterOperationCallable().futureCall(request);
// Do something.
AwsCluster response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
OperationCallable<CreateAwsClusterRequest,AwsCluster,OperationMetadata> | |
createAwsNodePoolAsync(AwsClusterName parent, AwsNodePool awsNodePool, String awsNodePoolId)
public final OperationFuture<AwsNodePool,OperationMetadata> createAwsNodePoolAsync(AwsClusterName parent, AwsNodePool awsNodePool, String awsNodePoolId)Creates a new AwsNodePool, attached to a given AwsCluster.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
AwsClusterName parent = AwsClusterName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]");
AwsNodePool awsNodePool = AwsNodePool.newBuilder().build();
String awsNodePoolId = "awsNodePoolId-1885267498";
AwsNodePool response =
awsClustersClient.createAwsNodePoolAsync(parent, awsNodePool, awsNodePoolId).get();
}
| Parameters | |
|---|---|
| Name | Description |
parent | AwsClusterNameRequired. The AwsCluster resource where this node pool will be created.
See Resource Names for more details on Google Cloud resource names. |
awsNodePool | AwsNodePoolRequired. The specification of the AwsNodePool to create. |
awsNodePoolId | StringRequired. A client provided ID the resource. Must be unique within the parent resource. The provided ID will be part of the
AwsNodePool resource name formatted as
Valid characters are |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<AwsNodePool,OperationMetadata> | |
createAwsNodePoolAsync(CreateAwsNodePoolRequest request)
public final OperationFuture<AwsNodePool,OperationMetadata> createAwsNodePoolAsync(CreateAwsNodePoolRequest request)Creates a new AwsNodePool, attached to a given AwsCluster.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
CreateAwsNodePoolRequest request =
CreateAwsNodePoolRequest.newBuilder()
.setParent(AwsClusterName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]").toString())
.setAwsNodePool(AwsNodePool.newBuilder().build())
.setAwsNodePoolId("awsNodePoolId-1885267498")
.setValidateOnly(true)
.build();
AwsNodePool response = awsClustersClient.createAwsNodePoolAsync(request).get();
}
| Parameter | |
|---|---|
| Name | Description |
request | CreateAwsNodePoolRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<AwsNodePool,OperationMetadata> | |
createAwsNodePoolAsync(String parent, AwsNodePool awsNodePool, String awsNodePoolId)
public final OperationFuture<AwsNodePool,OperationMetadata> createAwsNodePoolAsync(String parent, AwsNodePool awsNodePool, String awsNodePoolId)Creates a new AwsNodePool, attached to a given AwsCluster.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
String parent = AwsClusterName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]").toString();
AwsNodePool awsNodePool = AwsNodePool.newBuilder().build();
String awsNodePoolId = "awsNodePoolId-1885267498";
AwsNodePool response =
awsClustersClient.createAwsNodePoolAsync(parent, awsNodePool, awsNodePoolId).get();
}
| Parameters | |
|---|---|
| Name | Description |
parent | StringRequired. The AwsCluster resource where this node pool will be created.
See Resource Names for more details on Google Cloud resource names. |
awsNodePool | AwsNodePoolRequired. The specification of the AwsNodePool to create. |
awsNodePoolId | StringRequired. A client provided ID the resource. Must be unique within the parent resource. The provided ID will be part of the
AwsNodePool resource name formatted as
Valid characters are |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<AwsNodePool,OperationMetadata> | |
createAwsNodePoolCallable()
public final UnaryCallable<CreateAwsNodePoolRequest,Operation> createAwsNodePoolCallable()Creates a new AwsNodePool, attached to a given AwsCluster.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
CreateAwsNodePoolRequest request =
CreateAwsNodePoolRequest.newBuilder()
.setParent(AwsClusterName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]").toString())
.setAwsNodePool(AwsNodePool.newBuilder().build())
.setAwsNodePoolId("awsNodePoolId-1885267498")
.setValidateOnly(true)
.build();
ApiFuture<Operation> future =
awsClustersClient.createAwsNodePoolCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<CreateAwsNodePoolRequest,Operation> | |
createAwsNodePoolOperationCallable()
public final OperationCallable<CreateAwsNodePoolRequest,AwsNodePool,OperationMetadata> createAwsNodePoolOperationCallable()Creates a new AwsNodePool, attached to a given AwsCluster.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
CreateAwsNodePoolRequest request =
CreateAwsNodePoolRequest.newBuilder()
.setParent(AwsClusterName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]").toString())
.setAwsNodePool(AwsNodePool.newBuilder().build())
.setAwsNodePoolId("awsNodePoolId-1885267498")
.setValidateOnly(true)
.build();
OperationFuture<AwsNodePool, OperationMetadata> future =
awsClustersClient.createAwsNodePoolOperationCallable().futureCall(request);
// Do something.
AwsNodePool response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
OperationCallable<CreateAwsNodePoolRequest,AwsNodePool,OperationMetadata> | |
deleteAwsClusterAsync(AwsClusterName name)
public final OperationFuture<Empty,OperationMetadata> deleteAwsClusterAsync(AwsClusterName name)Deletes a specific AwsCluster resource.
Fails if the cluster has one or more associated AwsNodePool resources.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
AwsClusterName name = AwsClusterName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]");
awsClustersClient.deleteAwsClusterAsync(name).get();
}
| Parameter | |
|---|---|
| Name | Description |
name | AwsClusterNameRequired. The resource name the AwsCluster to delete.
See Resource Names for more details on Google Cloud Platform resource names. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Empty,OperationMetadata> | |
deleteAwsClusterAsync(DeleteAwsClusterRequest request)
public final OperationFuture<Empty,OperationMetadata> deleteAwsClusterAsync(DeleteAwsClusterRequest request)Deletes a specific AwsCluster resource.
Fails if the cluster has one or more associated AwsNodePool resources.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
DeleteAwsClusterRequest request =
DeleteAwsClusterRequest.newBuilder()
.setName(AwsClusterName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]").toString())
.setValidateOnly(true)
.setAllowMissing(true)
.setIgnoreErrors(true)
.setEtag("etag3123477")
.build();
awsClustersClient.deleteAwsClusterAsync(request).get();
}
| Parameter | |
|---|---|
| Name | Description |
request | DeleteAwsClusterRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Empty,OperationMetadata> | |
deleteAwsClusterAsync(String name)
public final OperationFuture<Empty,OperationMetadata> deleteAwsClusterAsync(String name)Deletes a specific AwsCluster resource.
Fails if the cluster has one or more associated AwsNodePool resources.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
String name = AwsClusterName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]").toString();
awsClustersClient.deleteAwsClusterAsync(name).get();
}
| Parameter | |
|---|---|
| Name | Description |
name | StringRequired. The resource name the AwsCluster to delete.
See Resource Names for more details on Google Cloud Platform resource names. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Empty,OperationMetadata> | |
deleteAwsClusterCallable()
public final UnaryCallable<DeleteAwsClusterRequest,Operation> deleteAwsClusterCallable()Deletes a specific AwsCluster resource.
Fails if the cluster has one or more associated AwsNodePool resources.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
DeleteAwsClusterRequest request =
DeleteAwsClusterRequest.newBuilder()
.setName(AwsClusterName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]").toString())
.setValidateOnly(true)
.setAllowMissing(true)
.setIgnoreErrors(true)
.setEtag("etag3123477")
.build();
ApiFuture<Operation> future =
awsClustersClient.deleteAwsClusterCallable().futureCall(request);
// Do something.
future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<DeleteAwsClusterRequest,Operation> | |
deleteAwsClusterOperationCallable()
public final OperationCallable<DeleteAwsClusterRequest,Empty,OperationMetadata> deleteAwsClusterOperationCallable()Deletes a specific AwsCluster resource.
Fails if the cluster has one or more associated AwsNodePool resources.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
DeleteAwsClusterRequest request =
DeleteAwsClusterRequest.newBuilder()
.setName(AwsClusterName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]").toString())
.setValidateOnly(true)
.setAllowMissing(true)
.setIgnoreErrors(true)
.setEtag("etag3123477")
.build();
OperationFuture<Empty, OperationMetadata> future =
awsClustersClient.deleteAwsClusterOperationCallable().futureCall(request);
// Do something.
future.get();
}
| Returns | |
|---|---|
| Type | Description |
OperationCallable<DeleteAwsClusterRequest,Empty,OperationMetadata> | |
deleteAwsNodePoolAsync(AwsNodePoolName name)
public final OperationFuture<Empty,OperationMetadata> deleteAwsNodePoolAsync(AwsNodePoolName name)Deletes a specific AwsNodePool resource.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
AwsNodePoolName name =
AwsNodePoolName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]", "[AWS_NODE_POOL]");
awsClustersClient.deleteAwsNodePoolAsync(name).get();
}
| Parameter | |
|---|---|
| Name | Description |
name | AwsNodePoolNameRequired. The resource name the AwsNodePool to delete.
See Resource Names for more details on Google Cloud resource names. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Empty,OperationMetadata> | |
deleteAwsNodePoolAsync(DeleteAwsNodePoolRequest request)
public final OperationFuture<Empty,OperationMetadata> deleteAwsNodePoolAsync(DeleteAwsNodePoolRequest request)Deletes a specific AwsNodePool resource.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
DeleteAwsNodePoolRequest request =
DeleteAwsNodePoolRequest.newBuilder()
.setName(
AwsNodePoolName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]", "[AWS_NODE_POOL]")
.toString())
.setValidateOnly(true)
.setAllowMissing(true)
.setIgnoreErrors(true)
.setEtag("etag3123477")
.build();
awsClustersClient.deleteAwsNodePoolAsync(request).get();
}
| Parameter | |
|---|---|
| Name | Description |
request | DeleteAwsNodePoolRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Empty,OperationMetadata> | |
deleteAwsNodePoolAsync(String name)
public final OperationFuture<Empty,OperationMetadata> deleteAwsNodePoolAsync(String name)Deletes a specific AwsNodePool resource.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
String name =
AwsNodePoolName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]", "[AWS_NODE_POOL]")
.toString();
awsClustersClient.deleteAwsNodePoolAsync(name).get();
}
| Parameter | |
|---|---|
| Name | Description |
name | StringRequired. The resource name the AwsNodePool to delete.
See Resource Names for more details on Google Cloud resource names. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Empty,OperationMetadata> | |
deleteAwsNodePoolCallable()
public final UnaryCallable<DeleteAwsNodePoolRequest,Operation> deleteAwsNodePoolCallable()Deletes a specific AwsNodePool resource.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
DeleteAwsNodePoolRequest request =
DeleteAwsNodePoolRequest.newBuilder()
.setName(
AwsNodePoolName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]", "[AWS_NODE_POOL]")
.toString())
.setValidateOnly(true)
.setAllowMissing(true)
.setIgnoreErrors(true)
.setEtag("etag3123477")
.build();
ApiFuture<Operation> future =
awsClustersClient.deleteAwsNodePoolCallable().futureCall(request);
// Do something.
future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<DeleteAwsNodePoolRequest,Operation> | |
deleteAwsNodePoolOperationCallable()
public final OperationCallable<DeleteAwsNodePoolRequest,Empty,OperationMetadata> deleteAwsNodePoolOperationCallable()Deletes a specific AwsNodePool resource.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
DeleteAwsNodePoolRequest request =
DeleteAwsNodePoolRequest.newBuilder()
.setName(
AwsNodePoolName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]", "[AWS_NODE_POOL]")
.toString())
.setValidateOnly(true)
.setAllowMissing(true)
.setIgnoreErrors(true)
.setEtag("etag3123477")
.build();
OperationFuture<Empty, OperationMetadata> future =
awsClustersClient.deleteAwsNodePoolOperationCallable().futureCall(request);
// Do something.
future.get();
}
| Returns | |
|---|---|
| Type | Description |
OperationCallable<DeleteAwsNodePoolRequest,Empty,OperationMetadata> | |
generateAwsAccessToken(GenerateAwsAccessTokenRequest request)
public final GenerateAwsAccessTokenResponse generateAwsAccessToken(GenerateAwsAccessTokenRequest request)Generates a short-lived access token to authenticate to a given AwsCluster resource.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
GenerateAwsAccessTokenRequest request =
GenerateAwsAccessTokenRequest.newBuilder()
.setAwsCluster(
AwsClusterName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]").toString())
.build();
GenerateAwsAccessTokenResponse response = awsClustersClient.generateAwsAccessToken(request);
}
| Parameter | |
|---|---|
| Name | Description |
request | GenerateAwsAccessTokenRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
GenerateAwsAccessTokenResponse | |
generateAwsAccessTokenCallable()
public final UnaryCallable<GenerateAwsAccessTokenRequest,GenerateAwsAccessTokenResponse> generateAwsAccessTokenCallable()Generates a short-lived access token to authenticate to a given AwsCluster resource.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
GenerateAwsAccessTokenRequest request =
GenerateAwsAccessTokenRequest.newBuilder()
.setAwsCluster(
AwsClusterName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]").toString())
.build();
ApiFuture<GenerateAwsAccessTokenResponse> future =
awsClustersClient.generateAwsAccessTokenCallable().futureCall(request);
// Do something.
GenerateAwsAccessTokenResponse response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<GenerateAwsAccessTokenRequest,GenerateAwsAccessTokenResponse> | |
generateAwsClusterAgentToken(GenerateAwsClusterAgentTokenRequest request)
public final GenerateAwsClusterAgentTokenResponse generateAwsClusterAgentToken(GenerateAwsClusterAgentTokenRequest request)Generates an access token for a cluster agent.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
GenerateAwsClusterAgentTokenRequest request =
GenerateAwsClusterAgentTokenRequest.newBuilder()
.setAwsCluster(
AwsClusterName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]").toString())
.setSubjectToken("subjectToken-1519661011")
.setSubjectTokenType("subjectTokenType1839592711")
.setVersion("version351608024")
.setNodePoolId("nodePoolId1121557241")
.setGrantType("grantType-1219832202")
.setAudience("audience975628804")
.setScope("scope109264468")
.setRequestedTokenType("requestedTokenType1733106949")
.setOptions("options-1249474914")
.build();
GenerateAwsClusterAgentTokenResponse response =
awsClustersClient.generateAwsClusterAgentToken(request);
}
| Parameter | |
|---|---|
| Name | Description |
request | GenerateAwsClusterAgentTokenRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
GenerateAwsClusterAgentTokenResponse | |
generateAwsClusterAgentTokenCallable()
public final UnaryCallable<GenerateAwsClusterAgentTokenRequest,GenerateAwsClusterAgentTokenResponse> generateAwsClusterAgentTokenCallable()Generates an access token for a cluster agent.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
GenerateAwsClusterAgentTokenRequest request =
GenerateAwsClusterAgentTokenRequest.newBuilder()
.setAwsCluster(
AwsClusterName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]").toString())
.setSubjectToken("subjectToken-1519661011")
.setSubjectTokenType("subjectTokenType1839592711")
.setVersion("version351608024")
.setNodePoolId("nodePoolId1121557241")
.setGrantType("grantType-1219832202")
.setAudience("audience975628804")
.setScope("scope109264468")
.setRequestedTokenType("requestedTokenType1733106949")
.setOptions("options-1249474914")
.build();
ApiFuture<GenerateAwsClusterAgentTokenResponse> future =
awsClustersClient.generateAwsClusterAgentTokenCallable().futureCall(request);
// Do something.
GenerateAwsClusterAgentTokenResponse response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<GenerateAwsClusterAgentTokenRequest,GenerateAwsClusterAgentTokenResponse> | |
getAwsCluster(AwsClusterName name)
public final AwsCluster getAwsCluster(AwsClusterName name)Describes a specific AwsCluster resource.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
AwsClusterName name = AwsClusterName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]");
AwsCluster response = awsClustersClient.getAwsCluster(name);
}
| Parameter | |
|---|---|
| Name | Description |
name | AwsClusterNameRequired. The name of the AwsCluster resource to describe.
See Resource Names for more details on Google Cloud Platform resource names. |
| Returns | |
|---|---|
| Type | Description |
AwsCluster | |
getAwsCluster(GetAwsClusterRequest request)
public final AwsCluster getAwsCluster(GetAwsClusterRequest request)Describes a specific AwsCluster resource.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
GetAwsClusterRequest request =
GetAwsClusterRequest.newBuilder()
.setName(AwsClusterName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]").toString())
.build();
AwsCluster response = awsClustersClient.getAwsCluster(request);
}
| Parameter | |
|---|---|
| Name | Description |
request | GetAwsClusterRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
AwsCluster | |
getAwsCluster(String name)
public final AwsCluster getAwsCluster(String name)Describes a specific AwsCluster resource.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
String name = AwsClusterName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]").toString();
AwsCluster response = awsClustersClient.getAwsCluster(name);
}
| Parameter | |
|---|---|
| Name | Description |
name | StringRequired. The name of the AwsCluster resource to describe.
See Resource Names for more details on Google Cloud Platform resource names. |
| Returns | |
|---|---|
| Type | Description |
AwsCluster | |
getAwsClusterCallable()
public final UnaryCallable<GetAwsClusterRequest,AwsCluster> getAwsClusterCallable()Describes a specific AwsCluster resource.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
GetAwsClusterRequest request =
GetAwsClusterRequest.newBuilder()
.setName(AwsClusterName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]").toString())
.build();
ApiFuture<AwsCluster> future = awsClustersClient.getAwsClusterCallable().futureCall(request);
// Do something.
AwsCluster response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<GetAwsClusterRequest,AwsCluster> | |
getAwsJsonWebKeys(GetAwsJsonWebKeysRequest request)
public final AwsJsonWebKeys getAwsJsonWebKeys(GetAwsJsonWebKeysRequest request)Gets the public component of the cluster signing keys in JSON Web Key format.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
GetAwsJsonWebKeysRequest request =
GetAwsJsonWebKeysRequest.newBuilder()
.setAwsCluster(
AwsClusterName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]").toString())
.build();
AwsJsonWebKeys response = awsClustersClient.getAwsJsonWebKeys(request);
}
| Parameter | |
|---|---|
| Name | Description |
request | GetAwsJsonWebKeysRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
AwsJsonWebKeys | |
getAwsJsonWebKeysCallable()
public final UnaryCallable<GetAwsJsonWebKeysRequest,AwsJsonWebKeys> getAwsJsonWebKeysCallable()Gets the public component of the cluster signing keys in JSON Web Key format.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
GetAwsJsonWebKeysRequest request =
GetAwsJsonWebKeysRequest.newBuilder()
.setAwsCluster(
AwsClusterName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]").toString())
.build();
ApiFuture<AwsJsonWebKeys> future =
awsClustersClient.getAwsJsonWebKeysCallable().futureCall(request);
// Do something.
AwsJsonWebKeys response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<GetAwsJsonWebKeysRequest,AwsJsonWebKeys> | |
getAwsNodePool(AwsNodePoolName name)
public final AwsNodePool getAwsNodePool(AwsNodePoolName name)Describes a specific AwsNodePool resource.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
AwsNodePoolName name =
AwsNodePoolName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]", "[AWS_NODE_POOL]");
AwsNodePool response = awsClustersClient.getAwsNodePool(name);
}
| Parameter | |
|---|---|
| Name | Description |
name | AwsNodePoolNameRequired. The name of the AwsNodePool resource to describe.
See Resource Names for more details on Google Cloud resource names. |
| Returns | |
|---|---|
| Type | Description |
AwsNodePool | |
getAwsNodePool(GetAwsNodePoolRequest request)
public final AwsNodePool getAwsNodePool(GetAwsNodePoolRequest request)Describes a specific AwsNodePool resource.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
GetAwsNodePoolRequest request =
GetAwsNodePoolRequest.newBuilder()
.setName(
AwsNodePoolName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]", "[AWS_NODE_POOL]")
.toString())
.build();
AwsNodePool response = awsClustersClient.getAwsNodePool(request);
}
| Parameter | |
|---|---|
| Name | Description |
request | GetAwsNodePoolRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
AwsNodePool | |
getAwsNodePool(String name)
public final AwsNodePool getAwsNodePool(String name)Describes a specific AwsNodePool resource.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
String name =
AwsNodePoolName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]", "[AWS_NODE_POOL]")
.toString();
AwsNodePool response = awsClustersClient.getAwsNodePool(name);
}
| Parameter | |
|---|---|
| Name | Description |
name | StringRequired. The name of the AwsNodePool resource to describe.
See Resource Names for more details on Google Cloud resource names. |
| Returns | |
|---|---|
| Type | Description |
AwsNodePool | |
getAwsNodePoolCallable()
public final UnaryCallable<GetAwsNodePoolRequest,AwsNodePool> getAwsNodePoolCallable()Describes a specific AwsNodePool resource.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
GetAwsNodePoolRequest request =
GetAwsNodePoolRequest.newBuilder()
.setName(
AwsNodePoolName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]", "[AWS_NODE_POOL]")
.toString())
.build();
ApiFuture<AwsNodePool> future =
awsClustersClient.getAwsNodePoolCallable().futureCall(request);
// Do something.
AwsNodePool response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<GetAwsNodePoolRequest,AwsNodePool> | |
getAwsOpenIdConfig(GetAwsOpenIdConfigRequest request)
public final AwsOpenIdConfig getAwsOpenIdConfig(GetAwsOpenIdConfigRequest request)Gets the OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
GetAwsOpenIdConfigRequest request =
GetAwsOpenIdConfigRequest.newBuilder()
.setAwsCluster(
AwsClusterName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]").toString())
.build();
AwsOpenIdConfig response = awsClustersClient.getAwsOpenIdConfig(request);
}
| Parameter | |
|---|---|
| Name | Description |
request | GetAwsOpenIdConfigRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
AwsOpenIdConfig | |
getAwsOpenIdConfigCallable()
public final UnaryCallable<GetAwsOpenIdConfigRequest,AwsOpenIdConfig> getAwsOpenIdConfigCallable()Gets the OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
GetAwsOpenIdConfigRequest request =
GetAwsOpenIdConfigRequest.newBuilder()
.setAwsCluster(
AwsClusterName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]").toString())
.build();
ApiFuture<AwsOpenIdConfig> future =
awsClustersClient.getAwsOpenIdConfigCallable().futureCall(request);
// Do something.
AwsOpenIdConfig response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<GetAwsOpenIdConfigRequest,AwsOpenIdConfig> | |
getAwsServerConfig(AwsServerConfigName name)
public final AwsServerConfig getAwsServerConfig(AwsServerConfigName name)Returns information, such as supported AWS regions and Kubernetes versions, on a given Google Cloud location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
AwsServerConfigName name = AwsServerConfigName.of("[PROJECT]", "[LOCATION]");
AwsServerConfig response = awsClustersClient.getAwsServerConfig(name);
}
| Parameter | |
|---|---|
| Name | Description |
name | AwsServerConfigNameRequired. The name of the AwsServerConfig resource to describe.
See Resource Names for more details on Google Cloud resource names. |
| Returns | |
|---|---|
| Type | Description |
AwsServerConfig | |
getAwsServerConfig(GetAwsServerConfigRequest request)
public final AwsServerConfig getAwsServerConfig(GetAwsServerConfigRequest request)Returns information, such as supported AWS regions and Kubernetes versions, on a given Google Cloud location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
GetAwsServerConfigRequest request =
GetAwsServerConfigRequest.newBuilder()
.setName(AwsServerConfigName.of("[PROJECT]", "[LOCATION]").toString())
.build();
AwsServerConfig response = awsClustersClient.getAwsServerConfig(request);
}
| Parameter | |
|---|---|
| Name | Description |
request | GetAwsServerConfigRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
AwsServerConfig | |
getAwsServerConfig(String name)
public final AwsServerConfig getAwsServerConfig(String name)Returns information, such as supported AWS regions and Kubernetes versions, on a given Google Cloud location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
String name = AwsServerConfigName.of("[PROJECT]", "[LOCATION]").toString();
AwsServerConfig response = awsClustersClient.getAwsServerConfig(name);
}
| Parameter | |
|---|---|
| Name | Description |
name | StringRequired. The name of the AwsServerConfig resource to describe.
See Resource Names for more details on Google Cloud resource names. |
| Returns | |
|---|---|
| Type | Description |
AwsServerConfig | |
getAwsServerConfigCallable()
public final UnaryCallable<GetAwsServerConfigRequest,AwsServerConfig> getAwsServerConfigCallable()Returns information, such as supported AWS regions and Kubernetes versions, on a given Google Cloud location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
GetAwsServerConfigRequest request =
GetAwsServerConfigRequest.newBuilder()
.setName(AwsServerConfigName.of("[PROJECT]", "[LOCATION]").toString())
.build();
ApiFuture<AwsServerConfig> future =
awsClustersClient.getAwsServerConfigCallable().futureCall(request);
// Do something.
AwsServerConfig response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<GetAwsServerConfigRequest,AwsServerConfig> | |
getHttpJsonOperationsClient()
public final OperationsClient getHttpJsonOperationsClient()Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
| Returns | |
|---|---|
| Type | Description |
OperationsClient | |
getOperationsClient()
public final OperationsClient getOperationsClient()Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
| Returns | |
|---|---|
| Type | Description |
OperationsClient | |
getSettings()
public final AwsClustersSettings getSettings()| Returns | |
|---|---|
| Type | Description |
AwsClustersSettings | |
getStub()
public AwsClustersStub getStub()| Returns | |
|---|---|
| Type | Description |
AwsClustersStub | |
isShutdown()
public boolean isShutdown()| Returns | |
|---|---|
| Type | Description |
boolean | |
isTerminated()
public boolean isTerminated()| Returns | |
|---|---|
| Type | Description |
boolean | |
listAwsClusters(ListAwsClustersRequest request)
public final AwsClustersClient.ListAwsClustersPagedResponse listAwsClusters(ListAwsClustersRequest request)Lists all AwsCluster resources on a given Google Cloud project and region.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
ListAwsClustersRequest request =
ListAwsClustersRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (AwsCluster element : awsClustersClient.listAwsClusters(request).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request | ListAwsClustersRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
AwsClustersClient.ListAwsClustersPagedResponse | |
listAwsClusters(LocationName parent)
public final AwsClustersClient.ListAwsClustersPagedResponse listAwsClusters(LocationName parent)Lists all AwsCluster resources on a given Google Cloud project and region.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (AwsCluster element : awsClustersClient.listAwsClusters(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent | LocationNameRequired. The parent location which owns this collection of AwsCluster resources. Location names are formatted as See Resource Names for more details on Google Cloud Platform resource names. |
| Returns | |
|---|---|
| Type | Description |
AwsClustersClient.ListAwsClustersPagedResponse | |
listAwsClusters(String parent)
public final AwsClustersClient.ListAwsClustersPagedResponse listAwsClusters(String parent)Lists all AwsCluster resources on a given Google Cloud project and region.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (AwsCluster element : awsClustersClient.listAwsClusters(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent | StringRequired. The parent location which owns this collection of AwsCluster resources. Location names are formatted as See Resource Names for more details on Google Cloud Platform resource names. |
| Returns | |
|---|---|
| Type | Description |
AwsClustersClient.ListAwsClustersPagedResponse | |
listAwsClustersCallable()
public final UnaryCallable<ListAwsClustersRequest,ListAwsClustersResponse> listAwsClustersCallable()Lists all AwsCluster resources on a given Google Cloud project and region.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
ListAwsClustersRequest request =
ListAwsClustersRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListAwsClustersResponse response =
awsClustersClient.listAwsClustersCallable().call(request);
for (AwsCluster element : response.getAwsClustersList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListAwsClustersRequest,ListAwsClustersResponse> | |
listAwsClustersPagedCallable()
public final UnaryCallable<ListAwsClustersRequest,AwsClustersClient.ListAwsClustersPagedResponse> listAwsClustersPagedCallable()Lists all AwsCluster resources on a given Google Cloud project and region.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
ListAwsClustersRequest request =
ListAwsClustersRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<AwsCluster> future =
awsClustersClient.listAwsClustersPagedCallable().futureCall(request);
// Do something.
for (AwsCluster element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListAwsClustersRequest,ListAwsClustersPagedResponse> | |
listAwsNodePools(AwsClusterName parent)
public final AwsClustersClient.ListAwsNodePoolsPagedResponse listAwsNodePools(AwsClusterName parent)Lists all AwsNodePool resources on a given AwsCluster.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
AwsClusterName parent = AwsClusterName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]");
for (AwsNodePool element : awsClustersClient.listAwsNodePools(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent | AwsClusterNameRequired. The parent
See Resource Names for more details on Google Cloud resource names. |
| Returns | |
|---|---|
| Type | Description |
AwsClustersClient.ListAwsNodePoolsPagedResponse | |
listAwsNodePools(ListAwsNodePoolsRequest request)
public final AwsClustersClient.ListAwsNodePoolsPagedResponse listAwsNodePools(ListAwsNodePoolsRequest request)Lists all AwsNodePool resources on a given AwsCluster.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
ListAwsNodePoolsRequest request =
ListAwsNodePoolsRequest.newBuilder()
.setParent(AwsClusterName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (AwsNodePool element : awsClustersClient.listAwsNodePools(request).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request | ListAwsNodePoolsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
AwsClustersClient.ListAwsNodePoolsPagedResponse | |
listAwsNodePools(String parent)
public final AwsClustersClient.ListAwsNodePoolsPagedResponse listAwsNodePools(String parent)Lists all AwsNodePool resources on a given AwsCluster.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
String parent = AwsClusterName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]").toString();
for (AwsNodePool element : awsClustersClient.listAwsNodePools(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent | StringRequired. The parent
See Resource Names for more details on Google Cloud resource names. |
| Returns | |
|---|---|
| Type | Description |
AwsClustersClient.ListAwsNodePoolsPagedResponse | |
listAwsNodePoolsCallable()
public final UnaryCallable<ListAwsNodePoolsRequest,ListAwsNodePoolsResponse> listAwsNodePoolsCallable()Lists all AwsNodePool resources on a given AwsCluster.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
ListAwsNodePoolsRequest request =
ListAwsNodePoolsRequest.newBuilder()
.setParent(AwsClusterName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListAwsNodePoolsResponse response =
awsClustersClient.listAwsNodePoolsCallable().call(request);
for (AwsNodePool element : response.getAwsNodePoolsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListAwsNodePoolsRequest,ListAwsNodePoolsResponse> | |
listAwsNodePoolsPagedCallable()
public final UnaryCallable<ListAwsNodePoolsRequest,AwsClustersClient.ListAwsNodePoolsPagedResponse> listAwsNodePoolsPagedCallable()Lists all AwsNodePool resources on a given AwsCluster.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
ListAwsNodePoolsRequest request =
ListAwsNodePoolsRequest.newBuilder()
.setParent(AwsClusterName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<AwsNodePool> future =
awsClustersClient.listAwsNodePoolsPagedCallable().futureCall(request);
// Do something.
for (AwsNodePool element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListAwsNodePoolsRequest,ListAwsNodePoolsPagedResponse> | |
rollbackAwsNodePoolUpdateAsync(AwsNodePoolName name)
public final OperationFuture<AwsNodePool,OperationMetadata> rollbackAwsNodePoolUpdateAsync(AwsNodePoolName name)Rolls back a previously aborted or failed 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.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
AwsNodePoolName name =
AwsNodePoolName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]", "[AWS_NODE_POOL]");
AwsNodePool response = awsClustersClient.rollbackAwsNodePoolUpdateAsync(name).get();
}
| Parameter | |
|---|---|
| Name | Description |
name | AwsNodePoolNameRequired. The name of the AwsNodePool resource to rollback.
See Resource Names for more details on Google Cloud resource names. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<AwsNodePool,OperationMetadata> | |
rollbackAwsNodePoolUpdateAsync(RollbackAwsNodePoolUpdateRequest request)
public final OperationFuture<AwsNodePool,OperationMetadata> rollbackAwsNodePoolUpdateAsync(RollbackAwsNodePoolUpdateRequest request)Rolls back a previously aborted or failed 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.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
RollbackAwsNodePoolUpdateRequest request =
RollbackAwsNodePoolUpdateRequest.newBuilder()
.setName(
AwsNodePoolName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]", "[AWS_NODE_POOL]")
.toString())
.setRespectPdb(true)
.build();
AwsNodePool response = awsClustersClient.rollbackAwsNodePoolUpdateAsync(request).get();
}
| Parameter | |
|---|---|
| Name | Description |
request | RollbackAwsNodePoolUpdateRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<AwsNodePool,OperationMetadata> | |
rollbackAwsNodePoolUpdateAsync(String name)
public final OperationFuture<AwsNodePool,OperationMetadata> rollbackAwsNodePoolUpdateAsync(String name)Rolls back a previously aborted or failed 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.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
String name =
AwsNodePoolName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]", "[AWS_NODE_POOL]")
.toString();
AwsNodePool response = awsClustersClient.rollbackAwsNodePoolUpdateAsync(name).get();
}
| Parameter | |
|---|---|
| Name | Description |
name | StringRequired. The name of the AwsNodePool resource to rollback.
See Resource Names for more details on Google Cloud resource names. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<AwsNodePool,OperationMetadata> | |
rollbackAwsNodePoolUpdateCallable()
public final UnaryCallable<RollbackAwsNodePoolUpdateRequest,Operation> rollbackAwsNodePoolUpdateCallable()Rolls back a previously aborted or failed 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.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
RollbackAwsNodePoolUpdateRequest request =
RollbackAwsNodePoolUpdateRequest.newBuilder()
.setName(
AwsNodePoolName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]", "[AWS_NODE_POOL]")
.toString())
.setRespectPdb(true)
.build();
ApiFuture<Operation> future =
awsClustersClient.rollbackAwsNodePoolUpdateCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<RollbackAwsNodePoolUpdateRequest,Operation> | |
rollbackAwsNodePoolUpdateOperationCallable()
public final OperationCallable<RollbackAwsNodePoolUpdateRequest,AwsNodePool,OperationMetadata> rollbackAwsNodePoolUpdateOperationCallable()Rolls back a previously aborted or failed 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.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
RollbackAwsNodePoolUpdateRequest request =
RollbackAwsNodePoolUpdateRequest.newBuilder()
.setName(
AwsNodePoolName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]", "[AWS_NODE_POOL]")
.toString())
.setRespectPdb(true)
.build();
OperationFuture<AwsNodePool, OperationMetadata> future =
awsClustersClient.rollbackAwsNodePoolUpdateOperationCallable().futureCall(request);
// Do something.
AwsNodePool response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
OperationCallable<RollbackAwsNodePoolUpdateRequest,AwsNodePool,OperationMetadata> | |
shutdown()
public void shutdown()shutdownNow()
public void shutdownNow()updateAwsClusterAsync(AwsCluster awsCluster, FieldMask updateMask)
public final OperationFuture<AwsCluster,OperationMetadata> updateAwsClusterAsync(AwsCluster awsCluster, FieldMask updateMask)Updates an AwsCluster.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
AwsCluster awsCluster = AwsCluster.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
AwsCluster response = awsClustersClient.updateAwsClusterAsync(awsCluster, updateMask).get();
}
| Parameters | |
|---|---|
| Name | Description |
awsCluster | AwsClusterRequired. The AwsCluster resource to update. |
updateMask | FieldMaskRequired. 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: * |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<AwsCluster,OperationMetadata> | |
updateAwsClusterAsync(UpdateAwsClusterRequest request)
public final OperationFuture<AwsCluster,OperationMetadata> updateAwsClusterAsync(UpdateAwsClusterRequest request)Updates an AwsCluster.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
UpdateAwsClusterRequest request =
UpdateAwsClusterRequest.newBuilder()
.setAwsCluster(AwsCluster.newBuilder().build())
.setValidateOnly(true)
.setUpdateMask(FieldMask.newBuilder().build())
.build();
AwsCluster response = awsClustersClient.updateAwsClusterAsync(request).get();
}
| Parameter | |
|---|---|
| Name | Description |
request | UpdateAwsClusterRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<AwsCluster,OperationMetadata> | |
updateAwsClusterCallable()
public final UnaryCallable<UpdateAwsClusterRequest,Operation> updateAwsClusterCallable()Updates an AwsCluster.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
UpdateAwsClusterRequest request =
UpdateAwsClusterRequest.newBuilder()
.setAwsCluster(AwsCluster.newBuilder().build())
.setValidateOnly(true)
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Operation> future =
awsClustersClient.updateAwsClusterCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<UpdateAwsClusterRequest,Operation> | |
updateAwsClusterOperationCallable()
public final OperationCallable<UpdateAwsClusterRequest,AwsCluster,OperationMetadata> updateAwsClusterOperationCallable()Updates an AwsCluster.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
UpdateAwsClusterRequest request =
UpdateAwsClusterRequest.newBuilder()
.setAwsCluster(AwsCluster.newBuilder().build())
.setValidateOnly(true)
.setUpdateMask(FieldMask.newBuilder().build())
.build();
OperationFuture<AwsCluster, OperationMetadata> future =
awsClustersClient.updateAwsClusterOperationCallable().futureCall(request);
// Do something.
AwsCluster response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
OperationCallable<UpdateAwsClusterRequest,AwsCluster,OperationMetadata> | |
updateAwsNodePoolAsync(AwsNodePool awsNodePool, FieldMask updateMask)
public final OperationFuture<AwsNodePool,OperationMetadata> updateAwsNodePoolAsync(AwsNodePool awsNodePool, FieldMask updateMask)Updates an AwsNodePool.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
AwsNodePool awsNodePool = AwsNodePool.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
AwsNodePool response =
awsClustersClient.updateAwsNodePoolAsync(awsNodePool, updateMask).get();
}
| Parameters | |
|---|---|
| Name | Description |
awsNodePool | AwsNodePoolRequired. The AwsNodePool resource to update. |
updateMask | FieldMaskRequired. 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: * |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<AwsNodePool,OperationMetadata> | |
updateAwsNodePoolAsync(UpdateAwsNodePoolRequest request)
public final OperationFuture<AwsNodePool,OperationMetadata> updateAwsNodePoolAsync(UpdateAwsNodePoolRequest request)Updates an AwsNodePool.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
UpdateAwsNodePoolRequest request =
UpdateAwsNodePoolRequest.newBuilder()
.setAwsNodePool(AwsNodePool.newBuilder().build())
.setValidateOnly(true)
.setUpdateMask(FieldMask.newBuilder().build())
.build();
AwsNodePool response = awsClustersClient.updateAwsNodePoolAsync(request).get();
}
| Parameter | |
|---|---|
| Name | Description |
request | UpdateAwsNodePoolRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<AwsNodePool,OperationMetadata> | |
updateAwsNodePoolCallable()
public final UnaryCallable<UpdateAwsNodePoolRequest,Operation> updateAwsNodePoolCallable()Updates an AwsNodePool.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
UpdateAwsNodePoolRequest request =
UpdateAwsNodePoolRequest.newBuilder()
.setAwsNodePool(AwsNodePool.newBuilder().build())
.setValidateOnly(true)
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Operation> future =
awsClustersClient.updateAwsNodePoolCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<UpdateAwsNodePoolRequest,Operation> | |
updateAwsNodePoolOperationCallable()
public final OperationCallable<UpdateAwsNodePoolRequest,AwsNodePool,OperationMetadata> updateAwsNodePoolOperationCallable()Updates an AwsNodePool.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
UpdateAwsNodePoolRequest request =
UpdateAwsNodePoolRequest.newBuilder()
.setAwsNodePool(AwsNodePool.newBuilder().build())
.setValidateOnly(true)
.setUpdateMask(FieldMask.newBuilder().build())
.build();
OperationFuture<AwsNodePool, OperationMetadata> future =
awsClustersClient.updateAwsNodePoolOperationCallable().futureCall(request);
// Do something.
AwsNodePool response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
OperationCallable<UpdateAwsNodePoolRequest,AwsNodePool,OperationMetadata> | |