Class AwsClustersSettings (0.51.0) 

public class AwsClustersSettings extends ClientSettings<AwsClustersSettings>

Settings class to configure an instance of AwsClustersClient.

The default instance has everything set to sensible defaults:

  • The default service address (gkemulticloud.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the RetrySettings of getAwsCluster:


 // 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.Builder awsClustersSettingsBuilder = AwsClustersSettings.newBuilder();
 awsClustersSettingsBuilder
     .getAwsClusterSettings()
     .setRetrySettings(
         awsClustersSettingsBuilder
             .getAwsClusterSettings()
             .getRetrySettings()
             .toBuilder()
             .setInitialRetryDelayDuration(Duration.ofSeconds(1))
             .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
             .setMaxAttempts(5)
             .setMaxRetryDelayDuration(Duration.ofSeconds(30))
             .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
             .setRetryDelayMultiplier(1.3)
             .setRpcTimeoutMultiplier(1.5)
             .setTotalTimeoutDuration(Duration.ofSeconds(300))
             .build());
 AwsClustersSettings awsClustersSettings = awsClustersSettingsBuilder.build();

Please refer to the Client Side Retry Guide for additional support in setting retries.

To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for createAwsCluster:


 // 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.Builder awsClustersSettingsBuilder = AwsClustersSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelay(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 awsClustersSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();

Inheritance

java.lang.Object > ClientSettings > AwsClustersSettings

Static Methods

create(AwsClustersStubSettings stub)

public static final AwsClustersSettings create(AwsClustersStubSettings stub)
Parameter
Name Description
stub AwsClustersStubSettings
Returns
Type Description
AwsClustersSettings
Exceptions
Type Description
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
Type Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

Returns
Type Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
Type Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type Description
List<String>

newBuilder()

public static AwsClustersSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
AwsClustersSettings.Builder

newBuilder(ClientContext clientContext)

public static AwsClustersSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
AwsClustersSettings.Builder

newHttpJsonBuilder()

public static AwsClustersSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
AwsClustersSettings.Builder

Constructors

AwsClustersSettings(AwsClustersSettings.Builder settingsBuilder)

protected AwsClustersSettings(AwsClustersSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder AwsClustersSettings.Builder

Methods

createAwsClusterOperationSettings()

public OperationCallSettings<CreateAwsClusterRequest,AwsCluster,OperationMetadata> createAwsClusterOperationSettings()

Returns the object with the settings used for calls to createAwsCluster.

Returns
Type Description
OperationCallSettings<CreateAwsClusterRequest,AwsCluster,OperationMetadata>

createAwsClusterSettings()

public UnaryCallSettings<CreateAwsClusterRequest,Operation> createAwsClusterSettings()

Returns the object with the settings used for calls to createAwsCluster.

Returns
Type Description
UnaryCallSettings<CreateAwsClusterRequest,Operation>

createAwsNodePoolOperationSettings()

public OperationCallSettings<CreateAwsNodePoolRequest,AwsNodePool,OperationMetadata> createAwsNodePoolOperationSettings()

Returns the object with the settings used for calls to createAwsNodePool.

Returns
Type Description
OperationCallSettings<CreateAwsNodePoolRequest,AwsNodePool,OperationMetadata>

createAwsNodePoolSettings()

public UnaryCallSettings<CreateAwsNodePoolRequest,Operation> createAwsNodePoolSettings()

Returns the object with the settings used for calls to createAwsNodePool.

Returns
Type Description
UnaryCallSettings<CreateAwsNodePoolRequest,Operation>

deleteAwsClusterOperationSettings()

public OperationCallSettings<DeleteAwsClusterRequest,Empty,OperationMetadata> deleteAwsClusterOperationSettings()

Returns the object with the settings used for calls to deleteAwsCluster.

Returns
Type Description
OperationCallSettings<DeleteAwsClusterRequest,Empty,OperationMetadata>

deleteAwsClusterSettings()

public UnaryCallSettings<DeleteAwsClusterRequest,Operation> deleteAwsClusterSettings()

Returns the object with the settings used for calls to deleteAwsCluster.

Returns
Type Description
UnaryCallSettings<DeleteAwsClusterRequest,Operation>

deleteAwsNodePoolOperationSettings()

public OperationCallSettings<DeleteAwsNodePoolRequest,Empty,OperationMetadata> deleteAwsNodePoolOperationSettings()

Returns the object with the settings used for calls to deleteAwsNodePool.

Returns
Type Description
OperationCallSettings<DeleteAwsNodePoolRequest,Empty,OperationMetadata>

deleteAwsNodePoolSettings()

public UnaryCallSettings<DeleteAwsNodePoolRequest,Operation> deleteAwsNodePoolSettings()

Returns the object with the settings used for calls to deleteAwsNodePool.

Returns
Type Description
UnaryCallSettings<DeleteAwsNodePoolRequest,Operation>

generateAwsAccessTokenSettings()

public UnaryCallSettings<GenerateAwsAccessTokenRequest,GenerateAwsAccessTokenResponse> generateAwsAccessTokenSettings()

Returns the object with the settings used for calls to generateAwsAccessToken.

Returns
Type Description
UnaryCallSettings<GenerateAwsAccessTokenRequest,GenerateAwsAccessTokenResponse>

generateAwsClusterAgentTokenSettings()

public UnaryCallSettings<GenerateAwsClusterAgentTokenRequest,GenerateAwsClusterAgentTokenResponse> generateAwsClusterAgentTokenSettings()

Returns the object with the settings used for calls to generateAwsClusterAgentToken.

Returns
Type Description
UnaryCallSettings<GenerateAwsClusterAgentTokenRequest,GenerateAwsClusterAgentTokenResponse>

getAwsClusterSettings()

public UnaryCallSettings<GetAwsClusterRequest,AwsCluster> getAwsClusterSettings()

Returns the object with the settings used for calls to getAwsCluster.

Returns
Type Description
UnaryCallSettings<GetAwsClusterRequest,AwsCluster>

getAwsJsonWebKeysSettings()

public UnaryCallSettings<GetAwsJsonWebKeysRequest,AwsJsonWebKeys> getAwsJsonWebKeysSettings()

Returns the object with the settings used for calls to getAwsJsonWebKeys.

Returns
Type Description
UnaryCallSettings<GetAwsJsonWebKeysRequest,AwsJsonWebKeys>

getAwsNodePoolSettings()

public UnaryCallSettings<GetAwsNodePoolRequest,AwsNodePool> getAwsNodePoolSettings()

Returns the object with the settings used for calls to getAwsNodePool.

Returns
Type Description
UnaryCallSettings<GetAwsNodePoolRequest,AwsNodePool>

getAwsOpenIdConfigSettings()

public UnaryCallSettings<GetAwsOpenIdConfigRequest,AwsOpenIdConfig> getAwsOpenIdConfigSettings()

Returns the object with the settings used for calls to getAwsOpenIdConfig.

Returns
Type Description
UnaryCallSettings<GetAwsOpenIdConfigRequest,AwsOpenIdConfig>

getAwsServerConfigSettings()

public UnaryCallSettings<GetAwsServerConfigRequest,AwsServerConfig> getAwsServerConfigSettings()

Returns the object with the settings used for calls to getAwsServerConfig.

Returns
Type Description
UnaryCallSettings<GetAwsServerConfigRequest,AwsServerConfig>

listAwsClustersSettings()

public PagedCallSettings<ListAwsClustersRequest,ListAwsClustersResponse,AwsClustersClient.ListAwsClustersPagedResponse> listAwsClustersSettings()

Returns the object with the settings used for calls to listAwsClusters.

Returns
Type Description
PagedCallSettings<ListAwsClustersRequest,ListAwsClustersResponse,ListAwsClustersPagedResponse>

listAwsNodePoolsSettings()

public PagedCallSettings<ListAwsNodePoolsRequest,ListAwsNodePoolsResponse,AwsClustersClient.ListAwsNodePoolsPagedResponse> listAwsNodePoolsSettings()

Returns the object with the settings used for calls to listAwsNodePools.

Returns
Type Description
PagedCallSettings<ListAwsNodePoolsRequest,ListAwsNodePoolsResponse,ListAwsNodePoolsPagedResponse>

rollbackAwsNodePoolUpdateOperationSettings()

public OperationCallSettings<RollbackAwsNodePoolUpdateRequest,AwsNodePool,OperationMetadata> rollbackAwsNodePoolUpdateOperationSettings()

Returns the object with the settings used for calls to rollbackAwsNodePoolUpdate.

Returns
Type Description
OperationCallSettings<RollbackAwsNodePoolUpdateRequest,AwsNodePool,OperationMetadata>

rollbackAwsNodePoolUpdateSettings()

public UnaryCallSettings<RollbackAwsNodePoolUpdateRequest,Operation> rollbackAwsNodePoolUpdateSettings()

Returns the object with the settings used for calls to rollbackAwsNodePoolUpdate.

Returns
Type Description
UnaryCallSettings<RollbackAwsNodePoolUpdateRequest,Operation>

toBuilder()

public AwsClustersSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns
Type Description
AwsClustersSettings.Builder
Overrides

updateAwsClusterOperationSettings()

public OperationCallSettings<UpdateAwsClusterRequest,AwsCluster,OperationMetadata> updateAwsClusterOperationSettings()

Returns the object with the settings used for calls to updateAwsCluster.

Returns
Type Description
OperationCallSettings<UpdateAwsClusterRequest,AwsCluster,OperationMetadata>

updateAwsClusterSettings()

public UnaryCallSettings<UpdateAwsClusterRequest,Operation> updateAwsClusterSettings()

Returns the object with the settings used for calls to updateAwsCluster.

Returns
Type Description
UnaryCallSettings<UpdateAwsClusterRequest,Operation>

updateAwsNodePoolOperationSettings()

public OperationCallSettings<UpdateAwsNodePoolRequest,AwsNodePool,OperationMetadata> updateAwsNodePoolOperationSettings()

Returns the object with the settings used for calls to updateAwsNodePool.

Returns
Type Description
OperationCallSettings<UpdateAwsNodePoolRequest,AwsNodePool,OperationMetadata>

updateAwsNodePoolSettings()

public UnaryCallSettings<UpdateAwsNodePoolRequest,Operation> updateAwsNodePoolSettings()

Returns the object with the settings used for calls to updateAwsNodePool.

Returns
Type Description
UnaryCallSettings<UpdateAwsNodePoolRequest,Operation>