Module: Google::Cloud::Redis::V1beta1

Defined in:
lib/google/cloud/redis/v1beta1/doc/google/cloud/redis/v1beta1/cloud_redis.rb,
lib/google/cloud/redis/v1beta1.rb,
lib/google/cloud/redis/v1beta1/doc/overview.rb,
lib/google/cloud/redis/v1beta1/cloud_redis_client.rb

Overview

Google Cloud Memorystore for Redis API Contents

Class Description
CloudRedisClient Configures and manages Cloud Memorystore for Redis instances
Data Types Data types for Google::Cloud::Redis::V1beta1

Defined Under Namespace

Classes: CloudRedisClient, CreateInstanceRequest, DeleteInstanceRequest, GetInstanceRequest, Instance, ListInstancesRequest, ListInstancesResponse, LocationMetadata, UpdateInstanceRequest, ZoneMetadata

Class Method Summary collapse

Class Method Details

.new(credentials: nil, scopes: nil, client_config: nil, timeout: nil, lib_name: nil, lib_version: nil) ⇒ Object

Configures and manages Cloud Memorystore for Redis instances

Google Cloud Memorystore for Redis v1beta1

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 refering to a GCP +region+; for example:

  • +projects/redpepper-1290/locations/us-central1/instances/my-redis+

Parameters:

  • credentials (Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc) —

    Provides the means for authenticating requests made by the client. This parameter can be many types. A Google::Auth::Credentials uses a the properties of its represented keyfile for authenticating requests made by this client. A String will be treated as the path to the keyfile to be used for the construction of credentials for this client. A Hash will be treated as the contents of a keyfile to be used for the construction of credentials for this client. A GRPC::Core::Channel will be used to make calls through. A GRPC::Core::ChannelCredentials for the setting up the RPC client. The channel credentials should already be composed with a GRPC::Core::CallCredentials object. A Proc will be used as an updater_proc for the Grpc channel. The proc transforms the metadata for requests, generally, to give OAuth credentials.

  • scopes (Array<String>) —

    The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.

  • client_config (Hash) —

    A Hash for call options for each method. See Google::Gax#construct_settings for the structure of this data. Falls back to the default config if not specified or the specified config is missing data points.

  • timeout (Numeric) —

    The default timeout, in seconds, for calls made through this client.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/google/cloud/redis/v1beta1.rb', line 93

def self.new \
    credentials: nil,
    scopes: nil,
    client_config: nil,
    timeout: nil,
    lib_name: nil,
    lib_version: nil
  kwargs = {
    credentials: credentials,
    scopes: scopes,
    client_config: client_config,
    timeout: timeout,
    lib_name: lib_name,
    lib_version: lib_version
  }.select { |_, v| v != nil }
  Google::Cloud::Redis::V1beta1::CloudRedisClient.new(**kwargs)
end