Package com.google.cloud.redis.v1beta1

Class CloudRedisSettings

  • @BetaApi
@Generated("by gapic-generator-java")
public class CloudRedisSettings
extends com.google.api.gax.rpc.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();

    • Method Detail

      • 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,​com.google.protobuf.Any> 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,​com.google.protobuf.Any> 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,​com.google.protobuf.Any> 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,​com.google.protobuf.Any> 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,​com.google.protobuf.Any> 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,​com.google.protobuf.Any> 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,​com.google.protobuf.Any> 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,​com.google.protobuf.Any> rescheduleMaintenanceOperationSettings()
        Returns the object with the settings used for calls to rescheduleMaintenance.

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

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

      • defaultApiClientHeaderProviderBuilder

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

      • newHttpJsonBuilder

        @BetaApi
public static CloudRedisSettings.Builder newHttpJsonBuilder()
        Returns a new REST builder for this class.

      • newBuilder

        public static CloudRedisSettings.Builder newBuilder​(com.google.api.gax.rpc.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 com.google.api.gax.rpc.ClientSettings<CloudRedisSettings>