Class ClusterControllerStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<ClusterControllerStubSettings>
com.google.cloud.dataproc.v1.stub.ClusterControllerStubSettings
@Generated("by gapic-generator-java")
public class ClusterControllerStubSettings
extends StubSettings<ClusterControllerStubSettings>
Settings class to configure an instance of
ClusterControllerStub.
The default instance has everything set to sensible defaults:
- The default service address (dataproc.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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of getCluster:
// 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
ClusterControllerStubSettings.Builder clusterControllerSettingsBuilder =
ClusterControllerStubSettings.newBuilder();
clusterControllerSettingsBuilder
.getClusterSettings()
.setRetrySettings(
clusterControllerSettingsBuilder
.getClusterSettings()
.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());
ClusterControllerStubSettings clusterControllerSettings =
clusterControllerSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) 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 createCluster:
// 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
ClusterControllerStubSettings.Builder clusterControllerSettingsBuilder =
ClusterControllerStubSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
clusterControllerSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for ClusterControllerStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedClusterControllerStubSettings(ClusterControllerStubSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to createCluster.Returns the object with the settings used for calls to createCluster.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default gRPC ChannelProvider for this service.Returns a builder for the default REST ChannelProvider for this service.static TransportChannelProviderOperationCallSettings<DeleteClusterRequest,com.google.protobuf.Empty, ClusterOperationMetadata> Returns the object with the settings used for calls to deleteCluster.Returns the object with the settings used for calls to deleteCluster.Returns the object with the settings used for calls to diagnoseCluster.Returns the object with the settings used for calls to diagnoseCluster.Returns the object with the settings used for calls to getCluster.static StringReturns the default service endpoint.static StringReturns the default mTLS service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getIamPolicy.protected LibraryMetadataReturns the default service name.PagedCallSettings<ListClustersRequest,ListClustersResponse, ClusterControllerClient.ListClustersPagedResponse> Returns the object with the settings used for calls to listClusters.Returns a new gRPC builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns a new REST builder for this class.Returns the object with the settings used for calls to setIamPolicy.Returns the object with the settings used for calls to startCluster.Returns the object with the settings used for calls to startCluster.Returns the object with the settings used for calls to stopCluster.Returns the object with the settings used for calls to stopCluster.Returns the object with the settings used for calls to testIamPermissions.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateCluster.Returns the object with the settings used for calls to updateCluster.Methods inherited from class com.google.api.gax.rpc.StubSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogCheckIntervalDuration, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, getUniverseDomain, toString
-
Constructor Details
-
ClusterControllerStubSettings
protected ClusterControllerStubSettings(ClusterControllerStubSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
createClusterSettings
Returns the object with the settings used for calls to createCluster. -
createClusterOperationSettings
public OperationCallSettings<CreateClusterRequest,Cluster, createClusterOperationSettings()ClusterOperationMetadata> Returns the object with the settings used for calls to createCluster. -
updateClusterSettings
Returns the object with the settings used for calls to updateCluster. -
updateClusterOperationSettings
public OperationCallSettings<UpdateClusterRequest,Cluster, updateClusterOperationSettings()ClusterOperationMetadata> Returns the object with the settings used for calls to updateCluster. -
stopClusterSettings
Returns the object with the settings used for calls to stopCluster. -
stopClusterOperationSettings
public OperationCallSettings<StopClusterRequest,Cluster, stopClusterOperationSettings()ClusterOperationMetadata> Returns the object with the settings used for calls to stopCluster. -
startClusterSettings
Returns the object with the settings used for calls to startCluster. -
startClusterOperationSettings
public OperationCallSettings<StartClusterRequest,Cluster, startClusterOperationSettings()ClusterOperationMetadata> Returns the object with the settings used for calls to startCluster. -
deleteClusterSettings
Returns the object with the settings used for calls to deleteCluster. -
deleteClusterOperationSettings
public OperationCallSettings<DeleteClusterRequest,com.google.protobuf.Empty, deleteClusterOperationSettings()ClusterOperationMetadata> Returns the object with the settings used for calls to deleteCluster. -
getClusterSettings
Returns the object with the settings used for calls to getCluster. -
listClustersSettings
public PagedCallSettings<ListClustersRequest,ListClustersResponse, listClustersSettings()ClusterControllerClient.ListClustersPagedResponse> Returns the object with the settings used for calls to listClusters. -
diagnoseClusterSettings
Returns the object with the settings used for calls to diagnoseCluster. -
diagnoseClusterOperationSettings
public OperationCallSettings<DiagnoseClusterRequest,DiagnoseClusterResults, diagnoseClusterOperationSettings()ClusterOperationMetadata> Returns the object with the settings used for calls to diagnoseCluster. -
setIamPolicySettings
Returns the object with the settings used for calls to setIamPolicy. -
getIamPolicySettings
Returns the object with the settings used for calls to getIamPolicy. -
testIamPermissionsSettings
public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()Returns the object with the settings used for calls to testIamPermissions. -
createStub
- Throws:
IOException
-
getServiceName
Returns the default service name.- Overrides:
getServiceNamein classStubSettings<ClusterControllerStubSettings>
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultMtlsEndpoint
Returns the default mTLS service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default gRPC ChannelProvider for this service. -
defaultHttpJsonTransportProviderBuilder
@BetaApi public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultGrpcApiClientHeaderProviderBuilder
-
defaultHttpJsonApiClientHeaderProviderBuilder
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new gRPC builder for this class. -
newHttpJsonBuilder
Returns a new REST builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classStubSettings<ClusterControllerStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<ClusterControllerStubSettings>
-