google-cloud-redis-v1 0.8.0 → 0.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -43,8 +43,10 @@ module Google
43
43
  # Note: Redis instances are managed and addressed at regional level so
44
44
  # location_id here refers to a GCP region; however, users may choose which
45
45
  # specific zone (or collection of zones for cross-zone instances) an instance
46
- # should be provisioned in. Refer to {::Google::Cloud::Redis::V1::Instance#location_id location_id} and
47
- # {::Google::Cloud::Redis::V1::Instance#alternative_location_id alternative_location_id} fields for more details.
46
+ # should be provisioned in. Refer to
47
+ # {::Google::Cloud::Redis::V1::Instance#location_id location_id} and
48
+ # {::Google::Cloud::Redis::V1::Instance#alternative_location_id alternative_location_id}
49
+ # fields for more details.
48
50
  # @!attribute [rw] display_name
49
51
  # @return [::String]
50
52
  # An arbitrary and optional user-provided name for the instance.
@@ -87,11 +89,11 @@ module Google
87
89
  # the default block size is /28.
88
90
  # @!attribute [rw] secondary_ip_range
89
91
  # @return [::String]
90
- # Optional. Additional IP range for node placement. Required when enabling read
91
- # replicas on an existing instance. For DIRECT_PEERING mode value must be a
92
- # CIDR range of size /28, or "auto". For PRIVATE_SERVICE_ACCESS mode value
93
- # must be the name of an allocated address range associated with the private
94
- # service access connection, or "auto".
92
+ # Optional. Additional IP range for node placement. Required when enabling
93
+ # read replicas on an existing instance. For DIRECT_PEERING mode value must
94
+ # be a CIDR range of size /28, or "auto". For PRIVATE_SERVICE_ACCESS mode
95
+ # value must be the name of an allocated address range associated with the
96
+ # private service access connection, or "auto".
95
97
  # @!attribute [r] host
96
98
  # @return [::String]
97
99
  # Output only. Hostname or IP address of the exposed Redis endpoint used by
@@ -161,9 +163,9 @@ module Google
161
163
  # If not provided, the connect mode defaults to DIRECT_PEERING.
162
164
  # @!attribute [rw] auth_enabled
163
165
  # @return [::Boolean]
164
- # Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If set to
165
- # "true" AUTH is enabled on the instance. Default value is "false" meaning
166
- # AUTH is disabled.
166
+ # Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If
167
+ # set to "true" AUTH is enabled on the instance. Default value is "false"
168
+ # meaning AUTH is disabled.
167
169
  # @!attribute [r] server_ca_certs
168
170
  # @return [::Array<::Google::Cloud::Redis::V1::TlsCertificate>]
169
171
  # Output only. List of server CA certificates for the instance.
@@ -181,11 +183,11 @@ module Google
181
183
  # scheduled.
182
184
  # @!attribute [rw] replica_count
183
185
  # @return [::Integer]
184
- # Optional. The number of replica nodes. The valid range for the Standard Tier with
185
- # read replicas enabled is [1-5] and defaults to 2. If read replicas are not
186
- # enabled for a Standard Tier instance, the only valid value is 1 and the
187
- # default is 1. The valid value for basic tier is 0 and the default is also
188
- # 0.
186
+ # Optional. The number of replica nodes. The valid range for the Standard
187
+ # Tier with read replicas enabled is [1-5] and defaults to 2. If read
188
+ # replicas are not enabled for a Standard Tier instance, the only valid value
189
+ # is 1 and the default is 1. The valid value for basic tier is 0 and the
190
+ # default is also 0.
189
191
  # @!attribute [r] nodes
190
192
  # @return [::Array<::Google::Cloud::Redis::V1::NodeInfo>]
191
193
  # Output only. Info per node.
@@ -201,7 +203,26 @@ module Google
201
203
  # endpoint. Standard tier only. Write requests should target 'port'.
202
204
  # @!attribute [rw] read_replicas_mode
203
205
  # @return [::Google::Cloud::Redis::V1::Instance::ReadReplicasMode]
204
- # Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED.
206
+ # Optional. Read replicas mode for the instance. Defaults to
207
+ # READ_REPLICAS_DISABLED.
208
+ # @!attribute [rw] customer_managed_key
209
+ # @return [::String]
210
+ # Optional. The KMS key reference that the customer provides when trying to
211
+ # create the instance.
212
+ # @!attribute [rw] persistence_config
213
+ # @return [::Google::Cloud::Redis::V1::PersistenceConfig]
214
+ # Optional. Persistence configuration parameters
215
+ # @!attribute [rw] suspension_reasons
216
+ # @return [::Array<::Google::Cloud::Redis::V1::Instance::SuspensionReason>]
217
+ # Optional. reasons that causes instance in "SUSPENDED" state.
218
+ # @!attribute [rw] maintenance_version
219
+ # @return [::String]
220
+ # Optional. The self service update maintenance version.
221
+ # The version is date based such as "20210712_00_00".
222
+ # @!attribute [rw] available_maintenance_versions
223
+ # @return [::Array<::String>]
224
+ # Optional. The available maintenance versions that an instance could update
225
+ # to.
205
226
  class Instance
206
227
  include ::Google::Protobuf::MessageExts
207
228
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -308,9 +329,76 @@ module Google
308
329
  # up and down the number of replicas. Not valid for basic tier.
309
330
  READ_REPLICAS_ENABLED = 2
310
331
  end
332
+
333
+ # Possible reasons for the instance to be in a "SUSPENDED" state.
334
+ module SuspensionReason
335
+ # Not set.
336
+ SUSPENSION_REASON_UNSPECIFIED = 0
337
+
338
+ # Something wrong with the CMEK key provided by customer.
339
+ CUSTOMER_MANAGED_KEY_ISSUE = 1
340
+ end
341
+ end
342
+
343
+ # Configuration of the persistence functionality.
344
+ # @!attribute [rw] persistence_mode
345
+ # @return [::Google::Cloud::Redis::V1::PersistenceConfig::PersistenceMode]
346
+ # Optional. Controls whether Persistence features are enabled.
347
+ # If not provided, the existing value will be used.
348
+ # @!attribute [rw] rdb_snapshot_period
349
+ # @return [::Google::Cloud::Redis::V1::PersistenceConfig::SnapshotPeriod]
350
+ # Optional. Period between RDB snapshots. Snapshots will be attempted every
351
+ # period starting from the provided snapshot start time. For example, a start
352
+ # time of 01/01/2033 06:45 and SIX_HOURS snapshot period will do nothing
353
+ # until 01/01/2033, and then trigger snapshots every day at 06:45, 12:45,
354
+ # 18:45, and 00:45 the next day, and so on. If not provided,
355
+ # TWENTY_FOUR_HOURS will be used as default.
356
+ # @!attribute [r] rdb_next_snapshot_time
357
+ # @return [::Google::Protobuf::Timestamp]
358
+ # Output only. The next time that a snapshot attempt is scheduled to occur.
359
+ # @!attribute [rw] rdb_snapshot_start_time
360
+ # @return [::Google::Protobuf::Timestamp]
361
+ # Optional. Date and time that the first snapshot was/will be attempted, and
362
+ # to which future snapshots will be aligned. If not provided, the current
363
+ # time will be used.
364
+ class PersistenceConfig
365
+ include ::Google::Protobuf::MessageExts
366
+ extend ::Google::Protobuf::MessageExts::ClassMethods
367
+
368
+ # Available Persistence modes.
369
+ module PersistenceMode
370
+ # Not set.
371
+ PERSISTENCE_MODE_UNSPECIFIED = 0
372
+
373
+ # Persistence is disabled for the instance,
374
+ # and any existing snapshots are deleted.
375
+ DISABLED = 1
376
+
377
+ # RDB based Persistence is enabled.
378
+ RDB = 2
379
+ end
380
+
381
+ # Available snapshot periods for scheduling.
382
+ module SnapshotPeriod
383
+ # Not set.
384
+ SNAPSHOT_PERIOD_UNSPECIFIED = 0
385
+
386
+ # Snapshot every 1 hour.
387
+ ONE_HOUR = 3
388
+
389
+ # Snapshot every 6 hours.
390
+ SIX_HOURS = 4
391
+
392
+ # Snapshot every 12 hours.
393
+ TWELVE_HOURS = 5
394
+
395
+ # Snapshot every 24 hours.
396
+ TWENTY_FOUR_HOURS = 6
397
+ end
311
398
  end
312
399
 
313
- # Request for {::Google::Cloud::Redis::V1::CloudRedis::Client#reschedule_maintenance RescheduleMaintenance}.
400
+ # Request for
401
+ # {::Google::Cloud::Redis::V1::CloudRedis::Client#reschedule_maintenance RescheduleMaintenance}.
314
402
  # @!attribute [rw] name
315
403
  # @return [::String]
316
404
  # Required. Redis instance resource name using the form:
@@ -318,7 +406,8 @@ module Google
318
406
  # where `location_id` refers to a GCP region.
319
407
  # @!attribute [rw] reschedule_type
320
408
  # @return [::Google::Cloud::Redis::V1::RescheduleMaintenanceRequest::RescheduleType]
321
- # Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well.
409
+ # Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as
410
+ # well.
322
411
  # @!attribute [rw] schedule_time
323
412
  # @return [::Google::Protobuf::Timestamp]
324
413
  # Optional. Timestamp when the maintenance shall be rescheduled to if
@@ -376,7 +465,8 @@ module Google
376
465
  # Required. Start time of the window in UTC time.
377
466
  # @!attribute [r] duration
378
467
  # @return [::Google::Protobuf::Duration]
379
- # Output only. Duration of the maintenance window. The current window is fixed at 1 hour.
468
+ # Output only. Duration of the maintenance window. The current window is
469
+ # fixed at 1 hour.
380
470
  class WeeklyMaintenanceWindow
381
471
  include ::Google::Protobuf::MessageExts
382
472
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -386,17 +476,19 @@ module Google
386
476
  # populated.
387
477
  # @!attribute [r] start_time
388
478
  # @return [::Google::Protobuf::Timestamp]
389
- # Output only. The start time of any upcoming scheduled maintenance for this instance.
479
+ # Output only. The start time of any upcoming scheduled maintenance for this
480
+ # instance.
390
481
  # @!attribute [r] end_time
391
482
  # @return [::Google::Protobuf::Timestamp]
392
- # Output only. The end time of any upcoming scheduled maintenance for this instance.
483
+ # Output only. The end time of any upcoming scheduled maintenance for this
484
+ # instance.
393
485
  # @!attribute [rw] can_reschedule
394
486
  # @return [::Boolean]
395
487
  # If the scheduled maintenance can be rescheduled, default is true.
396
488
  # @!attribute [r] schedule_deadline_time
397
489
  # @return [::Google::Protobuf::Timestamp]
398
- # Output only. The deadline that the maintenance schedule start time can not go beyond,
399
- # including reschedule.
490
+ # Output only. The deadline that the maintenance schedule start time can not
491
+ # go beyond, including reschedule.
400
492
  class MaintenanceSchedule
401
493
  include ::Google::Protobuf::MessageExts
402
494
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -420,7 +512,8 @@ module Google
420
512
  # @!attribute [rw] page_token
421
513
  # @return [::String]
422
514
  # The `next_page_token` value returned from a previous
423
- # {::Google::Cloud::Redis::V1::CloudRedis::Client#list_instances ListInstances} request, if any.
515
+ # {::Google::Cloud::Redis::V1::CloudRedis::Client#list_instances ListInstances} request, if
516
+ # any.
424
517
  class ListInstancesRequest
425
518
  include ::Google::Protobuf::MessageExts
426
519
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -463,7 +556,8 @@ module Google
463
556
  extend ::Google::Protobuf::MessageExts::ClassMethods
464
557
  end
465
558
 
466
- # Request for {::Google::Cloud::Redis::V1::CloudRedis::Client#get_instance_auth_string GetInstanceAuthString}.
559
+ # Request for
560
+ # {::Google::Cloud::Redis::V1::CloudRedis::Client#get_instance_auth_string GetInstanceAuthString}.
467
561
  # @!attribute [rw] name
468
562
  # @return [::String]
469
563
  # Required. Redis instance resource name using the form:
@@ -483,7 +577,8 @@ module Google
483
577
  extend ::Google::Protobuf::MessageExts::ClassMethods
484
578
  end
485
579
 
486
- # Request for {::Google::Cloud::Redis::V1::CloudRedis::Client#create_instance CreateInstance}.
580
+ # Request for
581
+ # {::Google::Cloud::Redis::V1::CloudRedis::Client#create_instance CreateInstance}.
487
582
  # @!attribute [rw] parent
488
583
  # @return [::String]
489
584
  # Required. The resource name of the instance location using the form:
@@ -507,7 +602,8 @@ module Google
507
602
  extend ::Google::Protobuf::MessageExts::ClassMethods
508
603
  end
509
604
 
510
- # Request for {::Google::Cloud::Redis::V1::CloudRedis::Client#update_instance UpdateInstance}.
605
+ # Request for
606
+ # {::Google::Cloud::Redis::V1::CloudRedis::Client#update_instance UpdateInstance}.
511
607
  # @!attribute [rw] update_mask
512
608
  # @return [::Google::Protobuf::FieldMask]
513
609
  # Required. Mask of fields to update. At least one path must be supplied in
@@ -528,7 +624,8 @@ module Google
528
624
  extend ::Google::Protobuf::MessageExts::ClassMethods
529
625
  end
530
626
 
531
- # Request for {::Google::Cloud::Redis::V1::CloudRedis::Client#upgrade_instance UpgradeInstance}.
627
+ # Request for
628
+ # {::Google::Cloud::Redis::V1::CloudRedis::Client#upgrade_instance UpgradeInstance}.
532
629
  # @!attribute [rw] name
533
630
  # @return [::String]
534
631
  # Required. Redis instance resource name using the form:
@@ -542,7 +639,8 @@ module Google
542
639
  extend ::Google::Protobuf::MessageExts::ClassMethods
543
640
  end
544
641
 
545
- # Request for {::Google::Cloud::Redis::V1::CloudRedis::Client#delete_instance DeleteInstance}.
642
+ # Request for
643
+ # {::Google::Cloud::Redis::V1::CloudRedis::Client#delete_instance DeleteInstance}.
546
644
  # @!attribute [rw] name
547
645
  # @return [::String]
548
646
  # Required. Redis instance resource name using the form:
@@ -26,8 +26,6 @@ module Google
26
26
  # service Foo {
27
27
  # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
28
28
  # }
29
- #
30
- # The JSON representation for `Empty` is empty JSON object `{}`.
31
29
  class Empty
32
30
  include ::Google::Protobuf::MessageExts
33
31
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -28,12 +28,14 @@ module Google
28
28
  # [API Design Guide](https://cloud.google.com/apis/design/errors).
29
29
  # @!attribute [rw] code
30
30
  # @return [::Integer]
31
- # The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
31
+ # The status code, which should be an enum value of
32
+ # [google.rpc.Code][google.rpc.Code].
32
33
  # @!attribute [rw] message
33
34
  # @return [::String]
34
35
  # A developer-facing error message, which should be in English. Any
35
36
  # user-facing error message should be localized and sent in the
36
- # {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized by the client.
37
+ # {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized
38
+ # by the client.
37
39
  # @!attribute [rw] details
38
40
  # @return [::Array<::Google::Protobuf::Any>]
39
41
  # A list of messages that carry the error details. There is a common set of
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-redis-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.8.0
4
+ version: 0.10.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-07-07 00:00:00.000000000 Z
11
+ date: 2023-05-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: '0.10'
19
+ version: 0.18.0
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: '0.10'
29
+ version: 0.18.0
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -44,20 +44,40 @@ dependencies:
44
44
  - - "~>"
45
45
  - !ruby/object:Gem::Version
46
46
  version: '1.0'
47
+ - !ruby/object:Gem::Dependency
48
+ name: google-cloud-location
49
+ requirement: !ruby/object:Gem::Requirement
50
+ requirements:
51
+ - - ">="
52
+ - !ruby/object:Gem::Version
53
+ version: '0.4'
54
+ - - "<"
55
+ - !ruby/object:Gem::Version
56
+ version: 2.a
57
+ type: :runtime
58
+ prerelease: false
59
+ version_requirements: !ruby/object:Gem::Requirement
60
+ requirements:
61
+ - - ">="
62
+ - !ruby/object:Gem::Version
63
+ version: '0.4'
64
+ - - "<"
65
+ - !ruby/object:Gem::Version
66
+ version: 2.a
47
67
  - !ruby/object:Gem::Dependency
48
68
  name: google-style
49
69
  requirement: !ruby/object:Gem::Requirement
50
70
  requirements:
51
71
  - - "~>"
52
72
  - !ruby/object:Gem::Version
53
- version: 1.26.1
73
+ version: 1.26.3
54
74
  type: :development
55
75
  prerelease: false
56
76
  version_requirements: !ruby/object:Gem::Requirement
57
77
  requirements:
58
78
  - - "~>"
59
79
  - !ruby/object:Gem::Version
60
- version: 1.26.1
80
+ version: 1.26.3
61
81
  - !ruby/object:Gem::Dependency
62
82
  name: minitest
63
83
  requirement: !ruby/object:Gem::Requirement
@@ -171,16 +191,24 @@ files:
171
191
  - README.md
172
192
  - lib/google-cloud-redis-v1.rb
173
193
  - lib/google/cloud/redis/v1.rb
194
+ - lib/google/cloud/redis/v1/bindings_override.rb
174
195
  - lib/google/cloud/redis/v1/cloud_redis.rb
175
196
  - lib/google/cloud/redis/v1/cloud_redis/client.rb
176
197
  - lib/google/cloud/redis/v1/cloud_redis/credentials.rb
177
198
  - lib/google/cloud/redis/v1/cloud_redis/operations.rb
178
199
  - lib/google/cloud/redis/v1/cloud_redis/paths.rb
200
+ - lib/google/cloud/redis/v1/cloud_redis/rest.rb
201
+ - lib/google/cloud/redis/v1/cloud_redis/rest/client.rb
202
+ - lib/google/cloud/redis/v1/cloud_redis/rest/operations.rb
203
+ - lib/google/cloud/redis/v1/cloud_redis/rest/service_stub.rb
179
204
  - lib/google/cloud/redis/v1/cloud_redis_pb.rb
180
205
  - lib/google/cloud/redis/v1/cloud_redis_services_pb.rb
206
+ - lib/google/cloud/redis/v1/rest.rb
181
207
  - lib/google/cloud/redis/v1/version.rb
182
208
  - proto_docs/README.md
209
+ - proto_docs/google/api/client.rb
183
210
  - proto_docs/google/api/field_behavior.rb
211
+ - proto_docs/google/api/launch_stage.rb
184
212
  - proto_docs/google/api/resource.rb
185
213
  - proto_docs/google/cloud/redis/v1/cloud_redis.rb
186
214
  - proto_docs/google/longrunning/operations.rb
@@ -211,8 +239,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
211
239
  - !ruby/object:Gem::Version
212
240
  version: '0'
213
241
  requirements: []
214
- rubygems_version: 3.3.14
242
+ rubygems_version: 3.4.2
215
243
  signing_key:
216
244
  specification_version: 4
217
- summary: API Client library for the Google Cloud Memorystore for Redis V1 API
245
+ summary: Creates and manages Redis instances on the Google Cloud Platform.
218
246
  test_files: []