Class ClusterManagerSettings (2.9.0)

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 total timeout of listClusters to 30 seconds:


 // 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()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ClusterManagerSettings clusterManagerSettings = clusterManagerSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > ClusterManagerSettings

Static Methods

create(ClusterManagerStubSettings stub)

public static final ClusterManagerSettings create(ClusterManagerStubSettings stub)
Parameter
NameDescription
stubClusterManagerStubSettings
Returns
TypeDescription
ClusterManagerSettings
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 ClusterManagerSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
ClusterManagerSettings.Builder

newBuilder(ClientContext clientContext)

public static ClusterManagerSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
ClusterManagerSettings.Builder

Constructors

ClusterManagerSettings(ClusterManagerSettings.Builder settingsBuilder)

protected ClusterManagerSettings(ClusterManagerSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderClusterManagerSettings.Builder

Methods

cancelOperationSettings()

public UnaryCallSettings<CancelOperationRequest,Empty> cancelOperationSettings()

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

Returns
TypeDescription
UnaryCallSettings<CancelOperationRequest,Empty>

completeIPRotationSettings()

public UnaryCallSettings<CompleteIPRotationRequest,Operation> completeIPRotationSettings()

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

Returns
TypeDescription
UnaryCallSettings<CompleteIPRotationRequest,Operation>

completeNodePoolUpgradeSettings()

public UnaryCallSettings<CompleteNodePoolUpgradeRequest,Empty> completeNodePoolUpgradeSettings()

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

Returns
TypeDescription
UnaryCallSettings<CompleteNodePoolUpgradeRequest,Empty>

createClusterSettings()

public UnaryCallSettings<CreateClusterRequest,Operation> createClusterSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateClusterRequest,Operation>

createNodePoolSettings()

public UnaryCallSettings<CreateNodePoolRequest,Operation> createNodePoolSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateNodePoolRequest,Operation>

deleteClusterSettings()

public UnaryCallSettings<DeleteClusterRequest,Operation> deleteClusterSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteClusterRequest,Operation>

deleteNodePoolSettings()

public UnaryCallSettings<DeleteNodePoolRequest,Operation> deleteNodePoolSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteNodePoolRequest,Operation>

getClusterSettings()

public UnaryCallSettings<GetClusterRequest,Cluster> getClusterSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetClusterRequest,Cluster>

getJSONWebKeysSettings()

public UnaryCallSettings<GetJSONWebKeysRequest,GetJSONWebKeysResponse> getJSONWebKeysSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetJSONWebKeysRequest,GetJSONWebKeysResponse>

getNodePoolSettings()

public UnaryCallSettings<GetNodePoolRequest,NodePool> getNodePoolSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetNodePoolRequest,NodePool>

getOperationSettings()

public UnaryCallSettings<GetOperationRequest,Operation> getOperationSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetOperationRequest,Operation>

getServerConfigSettings()

public UnaryCallSettings<GetServerConfigRequest,ServerConfig> getServerConfigSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetServerConfigRequest,ServerConfig>

listClustersSettings()

public UnaryCallSettings<ListClustersRequest,ListClustersResponse> listClustersSettings()

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

Returns
TypeDescription
UnaryCallSettings<ListClustersRequest,ListClustersResponse>

listLocationsSettings()

public UnaryCallSettings<ListLocationsRequest,ListLocationsResponse> listLocationsSettings()

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

Returns
TypeDescription
UnaryCallSettings<ListLocationsRequest,ListLocationsResponse>

listNodePoolsSettings()

public UnaryCallSettings<ListNodePoolsRequest,ListNodePoolsResponse> listNodePoolsSettings()

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

Returns
TypeDescription
UnaryCallSettings<ListNodePoolsRequest,ListNodePoolsResponse>

listOperationsSettings()

public UnaryCallSettings<ListOperationsRequest,ListOperationsResponse> listOperationsSettings()

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

Returns
TypeDescription
UnaryCallSettings<ListOperationsRequest,ListOperationsResponse>

listUsableSubnetworksSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListUsableSubnetworksRequest,ListUsableSubnetworksResponse,ListUsableSubnetworksPagedResponse>

rollbackNodePoolUpgradeSettings()

public UnaryCallSettings<RollbackNodePoolUpgradeRequest,Operation> rollbackNodePoolUpgradeSettings()

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

Returns
TypeDescription
UnaryCallSettings<RollbackNodePoolUpgradeRequest,Operation>

setAddonsConfigSettings()

public UnaryCallSettings<SetAddonsConfigRequest,Operation> setAddonsConfigSettings()

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

Returns
TypeDescription
UnaryCallSettings<SetAddonsConfigRequest,Operation>

setLabelsSettings()

public UnaryCallSettings<SetLabelsRequest,Operation> setLabelsSettings()

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

Returns
TypeDescription
UnaryCallSettings<SetLabelsRequest,Operation>

setLegacyAbacSettings()

public UnaryCallSettings<SetLegacyAbacRequest,Operation> setLegacyAbacSettings()

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

Returns
TypeDescription
UnaryCallSettings<SetLegacyAbacRequest,Operation>

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
TypeDescription
UnaryCallSettings<SetLocationsRequest,Operation>

setLoggingServiceSettings()

public UnaryCallSettings<SetLoggingServiceRequest,Operation> setLoggingServiceSettings()

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

Returns
TypeDescription
UnaryCallSettings<SetLoggingServiceRequest,Operation>

setMaintenancePolicySettings()

public UnaryCallSettings<SetMaintenancePolicyRequest,Operation> setMaintenancePolicySettings()

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

Returns
TypeDescription
UnaryCallSettings<SetMaintenancePolicyRequest,Operation>

setMasterAuthSettings()

public UnaryCallSettings<SetMasterAuthRequest,Operation> setMasterAuthSettings()

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

Returns
TypeDescription
UnaryCallSettings<SetMasterAuthRequest,Operation>

setMonitoringServiceSettings()

public UnaryCallSettings<SetMonitoringServiceRequest,Operation> setMonitoringServiceSettings()

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

Returns
TypeDescription
UnaryCallSettings<SetMonitoringServiceRequest,Operation>

setNetworkPolicySettings()

public UnaryCallSettings<SetNetworkPolicyRequest,Operation> setNetworkPolicySettings()

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

Returns
TypeDescription
UnaryCallSettings<SetNetworkPolicyRequest,Operation>

setNodePoolAutoscalingSettings()

public UnaryCallSettings<SetNodePoolAutoscalingRequest,Operation> setNodePoolAutoscalingSettings()

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

Returns
TypeDescription
UnaryCallSettings<SetNodePoolAutoscalingRequest,Operation>

setNodePoolManagementSettings()

public UnaryCallSettings<SetNodePoolManagementRequest,Operation> setNodePoolManagementSettings()

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

Returns
TypeDescription
UnaryCallSettings<SetNodePoolManagementRequest,Operation>

setNodePoolSizeSettings()

public UnaryCallSettings<SetNodePoolSizeRequest,Operation> setNodePoolSizeSettings()

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

Returns
TypeDescription
UnaryCallSettings<SetNodePoolSizeRequest,Operation>

startIPRotationSettings()

public UnaryCallSettings<StartIPRotationRequest,Operation> startIPRotationSettings()

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

Returns
TypeDescription
UnaryCallSettings<StartIPRotationRequest,Operation>

toBuilder()

public ClusterManagerSettings.Builder toBuilder()

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

Returns
TypeDescription
ClusterManagerSettings.Builder
Overrides

updateClusterSettings()

public UnaryCallSettings<UpdateClusterRequest,Operation> updateClusterSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateClusterRequest,Operation>

updateMasterSettings()

public UnaryCallSettings<UpdateMasterRequest,Operation> updateMasterSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateMasterRequest,Operation>

updateNodePoolSettings()

public UnaryCallSettings<UpdateNodePoolRequest,Operation> updateNodePoolSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateNodePoolRequest,Operation>