Class ClusterManagerSettings (2.54.0)

See more code actions.
public class ClusterManagerSettings extends ClientSettings<ClusterManagerSettings>

Settings class to configure an instance of ClusterManagerClient.

The default instance has everything set to sensible defaults:

  • The default service address (container.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 listClusters:


 // 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
 ClusterManagerSettings.Builder clusterManagerSettingsBuilder =
     ClusterManagerSettings.newBuilder();
 clusterManagerSettingsBuilder
     .listClustersSettings()
     .setRetrySettings(
         clusterManagerSettingsBuilder
             .listClustersSettings()
             .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());
 ClusterManagerSettings clusterManagerSettings = clusterManagerSettingsBuilder.build();
 

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

Inheritance

java.lang.Object > ClientSettings > ClusterManagerSettings

Static Methods

create(ClusterManagerStubSettings stub)

public static final ClusterManagerSettings create(ClusterManagerStubSettings stub)
Parameter
Name Description
stub ClusterManagerStubSettings
Returns
Type Description
ClusterManagerSettings
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 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 ClusterManagerSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type Description
ClusterManagerSettings.Builder

newBuilder(ClientContext clientContext)

public static ClusterManagerSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
ClusterManagerSettings.Builder

Constructors

ClusterManagerSettings(ClusterManagerSettings.Builder settingsBuilder)

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

Methods

cancelOperationSettings()

public UnaryCallSettings<CancelOperationRequest,Empty> cancelOperationSettings()

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

Returns
Type Description
UnaryCallSettings<CancelOperationRequest,Empty>

checkAutopilotCompatibilitySettings()

public UnaryCallSettings<CheckAutopilotCompatibilityRequest,CheckAutopilotCompatibilityResponse> checkAutopilotCompatibilitySettings()

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

completeIPRotationSettings()

public UnaryCallSettings<CompleteIPRotationRequest,Operation> completeIPRotationSettings()

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

completeNodePoolUpgradeSettings()

public UnaryCallSettings<CompleteNodePoolUpgradeRequest,Empty> completeNodePoolUpgradeSettings()

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

createClusterSettings()

public UnaryCallSettings<CreateClusterRequest,Operation> createClusterSettings()

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

createNodePoolSettings()

public UnaryCallSettings<CreateNodePoolRequest,Operation> createNodePoolSettings()

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

deleteClusterSettings()

public UnaryCallSettings<DeleteClusterRequest,Operation> deleteClusterSettings()

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

deleteNodePoolSettings()

public UnaryCallSettings<DeleteNodePoolRequest,Operation> deleteNodePoolSettings()

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

getClusterSettings()

public UnaryCallSettings<GetClusterRequest,Cluster> getClusterSettings()

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

Returns
Type Description
UnaryCallSettings<GetClusterRequest,Cluster>

getJSONWebKeysSettings()

public UnaryCallSettings<GetJSONWebKeysRequest,GetJSONWebKeysResponse> getJSONWebKeysSettings()

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

getNodePoolSettings()

public UnaryCallSettings<GetNodePoolRequest,NodePool> getNodePoolSettings()

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

Returns
Type Description
UnaryCallSettings<GetNodePoolRequest,NodePool>

getOperationSettings()

public UnaryCallSettings<GetOperationRequest,Operation> getOperationSettings()

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

Returns
Type Description
UnaryCallSettings<GetOperationRequest,Operation>

getServerConfigSettings()

public UnaryCallSettings<GetServerConfigRequest,ServerConfig> getServerConfigSettings()

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

listClustersSettings()

public UnaryCallSettings<ListClustersRequest,ListClustersResponse> listClustersSettings()

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

listLocationsSettings()

public UnaryCallSettings<ListLocationsRequest,ListLocationsResponse> listLocationsSettings()

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

listNodePoolsSettings()

public UnaryCallSettings<ListNodePoolsRequest,ListNodePoolsResponse> listNodePoolsSettings()

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

listOperationsSettings()

public UnaryCallSettings<ListOperationsRequest,ListOperationsResponse> listOperationsSettings()

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

listUsableSubnetworksSettings()

public PagedCallSettings<ListUsableSubnetworksRequest,ListUsableSubnetworksResponse,ClusterManagerClient.ListUsableSubnetworksPagedResponse> listUsableSubnetworksSettings()

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

rollbackNodePoolUpgradeSettings()

public UnaryCallSettings<RollbackNodePoolUpgradeRequest,Operation> rollbackNodePoolUpgradeSettings()

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

setAddonsConfigSettings()

public UnaryCallSettings<SetAddonsConfigRequest,Operation> setAddonsConfigSettings()

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

setLabelsSettings()

public UnaryCallSettings<SetLabelsRequest,Operation> setLabelsSettings()

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

Returns
Type Description
UnaryCallSettings<SetLabelsRequest,Operation>

setLegacyAbacSettings()

public UnaryCallSettings<SetLegacyAbacRequest,Operation> setLegacyAbacSettings()

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

setLocationsSettings() (deprecated)

public UnaryCallSettings<SetLocationsRequest,Operation> setLocationsSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
UnaryCallSettings<SetLocationsRequest,Operation>

setLoggingServiceSettings()

public UnaryCallSettings<SetLoggingServiceRequest,Operation> setLoggingServiceSettings()

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

setMaintenancePolicySettings()

public UnaryCallSettings<SetMaintenancePolicyRequest,Operation> setMaintenancePolicySettings()

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

setMasterAuthSettings()

public UnaryCallSettings<SetMasterAuthRequest,Operation> setMasterAuthSettings()

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

setMonitoringServiceSettings()

public UnaryCallSettings<SetMonitoringServiceRequest,Operation> setMonitoringServiceSettings()

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

setNetworkPolicySettings()

public UnaryCallSettings<SetNetworkPolicyRequest,Operation> setNetworkPolicySettings()

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

setNodePoolAutoscalingSettings()

public UnaryCallSettings<SetNodePoolAutoscalingRequest,Operation> setNodePoolAutoscalingSettings()

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

setNodePoolManagementSettings()

public UnaryCallSettings<SetNodePoolManagementRequest,Operation> setNodePoolManagementSettings()

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

setNodePoolSizeSettings()

public UnaryCallSettings<SetNodePoolSizeRequest,Operation> setNodePoolSizeSettings()

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

startIPRotationSettings()

public UnaryCallSettings<StartIPRotationRequest,Operation> startIPRotationSettings()

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

toBuilder()

public ClusterManagerSettings.Builder toBuilder()

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

Returns
Type Description
ClusterManagerSettings.Builder
Overrides

updateClusterSettings()

public UnaryCallSettings<UpdateClusterRequest,Operation> updateClusterSettings()

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

updateMasterSettings()

public UnaryCallSettings<UpdateMasterRequest,Operation> updateMasterSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateMasterRequest,Operation>

updateNodePoolSettings()

public UnaryCallSettings<UpdateNodePoolRequest,Operation> updateNodePoolSettings()

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