google-cloud-redis-v1beta1 0.4.2 → 0.5.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.yardopts +1 -1
- data/AUTHENTICATION.md +7 -25
- data/lib/google/cloud/redis/v1beta1/cloud_redis/client.rb +298 -76
- data/lib/google/cloud/redis/v1beta1/cloud_redis/operations.rb +145 -33
- data/lib/google/cloud/redis/v1beta1/cloud_redis.rb +1 -1
- data/lib/google/cloud/redis/v1beta1/cloud_redis_pb.rb +18 -2
- data/lib/google/cloud/redis/v1beta1/cloud_redis_services_pb.rb +4 -4
- data/lib/google/cloud/redis/v1beta1/version.rb +1 -1
- data/proto_docs/google/api/resource.rb +10 -71
- data/proto_docs/google/cloud/redis/v1beta1/cloud_redis.rb +104 -39
- metadata +5 -5
@@ -21,6 +21,18 @@ module Google
|
|
21
21
|
module Cloud
|
22
22
|
module Redis
|
23
23
|
module V1beta1
|
24
|
+
# Node specific properties.
|
25
|
+
# @!attribute [r] id
|
26
|
+
# @return [::String]
|
27
|
+
# Output only. Node identifying string. e.g. 'node-0', 'node-1'
|
28
|
+
# @!attribute [r] zone
|
29
|
+
# @return [::String]
|
30
|
+
# Output only. Location of the node.
|
31
|
+
class NodeInfo
|
32
|
+
include ::Google::Protobuf::MessageExts
|
33
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
34
|
+
end
|
35
|
+
|
24
36
|
# A Google Cloud Redis instance.
|
25
37
|
# @!attribute [rw] name
|
26
38
|
# @return [::String]
|
@@ -31,8 +43,10 @@ module Google
|
|
31
43
|
# Note: Redis instances are managed and addressed at regional level so
|
32
44
|
# location_id here refers to a GCP region; however, users may choose which
|
33
45
|
# specific zone (or collection of zones for cross-zone instances) an instance
|
34
|
-
# should be provisioned in. Refer to
|
35
|
-
# {::Google::Cloud::Redis::V1beta1::Instance#
|
46
|
+
# should be provisioned in. Refer to
|
47
|
+
# {::Google::Cloud::Redis::V1beta1::Instance#location_id location_id} and
|
48
|
+
# {::Google::Cloud::Redis::V1beta1::Instance#alternative_location_id alternative_location_id}
|
49
|
+
# fields for more details.
|
36
50
|
# @!attribute [rw] display_name
|
37
51
|
# @return [::String]
|
38
52
|
# An arbitrary and optional user-provided name for the instance.
|
@@ -42,15 +56,17 @@ module Google
|
|
42
56
|
# @!attribute [rw] location_id
|
43
57
|
# @return [::String]
|
44
58
|
# Optional. The zone where the instance will be provisioned. If not provided,
|
45
|
-
# the service will choose a zone for the instance.
|
46
|
-
#
|
47
|
-
# failures. If
|
48
|
-
#
|
59
|
+
# the service will choose a zone from the specified region for the instance.
|
60
|
+
# For standard tier, additional nodes will be added across multiple zones for
|
61
|
+
# protection against zonal failures. If specified, at least one node will be
|
62
|
+
# provisioned in this zone.
|
49
63
|
# @!attribute [rw] alternative_location_id
|
50
64
|
# @return [::String]
|
51
|
-
# Optional.
|
52
|
-
#
|
53
|
-
# must be a different zone from the one
|
65
|
+
# Optional. If specified, at least one node will be provisioned in this zone
|
66
|
+
# in addition to the zone specified in location_id. Only applicable to
|
67
|
+
# standard tier. If provided, it must be a different zone from the one
|
68
|
+
# provided in [location_id]. Additional nodes beyond the first 2 will be
|
69
|
+
# placed in zones selected by the service.
|
54
70
|
# @!attribute [rw] redis_version
|
55
71
|
# @return [::String]
|
56
72
|
# Optional. The version of Redis software.
|
@@ -60,26 +76,29 @@ module Google
|
|
60
76
|
# * `REDIS_3_2` for Redis 3.2 compatibility
|
61
77
|
# * `REDIS_4_0` for Redis 4.0 compatibility (default)
|
62
78
|
# * `REDIS_5_0` for Redis 5.0 compatibility
|
79
|
+
# * `REDIS_6_X` for Redis 6.x compatibility
|
63
80
|
# @!attribute [rw] reserved_ip_range
|
64
81
|
# @return [::String]
|
65
|
-
# Optional.
|
66
|
-
#
|
67
|
-
#
|
68
|
-
#
|
82
|
+
# Optional. For DIRECT_PEERING mode, the CIDR range of internal addresses
|
83
|
+
# that are reserved for this instance. Range must
|
84
|
+
# be unique and non-overlapping with existing subnets in an authorized
|
85
|
+
# network. For PRIVATE_SERVICE_ACCESS mode, the name of one allocated IP
|
86
|
+
# address ranges associated with this private service access connection.
|
87
|
+
# If not provided, the service will choose an unused /29 block, for
|
88
|
+
# example, 10.0.0.0/29 or 192.168.0.0/29. For READ_REPLICAS_ENABLED
|
89
|
+
# the default block size is /28.
|
69
90
|
# @!attribute [r] host
|
70
91
|
# @return [::String]
|
71
92
|
# Output only. Hostname or IP address of the exposed Redis endpoint used by
|
72
|
-
#
|
93
|
+
# clients to connect to the service.
|
73
94
|
# @!attribute [r] port
|
74
95
|
# @return [::Integer]
|
75
96
|
# Output only. The port number of the exposed Redis endpoint.
|
76
97
|
# @!attribute [r] current_location_id
|
77
98
|
# @return [::String]
|
78
|
-
# Output only. The current zone where the Redis
|
79
|
-
#
|
80
|
-
#
|
81
|
-
# this can be either {::Google::Cloud::Redis::V1beta1::Instance#location_id location_id} or {::Google::Cloud::Redis::V1beta1::Instance#alternative_location_id alternative_location_id} and can
|
82
|
-
# change after a failover event.
|
99
|
+
# Output only. The current zone where the Redis primary node is located. In
|
100
|
+
# basic tier, this will always be the same as [location_id]. In
|
101
|
+
# standard tier, this can be the zone of any node in the instance.
|
83
102
|
# @!attribute [r] create_time
|
84
103
|
# @return [::Google::Protobuf::Timestamp]
|
85
104
|
# Output only. The time the instance was created.
|
@@ -133,9 +152,29 @@ module Google
|
|
133
152
|
# operation.
|
134
153
|
# @!attribute [rw] connect_mode
|
135
154
|
# @return [::Google::Cloud::Redis::V1beta1::Instance::ConnectMode]
|
136
|
-
# Optional. The connect mode of Redis instance.
|
137
|
-
# If not provided,
|
138
|
-
#
|
155
|
+
# Optional. The network connect mode of the Redis instance.
|
156
|
+
# If not provided, the connect mode defaults to DIRECT_PEERING.
|
157
|
+
# @!attribute [rw] replica_count
|
158
|
+
# @return [::Integer]
|
159
|
+
# Optional. The number of replica nodes. Valid range for standard tier
|
160
|
+
# is [1-5] and defaults to 1. Valid value for basic tier is 0 and defaults
|
161
|
+
# to 0.
|
162
|
+
# @!attribute [r] nodes
|
163
|
+
# @return [::Array<::Google::Cloud::Redis::V1beta1::NodeInfo>]
|
164
|
+
# Output only. Info per node.
|
165
|
+
# @!attribute [r] read_endpoint
|
166
|
+
# @return [::String]
|
167
|
+
# Output only. Hostname or IP address of the exposed readonly Redis
|
168
|
+
# endpoint. Standard tier only. Targets all healthy replica nodes in
|
169
|
+
# instance. Replication is asynchronous and replica nodes will exhibit some
|
170
|
+
# lag behind the primary. Write requests must target 'host'.
|
171
|
+
# @!attribute [r] read_endpoint_port
|
172
|
+
# @return [::Integer]
|
173
|
+
# Output only. The port number of the exposed readonly redis
|
174
|
+
# endpoint. Standard tier only. Write requests should target 'port'.
|
175
|
+
# @!attribute [rw] read_replicas_mode
|
176
|
+
# @return [::Google::Cloud::Redis::V1beta1::Instance::ReadReplicasMode]
|
177
|
+
# Optional. Read replica mode.
|
139
178
|
class Instance
|
140
179
|
include ::Google::Protobuf::MessageExts
|
141
180
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -207,16 +246,33 @@ module Google
|
|
207
246
|
# Not set.
|
208
247
|
CONNECT_MODE_UNSPECIFIED = 0
|
209
248
|
|
210
|
-
# Connect via
|
249
|
+
# Connect via direct peering to the Memorystore for Redis hosted service.
|
211
250
|
DIRECT_PEERING = 1
|
212
251
|
|
213
|
-
# Connect
|
214
|
-
#
|
252
|
+
# Connect your Memorystore for Redis instance using Private Service
|
253
|
+
# Access. Private services access provides an IP address range for multiple
|
254
|
+
# Google Cloud services, including Memorystore.
|
215
255
|
PRIVATE_SERVICE_ACCESS = 2
|
216
256
|
end
|
257
|
+
|
258
|
+
# Read replicas mode.
|
259
|
+
module ReadReplicasMode
|
260
|
+
# If not set, Memorystore for Redis backend will pick the mode based on
|
261
|
+
# other fields in the request.
|
262
|
+
READ_REPLICAS_MODE_UNSPECIFIED = 0
|
263
|
+
|
264
|
+
# If disabled, read endpoint will not be provided and the instance cannot
|
265
|
+
# scale up or down the number of replicas.
|
266
|
+
READ_REPLICAS_DISABLED = 1
|
267
|
+
|
268
|
+
# If enabled, read endpoint will be provided and the instance can scale
|
269
|
+
# up and down the number of replicas.
|
270
|
+
READ_REPLICAS_ENABLED = 2
|
271
|
+
end
|
217
272
|
end
|
218
273
|
|
219
|
-
# Request for
|
274
|
+
# Request for
|
275
|
+
# {::Google::Cloud::Redis::V1beta1::CloudRedis::Client#list_instances ListInstances}.
|
220
276
|
# @!attribute [rw] parent
|
221
277
|
# @return [::String]
|
222
278
|
# Required. The resource name of the instance location using the form:
|
@@ -234,13 +290,15 @@ module Google
|
|
234
290
|
# @!attribute [rw] page_token
|
235
291
|
# @return [::String]
|
236
292
|
# The `next_page_token` value returned from a previous
|
237
|
-
# {::Google::Cloud::Redis::V1beta1::CloudRedis::Client#list_instances ListInstances}
|
293
|
+
# {::Google::Cloud::Redis::V1beta1::CloudRedis::Client#list_instances ListInstances}
|
294
|
+
# request, if any.
|
238
295
|
class ListInstancesRequest
|
239
296
|
include ::Google::Protobuf::MessageExts
|
240
297
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
241
298
|
end
|
242
299
|
|
243
|
-
# Response for
|
300
|
+
# Response for
|
301
|
+
# {::Google::Cloud::Redis::V1beta1::CloudRedis::Client#list_instances ListInstances}.
|
244
302
|
# @!attribute [rw] instances
|
245
303
|
# @return [::Array<::Google::Cloud::Redis::V1beta1::Instance>]
|
246
304
|
# A list of Redis instances in the project in the specified location,
|
@@ -248,11 +306,12 @@ module Google
|
|
248
306
|
#
|
249
307
|
# If the `location_id` in the parent field of the request is "-", all regions
|
250
308
|
# available to the project are queried, and the results aggregated.
|
251
|
-
# If in such an aggregated query a location is unavailable, a
|
252
|
-
# entry is included in the response with the `name` field set to a
|
253
|
-
# the form
|
254
|
-
#
|
255
|
-
#
|
309
|
+
# If in such an aggregated query a location is unavailable, a placeholder
|
310
|
+
# Redis entry is included in the response with the `name` field set to a
|
311
|
+
# value of the form
|
312
|
+
# `projects/{project_id}/locations/{location_id}/instances/`- and the
|
313
|
+
# `status` field set to ERROR and `status_message` field set to "location not
|
314
|
+
# available for ListInstances".
|
256
315
|
# @!attribute [rw] next_page_token
|
257
316
|
# @return [::String]
|
258
317
|
# Token to retrieve the next page of results, or empty if there are no more
|
@@ -276,7 +335,8 @@ module Google
|
|
276
335
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
277
336
|
end
|
278
337
|
|
279
|
-
# Request for
|
338
|
+
# Request for
|
339
|
+
# {::Google::Cloud::Redis::V1beta1::CloudRedis::Client#create_instance CreateInstance}.
|
280
340
|
# @!attribute [rw] parent
|
281
341
|
# @return [::String]
|
282
342
|
# Required. The resource name of the instance location using the form:
|
@@ -300,7 +360,8 @@ module Google
|
|
300
360
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
301
361
|
end
|
302
362
|
|
303
|
-
# Request for
|
363
|
+
# Request for
|
364
|
+
# {::Google::Cloud::Redis::V1beta1::CloudRedis::Client#update_instance UpdateInstance}.
|
304
365
|
# @!attribute [rw] update_mask
|
305
366
|
# @return [::Google::Protobuf::FieldMask]
|
306
367
|
# Required. Mask of fields to update. At least one path must be supplied in
|
@@ -311,6 +372,7 @@ module Google
|
|
311
372
|
# * `labels`
|
312
373
|
# * `memorySizeGb`
|
313
374
|
# * `redisConfig`
|
375
|
+
# * `replica_count`
|
314
376
|
# @!attribute [rw] instance
|
315
377
|
# @return [::Google::Cloud::Redis::V1beta1::Instance]
|
316
378
|
# Required. Update description.
|
@@ -320,7 +382,8 @@ module Google
|
|
320
382
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
321
383
|
end
|
322
384
|
|
323
|
-
# Request for
|
385
|
+
# Request for
|
386
|
+
# {::Google::Cloud::Redis::V1beta1::CloudRedis::Client#upgrade_instance UpgradeInstance}.
|
324
387
|
# @!attribute [rw] name
|
325
388
|
# @return [::String]
|
326
389
|
# Required. Redis instance resource name using the form:
|
@@ -334,7 +397,8 @@ module Google
|
|
334
397
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
335
398
|
end
|
336
399
|
|
337
|
-
# Request for
|
400
|
+
# Request for
|
401
|
+
# {::Google::Cloud::Redis::V1beta1::CloudRedis::Client#delete_instance DeleteInstance}.
|
338
402
|
# @!attribute [rw] name
|
339
403
|
# @return [::String]
|
340
404
|
# Required. Redis instance resource name using the form:
|
@@ -410,7 +474,8 @@ module Google
|
|
410
474
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
411
475
|
end
|
412
476
|
|
413
|
-
# Request for
|
477
|
+
# Request for
|
478
|
+
# {::Google::Cloud::Redis::V1beta1::CloudRedis::Client#failover_instance Failover}.
|
414
479
|
# @!attribute [rw] name
|
415
480
|
# @return [::String]
|
416
481
|
# Required. Redis instance resource name using the form:
|
@@ -432,7 +497,7 @@ module Google
|
|
432
497
|
|
433
498
|
# Instance failover will be protected with data loss control. More
|
434
499
|
# specifically, the failover will only be performed if the current
|
435
|
-
# replication offset diff between
|
500
|
+
# replication offset diff between primary and replica is under a certain
|
436
501
|
# threshold.
|
437
502
|
LIMITED_DATA_LOSS = 1
|
438
503
|
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-redis-v1beta1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.5.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2022-01-11 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.
|
19
|
+
version: '0.7'
|
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.
|
29
|
+
version: '0.7'
|
30
30
|
- - "<"
|
31
31
|
- !ruby/object:Gem::Version
|
32
32
|
version: 2.a
|
@@ -209,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
209
209
|
- !ruby/object:Gem::Version
|
210
210
|
version: '0'
|
211
211
|
requirements: []
|
212
|
-
rubygems_version: 3.
|
212
|
+
rubygems_version: 3.3.4
|
213
213
|
signing_key:
|
214
214
|
specification_version: 4
|
215
215
|
summary: API Client library for the Google Cloud Memorystore for Redis V1beta1 API
|