com.google.cloud.redis.v1

Class CloudRedisClient

java.lang.Object

com.google.cloud.redis.v1.CloudRedisClient

All Implemented Interfaces:

BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
 @BetaApi
public class CloudRedisClient
extends Object
implements BackgroundResource

Service Description: Configures and manages Cloud Memorystore for Redis instances

Google Cloud Memorystore for Redis v1

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);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CloudRedisClient.ListInstancesFixedSizeCollection
static class	CloudRedisClient.ListInstancesPage
static class	CloudRedisClient.ListInstancesPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CloudRedisClient(CloudRedisSettings settings) Constructs an instance of CloudRedisClient, using the given settings.
protected	CloudRedisClient(CloudRedisStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static CloudRedisClient	create() Constructs an instance of CloudRedisClient with default settings.
static CloudRedisClient	create(CloudRedisSettings settings) Constructs an instance of CloudRedisClient, using the given settings.
static CloudRedisClient	create(CloudRedisStub stub) Constructs an instance of CloudRedisClient, using the given stub for making calls.
OperationFuture<com.google.cloud.redis.v1.Instance,com.google.cloud.redis.v1.OperationMetadata>	createInstanceAsync(com.google.cloud.redis.v1.CreateInstanceRequest request) Creates a Redis instance based on the specified tier and memory size.
OperationFuture<com.google.cloud.redis.v1.Instance,com.google.cloud.redis.v1.OperationMetadata>	createInstanceAsync(com.google.cloud.redis.v1.LocationName parent, String instanceId, com.google.cloud.redis.v1.Instance instance) Creates a Redis instance based on the specified tier and memory size.
OperationFuture<com.google.cloud.redis.v1.Instance,com.google.cloud.redis.v1.OperationMetadata>	createInstanceAsync(String parent, String instanceId, com.google.cloud.redis.v1.Instance instance) Creates a Redis instance based on the specified tier and memory size.
UnaryCallable<com.google.cloud.redis.v1.CreateInstanceRequest,Operation>	createInstanceCallable() Creates a Redis instance based on the specified tier and memory size.
OperationCallable<com.google.cloud.redis.v1.CreateInstanceRequest,com.google.cloud.redis.v1.Instance,com.google.cloud.redis.v1.OperationMetadata>	createInstanceOperationCallable() Creates a Redis instance based on the specified tier and memory size.
OperationFuture<Empty,com.google.cloud.redis.v1.OperationMetadata>	deleteInstanceAsync(com.google.cloud.redis.v1.DeleteInstanceRequest request) Deletes a specific Redis instance.
OperationFuture<Empty,com.google.cloud.redis.v1.OperationMetadata>	deleteInstanceAsync(com.google.cloud.redis.v1.InstanceName name) Deletes a specific Redis instance.
OperationFuture<Empty,com.google.cloud.redis.v1.OperationMetadata>	deleteInstanceAsync(String name) Deletes a specific Redis instance.
UnaryCallable<com.google.cloud.redis.v1.DeleteInstanceRequest,Operation>	deleteInstanceCallable() Deletes a specific Redis instance.
OperationCallable<com.google.cloud.redis.v1.DeleteInstanceRequest,Empty,com.google.cloud.redis.v1.OperationMetadata>	deleteInstanceOperationCallable() Deletes a specific Redis instance.
OperationFuture<com.google.cloud.redis.v1.Instance,com.google.cloud.redis.v1.OperationMetadata>	failoverInstanceAsync(com.google.cloud.redis.v1.FailoverInstanceRequest request) Failover the master role to current replica node against a specific STANDARD tier redis instance.
OperationFuture<com.google.cloud.redis.v1.Instance,com.google.cloud.redis.v1.OperationMetadata>	failoverInstanceAsync(com.google.cloud.redis.v1.InstanceName name, com.google.cloud.redis.v1.FailoverInstanceRequest.DataProtectionMode dataProtectionMode) Failover the master role to current replica node against a specific STANDARD tier redis instance.
OperationFuture<com.google.cloud.redis.v1.Instance,com.google.cloud.redis.v1.OperationMetadata>	failoverInstanceAsync(String name, com.google.cloud.redis.v1.FailoverInstanceRequest.DataProtectionMode dataProtectionMode) Failover the master role to current replica node against a specific STANDARD tier redis instance.
UnaryCallable<com.google.cloud.redis.v1.FailoverInstanceRequest,Operation>	failoverInstanceCallable() Failover the master role to current replica node against a specific STANDARD tier redis instance.
OperationCallable<com.google.cloud.redis.v1.FailoverInstanceRequest,com.google.cloud.redis.v1.Instance,com.google.cloud.redis.v1.OperationMetadata>	failoverInstanceOperationCallable() Failover the master role to current replica node against a specific STANDARD tier redis instance.
com.google.cloud.redis.v1.Instance	getInstance(com.google.cloud.redis.v1.GetInstanceRequest request) Gets the details of a specific Redis instance.
com.google.cloud.redis.v1.Instance	getInstance(com.google.cloud.redis.v1.InstanceName name) Gets the details of a specific Redis instance.
com.google.cloud.redis.v1.Instance	getInstance(String name) Gets the details of a specific Redis instance.
UnaryCallable<com.google.cloud.redis.v1.GetInstanceRequest,com.google.cloud.redis.v1.Instance>	getInstanceCallable() Gets the details of a specific Redis instance.
OperationsClient	getOperationsClient() Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
CloudRedisSettings	getSettings()
CloudRedisStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
CloudRedisClient.ListInstancesPagedResponse	listInstances(com.google.cloud.redis.v1.ListInstancesRequest request) Lists all Redis instances owned by a project in either the specified location (region) or all locations.
CloudRedisClient.ListInstancesPagedResponse	listInstances(com.google.cloud.redis.v1.LocationName parent) Lists all Redis instances owned by a project in either the specified location (region) or all locations.
CloudRedisClient.ListInstancesPagedResponse	listInstances(String parent) Lists all Redis instances owned by a project in either the specified location (region) or all locations.
UnaryCallable<com.google.cloud.redis.v1.ListInstancesRequest,com.google.cloud.redis.v1.ListInstancesResponse>	listInstancesCallable() Lists all Redis instances owned by a project in either the specified location (region) or all locations.
UnaryCallable<com.google.cloud.redis.v1.ListInstancesRequest,CloudRedisClient.ListInstancesPagedResponse>	listInstancesPagedCallable() Lists all Redis instances owned by a project in either the specified location (region) or all locations.
void	shutdown()
void	shutdownNow()
OperationFuture<com.google.cloud.redis.v1.Instance,com.google.cloud.redis.v1.OperationMetadata>	updateInstanceAsync(FieldMask updateMask, com.google.cloud.redis.v1.Instance instance) Updates the metadata and configuration of a specific Redis instance.
OperationFuture<com.google.cloud.redis.v1.Instance,com.google.cloud.redis.v1.OperationMetadata>	updateInstanceAsync(com.google.cloud.redis.v1.UpdateInstanceRequest request) Updates the metadata and configuration of a specific Redis instance.
UnaryCallable<com.google.cloud.redis.v1.UpdateInstanceRequest,Operation>	updateInstanceCallable() Updates the metadata and configuration of a specific Redis instance.
OperationCallable<com.google.cloud.redis.v1.UpdateInstanceRequest,com.google.cloud.redis.v1.Instance,com.google.cloud.redis.v1.OperationMetadata>	updateInstanceOperationCallable() Updates the metadata and configuration of a specific Redis instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

CloudRedisClient

protected CloudRedisClient(CloudRedisSettings settings)
                    throws IOException

Constructs an instance of CloudRedisClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

CloudRedisClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected CloudRedisClient(CloudRedisStub stub)

Method Detail

create

public static final CloudRedisClient create()
                                     throws IOException

Constructs an instance of CloudRedisClient with default settings.

Throws:

IOException

create

public static final CloudRedisClient create(CloudRedisSettings settings)
                                     throws IOException

Constructs an instance of CloudRedisClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final CloudRedisClient create(CloudRedisStub stub)

Constructs an instance of CloudRedisClient, using the given stub for making calls. This is for advanced usage - prefer to use CloudRedisSettings}.

getSettings

public final CloudRedisSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public CloudRedisStub getStub()

getOperationsClient

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

listInstances

public final CloudRedisClient.ListInstancesPagedResponse listInstances(com.google.cloud.redis.v1.LocationName parent)

Lists all Redis instances owned by a project in either the specified location (region) or all locations.

The location should have the following format: * `projects/{project_id}/locations/{location_id}`

If `location_id` is specified as `-` (wildcard), then all regions available to the project are queried, and the results are aggregated.

Sample code:

 try (CloudRedisClient cloudRedisClient = CloudRedisClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Instance element : cloudRedisClient.listInstances(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region

Throws:

ApiException - if the remote call fails

listInstances

public final CloudRedisClient.ListInstancesPagedResponse listInstances(String parent)

Lists all Redis instances owned by a project in either the specified location (region) or all locations.

The location should have the following format: * `projects/{project_id}/locations/{location_id}`

If `location_id` is specified as `-` (wildcard), then all regions available to the project are queried, and the results are aggregated.

Sample code:

 try (CloudRedisClient cloudRedisClient = CloudRedisClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Instance element : cloudRedisClient.listInstances(parent.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region

Throws:

ApiException - if the remote call fails

listInstances

public final CloudRedisClient.ListInstancesPagedResponse listInstances(com.google.cloud.redis.v1.ListInstancesRequest request)

Lists all Redis instances owned by a project in either the specified location (region) or all locations.

The location should have the following format: * `projects/{project_id}/locations/{location_id}`

If `location_id` is specified as `-` (wildcard), then all regions available to the project are queried, and the results are aggregated.

Sample code:

 try (CloudRedisClient cloudRedisClient = CloudRedisClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ListInstancesRequest request = ListInstancesRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   for (Instance element : cloudRedisClient.listInstances(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

listInstancesPagedCallable

public final UnaryCallable<com.google.cloud.redis.v1.ListInstancesRequest,CloudRedisClient.ListInstancesPagedResponse> listInstancesPagedCallable()

Lists all Redis instances owned by a project in either the specified location (region) or all locations.

The location should have the following format: * `projects/{project_id}/locations/{location_id}`

If `location_id` is specified as `-` (wildcard), then all regions available to the project are queried, and the results are aggregated.

Sample code:

 try (CloudRedisClient cloudRedisClient = CloudRedisClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ListInstancesRequest request = ListInstancesRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ApiFuture<ListInstancesPagedResponse> future = cloudRedisClient.listInstancesPagedCallable().futureCall(request);
   // Do something
   for (Instance element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listInstancesCallable

public final UnaryCallable<com.google.cloud.redis.v1.ListInstancesRequest,com.google.cloud.redis.v1.ListInstancesResponse> listInstancesCallable()

Lists all Redis instances owned by a project in either the specified location (region) or all locations.

The location should have the following format: * `projects/{project_id}/locations/{location_id}`

If `location_id` is specified as `-` (wildcard), then all regions available to the project are queried, and the results are aggregated.

Sample code:

 try (CloudRedisClient cloudRedisClient = CloudRedisClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ListInstancesRequest request = ListInstancesRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   while (true) {
     ListInstancesResponse response = cloudRedisClient.listInstancesCallable().call(request);
     for (Instance element : response.getInstancesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

getInstance

public final com.google.cloud.redis.v1.Instance getInstance(com.google.cloud.redis.v1.InstanceName name)

Gets the details of a specific Redis instance.

Sample code:

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

Parameters:

name - Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region

Throws:

ApiException - if the remote call fails

getInstance

public final com.google.cloud.redis.v1.Instance getInstance(String name)

Gets the details of a specific Redis instance.

Sample code:

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

Parameters:

name - Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region

Throws:

ApiException - if the remote call fails

getInstance

public final com.google.cloud.redis.v1.Instance getInstance(com.google.cloud.redis.v1.GetInstanceRequest request)

Gets the details of a specific Redis instance.

Sample code:

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

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

getInstanceCallable

public final UnaryCallable<com.google.cloud.redis.v1.GetInstanceRequest,com.google.cloud.redis.v1.Instance> getInstanceCallable()

Gets the details of a specific Redis instance.

Sample code:

 try (CloudRedisClient cloudRedisClient = CloudRedisClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   GetInstanceRequest request = GetInstanceRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Instance> future = cloudRedisClient.getInstanceCallable().futureCall(request);
   // Do something
   Instance response = future.get();
 }
 

createInstanceAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<com.google.cloud.redis.v1.Instance,com.google.cloud.redis.v1.OperationMetadata> createInstanceAsync(com.google.cloud.redis.v1.LocationName parent,
                                                                                                                                                                                                                                           String instanceId,
                                                                                                                                                                                                                                           com.google.cloud.redis.v1.Instance instance)

Creates a Redis instance based on the specified tier and memory size.

By default, the instance is accessible from the project's [default network](/compute/docs/networks-and-firewalls#networks).

The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis instance will be fully functional. Completed longrunning.Operation will contain the new instance object in the response field.

The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Sample code:

 try (CloudRedisClient cloudRedisClient = CloudRedisClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   String instanceId = "test_instance";
   Instance.Tier tier = Instance.Tier.BASIC;
   int memorySizeGb = 1;
   Instance instance = Instance.newBuilder()
     .setTier(tier)
     .setMemorySizeGb(memorySizeGb)
     .build();
   Instance response = cloudRedisClient.createInstanceAsync(parent, instanceId, instance).get();
 }
 

Parameters:

parent - Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region

instanceId - Required. The logical name of the Redis instance in the customer project with the following restrictions:

* Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-40 characters. * Must end with a number or a letter. * Must be unique within the customer project / location

instance - Required. A Redis [Instance] resource

Throws:

ApiException - if the remote call fails

createInstanceAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<com.google.cloud.redis.v1.Instance,com.google.cloud.redis.v1.OperationMetadata> createInstanceAsync(String parent,
                                                                                                                                                                                                                                           String instanceId,
                                                                                                                                                                                                                                           com.google.cloud.redis.v1.Instance instance)

Creates a Redis instance based on the specified tier and memory size.

By default, the instance is accessible from the project's [default network](/compute/docs/networks-and-firewalls#networks).

The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis instance will be fully functional. Completed longrunning.Operation will contain the new instance object in the response field.

The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Sample code:

 try (CloudRedisClient cloudRedisClient = CloudRedisClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   String instanceId = "test_instance";
   Instance.Tier tier = Instance.Tier.BASIC;
   int memorySizeGb = 1;
   Instance instance = Instance.newBuilder()
     .setTier(tier)
     .setMemorySizeGb(memorySizeGb)
     .build();
   Instance response = cloudRedisClient.createInstanceAsync(parent.toString(), instanceId, instance).get();
 }
 

Parameters:

parent - Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region

instanceId - Required. The logical name of the Redis instance in the customer project with the following restrictions:

* Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-40 characters. * Must end with a number or a letter. * Must be unique within the customer project / location

instance - Required. A Redis [Instance] resource

Throws:

ApiException - if the remote call fails

createInstanceAsync

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

Creates a Redis instance based on the specified tier and memory size.

By default, the instance is accessible from the project's [default network](/compute/docs/networks-and-firewalls#networks).

The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis instance will be fully functional. Completed longrunning.Operation will contain the new instance object in the response field.

The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Sample code:

 try (CloudRedisClient cloudRedisClient = CloudRedisClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   String instanceId = "test_instance";
   Instance.Tier tier = Instance.Tier.BASIC;
   int memorySizeGb = 1;
   Instance instance = Instance.newBuilder()
     .setTier(tier)
     .setMemorySizeGb(memorySizeGb)
     .build();
   CreateInstanceRequest request = CreateInstanceRequest.newBuilder()
     .setParent(parent.toString())
     .setInstanceId(instanceId)
     .setInstance(instance)
     .build();
   Instance response = cloudRedisClient.createInstanceAsync(request).get();
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

createInstanceOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable<com.google.cloud.redis.v1.CreateInstanceRequest,com.google.cloud.redis.v1.Instance,com.google.cloud.redis.v1.OperationMetadata> createInstanceOperationCallable()

Creates a Redis instance based on the specified tier and memory size.

By default, the instance is accessible from the project's [default network](/compute/docs/networks-and-firewalls#networks).

The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis instance will be fully functional. Completed longrunning.Operation will contain the new instance object in the response field.

The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Sample code:

 try (CloudRedisClient cloudRedisClient = CloudRedisClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   String instanceId = "test_instance";
   Instance.Tier tier = Instance.Tier.BASIC;
   int memorySizeGb = 1;
   Instance instance = Instance.newBuilder()
     .setTier(tier)
     .setMemorySizeGb(memorySizeGb)
     .build();
   CreateInstanceRequest request = CreateInstanceRequest.newBuilder()
     .setParent(parent.toString())
     .setInstanceId(instanceId)
     .setInstance(instance)
     .build();
   OperationFuture<Instance, OperationMetadata> future = cloudRedisClient.createInstanceOperationCallable().futureCall(request);
   // Do something
   Instance response = future.get();
 }
 

createInstanceCallable

public final UnaryCallable<com.google.cloud.redis.v1.CreateInstanceRequest,Operation> createInstanceCallable()

Creates a Redis instance based on the specified tier and memory size.

By default, the instance is accessible from the project's [default network](/compute/docs/networks-and-firewalls#networks).

The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis instance will be fully functional. Completed longrunning.Operation will contain the new instance object in the response field.

The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Sample code:

 try (CloudRedisClient cloudRedisClient = CloudRedisClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   String instanceId = "test_instance";
   Instance.Tier tier = Instance.Tier.BASIC;
   int memorySizeGb = 1;
   Instance instance = Instance.newBuilder()
     .setTier(tier)
     .setMemorySizeGb(memorySizeGb)
     .build();
   CreateInstanceRequest request = CreateInstanceRequest.newBuilder()
     .setParent(parent.toString())
     .setInstanceId(instanceId)
     .setInstance(instance)
     .build();
   ApiFuture<Operation> future = cloudRedisClient.createInstanceCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

updateInstanceAsync

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

Updates the metadata and configuration of a specific Redis instance.

Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Sample code:

 try (CloudRedisClient cloudRedisClient = CloudRedisClient.create()) {
   String pathsElement = "display_name";
   String pathsElement2 = "memory_size_gb";
   List<String> paths = Arrays.asList(pathsElement, pathsElement2);
   FieldMask updateMask = FieldMask.newBuilder()
     .addAllPaths(paths)
     .build();
   String displayName = "UpdatedDisplayName";
   int memorySizeGb = 4;
   Instance instance = Instance.newBuilder()
     .setDisplayName(displayName)
     .setMemorySizeGb(memorySizeGb)
     .build();
   Instance response = cloudRedisClient.updateInstanceAsync(updateMask, instance).get();
 }
 

Parameters:

updateMask - Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from [Instance][CloudRedis.Instance]:

* `displayName` * `labels` * `memorySizeGb` * `redisConfig`

instance - Required. Update description. Only fields specified in update_mask are updated.

Throws:

ApiException - if the remote call fails

updateInstanceAsync

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

Updates the metadata and configuration of a specific Redis instance.

Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Sample code:

 try (CloudRedisClient cloudRedisClient = CloudRedisClient.create()) {
   String pathsElement = "display_name";
   String pathsElement2 = "memory_size_gb";
   List<String> paths = Arrays.asList(pathsElement, pathsElement2);
   FieldMask updateMask = FieldMask.newBuilder()
     .addAllPaths(paths)
     .build();
   String displayName = "UpdatedDisplayName";
   int memorySizeGb = 4;
   Instance instance = Instance.newBuilder()
     .setDisplayName(displayName)
     .setMemorySizeGb(memorySizeGb)
     .build();
   UpdateInstanceRequest request = UpdateInstanceRequest.newBuilder()
     .setUpdateMask(updateMask)
     .setInstance(instance)
     .build();
   Instance response = cloudRedisClient.updateInstanceAsync(request).get();
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

updateInstanceOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable<com.google.cloud.redis.v1.UpdateInstanceRequest,com.google.cloud.redis.v1.Instance,com.google.cloud.redis.v1.OperationMetadata> updateInstanceOperationCallable()

Updates the metadata and configuration of a specific Redis instance.

Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Sample code:

 try (CloudRedisClient cloudRedisClient = CloudRedisClient.create()) {
   String pathsElement = "display_name";
   String pathsElement2 = "memory_size_gb";
   List<String> paths = Arrays.asList(pathsElement, pathsElement2);
   FieldMask updateMask = FieldMask.newBuilder()
     .addAllPaths(paths)
     .build();
   String displayName = "UpdatedDisplayName";
   int memorySizeGb = 4;
   Instance instance = Instance.newBuilder()
     .setDisplayName(displayName)
     .setMemorySizeGb(memorySizeGb)
     .build();
   UpdateInstanceRequest request = UpdateInstanceRequest.newBuilder()
     .setUpdateMask(updateMask)
     .setInstance(instance)
     .build();
   OperationFuture<Instance, OperationMetadata> future = cloudRedisClient.updateInstanceOperationCallable().futureCall(request);
   // Do something
   Instance response = future.get();
 }
 

updateInstanceCallable

public final UnaryCallable<com.google.cloud.redis.v1.UpdateInstanceRequest,Operation> updateInstanceCallable()

Updates the metadata and configuration of a specific Redis instance.

Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Sample code:

 try (CloudRedisClient cloudRedisClient = CloudRedisClient.create()) {
   String pathsElement = "display_name";
   String pathsElement2 = "memory_size_gb";
   List<String> paths = Arrays.asList(pathsElement, pathsElement2);
   FieldMask updateMask = FieldMask.newBuilder()
     .addAllPaths(paths)
     .build();
   String displayName = "UpdatedDisplayName";
   int memorySizeGb = 4;
   Instance instance = Instance.newBuilder()
     .setDisplayName(displayName)
     .setMemorySizeGb(memorySizeGb)
     .build();
   UpdateInstanceRequest request = UpdateInstanceRequest.newBuilder()
     .setUpdateMask(updateMask)
     .setInstance(instance)
     .build();
   ApiFuture<Operation> future = cloudRedisClient.updateInstanceCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

deleteInstanceAsync

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

Deletes a specific Redis instance. Instance stops serving and data is deleted.

Sample code:

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

Parameters:

name - Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region

Throws:

ApiException - if the remote call fails

deleteInstanceAsync

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

Deletes a specific Redis instance. Instance stops serving and data is deleted.

Sample code:

 try (CloudRedisClient cloudRedisClient = CloudRedisClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   cloudRedisClient.deleteInstanceAsync(name.toString()).get();
 }
 

Parameters:

name - Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region

Throws:

ApiException - if the remote call fails

deleteInstanceAsync

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

Deletes a specific Redis instance. Instance stops serving and data is deleted.

Sample code:

 try (CloudRedisClient cloudRedisClient = CloudRedisClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   DeleteInstanceRequest request = DeleteInstanceRequest.newBuilder()
     .setName(name.toString())
     .build();
   cloudRedisClient.deleteInstanceAsync(request).get();
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

deleteInstanceOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable<com.google.cloud.redis.v1.DeleteInstanceRequest,Empty,com.google.cloud.redis.v1.OperationMetadata> deleteInstanceOperationCallable()

Deletes a specific Redis instance. Instance stops serving and data is deleted.

Sample code:

 try (CloudRedisClient cloudRedisClient = CloudRedisClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   DeleteInstanceRequest request = DeleteInstanceRequest.newBuilder()
     .setName(name.toString())
     .build();
   OperationFuture<Empty, OperationMetadata> future = cloudRedisClient.deleteInstanceOperationCallable().futureCall(request);
   // Do something
   future.get();
 }
 

deleteInstanceCallable

public final UnaryCallable<com.google.cloud.redis.v1.DeleteInstanceRequest,Operation> deleteInstanceCallable()

Deletes a specific Redis instance. Instance stops serving and data is deleted.

Sample code:

 try (CloudRedisClient cloudRedisClient = CloudRedisClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   DeleteInstanceRequest request = DeleteInstanceRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Operation> future = cloudRedisClient.deleteInstanceCallable().futureCall(request);
   // Do something
   future.get();
 }
 

failoverInstanceAsync

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

Failover the master role to current replica node against a specific STANDARD tier redis instance.

Sample code:

 try (CloudRedisClient cloudRedisClient = CloudRedisClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   FailoverInstanceRequest.DataProtectionMode dataProtectionMode = FailoverInstanceRequest.DataProtectionMode.DATA_PROTECTION_MODE_UNSPECIFIED;
   Instance response = cloudRedisClient.failoverInstanceAsync(name, dataProtectionMode).get();
 }
 

Parameters:

name - Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region

dataProtectionMode - Optional. Available data protection modes that the user can choose. If it's unspecified, data protection mode will be LIMITED_DATA_LOSS by default.

Throws:

ApiException - if the remote call fails

failoverInstanceAsync

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

Failover the master role to current replica node against a specific STANDARD tier redis instance.

Sample code:

 try (CloudRedisClient cloudRedisClient = CloudRedisClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   FailoverInstanceRequest.DataProtectionMode dataProtectionMode = FailoverInstanceRequest.DataProtectionMode.DATA_PROTECTION_MODE_UNSPECIFIED;
   Instance response = cloudRedisClient.failoverInstanceAsync(name.toString(), dataProtectionMode).get();
 }
 

Parameters:

name - Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region

dataProtectionMode - Optional. Available data protection modes that the user can choose. If it's unspecified, data protection mode will be LIMITED_DATA_LOSS by default.

Throws:

ApiException - if the remote call fails

failoverInstanceAsync

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

Failover the master role to current replica node against a specific STANDARD tier redis instance.

Sample code:

 try (CloudRedisClient cloudRedisClient = CloudRedisClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   FailoverInstanceRequest.DataProtectionMode dataProtectionMode = FailoverInstanceRequest.DataProtectionMode.DATA_PROTECTION_MODE_UNSPECIFIED;
   FailoverInstanceRequest request = FailoverInstanceRequest.newBuilder()
     .setName(name.toString())
     .setDataProtectionMode(dataProtectionMode)
     .build();
   Instance response = cloudRedisClient.failoverInstanceAsync(request).get();
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

failoverInstanceOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable<com.google.cloud.redis.v1.FailoverInstanceRequest,com.google.cloud.redis.v1.Instance,com.google.cloud.redis.v1.OperationMetadata> failoverInstanceOperationCallable()

Failover the master role to current replica node against a specific STANDARD tier redis instance.

Sample code:

 try (CloudRedisClient cloudRedisClient = CloudRedisClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   FailoverInstanceRequest.DataProtectionMode dataProtectionMode = FailoverInstanceRequest.DataProtectionMode.DATA_PROTECTION_MODE_UNSPECIFIED;
   FailoverInstanceRequest request = FailoverInstanceRequest.newBuilder()
     .setName(name.toString())
     .setDataProtectionMode(dataProtectionMode)
     .build();
   OperationFuture<Instance, OperationMetadata> future = cloudRedisClient.failoverInstanceOperationCallable().futureCall(request);
   // Do something
   Instance response = future.get();
 }
 

failoverInstanceCallable

public final UnaryCallable<com.google.cloud.redis.v1.FailoverInstanceRequest,Operation> failoverInstanceCallable()

Failover the master role to current replica node against a specific STANDARD tier redis instance.

Sample code:

 try (CloudRedisClient cloudRedisClient = CloudRedisClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   FailoverInstanceRequest.DataProtectionMode dataProtectionMode = FailoverInstanceRequest.DataProtectionMode.DATA_PROTECTION_MODE_UNSPECIFIED;
   FailoverInstanceRequest request = FailoverInstanceRequest.newBuilder()
     .setName(name.toString())
     .setDataProtectionMode(dataProtectionMode)
     .build();
   ApiFuture<Operation> future = cloudRedisClient.failoverInstanceCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface BackgroundResource

Throws:

InterruptedException