Class AwsClustersSettings (0.1.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 total timeout of getAwsCluster to 30 seconds:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 AwsClustersSettings.Builder awsClustersSettingsBuilder = AwsClustersSettings.newBuilder();
 awsClustersSettingsBuilder
     .getAwsClusterSettings()
     .setRetrySettings(
         awsClustersSettingsBuilder
             .getAwsClusterSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 AwsClustersSettings awsClustersSettings = awsClustersSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > AwsClustersSettings

Static Methods

create(AwsClustersStubSettings stub)

public static final AwsClustersSettings create(AwsClustersStubSettings stub)
Parameter
NameDescription
stubAwsClustersStubSettings
Returns
TypeDescription
AwsClustersSettings
Exceptions
TypeDescription
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static AwsClustersSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
AwsClustersSettings.Builder

newBuilder(ClientContext clientContext)

public static AwsClustersSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
AwsClustersSettings.Builder

Constructors

AwsClustersSettings(AwsClustersSettings.Builder settingsBuilder)

protected AwsClustersSettings(AwsClustersSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderAwsClustersSettings.Builder

Methods

createAwsClusterOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreateAwsClusterRequest,AwsCluster,OperationMetadata>

createAwsClusterSettings()

public UnaryCallSettings<CreateAwsClusterRequest,Operation> createAwsClusterSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateAwsClusterRequest,Operation>

createAwsNodePoolOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreateAwsNodePoolRequest,AwsNodePool,OperationMetadata>

createAwsNodePoolSettings()

public UnaryCallSettings<CreateAwsNodePoolRequest,Operation> createAwsNodePoolSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateAwsNodePoolRequest,Operation>

deleteAwsClusterOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteAwsClusterRequest,Empty,OperationMetadata>

deleteAwsClusterSettings()

public UnaryCallSettings<DeleteAwsClusterRequest,Operation> deleteAwsClusterSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteAwsClusterRequest,Operation>

deleteAwsNodePoolOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteAwsNodePoolRequest,Empty,OperationMetadata>

deleteAwsNodePoolSettings()

public UnaryCallSettings<DeleteAwsNodePoolRequest,Operation> deleteAwsNodePoolSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteAwsNodePoolRequest,Operation>

generateAwsAccessTokenSettings()

public UnaryCallSettings<GenerateAwsAccessTokenRequest,GenerateAwsAccessTokenResponse> generateAwsAccessTokenSettings()

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

Returns
TypeDescription
UnaryCallSettings<GenerateAwsAccessTokenRequest,GenerateAwsAccessTokenResponse>

getAwsClusterSettings()

public UnaryCallSettings<GetAwsClusterRequest,AwsCluster> getAwsClusterSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetAwsClusterRequest,AwsCluster>

getAwsNodePoolSettings()

public UnaryCallSettings<GetAwsNodePoolRequest,AwsNodePool> getAwsNodePoolSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetAwsNodePoolRequest,AwsNodePool>

getAwsServerConfigSettings()

public UnaryCallSettings<GetAwsServerConfigRequest,AwsServerConfig> getAwsServerConfigSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetAwsServerConfigRequest,AwsServerConfig>

listAwsClustersSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListAwsClustersRequest,ListAwsClustersResponse,ListAwsClustersPagedResponse>

listAwsNodePoolsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListAwsNodePoolsRequest,ListAwsNodePoolsResponse,ListAwsNodePoolsPagedResponse>

toBuilder()

public AwsClustersSettings.Builder toBuilder()

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

Returns
TypeDescription
AwsClustersSettings.Builder
Overrides

updateAwsClusterOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<UpdateAwsClusterRequest,AwsCluster,OperationMetadata>

updateAwsClusterSettings()

public UnaryCallSettings<UpdateAwsClusterRequest,Operation> updateAwsClusterSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateAwsClusterRequest,Operation>

updateAwsNodePoolOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<UpdateAwsNodePoolRequest,AwsNodePool,OperationMetadata>

updateAwsNodePoolSettings()

public UnaryCallSettings<UpdateAwsNodePoolRequest,Operation> updateAwsNodePoolSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateAwsNodePoolRequest,Operation>