Service Description: Configures and manages Cloud Memorystore for Redis instances

Google Cloud Memorystore for Redis v1

Theredis.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 GCPregion; 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:

// 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_librarytry(CloudRedisClientcloudRedisClient=CloudRedisClient.create()){InstanceNamename=InstanceName.of("[PROJECT]","[LOCATION]","[INSTANCE]");Instanceresponse=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:

// 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_libraryCloudRedisSettingscloudRedisSettings=CloudRedisSettings.newBuilder().setCredentialsProvider(FixedCredentialsProvider.create(myCredentials)).build();CloudRedisClientcloudRedisClient=CloudRedisClient.create(cloudRedisSettings);

To customize the endpoint:

// 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_libraryCloudRedisSettingscloudRedisSettings=CloudRedisSettings.newBuilder().setEndpoint(myEndpoint).build();CloudRedisClientcloudRedisClient=CloudRedisClient.create(cloudRedisSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:

// 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_libraryCloudRedisSettingscloudRedisSettings=CloudRedisSettings.newHttpJsonBuilder().build();CloudRedisClientcloudRedisClient=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 v1 Theredis.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 GCPregion; for example:
• projects/redpepper-1290/locations/us-central1/instances/my-redis

Configures and manages Cloud Memorystore for Redis instances Google Cloud Memorystore for Redis v1 Theredis.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 GCPregion; for example:
• projects/redpepper-1290/locations/us-central1/instances/my-redis

Configures and manages Cloud Memorystore for Redis instances Google Cloud Memorystore for Redis v1 Theredis.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 GCPregion; for example:
• projects/redpepper-1290/locations/us-central1/instances/my-redis

Configures and manages Cloud Memorystore for Redis instances Google Cloud Memorystore for Redis v1 Theredis.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 GCPregion; for example:
• projects/redpepper-1290/locations/us-central1/instances/my-redis

Configures and manages Cloud Memorystore for Redis instances Google Cloud Memorystore for Redis v1 Theredis.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 GCPregion; for example:
• projects/redpepper-1290/locations/us-central1/instances/my-redis

Settings class to configure an instance ofCloudRedisClient.

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

Builder for CloudRedisSettings.

Request forCreateInstance.

Protobuf typegoogle.cloud.redis.v1.CreateInstanceRequest

Request forCreateInstance.

Protobuf typegoogle.cloud.redis.v1.CreateInstanceRequest

Request forDeleteInstance.

Protobuf typegoogle.cloud.redis.v1.DeleteInstanceRequest

Request forDeleteInstance.

Protobuf typegoogle.cloud.redis.v1.DeleteInstanceRequest

Request forExport.

Protobuf typegoogle.cloud.redis.v1.ExportInstanceRequest

Request forExport.

Protobuf typegoogle.cloud.redis.v1.ExportInstanceRequest

Request forFailover.

Protobuf typegoogle.cloud.redis.v1.FailoverInstanceRequest

Request forFailover.

Protobuf typegoogle.cloud.redis.v1.FailoverInstanceRequest

The Cloud Storage location for the output content

Protobuf typegoogle.cloud.redis.v1.GcsDestination

The Cloud Storage location for the output content

Protobuf typegoogle.cloud.redis.v1.GcsDestination

The Cloud Storage location for the input content

Protobuf typegoogle.cloud.redis.v1.GcsSource

The Cloud Storage location for the input content

Protobuf typegoogle.cloud.redis.v1.GcsSource

Request forGetInstanceAuthString.

Protobuf typegoogle.cloud.redis.v1.GetInstanceAuthStringRequest

Request forGetInstanceAuthString.

Protobuf typegoogle.cloud.redis.v1.GetInstanceAuthStringRequest

Request forGetInstance.

Protobuf typegoogle.cloud.redis.v1.GetInstanceRequest

Request forGetInstance.

Protobuf typegoogle.cloud.redis.v1.GetInstanceRequest

Request forImport.

Protobuf typegoogle.cloud.redis.v1.ImportInstanceRequest

Request forImport.

Protobuf typegoogle.cloud.redis.v1.ImportInstanceRequest

The input content

Protobuf typegoogle.cloud.redis.v1.InputConfig

The input content

Protobuf typegoogle.cloud.redis.v1.InputConfig

A Memorystore for Redis instance.

Protobuf typegoogle.cloud.redis.v1.Instance

A Memorystore for Redis instance.

Protobuf typegoogle.cloud.redis.v1.Instance

Instance AUTH string details.

Protobuf typegoogle.cloud.redis.v1.InstanceAuthString

Instance AUTH string details.

Protobuf typegoogle.cloud.redis.v1.InstanceAuthString

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

Request forListInstances.

Protobuf typegoogle.cloud.redis.v1.ListInstancesRequest

Request forListInstances.

Protobuf typegoogle.cloud.redis.v1.ListInstancesRequest

Response forListInstances.

Protobuf typegoogle.cloud.redis.v1.ListInstancesResponse

Response forListInstances.

Protobuf typegoogle.cloud.redis.v1.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 thegoogle.cloud.location.Location.metadata field.

Protobuf typegoogle.cloud.redis.v1.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 thegoogle.cloud.location.Location.metadata field.

Protobuf typegoogle.cloud.redis.v1.LocationMetadata

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

Maintenance policy for an instance.

Protobuf typegoogle.cloud.redis.v1.MaintenancePolicy

Maintenance policy for an instance.

Protobuf typegoogle.cloud.redis.v1.MaintenancePolicy

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

Protobuf typegoogle.cloud.redis.v1.MaintenanceSchedule

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

Protobuf typegoogle.cloud.redis.v1.MaintenanceSchedule

Node specific properties.

Protobuf typegoogle.cloud.redis.v1.NodeInfo

Node specific properties.

Protobuf typegoogle.cloud.redis.v1.NodeInfo

Represents the v1 metadata of the long-running operation.

Protobuf typegoogle.cloud.redis.v1.OperationMetadata

Represents the v1 metadata of the long-running operation.

Protobuf typegoogle.cloud.redis.v1.OperationMetadata

The output content

Protobuf typegoogle.cloud.redis.v1.OutputConfig

The output content

Protobuf typegoogle.cloud.redis.v1.OutputConfig

Request forRescheduleMaintenance.

Protobuf typegoogle.cloud.redis.v1.RescheduleMaintenanceRequest

Request forRescheduleMaintenance.

Protobuf typegoogle.cloud.redis.v1.RescheduleMaintenanceRequest

TlsCertificate Resource

Protobuf typegoogle.cloud.redis.v1.TlsCertificate

TlsCertificate Resource

Protobuf typegoogle.cloud.redis.v1.TlsCertificate

Request forUpdateInstance.

Protobuf typegoogle.cloud.redis.v1.UpdateInstanceRequest

Request forUpdateInstance.

Protobuf typegoogle.cloud.redis.v1.UpdateInstanceRequest

Request forUpgradeInstance.

Protobuf typegoogle.cloud.redis.v1.UpgradeInstanceRequest

Request forUpgradeInstance.

Protobuf typegoogle.cloud.redis.v1.UpgradeInstanceRequest

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

Protobuf typegoogle.cloud.redis.v1.WeeklyMaintenanceWindow

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

Protobuf typegoogle.cloud.redis.v1.WeeklyMaintenanceWindow

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

Protobuf typegoogle.cloud.redis.v1.ZoneMetadata

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

Protobuf typegoogle.cloud.redis.v1.ZoneMetadata

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

Protobuf enumgoogle.cloud.redis.v1.FailoverInstanceRequest.DataProtectionMode

Available connection modes.

Protobuf enumgoogle.cloud.redis.v1.Instance.ConnectMode

Read replicas mode.

Protobuf enumgoogle.cloud.redis.v1.Instance.ReadReplicasMode

Represents the different states of a Redis instance.

Protobuf enumgoogle.cloud.redis.v1.Instance.State

Available service tiers to choose from

Protobuf enumgoogle.cloud.redis.v1.Instance.Tier

Available TLS modes.

Protobuf enumgoogle.cloud.redis.v1.Instance.TransitEncryptionMode

Reschedule options.

Protobuf enumgoogle.cloud.redis.v1.RescheduleMaintenanceRequest.RescheduleType