Class CloudRedisClusterStubSettings (0.35.0)

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

Inheritance

java.lang.Object > StubSettings > CloudRedisClusterStubSettings

Static Methods

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

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST 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

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static CloudRedisClusterStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
TypeDescription
CloudRedisClusterStubSettings.Builder

newBuilder(ClientContext clientContext)

public static CloudRedisClusterStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
CloudRedisClusterStubSettings.Builder

newHttpJsonBuilder()

public static CloudRedisClusterStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
TypeDescription
CloudRedisClusterStubSettings.Builder

Constructors

CloudRedisClusterStubSettings(CloudRedisClusterStubSettings.Builder settingsBuilder)

protected CloudRedisClusterStubSettings(CloudRedisClusterStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderCloudRedisClusterStubSettings.Builder

Methods

backupClusterOperationSettings()

public OperationCallSettings<BackupClusterRequest,Cluster,Any> backupClusterOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<BackupClusterRequest,Cluster,Any>

backupClusterSettings()

public UnaryCallSettings<BackupClusterRequest,Operation> backupClusterSettings()

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

Returns
TypeDescription
UnaryCallSettings<BackupClusterRequest,Operation>

createClusterOperationSettings()

public OperationCallSettings<CreateClusterRequest,Cluster,Any> createClusterOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<CreateClusterRequest,Cluster,Any>

createClusterSettings()

public UnaryCallSettings<CreateClusterRequest,Operation> createClusterSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateClusterRequest,Operation>

createStub()

public CloudRedisClusterStub createStub()
Returns
TypeDescription
CloudRedisClusterStub
Exceptions
TypeDescription
IOException

deleteBackupOperationSettings()

public OperationCallSettings<DeleteBackupRequest,Empty,Any> deleteBackupOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<DeleteBackupRequest,Empty,Any>

deleteBackupSettings()

public UnaryCallSettings<DeleteBackupRequest,Operation> deleteBackupSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteBackupRequest,Operation>

deleteClusterOperationSettings()

public OperationCallSettings<DeleteClusterRequest,Empty,Any> deleteClusterOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<DeleteClusterRequest,Empty,Any>

deleteClusterSettings()

public UnaryCallSettings<DeleteClusterRequest,Operation> deleteClusterSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteClusterRequest,Operation>

exportBackupOperationSettings()

public OperationCallSettings<ExportBackupRequest,Backup,Any> exportBackupOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<ExportBackupRequest,Backup,Any>

exportBackupSettings()

public UnaryCallSettings<ExportBackupRequest,Operation> exportBackupSettings()

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

Returns
TypeDescription
UnaryCallSettings<ExportBackupRequest,Operation>

getBackupCollectionSettings()

public UnaryCallSettings<GetBackupCollectionRequest,BackupCollection> getBackupCollectionSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetBackupCollectionRequest,BackupCollection>

getBackupSettings()

public UnaryCallSettings<GetBackupRequest,Backup> getBackupSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetBackupRequest,Backup>

getClusterCertificateAuthoritySettings()

public UnaryCallSettings<GetClusterCertificateAuthorityRequest,CertificateAuthority> getClusterCertificateAuthoritySettings()

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

Returns
TypeDescription
UnaryCallSettings<GetClusterCertificateAuthorityRequest,CertificateAuthority>

getClusterSettings()

public UnaryCallSettings<GetClusterRequest,Cluster> getClusterSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetClusterRequest,Cluster>

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

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

Returns
TypeDescription
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
TypeDescription
String
Overrides

listBackupCollectionsSettings()

public PagedCallSettings<ListBackupCollectionsRequest,ListBackupCollectionsResponse,CloudRedisClusterClient.ListBackupCollectionsPagedResponse> listBackupCollectionsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListBackupCollectionsRequest,ListBackupCollectionsResponse,ListBackupCollectionsPagedResponse>

listBackupsSettings()

public PagedCallSettings<ListBackupsRequest,ListBackupsResponse,CloudRedisClusterClient.ListBackupsPagedResponse> listBackupsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListBackupsRequest,ListBackupsResponse,ListBackupsPagedResponse>

listClustersSettings()

public PagedCallSettings<ListClustersRequest,ListClustersResponse,CloudRedisClusterClient.ListClustersPagedResponse> listClustersSettings()

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

Returns
TypeDescription
PagedCallSettings<ListClustersRequest,ListClustersResponse,ListClustersPagedResponse>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,CloudRedisClusterClient.ListLocationsPagedResponse> listLocationsSettings()

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

Returns
TypeDescription
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

rescheduleClusterMaintenanceOperationSettings()

public OperationCallSettings<RescheduleClusterMaintenanceRequest,Cluster,Any> rescheduleClusterMaintenanceOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<RescheduleClusterMaintenanceRequest,Cluster,Any>

rescheduleClusterMaintenanceSettings()

public UnaryCallSettings<RescheduleClusterMaintenanceRequest,Operation> rescheduleClusterMaintenanceSettings()

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

Returns
TypeDescription
UnaryCallSettings<RescheduleClusterMaintenanceRequest,Operation>

toBuilder()

public CloudRedisClusterStubSettings.Builder toBuilder()

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

Returns
TypeDescription
CloudRedisClusterStubSettings.Builder
Overrides

updateClusterOperationSettings()

public OperationCallSettings<UpdateClusterRequest,Cluster,Any> updateClusterOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<UpdateClusterRequest,Cluster,Any>

updateClusterSettings()

public UnaryCallSettings<UpdateClusterRequest,Operation> updateClusterSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateClusterRequest,Operation>