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

Instance Attribute Summary collapse

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.



154
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
 
# File 'lib/google/cloud/redis/v1beta1/cloud_redis_client.rb', line 154

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

Instance Attribute Details

#cloud_redis_stub ⇒ Google::Cloud::Redis::V1beta1::CloudRedis::Stub (readonly)

Returns:

  • (Google::Cloud::Redis::V1beta1::CloudRedis::Stub) 


54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
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 54

class CloudRedisClient
  attr_reader :cloud_redis_stub

  # The default address of the service.
  SERVICE_ADDRESS = "redis.googleapis.com".freeze

  # The default port of the service.
  DEFAULT_SERVICE_PORT = 443

  # The default set of gRPC interceptors.
  GRPC_INTERCEPTORS = []

  DEFAULT_TIMEOUT = 30

  PAGE_DESCRIPTORS = {
    "list_instances" => Google::Gax::PageDescriptor.new(
      "page_token",
      "next_page_token",
      "instances")
  }.freeze

  private_constant :PAGE_DESCRIPTORS

  # The scopes needed to make gRPC calls to all of the methods defined in
  # this service.
  ALL_SCOPES = [
    "https://www.googleapis.com/auth/cloud-platform"
  ].freeze

  # @private
  class OperationsClient < Google::Longrunning::OperationsClient
    self::SERVICE_ADDRESS = CloudRedisClient::SERVICE_ADDRESS
    self::GRPC_INTERCEPTORS = CloudRedisClient::GRPC_INTERCEPTORS
  end

  LOCATION_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}/locations/{location}"
  )

  private_constant :LOCATION_PATH_TEMPLATE

  INSTANCE_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}/locations/{location}/instances/{instance}"
  )

  private_constant :INSTANCE_PATH_TEMPLATE

  # Returns a fully-qualified location resource name string.
  # @param project [String]
  # @param location [String]
  # @return [String]
  def self.location_path project, location
    LOCATION_PATH_TEMPLATE.render(
      :"project" => project,
      :"location" => location
    )
  end

  # Returns a fully-qualified instance resource name string.
  # @param project [String]
  # @param location [String]
  # @param instance [String]
  # @return [String]
  def self.instance_path project, location, instance
    INSTANCE_PATH_TEMPLATE.render(
      :"project" => project,
      :"location" => location,
      :"instance" => instance
    )
  end

  # @param 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.
  # @param scopes [Array<String>]
  #   The OAuth scopes for this service. This parameter is ignored if
  #   an updater_proc is supplied.
  # @param 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.
  # @param timeout [Numeric]
  #   The default timeout, in seconds, for calls made through this client.
  # @param metadata [Hash]
  #   Default metadata to be sent with each request. This can be overridden on a per call basis.
  # @param exception_transformer [Proc]
  #   An optional proc that intercepts any exceptions raised during an API call to inject
  #   custom error handling.
  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

  # Service calls

  # 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.
  #
  # @param 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
  # @param 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.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @yield [result, operation] Access the result along with the RPC operation
  # @yieldparam result [Google::Gax::PagedEnumerable<Google::Cloud::Redis::V1beta1::Instance>]
  # @yieldparam operation [GRPC::ActiveCall::Operation]
  # @return [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.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   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

  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

  # Gets the details of a specific Redis instance.
  #
  # @param 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
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @yield [result, operation] Access the result along with the RPC operation
  # @yieldparam result [Google::Cloud::Redis::V1beta1::Instance]
  # @yieldparam operation [GRPC::ActiveCall::Operation]
  # @return [Google::Cloud::Redis::V1beta1::Instance]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   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)

  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

  # Creates a Redis instance based on the specified tier and memory size.
  #
  # By default, the instance is peered to the project's
  # [default network](https://cloud.google.com/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.
  #
  # @param 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
  # @param 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
  # @param 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.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Gax::Operation]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   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!

  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

  # 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.
  #
  # @param 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 {CloudRedis::Instance Instance}:
  #   * +display_name+
  #   * +labels+
  #   * +memory_size_gb+
  #   * +redis_config+
  #   A hash of the same form as `Google::Protobuf::FieldMask`
  #   can also be provided.
  # @param 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.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Gax::Operation]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   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!

  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

  # Deletes a specific Redis instance.  Instance stops serving and data is
  # deleted.
  #
  # @param 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
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Gax::Operation]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   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!

  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
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) 


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

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) 


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

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.



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

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.



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

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.



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

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.



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

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.



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

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