Google Cloud Memorystore for Redis API - Module Google::Cloud::Redis::Cluster (v2.0.0)

Reference documentation and code samples for the Google Cloud Memorystore for Redis API module Google::Cloud::Redis::Cluster.

Methods

.cloud_redis_cluster

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

Create a new client object for CloudRedisCluster.

By default, this returns an instance of Google::Cloud::Redis::Cluster::V1::CloudRedisCluster::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 CloudRedisCluster 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 CloudRedisCluster service. You can determine whether the method will succeed by calling Cluster.cloud_redis_cluster_available?.

About CloudRedisCluster

Configures and manages Cloud Memorystore for Redis clusters

Google Cloud Memorystore for Redis Cluster

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

  • 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 clusters, named: /clusters/*
  • As such, Redis clusters are resources of the form: /projects/{project_id}/locations/{location_id}/clusters/{instance_id}

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

  • projects/redpepper-1290/locations/us-central1/clusters/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_cluster_available?

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

Determines whether the CloudRedisCluster service is supported by the current client. If true, you can retrieve a client object by calling Cluster.cloud_redis_cluster. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the CloudRedisCluster service, or if the versioned client gem needs an update to support the CloudRedisCluster 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-cluster 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.
    • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.
Yields
  • (::Google::Cloud.configure.redis_cluster)
Returns
  • (::Google::Cloud::Config) — The default configuration used by this library

Constants

VERSION

value: "2.0.0"