com.google.api.services.redis.v1beta1

Class CloudRedis.Projects.Locations.Instances

java.lang.Object

com.google.api.services.redis.v1beta1.CloudRedis.Projects.Locations.Instances

Enclosing class:

CloudRedis.Projects.Locations

public class CloudRedis.Projects.Locations.Instances
extends java.lang.Object

The "instances" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CloudRedis.Projects.Locations.Instances.CloudRedisImport
class	CloudRedis.Projects.Locations.Instances.Create
class	CloudRedis.Projects.Locations.Instances.Delete
class	CloudRedis.Projects.Locations.Instances.Export
class	CloudRedis.Projects.Locations.Instances.Failover
class	CloudRedis.Projects.Locations.Instances.Get
class	CloudRedis.Projects.Locations.Instances.List
class	CloudRedis.Projects.Locations.Instances.Patch
class	CloudRedis.Projects.Locations.Instances.Upgrade

Constructor Summary

Constructors

Constructor and Description
Instances()

Method Summary

Modifier and Type	Method and Description
CloudRedis.Projects.Locations.Instances.Create	create(java.lang.String parent, Instance content) Creates a Redis instance based on the specified tier and memory size.
CloudRedis.Projects.Locations.Instances.Delete	delete(java.lang.String name) Deletes a specific Redis instance.
CloudRedis.Projects.Locations.Instances.Export	export(java.lang.String name, ExportInstanceRequest content) Export Redis instance data into a Redis RDB format file in Cloud Storage.
CloudRedis.Projects.Locations.Instances.Failover	failover(java.lang.String name, FailoverInstanceRequest content) Initiates a failover of the master node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.
CloudRedis.Projects.Locations.Instances.Get	get(java.lang.String name) Gets the details of a specific Redis instance.
CloudRedis.Projects.Locations.Instances.List	list(java.lang.String parent) Lists all Redis instances owned by a project in either the specified location (region) or all locations.
CloudRedis.Projects.Locations.Instances.Patch	patch(java.lang.String name, Instance content) Updates the metadata and configuration of a specific Redis instance.
CloudRedis.Projects.Locations.Instances.CloudRedisImport	redisImport(java.lang.String name, ImportInstanceRequest content) Import a Redis RDB snapshot file from Cloud Storage into a Redis instance.
CloudRedis.Projects.Locations.Instances.Upgrade	upgrade(java.lang.String name, UpgradeInstanceRequest content) Upgrades Redis instance to the newer Redis version specified in the request.

Methods inherited from class java.lang.Object

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

Constructor Detail

Instances

public Instances()

Method Detail

create

public CloudRedis.Projects.Locations.Instances.Create create(java.lang.String parent,
                                                             Instance content)
                                                      throws java.io.IOException

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. Create a request for the method "instances.create". This request holds the parameters needed by the redis server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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.

content - the Instance

Returns:

the request

Throws:

java.io.IOException

delete

public CloudRedis.Projects.Locations.Instances.Delete delete(java.lang.String name)
                                                      throws java.io.IOException

Deletes a specific Redis instance. Instance stops serving and data is deleted. Create a request for the method "instances.delete". This request holds the parameters needed by the redis server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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.

Returns:

the request

Throws:

java.io.IOException

export

public CloudRedis.Projects.Locations.Instances.Export export(java.lang.String name,
                                                             ExportInstanceRequest content)
                                                      throws java.io.IOException

Export Redis instance data into a Redis RDB format file in Cloud Storage. Redis will continue serving during this operation. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation. Create a request for the method "instances.export". This request holds the parameters needed by the redis server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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.

content - the ExportInstanceRequest

Returns:

the request

Throws:

java.io.IOException

failover

public CloudRedis.Projects.Locations.Instances.Failover failover(java.lang.String name,
                                                                 FailoverInstanceRequest content)
                                                          throws java.io.IOException

Initiates a failover of the master node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance. Create a request for the method "instances.failover". This request holds the parameters needed by the redis server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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.

content - the FailoverInstanceRequest

Returns:

the request

Throws:

java.io.IOException

get

public CloudRedis.Projects.Locations.Instances.Get get(java.lang.String name)
                                                throws java.io.IOException

Gets the details of a specific Redis instance. Create a request for the method "instances.get". This request holds the parameters needed by the redis server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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.

Returns:

the request

Throws:

java.io.IOException

redisImport

public CloudRedis.Projects.Locations.Instances.CloudRedisImport redisImport(java.lang.String name,
                                                                            ImportInstanceRequest content)
                                                                     throws java.io.IOException

Import a Redis RDB snapshot file from Cloud Storage into a Redis instance. Redis may stop serving during this operation. Instance state will be IMPORTING for entire operation. When complete, the instance will contain only data from the imported file. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation. Create a request for the method "instances.import". This request holds the parameters needed by the redis server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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.

content - the ImportInstanceRequest

Returns:

the request

Throws:

java.io.IOException

list

public CloudRedis.Projects.Locations.Instances.List list(java.lang.String parent)
                                                  throws java.io.IOException

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. Create a request for the method "instances.list". This request holds the parameters needed by the redis server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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.

Returns:

the request

Throws:

java.io.IOException

patch

public CloudRedis.Projects.Locations.Instances.Patch patch(java.lang.String name,
                                                           Instance content)
                                                    throws java.io.IOException

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. Create a request for the method "instances.patch". This request holds the parameters needed by the redis server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross- zone instances) an instance should be provisioned in. Refer to location_id and alternative_location_id fields for more details.

content - the Instance

Returns:

the request

Throws:

java.io.IOException

upgrade

public CloudRedis.Projects.Locations.Instances.Upgrade upgrade(java.lang.String name,
                                                               UpgradeInstanceRequest content)
                                                        throws java.io.IOException

Upgrades Redis instance to the newer Redis version specified in the request. Create a request for the method "instances.upgrade". This request holds the parameters needed by the redis server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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.

content - the UpgradeInstanceRequest

Returns:

the request

Throws:

java.io.IOException