Class AttachedClustersStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<AttachedClustersStubSettings>
com.google.cloud.gkemulticloud.v1.stub.AttachedClustersStubSettings
@Generated("by gapic-generator-java")
public class AttachedClustersStubSettings
extends StubSettings<AttachedClustersStubSettings>
Settings class to configure an instance of
AttachedClustersStub.
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 [RetrySettings](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of getAttachedCluster:
// 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
AttachedClustersStubSettings.Builder attachedClustersSettingsBuilder =
AttachedClustersStubSettings.newBuilder();
attachedClustersSettingsBuilder
.getAttachedClusterSettings()
.setRetrySettings(
attachedClustersSettingsBuilder
.getAttachedClusterSettings()
.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());
AttachedClustersStubSettings attachedClustersSettings = attachedClustersSettingsBuilder.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 createAttachedCluster:
// 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
AttachedClustersStubSettings.Builder attachedClustersSettingsBuilder =
AttachedClustersStubSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
attachedClustersSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for AttachedClustersStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedAttachedClustersStubSettings(AttachedClustersStubSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to createAttachedCluster.Returns the object with the settings used for calls to createAttachedCluster.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<DeleteAttachedClusterRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteAttachedCluster.Returns the object with the settings used for calls to deleteAttachedCluster.UnaryCallSettings<GenerateAttachedClusterAgentTokenRequest,GenerateAttachedClusterAgentTokenResponse> Returns the object with the settings used for calls to generateAttachedClusterAgentToken.UnaryCallSettings<GenerateAttachedClusterInstallManifestRequest,GenerateAttachedClusterInstallManifestResponse> Returns the object with the settings used for calls to generateAttachedClusterInstallManifest.Returns the object with the settings used for calls to getAttachedCluster.Returns the object with the settings used for calls to getAttachedServerConfig.static StringReturns the default service endpoint.static StringReturns the default mTLS service endpoint.Returns the default service scopes.protected LibraryMetadataReturns the default service name.Returns the object with the settings used for calls to importAttachedCluster.Returns the object with the settings used for calls to importAttachedCluster.PagedCallSettings<ListAttachedClustersRequest,ListAttachedClustersResponse, AttachedClustersClient.ListAttachedClustersPagedResponse> Returns the object with the settings used for calls to listAttachedClusters.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 a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateAttachedCluster.Returns the object with the settings used for calls to updateAttachedCluster.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
-
AttachedClustersStubSettings
protected AttachedClustersStubSettings(AttachedClustersStubSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
createAttachedClusterSettings
Returns the object with the settings used for calls to createAttachedCluster. -
createAttachedClusterOperationSettings
public OperationCallSettings<CreateAttachedClusterRequest,AttachedCluster, createAttachedClusterOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createAttachedCluster. -
updateAttachedClusterSettings
Returns the object with the settings used for calls to updateAttachedCluster. -
updateAttachedClusterOperationSettings
public OperationCallSettings<UpdateAttachedClusterRequest,AttachedCluster, updateAttachedClusterOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateAttachedCluster. -
importAttachedClusterSettings
Returns the object with the settings used for calls to importAttachedCluster. -
importAttachedClusterOperationSettings
public OperationCallSettings<ImportAttachedClusterRequest,AttachedCluster, importAttachedClusterOperationSettings()OperationMetadata> Returns the object with the settings used for calls to importAttachedCluster. -
getAttachedClusterSettings
Returns the object with the settings used for calls to getAttachedCluster. -
listAttachedClustersSettings
public PagedCallSettings<ListAttachedClustersRequest,ListAttachedClustersResponse, listAttachedClustersSettings()AttachedClustersClient.ListAttachedClustersPagedResponse> Returns the object with the settings used for calls to listAttachedClusters. -
deleteAttachedClusterSettings
Returns the object with the settings used for calls to deleteAttachedCluster. -
deleteAttachedClusterOperationSettings
public OperationCallSettings<DeleteAttachedClusterRequest,com.google.protobuf.Empty, deleteAttachedClusterOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteAttachedCluster. -
getAttachedServerConfigSettings
public UnaryCallSettings<GetAttachedServerConfigRequest,AttachedServerConfig> getAttachedServerConfigSettings()Returns the object with the settings used for calls to getAttachedServerConfig. -
generateAttachedClusterInstallManifestSettings
public UnaryCallSettings<GenerateAttachedClusterInstallManifestRequest,GenerateAttachedClusterInstallManifestResponse> generateAttachedClusterInstallManifestSettings()Returns the object with the settings used for calls to generateAttachedClusterInstallManifest. -
generateAttachedClusterAgentTokenSettings
public UnaryCallSettings<GenerateAttachedClusterAgentTokenRequest,GenerateAttachedClusterAgentTokenResponse> generateAttachedClusterAgentTokenSettings()Returns the object with the settings used for calls to generateAttachedClusterAgentToken. -
createStub
- Throws:
IOException
-
getServiceName
Returns the default service name.- Overrides:
getServiceNamein classStubSettings<AttachedClustersStubSettings>
-
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<AttachedClustersStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<AttachedClustersStubSettings>
-