Package com.google.cloud.redis.v1beta1 (2.2.0)

Service Description: Configures and manages Cloud Memorystore for Redis instances

Google Cloud Memorystore for Redis v1beta1

The redis.googleapis.com service implements the Google Cloud Memorystore for Redis API and defines the following resource model for managing Redis instances:

• The service works with a collection of cloud projects, named: /projects/*
• Each project has a collection of available locations, named: /locations/*
• Each location has a collection of Redis instances, named: /instances/*
• As such, Redis instances are resources of the form: /projects/{project_id}/locations/{location_id}/instances/{instance_id}

Note that location_id must be referring to a GCP region; for example:

• projects/redpepper-1290/locations/us-central1/instances/my-redis

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 try (CloudRedisClient cloudRedisClient = CloudRedisClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   Instance response = cloudRedisClient.getInstance(name);
 }
 

Note: close() needs to be called on the CloudRedisClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of CloudRedisSettings to create(). For example:

To customize credentials:

 CloudRedisSettings cloudRedisSettings =
     CloudRedisSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CloudRedisClient cloudRedisClient = CloudRedisClient.create(cloudRedisSettings);
 

To customize the endpoint:

 CloudRedisSettings cloudRedisSettings =
     CloudRedisSettings.newBuilder().setEndpoint(myEndpoint).build();
 CloudRedisClient cloudRedisClient = CloudRedisClient.create(cloudRedisSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Configures and manages Cloud Memorystore for Redis instances Google Cloud Memorystore for Redis v1beta1 The redis.googleapis.com service implements the Google Cloud Memorystore for Redis API and defines the following resource model for managing Redis instances:

• The service works with a collection of cloud projects, named: /projects/*
• Each project has a collection of available locations, named: /locations/*
• Each location has a collection of Redis instances, named: /instances/*
• As such, Redis instances are resources of the form: /projects/{project_id}/locations/{location_id}/instances/{instance_id} Note that location_id must be referring to a GCP region; for example:
• projects/redpepper-1290/locations/us-central1/instances/my-redis

Configures and manages Cloud Memorystore for Redis instances Google Cloud Memorystore for Redis v1beta1 The redis.googleapis.com service implements the Google Cloud Memorystore for Redis API and defines the following resource model for managing Redis instances:

• The service works with a collection of cloud projects, named: /projects/*
• Each project has a collection of available locations, named: /locations/*
• Each location has a collection of Redis instances, named: /instances/*
• As such, Redis instances are resources of the form: /projects/{project_id}/locations/{location_id}/instances/{instance_id} Note that location_id must be referring to a GCP region; for example:
• projects/redpepper-1290/locations/us-central1/instances/my-redis

Configures and manages Cloud Memorystore for Redis instances Google Cloud Memorystore for Redis v1beta1 The redis.googleapis.com service implements the Google Cloud Memorystore for Redis API and defines the following resource model for managing Redis instances:

• The service works with a collection of cloud projects, named: /projects/*
• Each project has a collection of available locations, named: /locations/*
• Each location has a collection of Redis instances, named: /instances/*
• As such, Redis instances are resources of the form: /projects/{project_id}/locations/{location_id}/instances/{instance_id} Note that location_id must be referring to a GCP region; for example:
• projects/redpepper-1290/locations/us-central1/instances/my-redis

Configures and manages Cloud Memorystore for Redis instances Google Cloud Memorystore for Redis v1beta1 The redis.googleapis.com service implements the Google Cloud Memorystore for Redis API and defines the following resource model for managing Redis instances:

• The service works with a collection of cloud projects, named: /projects/*
• Each project has a collection of available locations, named: /locations/*
• Each location has a collection of Redis instances, named: /instances/*
• As such, Redis instances are resources of the form: /projects/{project_id}/locations/{location_id}/instances/{instance_id} Note that location_id must be referring to a GCP region; for example:
• projects/redpepper-1290/locations/us-central1/instances/my-redis

Configures and manages Cloud Memorystore for Redis instances Google Cloud Memorystore for Redis v1beta1 The redis.googleapis.com service implements the Google Cloud Memorystore for Redis API and defines the following resource model for managing Redis instances:

• The service works with a collection of cloud projects, named: /projects/*
• Each project has a collection of available locations, named: /locations/*
• Each location has a collection of Redis instances, named: /instances/*
• As such, Redis instances are resources of the form: /projects/{project_id}/locations/{location_id}/instances/{instance_id} Note that location_id must be referring to a GCP region; for example:
• projects/redpepper-1290/locations/us-central1/instances/my-redis

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

Builder for CloudRedisSettings.

Request for CreateInstance.

Protobuf type google.cloud.redis.v1beta1.CreateInstanceRequest

Request for CreateInstance.

Protobuf type google.cloud.redis.v1beta1.CreateInstanceRequest

Request for DeleteInstance.

Protobuf type google.cloud.redis.v1beta1.DeleteInstanceRequest

Request for DeleteInstance.

Protobuf type google.cloud.redis.v1beta1.DeleteInstanceRequest

Request for Export.

Protobuf type google.cloud.redis.v1beta1.ExportInstanceRequest

Request for Export.

Protobuf type google.cloud.redis.v1beta1.ExportInstanceRequest

Request for Failover.

Protobuf type google.cloud.redis.v1beta1.FailoverInstanceRequest

Request for Failover.

Protobuf type google.cloud.redis.v1beta1.FailoverInstanceRequest

The Cloud Storage location for the output content

Protobuf type google.cloud.redis.v1beta1.GcsDestination

The Cloud Storage location for the output content

Protobuf type google.cloud.redis.v1beta1.GcsDestination

The Cloud Storage location for the input content

Protobuf type google.cloud.redis.v1beta1.GcsSource

The Cloud Storage location for the input content

Protobuf type google.cloud.redis.v1beta1.GcsSource

Request for GetInstanceAuthString.

Protobuf type google.cloud.redis.v1beta1.GetInstanceAuthStringRequest

Request for GetInstanceAuthString.

Protobuf type google.cloud.redis.v1beta1.GetInstanceAuthStringRequest

Request for GetInstance.

Protobuf type google.cloud.redis.v1beta1.GetInstanceRequest

Request for GetInstance.

Protobuf type google.cloud.redis.v1beta1.GetInstanceRequest

Request for Import.

Protobuf type google.cloud.redis.v1beta1.ImportInstanceRequest

Request for Import.

Protobuf type google.cloud.redis.v1beta1.ImportInstanceRequest

The input content

Protobuf type google.cloud.redis.v1beta1.InputConfig

The input content

Protobuf type google.cloud.redis.v1beta1.InputConfig

A Google Cloud Redis instance.

Protobuf type google.cloud.redis.v1beta1.Instance

A Google Cloud Redis instance.

Protobuf type google.cloud.redis.v1beta1.Instance

Instance AUTH string details.

Protobuf type google.cloud.redis.v1beta1.InstanceAuthString

Instance AUTH string details.

Protobuf type google.cloud.redis.v1beta1.InstanceAuthString

Builder for projects/{project}/locations/{location}/instances/{instance}.

Request for ListInstances.

Protobuf type google.cloud.redis.v1beta1.ListInstancesRequest

Request for ListInstances.

Protobuf type google.cloud.redis.v1beta1.ListInstancesRequest

Response for ListInstances.

Protobuf type google.cloud.redis.v1beta1.ListInstancesResponse

Response for ListInstances.

Protobuf type google.cloud.redis.v1beta1.ListInstancesResponse

This location metadata represents additional configuration options for a given location where a Redis instance may be created. All fields are output only. It is returned as content of the google.cloud.location.Location.metadata field.

Protobuf type google.cloud.redis.v1beta1.LocationMetadata

This location metadata represents additional configuration options for a given location where a Redis instance may be created. All fields are output only. It is returned as content of the google.cloud.location.Location.metadata field.

Protobuf type google.cloud.redis.v1beta1.LocationMetadata

Builder for projects/{project}/locations/{location}.

Maintenance policy for an instance.

Protobuf type google.cloud.redis.v1beta1.MaintenancePolicy

Maintenance policy for an instance.

Protobuf type google.cloud.redis.v1beta1.MaintenancePolicy

Upcoming maintenance schedule. If no maintenance is scheduled, fields are not populated.

Protobuf type google.cloud.redis.v1beta1.MaintenanceSchedule

Upcoming maintenance schedule. If no maintenance is scheduled, fields are not populated.

Protobuf type google.cloud.redis.v1beta1.MaintenanceSchedule

Node specific properties.

Protobuf type google.cloud.redis.v1beta1.NodeInfo

Node specific properties.

Protobuf type google.cloud.redis.v1beta1.NodeInfo

The output content

Protobuf type google.cloud.redis.v1beta1.OutputConfig

The output content

Protobuf type google.cloud.redis.v1beta1.OutputConfig

Configuration of the persistence functionality.

Protobuf type google.cloud.redis.v1beta1.PersistenceConfig

Configuration of the persistence functionality.

Protobuf type google.cloud.redis.v1beta1.PersistenceConfig

Request for RescheduleMaintenance.

Protobuf type google.cloud.redis.v1beta1.RescheduleMaintenanceRequest

Request for RescheduleMaintenance.

Protobuf type google.cloud.redis.v1beta1.RescheduleMaintenanceRequest

TlsCertificate Resource

Protobuf type google.cloud.redis.v1beta1.TlsCertificate

TlsCertificate Resource

Protobuf type google.cloud.redis.v1beta1.TlsCertificate

Request for UpdateInstance.

Protobuf type google.cloud.redis.v1beta1.UpdateInstanceRequest

Request for UpdateInstance.

Protobuf type google.cloud.redis.v1beta1.UpdateInstanceRequest

Request for UpgradeInstance.

Protobuf type google.cloud.redis.v1beta1.UpgradeInstanceRequest

Request for UpgradeInstance.

Protobuf type google.cloud.redis.v1beta1.UpgradeInstanceRequest

Time window in which disruptive maintenance updates occur. Non-disruptive updates can occur inside or outside this window.

Protobuf type google.cloud.redis.v1beta1.WeeklyMaintenanceWindow

Time window in which disruptive maintenance updates occur. Non-disruptive updates can occur inside or outside this window.

Protobuf type google.cloud.redis.v1beta1.WeeklyMaintenanceWindow

Defines specific information for a particular zone. Currently empty and reserved for future use only.

Protobuf type google.cloud.redis.v1beta1.ZoneMetadata

Defines specific information for a particular zone. Currently empty and reserved for future use only.

Protobuf type google.cloud.redis.v1beta1.ZoneMetadata

Specifies different modes of operation in relation to the data retention.

Protobuf enum google.cloud.redis.v1beta1.FailoverInstanceRequest.DataProtectionMode

Available connection modes.

Protobuf enum google.cloud.redis.v1beta1.Instance.ConnectMode

Read replicas mode.

Protobuf enum google.cloud.redis.v1beta1.Instance.ReadReplicasMode

Represents the different states of a Redis instance.

Protobuf enum google.cloud.redis.v1beta1.Instance.State

Available service tiers to choose from

Protobuf enum google.cloud.redis.v1beta1.Instance.Tier

Available TLS modes.

Protobuf enum google.cloud.redis.v1beta1.Instance.TransitEncryptionMode

Available Persistence modes.

Protobuf enum google.cloud.redis.v1beta1.PersistenceConfig.PersistenceMode

Available snapshot periods for scheduling.

Protobuf enum google.cloud.redis.v1beta1.PersistenceConfig.SnapshotPeriod

Reschedule options.

Protobuf enum google.cloud.redis.v1beta1.RescheduleMaintenanceRequest.RescheduleType