Class CloudRedisClusterStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<CloudRedisClusterStubSettings>
com.google.cloud.redis.cluster.v1.stub.CloudRedisClusterStubSettings
@Generated("by gapic-generator-java")
public class CloudRedisClusterStubSettings
extends StubSettings<CloudRedisClusterStubSettings>
Settings class to configure an instance of
CloudRedisClusterStub.
The default instance has everything set to sensible defaults:
- The default service address (redis.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
CloudRedisClusterStubSettings.Builder cloudRedisClusterSettingsBuilder =
CloudRedisClusterStubSettings.newBuilder();
cloudRedisClusterSettingsBuilder
.getClusterSettings()
.setRetrySettings(
cloudRedisClusterSettingsBuilder
.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());
CloudRedisClusterStubSettings cloudRedisClusterSettings =
cloudRedisClusterSettingsBuilder.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 updateCluster:
// 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
CloudRedisClusterStubSettings.Builder cloudRedisClusterSettingsBuilder =
CloudRedisClusterStubSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
cloudRedisClusterSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for CloudRedisClusterStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCloudRedisClusterStubSettings(CloudRedisClusterStubSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionOperationCallSettings<BackupClusterRequest,Cluster, com.google.protobuf.Any> Returns the object with the settings used for calls to backupCluster.Returns the object with the settings used for calls to backupCluster.OperationCallSettings<CreateClusterRequest,Cluster, com.google.protobuf.Any> Returns 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<DeleteBackupRequest,com.google.protobuf.Empty, com.google.protobuf.Any> Returns the object with the settings used for calls to deleteBackup.Returns the object with the settings used for calls to deleteBackup.OperationCallSettings<DeleteClusterRequest,com.google.protobuf.Empty, com.google.protobuf.Any> Returns the object with the settings used for calls to deleteCluster.Returns the object with the settings used for calls to deleteCluster.OperationCallSettings<ExportBackupRequest,Backup, com.google.protobuf.Any> Returns the object with the settings used for calls to exportBackup.Returns the object with the settings used for calls to exportBackup.Returns the object with the settings used for calls to getBackupCollection.Returns the object with the settings used for calls to getBackup.Returns the object with the settings used for calls to getClusterCertificateAuthority.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.protected LibraryMetadataReturns the object with the settings used for calls to getLocation.Returns the default service name.Returns the object with the settings used for calls to getSharedRegionalCertificateAuthority.PagedCallSettings<ListBackupCollectionsRequest,ListBackupCollectionsResponse, CloudRedisClusterClient.ListBackupCollectionsPagedResponse> Returns the object with the settings used for calls to listBackupCollections.PagedCallSettings<ListBackupsRequest,ListBackupsResponse, CloudRedisClusterClient.ListBackupsPagedResponse> Returns the object with the settings used for calls to listBackups.PagedCallSettings<ListClustersRequest,ListClustersResponse, CloudRedisClusterClient.ListClustersPagedResponse> Returns the object with the settings used for calls to listClusters.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, CloudRedisClusterClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.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.OperationCallSettings<RescheduleClusterMaintenanceRequest,Cluster, com.google.protobuf.Any> Returns the object with the settings used for calls to rescheduleClusterMaintenance.Returns the object with the settings used for calls to rescheduleClusterMaintenance.Returns a builder containing all the values of this settings class.OperationCallSettings<UpdateClusterRequest,Cluster, com.google.protobuf.Any> 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
-
CloudRedisClusterStubSettings
protected CloudRedisClusterStubSettings(CloudRedisClusterStubSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
listClustersSettings
public PagedCallSettings<ListClustersRequest,ListClustersResponse, listClustersSettings()CloudRedisClusterClient.ListClustersPagedResponse> Returns the object with the settings used for calls to listClusters. -
getClusterSettings
Returns the object with the settings used for calls to getCluster. -
updateClusterSettings
Returns the object with the settings used for calls to updateCluster. -
updateClusterOperationSettings
public OperationCallSettings<UpdateClusterRequest,Cluster, updateClusterOperationSettings()com.google.protobuf.Any> Returns the object with the settings used for calls to updateCluster. -
deleteClusterSettings
Returns the object with the settings used for calls to deleteCluster. -
deleteClusterOperationSettings
public OperationCallSettings<DeleteClusterRequest,com.google.protobuf.Empty, deleteClusterOperationSettings()com.google.protobuf.Any> Returns the object with the settings used for calls to deleteCluster. -
createClusterSettings
Returns the object with the settings used for calls to createCluster. -
createClusterOperationSettings
public OperationCallSettings<CreateClusterRequest,Cluster, createClusterOperationSettings()com.google.protobuf.Any> Returns the object with the settings used for calls to createCluster. -
getClusterCertificateAuthoritySettings
public UnaryCallSettings<GetClusterCertificateAuthorityRequest,CertificateAuthority> getClusterCertificateAuthoritySettings()Returns the object with the settings used for calls to getClusterCertificateAuthority. -
rescheduleClusterMaintenanceSettings
public UnaryCallSettings<RescheduleClusterMaintenanceRequest,Operation> rescheduleClusterMaintenanceSettings()Returns the object with the settings used for calls to rescheduleClusterMaintenance. -
rescheduleClusterMaintenanceOperationSettings
public OperationCallSettings<RescheduleClusterMaintenanceRequest,Cluster, rescheduleClusterMaintenanceOperationSettings()com.google.protobuf.Any> Returns the object with the settings used for calls to rescheduleClusterMaintenance. -
listBackupCollectionsSettings
public PagedCallSettings<ListBackupCollectionsRequest,ListBackupCollectionsResponse, listBackupCollectionsSettings()CloudRedisClusterClient.ListBackupCollectionsPagedResponse> Returns the object with the settings used for calls to listBackupCollections. -
getBackupCollectionSettings
Returns the object with the settings used for calls to getBackupCollection. -
listBackupsSettings
public PagedCallSettings<ListBackupsRequest,ListBackupsResponse, listBackupsSettings()CloudRedisClusterClient.ListBackupsPagedResponse> Returns the object with the settings used for calls to listBackups. -
getBackupSettings
Returns the object with the settings used for calls to getBackup. -
deleteBackupSettings
Returns the object with the settings used for calls to deleteBackup. -
deleteBackupOperationSettings
public OperationCallSettings<DeleteBackupRequest,com.google.protobuf.Empty, deleteBackupOperationSettings()com.google.protobuf.Any> Returns the object with the settings used for calls to deleteBackup. -
exportBackupSettings
Returns the object with the settings used for calls to exportBackup. -
exportBackupOperationSettings
public OperationCallSettings<ExportBackupRequest,Backup, exportBackupOperationSettings()com.google.protobuf.Any> Returns the object with the settings used for calls to exportBackup. -
backupClusterSettings
Returns the object with the settings used for calls to backupCluster. -
backupClusterOperationSettings
public OperationCallSettings<BackupClusterRequest,Cluster, backupClusterOperationSettings()com.google.protobuf.Any> Returns the object with the settings used for calls to backupCluster. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()CloudRedisClusterClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
createStub
- Throws:
IOException
-
getServiceName
Returns the default service name.- Overrides:
getServiceNamein classStubSettings<CloudRedisClusterStubSettings>
-
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<CloudRedisClusterStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<CloudRedisClusterStubSettings>
-