Class ClusterManagerStubSettings (2.56.0)

Version latest

• 2.56.0 (latest)
• 2.55.0
• 2.54.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.40.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.2
• 2.4.1
• 2.3.8

public class ClusterManagerStubSettings extends StubSettings<ClusterManagerStubSettings>

Settings class to configure an instance of ClusterManagerStub.

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
 ClusterManagerStubSettings.Builder clusterManagerSettingsBuilder =
     ClusterManagerStubSettings.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());
 ClusterManagerStubSettings clusterManagerSettings = clusterManagerSettingsBuilder.build();
 

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

Inheritance

java.lang.Object > StubSettings > ClusterManagerStubSettings

Inherited Members

StubSettings.getApiKey()

StubSettings.getBackgroundExecutorProvider()

StubSettings.getClock()

StubSettings.getCredentialsProvider()

StubSettings.getEndpoint()

StubSettings.getExecutorProvider()

StubSettings.getGdchApiAudience()

StubSettings.getHeaderProvider()

StubSettings.getInternalHeaderProvider()

StubSettings.getMtlsEndpoint()

StubSettings.getQuotaProjectId()

StubSettings.getServiceName()

StubSettings.getStreamWatchdogCheckInterval()

StubSettings.getStreamWatchdogCheckIntervalDuration()

StubSettings.getStreamWatchdogProvider()

StubSettings.getTracerFactory()

StubSettings.getTransportChannelProvider()

StubSettings.getUniverseDomain()

StubSettings.toBuilder()

StubSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

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

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()

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

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()

Returns
Type	Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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()

Obsolete

Use getEndpoint() instead

This feature is stable for usage in this major version, but may be deprecated in a future release.

Returns the default service endpoint.

Returns
Type	Description
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS 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 ClusterManagerStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type	Description
ClusterManagerStubSettings.Builder

newBuilder(ClientContext clientContext)

public static ClusterManagerStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
clientContext	ClientContext

Returns
Type	Description
ClusterManagerStubSettings.Builder

newHttpJsonBuilder()

public static ClusterManagerStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type	Description
ClusterManagerStubSettings.Builder

Constructors

ClusterManagerStubSettings(ClusterManagerStubSettings.Builder settingsBuilder)

protected ClusterManagerStubSettings(ClusterManagerStubSettings.Builder settingsBuilder)

Parameter
Name	Description
settingsBuilder	ClusterManagerStubSettings.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.

Returns
Type	Description
UnaryCallSettings<CheckAutopilotCompatibilityRequest,CheckAutopilotCompatibilityResponse>

completeIPRotationSettings()

public UnaryCallSettings<CompleteIPRotationRequest,Operation> completeIPRotationSettings()

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

Returns
Type	Description
UnaryCallSettings<CompleteIPRotationRequest,Operation>

completeNodePoolUpgradeSettings()

public UnaryCallSettings<CompleteNodePoolUpgradeRequest,Empty> completeNodePoolUpgradeSettings()

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

Returns
Type	Description
UnaryCallSettings<CompleteNodePoolUpgradeRequest,Empty>

createClusterSettings()

public UnaryCallSettings<CreateClusterRequest,Operation> createClusterSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateClusterRequest,Operation>

createNodePoolSettings()

public UnaryCallSettings<CreateNodePoolRequest,Operation> createNodePoolSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateNodePoolRequest,Operation>

createStub()

public ClusterManagerStub createStub()

Returns
Type	Description
ClusterManagerStub

Exceptions
Type	Description
IOException

deleteClusterSettings()

public UnaryCallSettings<DeleteClusterRequest,Operation> deleteClusterSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteClusterRequest,Operation>

deleteNodePoolSettings()

public UnaryCallSettings<DeleteNodePoolRequest,Operation> deleteNodePoolSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteNodePoolRequest,Operation>

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.

Returns
Type	Description
UnaryCallSettings<GetJSONWebKeysRequest,GetJSONWebKeysResponse>

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.

Returns
Type	Description
UnaryCallSettings<GetServerConfigRequest,ServerConfig>

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type	Description
String

Overrides

StubSettings<SettingsT>.getServiceName()

listClustersSettings()

public UnaryCallSettings<ListClustersRequest,ListClustersResponse> listClustersSettings()

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

Returns
Type	Description
UnaryCallSettings<ListClustersRequest,ListClustersResponse>

listNodePoolsSettings()

public UnaryCallSettings<ListNodePoolsRequest,ListNodePoolsResponse> listNodePoolsSettings()

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

Returns
Type	Description
UnaryCallSettings<ListNodePoolsRequest,ListNodePoolsResponse>

listOperationsSettings()

public UnaryCallSettings<ListOperationsRequest,ListOperationsResponse> listOperationsSettings()

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

Returns
Type	Description
UnaryCallSettings<ListOperationsRequest,ListOperationsResponse>

listUsableSubnetworksSettings()

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

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

Returns
Type	Description
PagedCallSettings<ListUsableSubnetworksRequest,ListUsableSubnetworksResponse,ListUsableSubnetworksPagedResponse>

rollbackNodePoolUpgradeSettings()

public UnaryCallSettings<RollbackNodePoolUpgradeRequest,Operation> rollbackNodePoolUpgradeSettings()

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

Returns
Type	Description
UnaryCallSettings<RollbackNodePoolUpgradeRequest,Operation>

setAddonsConfigSettings()

public UnaryCallSettings<SetAddonsConfigRequest,Operation> setAddonsConfigSettings()

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

Returns
Type	Description
UnaryCallSettings<SetAddonsConfigRequest,Operation>

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.

Returns
Type	Description
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
Type	Description
UnaryCallSettings<SetLocationsRequest,Operation>

setLoggingServiceSettings()

public UnaryCallSettings<SetLoggingServiceRequest,Operation> setLoggingServiceSettings()

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

Returns
Type	Description
UnaryCallSettings<SetLoggingServiceRequest,Operation>

setMaintenancePolicySettings()

public UnaryCallSettings<SetMaintenancePolicyRequest,Operation> setMaintenancePolicySettings()

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

Returns
Type	Description
UnaryCallSettings<SetMaintenancePolicyRequest,Operation>

setMasterAuthSettings()

public UnaryCallSettings<SetMasterAuthRequest,Operation> setMasterAuthSettings()

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

Returns
Type	Description
UnaryCallSettings<SetMasterAuthRequest,Operation>

setMonitoringServiceSettings()

public UnaryCallSettings<SetMonitoringServiceRequest,Operation> setMonitoringServiceSettings()

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

Returns
Type	Description
UnaryCallSettings<SetMonitoringServiceRequest,Operation>

setNetworkPolicySettings()

public UnaryCallSettings<SetNetworkPolicyRequest,Operation> setNetworkPolicySettings()

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

Returns
Type	Description
UnaryCallSettings<SetNetworkPolicyRequest,Operation>

setNodePoolAutoscalingSettings()

public UnaryCallSettings<SetNodePoolAutoscalingRequest,Operation> setNodePoolAutoscalingSettings()

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

Returns
Type	Description
UnaryCallSettings<SetNodePoolAutoscalingRequest,Operation>

setNodePoolManagementSettings()

public UnaryCallSettings<SetNodePoolManagementRequest,Operation> setNodePoolManagementSettings()

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

Returns
Type	Description
UnaryCallSettings<SetNodePoolManagementRequest,Operation>

setNodePoolSizeSettings()

public UnaryCallSettings<SetNodePoolSizeRequest,Operation> setNodePoolSizeSettings()

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

Returns
Type	Description
UnaryCallSettings<SetNodePoolSizeRequest,Operation>

startIPRotationSettings()

public UnaryCallSettings<StartIPRotationRequest,Operation> startIPRotationSettings()

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

Returns
Type	Description
UnaryCallSettings<StartIPRotationRequest,Operation>

toBuilder()

public ClusterManagerStubSettings.Builder toBuilder()

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

Returns
Type	Description
ClusterManagerStubSettings.Builder

Overrides

StubSettings<SettingsT>.toBuilder()

updateClusterSettings()

public UnaryCallSettings<UpdateClusterRequest,Operation> updateClusterSettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateClusterRequest,Operation>

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.

Returns
Type	Description
UnaryCallSettings<UpdateNodePoolRequest,Operation>