# Google Cloud Memorystore for Redis API - Module Google::Cloud::Redis (v2.2.0)

2.2.0 (latest) 2.1.0 2.0.3 1.7.0 1.6.1 1.5.0 1.4.0 1.3.0 1.2.3 Reference documentation and code samples for the Google Cloud Memorystore for Redis API module Google::Cloud::Redis.

## Methods

### .cloud_redis

    def self.cloud_redis(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for CloudRedis.

By default, this returns an instance of
[Google::Cloud::Redis::V1::CloudRedis::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-redis-v1/latest/Google-Cloud-Redis-V1-CloudRedis-Client)
for a gRPC client for version V1 of the API.
However, you can specify a different API version by passing it in the
`version` parameter. If the CloudRedis service is
supported by that API version, and the corresponding gem is available, the
appropriate versioned client will be returned.
You can also specify a different transport by passing `:rest` or `:grpc` in
the `transport` parameter.

Raises an exception if the currently installed versioned client gem for the
given API version does not support the given transport of the CloudRedis service.
You can determine whether the method will succeed by calling
[Redis.cloud_redis_available?](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis/latest/Google-Cloud-Redis#Google__Cloud__Redis_cloud_redis_available__class_ "Google::Cloud::Redis.cloud_redis_available? (method)").

#### About CloudRedis

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`
**Parameters**

- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.
- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`.
**Returns**

- (::Object) --- A client object for the specified version.

### .cloud_redis_available?

    def self.cloud_redis_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the CloudRedis service is supported by the current client.
If true, you can retrieve a client object by calling [Redis.cloud_redis](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-redis/latest/Google-Cloud-Redis#Google__Cloud__Redis_cloud_redis_class_ "Google::Cloud::Redis.cloud_redis (method)").
If false, that method will raise an exception. This could happen if the given
API version does not exist or does not support the CloudRedis service,
or if the versioned client gem needs an update to support the CloudRedis service.
**Parameters**

- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.
- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`.
**Returns**

- (boolean) --- Whether the service is available.

### .configure

    def self.configure() -> ::Google::Cloud::Config

Configure the google-cloud-redis library.

The following configuration parameters are supported:

- `credentials` (*type:* `String, Hash, Google::Auth::Credentials`) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
- `lib_name` (*type:* `String`) - The library name as recorded in instrumentation and logging.
- `lib_version` (*type:* `String`) - The library version as recorded in instrumentation and logging.
- `interceptors` (*type:* `Array<GRPC::ClientInterceptor>`) - An array of interceptors that are run before calls are executed.
- `timeout` (*type:* `Numeric`) - Default timeout in seconds.
- `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers to be sent with the call.
- `retry_policy` (*type:* `Hash`) - The retry policy. The value is a hash with the following keys:
  - `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  - `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  - `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  - `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  - `:retry_codes` (*type:* `Array<String>`) - The error codes that should trigger a retry.
**Yields**

- (::Google::Cloud.configure.redis)
**Returns**

- (::Google::Cloud::Config) --- The default configuration used by this library

## Constants

### VERSION

**value:**"2.2.0"