Class: Google::Cloud::Redis::V1beta1::CloudRedisClient

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/redis/v1beta1/cloud_redis_client.rb

Overview

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+

Constant Summary collapse

SERVICE_ADDRESS =

The default address of the service.

"redis.googleapis.com".freeze
DEFAULT_SERVICE_PORT =

The default port of the service.

443
GRPC_INTERCEPTORS =

The default set of gRPC interceptors.

[]
DEFAULT_TIMEOUT = 
30
ALL_SCOPES =

The scopes needed to make gRPC calls to all of the methods defined in this service.

[
  "https://www.googleapis.com/auth/cloud-platform"
].freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ CloudRedisClient

Returns a new instance of CloudRedisClient

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.

  • metadata (Hash) —

    Default metadata to be sent with each request. This can be overridden on a per call basis.

  • exception_transformer (Proc) —

    An optional proc that intercepts any exceptions raised during an API call to inject custom error handling.



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/google/cloud/redis/v1beta1/cloud_redis_client.rb', line 155

def initialize \
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    metadata: nil,
    exception_transformer: nil,
    lib_name: nil,
    lib_version: ""
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "google/gax/grpc"
  require "google/cloud/redis/v1beta1/cloud_redis_services_pb"

  credentials ||= Google::Cloud::Redis::V1beta1::Credentials.default

  @operations_client = OperationsClient.new(
    credentials: credentials,
    scopes: scopes,
    client_config: client_config,
    timeout: timeout,
    lib_name: lib_name,
    lib_version: lib_version,
  )

  if credentials.is_a?(String) || credentials.is_a?(Hash)
    updater_proc = Google::Cloud::Redis::V1beta1::Credentials.new(credentials).updater_proc
  end
  if credentials.is_a?(GRPC::Core::Channel)
    channel = credentials
  end
  if credentials.is_a?(GRPC::Core::ChannelCredentials)
    chan_creds = credentials
  end
  if credentials.is_a?(Proc)
    updater_proc = credentials
  end
  if credentials.is_a?(Google::Auth::Credentials)
    updater_proc = credentials.updater_proc
  end

  package_version = Gem.loaded_specs['google-cloud-redis'].version.version

  google_api_client = "gl-ruby/#{RUBY_VERSION}"
  google_api_client << " #{lib_name}/#{lib_version}" if lib_name
  google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
  google_api_client << " grpc/#{GRPC::VERSION}"
  google_api_client.freeze

  headers = { :"x-goog-api-client" => google_api_client }
  headers.merge!(metadata) unless metadata.nil?
  client_config_file = Pathname.new(__dir__).join(
    "cloud_redis_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.cloud.redis.v1beta1.CloudRedis",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      page_descriptors: PAGE_DESCRIPTORS,
      errors: Google::Gax::Grpc::API_ERRORS,
      metadata: headers
    )
  end

  # Allow overriding the service path/port in subclasses.
  service_path = self.class::SERVICE_ADDRESS
  port = self.class::DEFAULT_SERVICE_PORT
  interceptors = self.class::GRPC_INTERCEPTORS
  @cloud_redis_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    updater_proc: updater_proc,
    scopes: scopes,
    interceptors: interceptors,
    &Google::Cloud::Redis::V1beta1::CloudRedis::Stub.method(:new)
  )

  @list_instances = Google::Gax.create_api_call(
    @cloud_redis_stub.method(:list_instances),
    defaults["list_instances"],
    exception_transformer: exception_transformer
  )
  @get_instance = Google::Gax.create_api_call(
    @cloud_redis_stub.method(:get_instance),
    defaults["get_instance"],
    exception_transformer: exception_transformer
  )
  @create_instance = Google::Gax.create_api_call(
    @cloud_redis_stub.method(:create_instance),
    defaults["create_instance"],
    exception_transformer: exception_transformer
  )
  @update_instance = Google::Gax.create_api_call(
    @cloud_redis_stub.method(:update_instance),
    defaults["update_instance"],
    exception_transformer: exception_transformer
  )
  @delete_instance = Google::Gax.create_api_call(
    @cloud_redis_stub.method(:delete_instance),
    defaults["delete_instance"],
    exception_transformer: exception_transformer
  )
end

Class Method Details

.instance_path(project, location, instance) ⇒ String

Returns a fully-qualified instance resource name string.

Parameters:

  • project (String)
  • location (String)
  • instance (String)

Returns:

  • (String) 


118
119
120
121
122
123
124
 
# File 'lib/google/cloud/redis/v1beta1/cloud_redis_client.rb', line 118

def self.instance_path project, location, instance
  INSTANCE_PATH_TEMPLATE.render(
    :"project" => project,
    :"location" => location,
    :"instance" => instance
  )
end

.location_path(project, location) ⇒ String

Returns a fully-qualified location resource name string.

Parameters:

  • project (String)
  • location (String)

Returns:

  • (String) 


106
107
108
109
110
111
 
# File 'lib/google/cloud/redis/v1beta1/cloud_redis_client.rb', line 106

def self.location_path project, location
  LOCATION_PATH_TEMPLATE.render(
    :"project" => project,
    :"location" => location
  )
end

Instance Method Details

#create_instance(parent, instance_id, instance, options: nil) ⇒ Google::Gax::Operation

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

By default, the instance is peered to the project's default network.

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.

Examples:

require "google/cloud/redis"

cloud_redis_client = Google::Cloud::Redis.new(version: :v1beta1)
formatted_parent = Google::Cloud::Redis::V1beta1::CloudRedisClient.location_path("[PROJECT]", "[LOCATION]")
instance_id = "test_instance"
tier = :BASIC
memory_size_gb = 1
instance = { tier: tier, memory_size_gb: memory_size_gb }

# Register a callback during the method call.
operation = cloud_redis_client.create_instance(formatted_parent, instance_id, instance) do |op|
  raise op.results.message if op.error?
  op_results = op.results
  # Process the results.

  metadata = op.metadata
  # Process the metadata.
end

# Or use the return value to register a callback.
operation.on_done do |op|
  raise op.results.message if op.error?
  op_results = op.results
  # Process the results.

  metadata = op.metadata
  # Process the metadata.
end

# Manually reload the operation.
operation.reload!

# Or block until the operation completes, triggering callbacks on
# completion.
operation.wait_until_done!

Parameters:

  • parent (String) —

    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

  • instance_id (String) —

    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 (Google::Cloud::Redis::V1beta1::Instance | Hash) —

    Required. A Redis [Instance] resource A hash of the same form as Google::Cloud::Redis::V1beta1::Instance can also be provided.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

  • (Google::Gax::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
 
# File 'lib/google/cloud/redis/v1beta1/cloud_redis_client.rb', line 434

def create_instance \
    parent,
    instance_id,
    instance,
    options: nil
  req = {
    parent: parent,
    instance_id: instance_id,
    instance: instance
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Redis::V1beta1::CreateInstanceRequest)
  operation = Google::Gax::Operation.new(
    @create_instance.call(req, options),
    @operations_client,
    Google::Cloud::Redis::V1beta1::Instance,
    Google::Protobuf::Any,
    call_options: options
  )
  operation.on_done { |operation| yield(operation) } if block_given?
  operation
end

#delete_instance(name, options: nil) ⇒ Google::Gax::Operation

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

Examples:

require "google/cloud/redis"

cloud_redis_client = Google::Cloud::Redis.new(version: :v1beta1)
formatted_name = Google::Cloud::Redis::V1beta1::CloudRedisClient.instance_path("[PROJECT]", "[LOCATION]", "[INSTANCE]")

# Register a callback during the method call.
operation = cloud_redis_client.delete_instance(formatted_name) do |op|
  raise op.results.message if op.error?
  op_results = op.results
  # Process the results.

  metadata = op.metadata
  # Process the metadata.
end

# Or use the return value to register a callback.
operation.on_done do |op|
  raise op.results.message if op.error?
  op_results = op.results
  # Process the results.

  metadata = op.metadata
  # Process the metadata.
end

# Manually reload the operation.
operation.reload!

# Or block until the operation completes, triggering callbacks on
# completion.
operation.wait_until_done!

Parameters:

  • name (String) —

    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

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

  • (Google::Gax::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
 
# File 'lib/google/cloud/redis/v1beta1/cloud_redis_client.rb', line 586

def delete_instance \
    name,
    options: nil
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Redis::V1beta1::DeleteInstanceRequest)
  operation = Google::Gax::Operation.new(
    @delete_instance.call(req, options),
    @operations_client,
    Google::Protobuf::Empty,
    Google::Protobuf::Any,
    call_options: options
  )
  operation.on_done { |operation| yield(operation) } if block_given?
  operation
end

#get_instance(name, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Redis::V1beta1::Instance

Gets the details of a specific Redis instance.

Examples:

require "google/cloud/redis"

cloud_redis_client = Google::Cloud::Redis.new(version: :v1beta1)
formatted_name = Google::Cloud::Redis::V1beta1::CloudRedisClient.instance_path("[PROJECT]", "[LOCATION]", "[INSTANCE]")
response = cloud_redis_client.get_instance(formatted_name)

Parameters:

  • name (String) —

    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

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



351
352
353
354
355
356
357
358
359
360
 
# File 'lib/google/cloud/redis/v1beta1/cloud_redis_client.rb', line 351

def get_instance \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Redis::V1beta1::GetInstanceRequest)
  @get_instance.call(req, options, &block)
end

#list_instances(parent, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Cloud::Redis::V1beta1::Instance>

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.

Examples:

require "google/cloud/redis"

cloud_redis_client = Google::Cloud::Redis.new(version: :v1beta1)
formatted_parent = Google::Cloud::Redis::V1beta1::CloudRedisClient.location_path("[PROJECT]", "[LOCATION]")

# Iterate over all results.
cloud_redis_client.list_instances(formatted_parent).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
cloud_redis_client.list_instances(formatted_parent).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • parent (String) —

    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

  • page_size (Integer) —

    The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

  • (Google::Gax::PagedEnumerable<Google::Cloud::Redis::V1beta1::Instance>) —

    An enumerable of Google::Cloud::Redis::V1beta1::Instance instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/google/cloud/redis/v1beta1/cloud_redis_client.rb', line 317

def list_instances \
    parent,
    page_size: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    page_size: page_size
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Redis::V1beta1::ListInstancesRequest)
  @list_instances.call(req, options, &block)
end

#update_instance(update_mask, instance, options: nil) ⇒ Google::Gax::Operation

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.

Examples:

require "google/cloud/redis"

cloud_redis_client = Google::Cloud::Redis.new(version: :v1beta1)
paths_element = "display_name"
paths_element_2 = "memory_size_gb"
paths = [paths_element, paths_element_2]
update_mask = { paths: paths }
display_name = "UpdatedDisplayName"
memory_size_gb = 4
instance = { display_name: display_name, memory_size_gb: memory_size_gb }

# Register a callback during the method call.
operation = cloud_redis_client.update_instance(update_mask, instance) do |op|
  raise op.results.message if op.error?
  op_results = op.results
  # Process the results.

  metadata = op.metadata
  # Process the metadata.
end

# Or use the return value to register a callback.
operation.on_done do |op|
  raise op.results.message if op.error?
  op_results = op.results
  # Process the results.

  metadata = op.metadata
  # Process the metadata.
end

# Manually reload the operation.
operation.reload!

# Or block until the operation completes, triggering callbacks on
# completion.
operation.wait_until_done!

Parameters:

  • update_mask (Google::Protobuf::FieldMask | Hash) —

    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:

    • +display_name+
    • +labels+
    • +memory_size_gb+
    • +redis_config+ A hash of the same form as Google::Protobuf::FieldMask can also be provided.
  • instance (Google::Cloud::Redis::V1beta1::Instance | Hash) —

    Required. Update description. Only fields specified in update_mask are updated. A hash of the same form as Google::Cloud::Redis::V1beta1::Instance can also be provided.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

  • (Google::Gax::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
 
# File 'lib/google/cloud/redis/v1beta1/cloud_redis_client.rb', line 521

def update_instance \
    update_mask,
    instance,
    options: nil
  req = {
    update_mask: update_mask,
    instance: instance
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Redis::V1beta1::UpdateInstanceRequest)
  operation = Google::Gax::Operation.new(
    @update_instance.call(req, options),
    @operations_client,
    Google::Cloud::Redis::V1beta1::Instance,
    Google::Protobuf::Any,
    call_options: options
  )
  operation.on_done { |operation| yield(operation) } if block_given?
  operation
end