com.google.cloud.redis.v1

Class CloudRedisSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<CloudRedisSettings>

com.google.cloud.redis.v1.CloudRedisSettings

@Generated(value="by gapic-generator")
 @BetaApi
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:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CloudRedisSettings.Builder Builder for CloudRedisSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CloudRedisSettings(CloudRedisSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
static CloudRedisSettings	create(CloudRedisStubSettings stub)
OperationCallSettings<com.google.cloud.redis.v1.CreateInstanceRequest,com.google.cloud.redis.v1.Instance,com.google.cloud.redis.v1.OperationMetadata>	createInstanceOperationSettings() Returns the object with the settings used for calls to createInstance.
UnaryCallSettings<com.google.cloud.redis.v1.CreateInstanceRequest,Operation>	createInstanceSettings() Returns the object with the settings used for calls to createInstance.
static ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static TransportChannelProvider	defaultTransportChannelProvider()
OperationCallSettings<com.google.cloud.redis.v1.DeleteInstanceRequest,Empty,com.google.cloud.redis.v1.OperationMetadata>	deleteInstanceOperationSettings() Returns the object with the settings used for calls to deleteInstance.
UnaryCallSettings<com.google.cloud.redis.v1.DeleteInstanceRequest,Operation>	deleteInstanceSettings() Returns the object with the settings used for calls to deleteInstance.
OperationCallSettings<com.google.cloud.redis.v1.FailoverInstanceRequest,com.google.cloud.redis.v1.Instance,com.google.cloud.redis.v1.OperationMetadata>	failoverInstanceOperationSettings() Returns the object with the settings used for calls to failoverInstance.
UnaryCallSettings<com.google.cloud.redis.v1.FailoverInstanceRequest,Operation>	failoverInstanceSettings() Returns the object with the settings used for calls to failoverInstance.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
UnaryCallSettings<com.google.cloud.redis.v1.GetInstanceRequest,com.google.cloud.redis.v1.Instance>	getInstanceSettings() Returns the object with the settings used for calls to getInstance.
PagedCallSettings<com.google.cloud.redis.v1.ListInstancesRequest,com.google.cloud.redis.v1.ListInstancesResponse,CloudRedisClient.ListInstancesPagedResponse>	listInstancesSettings() Returns the object with the settings used for calls to listInstances.
static CloudRedisSettings.Builder	newBuilder() Returns a new builder for this class.
static CloudRedisSettings.Builder	newBuilder(ClientContext clientContext) Returns a new builder for this class.
CloudRedisSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
OperationCallSettings<com.google.cloud.redis.v1.UpdateInstanceRequest,com.google.cloud.redis.v1.Instance,com.google.cloud.redis.v1.OperationMetadata>	updateInstanceOperationSettings() Returns the object with the settings used for calls to updateInstance.
UnaryCallSettings<com.google.cloud.redis.v1.UpdateInstanceRequest,Operation>	updateInstanceSettings() Returns the object with the settings used for calls to updateInstance.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CloudRedisSettings

protected CloudRedisSettings(CloudRedisSettings.Builder settingsBuilder)
                      throws IOException

Throws:

IOException

Method Detail

listInstancesSettings

public PagedCallSettings<com.google.cloud.redis.v1.ListInstancesRequest,com.google.cloud.redis.v1.ListInstancesResponse,CloudRedisClient.ListInstancesPagedResponse> listInstancesSettings()

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

getInstanceSettings

public UnaryCallSettings<com.google.cloud.redis.v1.GetInstanceRequest,com.google.cloud.redis.v1.Instance> getInstanceSettings()

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

createInstanceSettings

public UnaryCallSettings<com.google.cloud.redis.v1.CreateInstanceRequest,Operation> createInstanceSettings()

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

createInstanceOperationSettings

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public OperationCallSettings<com.google.cloud.redis.v1.CreateInstanceRequest,com.google.cloud.redis.v1.Instance,com.google.cloud.redis.v1.OperationMetadata> createInstanceOperationSettings()

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

updateInstanceSettings

public UnaryCallSettings<com.google.cloud.redis.v1.UpdateInstanceRequest,Operation> updateInstanceSettings()

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

updateInstanceOperationSettings

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public OperationCallSettings<com.google.cloud.redis.v1.UpdateInstanceRequest,com.google.cloud.redis.v1.Instance,com.google.cloud.redis.v1.OperationMetadata> updateInstanceOperationSettings()

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

deleteInstanceSettings

public UnaryCallSettings<com.google.cloud.redis.v1.DeleteInstanceRequest,Operation> deleteInstanceSettings()

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

deleteInstanceOperationSettings

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public OperationCallSettings<com.google.cloud.redis.v1.DeleteInstanceRequest,Empty,com.google.cloud.redis.v1.OperationMetadata> deleteInstanceOperationSettings()

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

failoverInstanceSettings

public UnaryCallSettings<com.google.cloud.redis.v1.FailoverInstanceRequest,Operation> failoverInstanceSettings()

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

failoverInstanceOperationSettings

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public OperationCallSettings<com.google.cloud.redis.v1.FailoverInstanceRequest,com.google.cloud.redis.v1.Instance,com.google.cloud.redis.v1.OperationMetadata> failoverInstanceOperationSettings()

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

create

public static final CloudRedisSettings create(CloudRedisStubSettings stub)
                                       throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static CloudRedisSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static CloudRedisSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public CloudRedisSettings.Builder toBuilder()

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

Specified by:

toBuilder in class ClientSettings<CloudRedisSettings>