Class CloudRedisSettings (2.11.0)

Version 2.11.0

• 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.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.5
• 2.5.0
• 2.4.1
• 2.3.0
• 2.2.0
• 2.1.1

public class CloudRedisSettings extends ClientSettings<CloudRedisSettings>

Settings class to configure an instance of CloudRedisClient.

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 total timeout of getInstance to 30 seconds:

 // 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
 CloudRedisSettings.Builder cloudRedisSettingsBuilder = CloudRedisSettings.newBuilder();
 cloudRedisSettingsBuilder
     .getInstanceSettings()
     .setRetrySettings(
         cloudRedisSettingsBuilder
             .getInstanceSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CloudRedisSettings cloudRedisSettings = cloudRedisSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > CloudRedisSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.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

create(CloudRedisStubSettings stub)

public static final CloudRedisSettings create(CloudRedisStubSettings stub)

Parameter

Name	Description
stub	CloudRedisStubSettings

Returns

Type	Description
CloudRedisSettings

Exceptions

Type	Description
IOException

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

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

Returns

Type	Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

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

Returns a new gRPC builder for this class.

Returns

Type	Description
CloudRedisSettings.Builder

newBuilder(ClientContext clientContext)

public static CloudRedisSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
clientContext	ClientContext

Returns

Type	Description
CloudRedisSettings.Builder

newHttpJsonBuilder()

public static CloudRedisSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns

Type	Description
CloudRedisSettings.Builder

Constructors

CloudRedisSettings(CloudRedisSettings.Builder settingsBuilder)

protected CloudRedisSettings(CloudRedisSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	CloudRedisSettings.Builder

Methods

createInstanceOperationSettings()

public OperationCallSettings<CreateInstanceRequest,Instance,Any> createInstanceOperationSettings()

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

Returns

Type	Description
OperationCallSettings<CreateInstanceRequest,Instance,Any>

createInstanceSettings()

public UnaryCallSettings<CreateInstanceRequest,Operation> createInstanceSettings()

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

Returns

Type	Description
UnaryCallSettings<CreateInstanceRequest,Operation>

deleteInstanceOperationSettings()

public OperationCallSettings<DeleteInstanceRequest,Empty,Any> deleteInstanceOperationSettings()

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

Returns

Type	Description
OperationCallSettings<DeleteInstanceRequest,Empty,Any>

deleteInstanceSettings()

public UnaryCallSettings<DeleteInstanceRequest,Operation> deleteInstanceSettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteInstanceRequest,Operation>

exportInstanceOperationSettings()

public OperationCallSettings<ExportInstanceRequest,Instance,Any> exportInstanceOperationSettings()

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

Returns

Type	Description
OperationCallSettings<ExportInstanceRequest,Instance,Any>

exportInstanceSettings()

public UnaryCallSettings<ExportInstanceRequest,Operation> exportInstanceSettings()

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

Returns

Type	Description
UnaryCallSettings<ExportInstanceRequest,Operation>

failoverInstanceOperationSettings()

public OperationCallSettings<FailoverInstanceRequest,Instance,Any> failoverInstanceOperationSettings()

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

Returns

Type	Description
OperationCallSettings<FailoverInstanceRequest,Instance,Any>

failoverInstanceSettings()

public UnaryCallSettings<FailoverInstanceRequest,Operation> failoverInstanceSettings()

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

Returns

Type	Description
UnaryCallSettings<FailoverInstanceRequest,Operation>

getInstanceAuthStringSettings()

public UnaryCallSettings<GetInstanceAuthStringRequest,InstanceAuthString> getInstanceAuthStringSettings()

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

Returns

Type	Description
UnaryCallSettings<GetInstanceAuthStringRequest,InstanceAuthString>

getInstanceSettings()

public UnaryCallSettings<GetInstanceRequest,Instance> getInstanceSettings()

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

Returns

Type	Description
UnaryCallSettings<GetInstanceRequest,Instance>

importInstanceOperationSettings()

public OperationCallSettings<ImportInstanceRequest,Instance,Any> importInstanceOperationSettings()

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

Returns

Type	Description
OperationCallSettings<ImportInstanceRequest,Instance,Any>

importInstanceSettings()

public UnaryCallSettings<ImportInstanceRequest,Operation> importInstanceSettings()

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

Returns

Type	Description
UnaryCallSettings<ImportInstanceRequest,Operation>

listInstancesSettings()

public PagedCallSettings<ListInstancesRequest,ListInstancesResponse,CloudRedisClient.ListInstancesPagedResponse> listInstancesSettings()

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

Returns

Type	Description
PagedCallSettings<ListInstancesRequest,ListInstancesResponse,ListInstancesPagedResponse>

rescheduleMaintenanceOperationSettings()

public OperationCallSettings<RescheduleMaintenanceRequest,Instance,Any> rescheduleMaintenanceOperationSettings()

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

Returns

Type	Description
OperationCallSettings<RescheduleMaintenanceRequest,Instance,Any>

rescheduleMaintenanceSettings()

public UnaryCallSettings<RescheduleMaintenanceRequest,Operation> rescheduleMaintenanceSettings()

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

Returns

Type	Description
UnaryCallSettings<RescheduleMaintenanceRequest,Operation>

toBuilder()

public CloudRedisSettings.Builder toBuilder()

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

Returns

Type	Description
CloudRedisSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateInstanceOperationSettings()

public OperationCallSettings<UpdateInstanceRequest,Instance,Any> updateInstanceOperationSettings()

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

Returns

Type	Description
OperationCallSettings<UpdateInstanceRequest,Instance,Any>

updateInstanceSettings()

public UnaryCallSettings<UpdateInstanceRequest,Operation> updateInstanceSettings()

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

Returns

Type	Description
UnaryCallSettings<UpdateInstanceRequest,Operation>

upgradeInstanceOperationSettings()

public OperationCallSettings<UpgradeInstanceRequest,Instance,Any> upgradeInstanceOperationSettings()

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

Returns

Type	Description
OperationCallSettings<UpgradeInstanceRequest,Instance,Any>

upgradeInstanceSettings()

public UnaryCallSettings<UpgradeInstanceRequest,Operation> upgradeInstanceSettings()

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

Returns

Type	Description
UnaryCallSettings<UpgradeInstanceRequest,Operation>