Class CloudRedisStubSettings (2.3.0)

public class CloudRedisStubSettings extends StubSettings<CloudRedisStubSettings>

Settings class to configure an instance of CloudRedisStub.

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:


 CloudRedisStubSettings.Builder cloudRedisSettingsBuilder = CloudRedisStubSettings.newBuilder();
 cloudRedisSettingsBuilder
     .getInstanceSettings()
     .setRetrySettings(
         cloudRedisSettingsBuilder
             .getInstanceSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CloudRedisStubSettings cloudRedisSettings = cloudRedisSettingsBuilder.build();
 

Inheritance

java.lang.Object > StubSettings > CloudRedisStubSettings

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

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default 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 CloudRedisStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
CloudRedisStubSettings.Builder

newBuilder(ClientContext clientContext)

public static CloudRedisStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
CloudRedisStubSettings.Builder

Constructors

CloudRedisStubSettings(CloudRedisStubSettings.Builder settingsBuilder)

protected CloudRedisStubSettings(CloudRedisStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderCloudRedisStubSettings.Builder

Methods

createInstanceOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreateInstanceRequest,Instance,OperationMetadata>

createInstanceSettings()

public UnaryCallSettings<CreateInstanceRequest,Operation> createInstanceSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateInstanceRequest,Operation>

createStub()

public CloudRedisStub createStub()
Returns
TypeDescription
CloudRedisStub
Exceptions
TypeDescription
IOException

deleteInstanceOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteInstanceRequest,Empty,OperationMetadata>

deleteInstanceSettings()

public UnaryCallSettings<DeleteInstanceRequest,Operation> deleteInstanceSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteInstanceRequest,Operation>

exportInstanceOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<ExportInstanceRequest,Instance,OperationMetadata>

exportInstanceSettings()

public UnaryCallSettings<ExportInstanceRequest,Operation> exportInstanceSettings()

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

Returns
TypeDescription
UnaryCallSettings<ExportInstanceRequest,Operation>

failoverInstanceOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<FailoverInstanceRequest,Instance,OperationMetadata>

failoverInstanceSettings()

public UnaryCallSettings<FailoverInstanceRequest,Operation> failoverInstanceSettings()

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

Returns
TypeDescription
UnaryCallSettings<FailoverInstanceRequest,Operation>

getInstanceSettings()

public UnaryCallSettings<GetInstanceRequest,Instance> getInstanceSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetInstanceRequest,Instance>

importInstanceOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<ImportInstanceRequest,Instance,OperationMetadata>

importInstanceSettings()

public UnaryCallSettings<ImportInstanceRequest,Operation> importInstanceSettings()

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

Returns
TypeDescription
UnaryCallSettings<ImportInstanceRequest,Operation>

listInstancesSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListInstancesRequest,ListInstancesResponse,ListInstancesPagedResponse>

toBuilder()

public CloudRedisStubSettings.Builder toBuilder()

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

Returns
TypeDescription
CloudRedisStubSettings.Builder
Overrides

updateInstanceOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<UpdateInstanceRequest,Instance,OperationMetadata>

updateInstanceSettings()

public UnaryCallSettings<UpdateInstanceRequest,Operation> updateInstanceSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateInstanceRequest,Operation>

upgradeInstanceOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<UpgradeInstanceRequest,Instance,OperationMetadata>

upgradeInstanceSettings()

public UnaryCallSettings<UpgradeInstanceRequest,Operation> upgradeInstanceSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpgradeInstanceRequest,Operation>