com.google.cloud.redis.v1.stub

Class CloudRedisStubSettings

java.lang.Object

com.google.api.gax.rpc.StubSettings<CloudRedisStubSettings>

com.google.cloud.redis.v1.stub.CloudRedisStubSettings

@Generated(value="by gapic-generator-java")
public class CloudRedisStubSettings
extends com.google.api.gax.rpc.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:

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

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.OperationCallSettings<CreateInstanceRequest,Instance,OperationMetadata>	createInstanceOperationSettings() Returns the object with the settings used for calls to createInstance.
com.google.api.gax.rpc.UnaryCallSettings<CreateInstanceRequest,com.google.longrunning.Operation>	createInstanceSettings() Returns the object with the settings used for calls to createInstance.
CloudRedisStub	createStub()
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultGrpcApiClientHeaderProviderBuilder()
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default gRPC ChannelProvider for this service.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultHttpJsonApiClientHeaderProviderBuilder()
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default REST ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.OperationCallSettings<DeleteInstanceRequest,com.google.protobuf.Empty,OperationMetadata>	deleteInstanceOperationSettings() Returns the object with the settings used for calls to deleteInstance.
com.google.api.gax.rpc.UnaryCallSettings<DeleteInstanceRequest,com.google.longrunning.Operation>	deleteInstanceSettings() Returns the object with the settings used for calls to deleteInstance.
com.google.api.gax.rpc.OperationCallSettings<ExportInstanceRequest,Instance,OperationMetadata>	exportInstanceOperationSettings() Returns the object with the settings used for calls to exportInstance.
com.google.api.gax.rpc.UnaryCallSettings<ExportInstanceRequest,com.google.longrunning.Operation>	exportInstanceSettings() Returns the object with the settings used for calls to exportInstance.
com.google.api.gax.rpc.OperationCallSettings<FailoverInstanceRequest,Instance,OperationMetadata>	failoverInstanceOperationSettings() Returns the object with the settings used for calls to failoverInstance.
com.google.api.gax.rpc.UnaryCallSettings<FailoverInstanceRequest,com.google.longrunning.Operation>	failoverInstanceSettings() Returns the object with the settings used for calls to failoverInstance.
static String	getDefaultEndpoint() Returns the default service endpoint.
static String	getDefaultMtlsEndpoint() Returns the default mTLS service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
String	getEndpoint() Returns the endpoint set by the user or the the service's default endpoint.
com.google.api.gax.rpc.UnaryCallSettings<GetInstanceAuthStringRequest,InstanceAuthString>	getInstanceAuthStringSettings() Returns the object with the settings used for calls to getInstanceAuthString.
com.google.api.gax.rpc.UnaryCallSettings<GetInstanceRequest,Instance>	getInstanceSettings() Returns the object with the settings used for calls to getInstance.
com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>	getLocationSettings() Returns the object with the settings used for calls to getLocation.
String	getServiceName() Returns the default service name.
com.google.api.gax.rpc.OperationCallSettings<ImportInstanceRequest,Instance,OperationMetadata>	importInstanceOperationSettings() Returns the object with the settings used for calls to importInstance.
com.google.api.gax.rpc.UnaryCallSettings<ImportInstanceRequest,com.google.longrunning.Operation>	importInstanceSettings() Returns the object with the settings used for calls to importInstance.
com.google.api.gax.rpc.PagedCallSettings<ListInstancesRequest,ListInstancesResponse,CloudRedisClient.ListInstancesPagedResponse>	listInstancesSettings() Returns the object with the settings used for calls to listInstances.
com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,CloudRedisClient.ListLocationsPagedResponse>	listLocationsSettings() Returns the object with the settings used for calls to listLocations.
static CloudRedisStubSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static CloudRedisStubSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static CloudRedisStubSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
com.google.api.gax.rpc.OperationCallSettings<RescheduleMaintenanceRequest,Instance,OperationMetadata>	rescheduleMaintenanceOperationSettings() Returns the object with the settings used for calls to rescheduleMaintenance.
com.google.api.gax.rpc.UnaryCallSettings<RescheduleMaintenanceRequest,com.google.longrunning.Operation>	rescheduleMaintenanceSettings() Returns the object with the settings used for calls to rescheduleMaintenance.
CloudRedisStubSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.OperationCallSettings<UpdateInstanceRequest,Instance,OperationMetadata>	updateInstanceOperationSettings() Returns the object with the settings used for calls to updateInstance.
com.google.api.gax.rpc.UnaryCallSettings<UpdateInstanceRequest,com.google.longrunning.Operation>	updateInstanceSettings() Returns the object with the settings used for calls to updateInstance.
com.google.api.gax.rpc.OperationCallSettings<UpgradeInstanceRequest,Instance,OperationMetadata>	upgradeInstanceOperationSettings() Returns the object with the settings used for calls to upgradeInstance.
com.google.api.gax.rpc.UnaryCallSettings<UpgradeInstanceRequest,com.google.longrunning.Operation>	upgradeInstanceSettings() Returns the object with the settings used for calls to upgradeInstance.

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

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, getUniverseDomain, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CloudRedisStubSettings

protected CloudRedisStubSettings(CloudRedisStubSettings.Builder settingsBuilder)
                          throws IOException

Throws:

IOException

Method Detail

listInstancesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListInstancesRequest,ListInstancesResponse,CloudRedisClient.ListInstancesPagedResponse> listInstancesSettings()

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

getInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetInstanceRequest,Instance> getInstanceSettings()

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

getInstanceAuthStringSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetInstanceAuthStringRequest,InstanceAuthString> getInstanceAuthStringSettings()

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

createInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateInstanceRequest,com.google.longrunning.Operation> createInstanceSettings()

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

createInstanceOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateInstanceRequest,Instance,OperationMetadata> createInstanceOperationSettings()

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

updateInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateInstanceRequest,com.google.longrunning.Operation> updateInstanceSettings()

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

updateInstanceOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateInstanceRequest,Instance,OperationMetadata> updateInstanceOperationSettings()

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

upgradeInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpgradeInstanceRequest,com.google.longrunning.Operation> upgradeInstanceSettings()

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

upgradeInstanceOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpgradeInstanceRequest,Instance,OperationMetadata> upgradeInstanceOperationSettings()

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

importInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<ImportInstanceRequest,com.google.longrunning.Operation> importInstanceSettings()

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

importInstanceOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<ImportInstanceRequest,Instance,OperationMetadata> importInstanceOperationSettings()

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

exportInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<ExportInstanceRequest,com.google.longrunning.Operation> exportInstanceSettings()

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

exportInstanceOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<ExportInstanceRequest,Instance,OperationMetadata> exportInstanceOperationSettings()

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

failoverInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<FailoverInstanceRequest,com.google.longrunning.Operation> failoverInstanceSettings()

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

failoverInstanceOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<FailoverInstanceRequest,Instance,OperationMetadata> failoverInstanceOperationSettings()

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

deleteInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteInstanceRequest,com.google.longrunning.Operation> deleteInstanceSettings()

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

deleteInstanceOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteInstanceRequest,com.google.protobuf.Empty,OperationMetadata> deleteInstanceOperationSettings()

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

rescheduleMaintenanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<RescheduleMaintenanceRequest,com.google.longrunning.Operation> rescheduleMaintenanceSettings()

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

rescheduleMaintenanceOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<RescheduleMaintenanceRequest,Instance,OperationMetadata> rescheduleMaintenanceOperationSettings()

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

listLocationsSettings

public com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,CloudRedisClient.ListLocationsPagedResponse> listLocationsSettings()

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

getLocationSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> getLocationSettings()

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

createStub

public CloudRedisStub createStub()
                          throws IOException

Throws:

IOException

getEndpoint

public String getEndpoint()

Returns the endpoint set by the user or the the service's default endpoint.

Overrides:

getEndpoint in class com.google.api.gax.rpc.StubSettings<CloudRedisStubSettings>

getServiceName

public String getServiceName()

Returns the default service name.

Overrides:

getServiceName in class com.google.api.gax.rpc.StubSettings<CloudRedisStubSettings>

defaultExecutorProviderBuilder

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultMtlsEndpoint

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

defaultHttpJsonTransportProviderBuilder

@BetaApi
public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultGrpcApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()

defaultHttpJsonApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()

defaultApiClientHeaderProviderBuilder

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static CloudRedisStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

public static CloudRedisStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

public static CloudRedisStubSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public CloudRedisStubSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.StubSettings<CloudRedisStubSettings>