google-cloud-redis-v1 0.6.0 → 0.8.0
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/README.md +11 -6
- data/lib/google/cloud/redis/v1/cloud_redis/client.rb +210 -0
- data/lib/google/cloud/redis/v1/cloud_redis/operations.rb +3 -0
- data/lib/google/cloud/redis/v1/cloud_redis_pb.rb +66 -1
- data/lib/google/cloud/redis/v1/cloud_redis_services_pb.rb +7 -0
- data/lib/google/cloud/redis/v1/version.rb +1 -1
- data/lib/google/cloud/redis/v1.rb +2 -0
- data/proto_docs/google/api/resource.rb +10 -71
- data/proto_docs/google/cloud/redis/v1/cloud_redis.rb +186 -8
- data/proto_docs/google/protobuf/any.rb +3 -3
- data/proto_docs/google/type/dayofweek.rb +49 -0
- data/proto_docs/google/type/timeofday.rb +45 -0
- metadata +14 -12
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 5ebd67b21f3d1a1407b08ee649095c9a5c14889ead398a89ea171697d277df7b
|
4
|
+
data.tar.gz: 7ca3cb6081be0c2f308ac5361f9ea41f75ba56ea844b21de81ec994a4fce31a7
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ba9dd13fb9767bba489a0311285cb60da5d254e8c51d40551e3e633fb3e16a565cbc39331cc57480d1999f73e824e8029f6215ed9512fb683f21274eb03b1882
|
7
|
+
data.tar.gz: 8a5acf4955c7a4dfcda5768accb91076011971164409a3d62491c5f2867f9603252ed1d097a27e0739861fd08bbedb1a0ae8f3e8f53fc6a01d00c976eda04744
|
data/.yardopts
CHANGED
data/AUTHENTICATION.md
CHANGED
@@ -120,15 +120,6 @@ To configure your system for this, simply:
|
|
120
120
|
**NOTE:** This is _not_ recommended for running in production. The Cloud SDK
|
121
121
|
*should* only be used during development.
|
122
122
|
|
123
|
-
[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
|
124
|
-
[dev-console]: https://console.cloud.google.com/project
|
125
|
-
|
126
|
-
[enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
|
127
|
-
|
128
|
-
[create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
|
129
|
-
[create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
|
130
|
-
[reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
|
131
|
-
|
132
123
|
## Creating a Service Account
|
133
124
|
|
134
125
|
Google Cloud requires **Service Account Credentials** to
|
@@ -139,31 +130,22 @@ If you are not running this client within
|
|
139
130
|
[Google Cloud Platform environments](#google-cloud-platform-environments), you
|
140
131
|
need a Google Developers service account.
|
141
132
|
|
142
|
-
1. Visit the [Google
|
133
|
+
1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
|
143
134
|
2. Create a new project or click on an existing project.
|
144
|
-
3. Activate the
|
135
|
+
3. Activate the menu in the upper left and select **APIs & Services**. From
|
145
136
|
here, you will enable the APIs that your application requires.
|
146
137
|
|
147
|
-
![Enable the APIs that your application requires][enable-apis]
|
148
|
-
|
149
138
|
*Note: You may need to enable billing in order to use these services.*
|
150
139
|
|
151
140
|
4. Select **Credentials** from the side navigation.
|
152
141
|
|
153
|
-
|
154
|
-
|
155
|
-
![Create a new service account][create-new-service-account]
|
156
|
-
|
157
|
-
![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
|
158
|
-
|
159
|
-
Find the "Add credentials" drop down and select "Service account" to be
|
160
|
-
guided through downloading a new JSON key file.
|
142
|
+
Find the "Create credentials" drop down near the top of the page, and select
|
143
|
+
"Service account" to be guided through downloading a new JSON key file.
|
161
144
|
|
162
145
|
If you want to re-use an existing service account, you can easily generate a
|
163
|
-
new key file. Just select the account you wish to re-use,
|
164
|
-
|
165
|
-
|
166
|
-
![Re-use an existing service account][reuse-service-account]
|
146
|
+
new key file. Just select the account you wish to re-use, click the pencil
|
147
|
+
tool on the right side to edit the service account, select the **Keys** tab,
|
148
|
+
and then select **Add Key**.
|
167
149
|
|
168
150
|
The key file you download will be used by this library to authenticate API
|
169
151
|
requests and should be stored in a secure location.
|
data/README.md
CHANGED
@@ -37,7 +37,7 @@ request = ::Google::Cloud::Redis::V1::ListInstancesRequest.new # (request fields
|
|
37
37
|
response = client.list_instances request
|
38
38
|
```
|
39
39
|
|
40
|
-
View the [Client Library Documentation](https://
|
40
|
+
View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-redis-v1/latest)
|
41
41
|
for class and method documentation.
|
42
42
|
|
43
43
|
See also the [Product Documentation](https://cloud.google.com/memorystore/docs/redis)
|
@@ -69,16 +69,21 @@ module GRPC
|
|
69
69
|
end
|
70
70
|
```
|
71
71
|
|
72
|
+
|
73
|
+
## Google Cloud Samples
|
74
|
+
|
75
|
+
To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
|
76
|
+
|
72
77
|
## Supported Ruby Versions
|
73
78
|
|
74
|
-
This library is supported on Ruby 2.
|
79
|
+
This library is supported on Ruby 2.6+.
|
75
80
|
|
76
81
|
Google provides official support for Ruby versions that are actively supported
|
77
82
|
by Ruby Core—that is, Ruby versions that are either in normal maintenance or
|
78
|
-
in security maintenance, and not end of life.
|
79
|
-
|
80
|
-
|
81
|
-
|
83
|
+
in security maintenance, and not end of life. Older versions of Ruby _may_
|
84
|
+
still work, but are unsupported and not recommended. See
|
85
|
+
https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby
|
86
|
+
support schedule.
|
82
87
|
|
83
88
|
## Which client should I use?
|
84
89
|
|
@@ -82,6 +82,8 @@ module Google
|
|
82
82
|
|
83
83
|
default_config.rpcs.get_instance.timeout = 600.0
|
84
84
|
|
85
|
+
default_config.rpcs.get_instance_auth_string.timeout = 600.0
|
86
|
+
|
85
87
|
default_config.rpcs.create_instance.timeout = 600.0
|
86
88
|
|
87
89
|
default_config.rpcs.update_instance.timeout = 600.0
|
@@ -96,6 +98,8 @@ module Google
|
|
96
98
|
|
97
99
|
default_config.rpcs.delete_instance.timeout = 600.0
|
98
100
|
|
101
|
+
default_config.rpcs.reschedule_maintenance.timeout = 600.0
|
102
|
+
|
99
103
|
default_config
|
100
104
|
end
|
101
105
|
yield @configure if block_given?
|
@@ -167,6 +171,7 @@ module Google
|
|
167
171
|
|
168
172
|
@operations_client = Operations.new do |config|
|
169
173
|
config.credentials = credentials
|
174
|
+
config.quota_project = @quota_project_id
|
170
175
|
config.endpoint = @config.endpoint
|
171
176
|
end
|
172
177
|
|
@@ -388,6 +393,95 @@ module Google
|
|
388
393
|
raise ::Google::Cloud::Error.from_error(e)
|
389
394
|
end
|
390
395
|
|
396
|
+
##
|
397
|
+
# Gets the AUTH string for a Redis instance. If AUTH is not enabled for the
|
398
|
+
# instance the response will be empty. This information is not included in
|
399
|
+
# the details returned to GetInstance.
|
400
|
+
#
|
401
|
+
# @overload get_instance_auth_string(request, options = nil)
|
402
|
+
# Pass arguments to `get_instance_auth_string` via a request object, either of type
|
403
|
+
# {::Google::Cloud::Redis::V1::GetInstanceAuthStringRequest} or an equivalent Hash.
|
404
|
+
#
|
405
|
+
# @param request [::Google::Cloud::Redis::V1::GetInstanceAuthStringRequest, ::Hash]
|
406
|
+
# A request object representing the call parameters. Required. To specify no
|
407
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
408
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
409
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
410
|
+
#
|
411
|
+
# @overload get_instance_auth_string(name: nil)
|
412
|
+
# Pass arguments to `get_instance_auth_string` via keyword arguments. Note that at
|
413
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
414
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
415
|
+
#
|
416
|
+
# @param name [::String]
|
417
|
+
# Required. Redis instance resource name using the form:
|
418
|
+
# `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
|
419
|
+
# where `location_id` refers to a GCP region.
|
420
|
+
#
|
421
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
422
|
+
# @yieldparam response [::Google::Cloud::Redis::V1::InstanceAuthString]
|
423
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
424
|
+
#
|
425
|
+
# @return [::Google::Cloud::Redis::V1::InstanceAuthString]
|
426
|
+
#
|
427
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
428
|
+
#
|
429
|
+
# @example Basic example
|
430
|
+
# require "google/cloud/redis/v1"
|
431
|
+
#
|
432
|
+
# # Create a client object. The client can be reused for multiple calls.
|
433
|
+
# client = Google::Cloud::Redis::V1::CloudRedis::Client.new
|
434
|
+
#
|
435
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
436
|
+
# request = Google::Cloud::Redis::V1::GetInstanceAuthStringRequest.new
|
437
|
+
#
|
438
|
+
# # Call the get_instance_auth_string method.
|
439
|
+
# result = client.get_instance_auth_string request
|
440
|
+
#
|
441
|
+
# # The returned object is of type Google::Cloud::Redis::V1::InstanceAuthString.
|
442
|
+
# p result
|
443
|
+
#
|
444
|
+
def get_instance_auth_string request, options = nil
|
445
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
446
|
+
|
447
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Redis::V1::GetInstanceAuthStringRequest
|
448
|
+
|
449
|
+
# Converts hash and nil to an options object
|
450
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
451
|
+
|
452
|
+
# Customize the options with defaults
|
453
|
+
metadata = @config.rpcs.get_instance_auth_string.metadata.to_h
|
454
|
+
|
455
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
456
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
457
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
458
|
+
gapic_version: ::Google::Cloud::Redis::V1::VERSION
|
459
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
460
|
+
|
461
|
+
header_params = {}
|
462
|
+
if request.name
|
463
|
+
header_params["name"] = request.name
|
464
|
+
end
|
465
|
+
|
466
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
467
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
468
|
+
|
469
|
+
options.apply_defaults timeout: @config.rpcs.get_instance_auth_string.timeout,
|
470
|
+
metadata: metadata,
|
471
|
+
retry_policy: @config.rpcs.get_instance_auth_string.retry_policy
|
472
|
+
|
473
|
+
options.apply_defaults timeout: @config.timeout,
|
474
|
+
metadata: @config.metadata,
|
475
|
+
retry_policy: @config.retry_policy
|
476
|
+
|
477
|
+
@cloud_redis_stub.call_rpc :get_instance_auth_string, request, options: options do |response, operation|
|
478
|
+
yield response, operation if block_given?
|
479
|
+
return response
|
480
|
+
end
|
481
|
+
rescue ::GRPC::BadStatus => e
|
482
|
+
raise ::Google::Cloud::Error.from_error(e)
|
483
|
+
end
|
484
|
+
|
391
485
|
##
|
392
486
|
# Creates a Redis instance based on the specified tier and memory size.
|
393
487
|
#
|
@@ -1112,6 +1206,108 @@ module Google
|
|
1112
1206
|
raise ::Google::Cloud::Error.from_error(e)
|
1113
1207
|
end
|
1114
1208
|
|
1209
|
+
##
|
1210
|
+
# Reschedule maintenance for a given instance in a given project and
|
1211
|
+
# location.
|
1212
|
+
#
|
1213
|
+
# @overload reschedule_maintenance(request, options = nil)
|
1214
|
+
# Pass arguments to `reschedule_maintenance` via a request object, either of type
|
1215
|
+
# {::Google::Cloud::Redis::V1::RescheduleMaintenanceRequest} or an equivalent Hash.
|
1216
|
+
#
|
1217
|
+
# @param request [::Google::Cloud::Redis::V1::RescheduleMaintenanceRequest, ::Hash]
|
1218
|
+
# A request object representing the call parameters. Required. To specify no
|
1219
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
1220
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
1221
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
1222
|
+
#
|
1223
|
+
# @overload reschedule_maintenance(name: nil, reschedule_type: nil, schedule_time: nil)
|
1224
|
+
# Pass arguments to `reschedule_maintenance` via keyword arguments. Note that at
|
1225
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
1226
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
1227
|
+
#
|
1228
|
+
# @param name [::String]
|
1229
|
+
# Required. Redis instance resource name using the form:
|
1230
|
+
# `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
|
1231
|
+
# where `location_id` refers to a GCP region.
|
1232
|
+
# @param reschedule_type [::Google::Cloud::Redis::V1::RescheduleMaintenanceRequest::RescheduleType]
|
1233
|
+
# Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well.
|
1234
|
+
# @param schedule_time [::Google::Protobuf::Timestamp, ::Hash]
|
1235
|
+
# Optional. Timestamp when the maintenance shall be rescheduled to if
|
1236
|
+
# reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for
|
1237
|
+
# example `2012-11-15T16:19:00.094Z`.
|
1238
|
+
#
|
1239
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
1240
|
+
# @yieldparam response [::Gapic::Operation]
|
1241
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
1242
|
+
#
|
1243
|
+
# @return [::Gapic::Operation]
|
1244
|
+
#
|
1245
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
1246
|
+
#
|
1247
|
+
# @example Basic example
|
1248
|
+
# require "google/cloud/redis/v1"
|
1249
|
+
#
|
1250
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1251
|
+
# client = Google::Cloud::Redis::V1::CloudRedis::Client.new
|
1252
|
+
#
|
1253
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1254
|
+
# request = Google::Cloud::Redis::V1::RescheduleMaintenanceRequest.new
|
1255
|
+
#
|
1256
|
+
# # Call the reschedule_maintenance method.
|
1257
|
+
# result = client.reschedule_maintenance request
|
1258
|
+
#
|
1259
|
+
# # The returned object is of type Gapic::Operation. You can use this
|
1260
|
+
# # object to check the status of an operation, cancel it, or wait
|
1261
|
+
# # for results. Here is how to block until completion:
|
1262
|
+
# result.wait_until_done! timeout: 60
|
1263
|
+
# if result.response?
|
1264
|
+
# p result.response
|
1265
|
+
# else
|
1266
|
+
# puts "Error!"
|
1267
|
+
# end
|
1268
|
+
#
|
1269
|
+
def reschedule_maintenance request, options = nil
|
1270
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
1271
|
+
|
1272
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Redis::V1::RescheduleMaintenanceRequest
|
1273
|
+
|
1274
|
+
# Converts hash and nil to an options object
|
1275
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
1276
|
+
|
1277
|
+
# Customize the options with defaults
|
1278
|
+
metadata = @config.rpcs.reschedule_maintenance.metadata.to_h
|
1279
|
+
|
1280
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
1281
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
1282
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
1283
|
+
gapic_version: ::Google::Cloud::Redis::V1::VERSION
|
1284
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1285
|
+
|
1286
|
+
header_params = {}
|
1287
|
+
if request.name
|
1288
|
+
header_params["name"] = request.name
|
1289
|
+
end
|
1290
|
+
|
1291
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
1292
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
1293
|
+
|
1294
|
+
options.apply_defaults timeout: @config.rpcs.reschedule_maintenance.timeout,
|
1295
|
+
metadata: metadata,
|
1296
|
+
retry_policy: @config.rpcs.reschedule_maintenance.retry_policy
|
1297
|
+
|
1298
|
+
options.apply_defaults timeout: @config.timeout,
|
1299
|
+
metadata: @config.metadata,
|
1300
|
+
retry_policy: @config.retry_policy
|
1301
|
+
|
1302
|
+
@cloud_redis_stub.call_rpc :reschedule_maintenance, request, options: options do |response, operation|
|
1303
|
+
response = ::Gapic::Operation.new response, @operations_client, options: options
|
1304
|
+
yield response, operation if block_given?
|
1305
|
+
return response
|
1306
|
+
end
|
1307
|
+
rescue ::GRPC::BadStatus => e
|
1308
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1309
|
+
end
|
1310
|
+
|
1115
1311
|
##
|
1116
1312
|
# Configuration class for the CloudRedis API.
|
1117
1313
|
#
|
@@ -1258,6 +1454,11 @@ module Google
|
|
1258
1454
|
#
|
1259
1455
|
attr_reader :get_instance
|
1260
1456
|
##
|
1457
|
+
# RPC-specific configuration for `get_instance_auth_string`
|
1458
|
+
# @return [::Gapic::Config::Method]
|
1459
|
+
#
|
1460
|
+
attr_reader :get_instance_auth_string
|
1461
|
+
##
|
1261
1462
|
# RPC-specific configuration for `create_instance`
|
1262
1463
|
# @return [::Gapic::Config::Method]
|
1263
1464
|
#
|
@@ -1292,6 +1493,11 @@ module Google
|
|
1292
1493
|
# @return [::Gapic::Config::Method]
|
1293
1494
|
#
|
1294
1495
|
attr_reader :delete_instance
|
1496
|
+
##
|
1497
|
+
# RPC-specific configuration for `reschedule_maintenance`
|
1498
|
+
# @return [::Gapic::Config::Method]
|
1499
|
+
#
|
1500
|
+
attr_reader :reschedule_maintenance
|
1295
1501
|
|
1296
1502
|
# @private
|
1297
1503
|
def initialize parent_rpcs = nil
|
@@ -1299,6 +1505,8 @@ module Google
|
|
1299
1505
|
@list_instances = ::Gapic::Config::Method.new list_instances_config
|
1300
1506
|
get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
|
1301
1507
|
@get_instance = ::Gapic::Config::Method.new get_instance_config
|
1508
|
+
get_instance_auth_string_config = parent_rpcs.get_instance_auth_string if parent_rpcs.respond_to? :get_instance_auth_string
|
1509
|
+
@get_instance_auth_string = ::Gapic::Config::Method.new get_instance_auth_string_config
|
1302
1510
|
create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
|
1303
1511
|
@create_instance = ::Gapic::Config::Method.new create_instance_config
|
1304
1512
|
update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
|
@@ -1313,6 +1521,8 @@ module Google
|
|
1313
1521
|
@failover_instance = ::Gapic::Config::Method.new failover_instance_config
|
1314
1522
|
delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
|
1315
1523
|
@delete_instance = ::Gapic::Config::Method.new delete_instance_config
|
1524
|
+
reschedule_maintenance_config = parent_rpcs.reschedule_maintenance if parent_rpcs.respond_to? :reschedule_maintenance
|
1525
|
+
@reschedule_maintenance = ::Gapic::Config::Method.new reschedule_maintenance_config
|
1316
1526
|
|
1317
1527
|
yield self if block_given?
|
1318
1528
|
end
|
@@ -1,14 +1,18 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/cloud/redis/v1/cloud_redis.proto
|
3
3
|
|
4
|
+
require 'google/protobuf'
|
5
|
+
|
4
6
|
require 'google/api/annotations_pb'
|
5
7
|
require 'google/api/client_pb'
|
6
8
|
require 'google/api/field_behavior_pb'
|
7
9
|
require 'google/api/resource_pb'
|
8
10
|
require 'google/longrunning/operations_pb'
|
11
|
+
require 'google/protobuf/duration_pb'
|
9
12
|
require 'google/protobuf/field_mask_pb'
|
10
13
|
require 'google/protobuf/timestamp_pb'
|
11
|
-
require 'google/
|
14
|
+
require 'google/type/dayofweek_pb'
|
15
|
+
require 'google/type/timeofday_pb'
|
12
16
|
|
13
17
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
14
18
|
add_file("google/cloud/redis/v1/cloud_redis.proto", :syntax => :proto3) do
|
@@ -24,6 +28,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
24
28
|
optional :alternative_location_id, :string, 5
|
25
29
|
optional :redis_version, :string, 7
|
26
30
|
optional :reserved_ip_range, :string, 9
|
31
|
+
optional :secondary_ip_range, :string, 30
|
27
32
|
optional :host, :string, 10
|
28
33
|
optional :port, :int32, 11
|
29
34
|
optional :current_location_id, :string, 12
|
@@ -36,6 +41,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
36
41
|
optional :authorized_network, :string, 20
|
37
42
|
optional :persistence_iam_identity, :string, 21
|
38
43
|
optional :connect_mode, :enum, 22, "google.cloud.redis.v1.Instance.ConnectMode"
|
44
|
+
optional :auth_enabled, :bool, 23
|
45
|
+
repeated :server_ca_certs, :message, 25, "google.cloud.redis.v1.TlsCertificate"
|
46
|
+
optional :transit_encryption_mode, :enum, 26, "google.cloud.redis.v1.Instance.TransitEncryptionMode"
|
47
|
+
optional :maintenance_policy, :message, 27, "google.cloud.redis.v1.MaintenancePolicy"
|
48
|
+
optional :maintenance_schedule, :message, 28, "google.cloud.redis.v1.MaintenanceSchedule"
|
39
49
|
optional :replica_count, :int32, 31
|
40
50
|
repeated :nodes, :message, 32, "google.cloud.redis.v1.NodeInfo"
|
41
51
|
optional :read_endpoint, :string, 33
|
@@ -63,11 +73,44 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
63
73
|
value :DIRECT_PEERING, 1
|
64
74
|
value :PRIVATE_SERVICE_ACCESS, 2
|
65
75
|
end
|
76
|
+
add_enum "google.cloud.redis.v1.Instance.TransitEncryptionMode" do
|
77
|
+
value :TRANSIT_ENCRYPTION_MODE_UNSPECIFIED, 0
|
78
|
+
value :SERVER_AUTHENTICATION, 1
|
79
|
+
value :DISABLED, 2
|
80
|
+
end
|
66
81
|
add_enum "google.cloud.redis.v1.Instance.ReadReplicasMode" do
|
67
82
|
value :READ_REPLICAS_MODE_UNSPECIFIED, 0
|
68
83
|
value :READ_REPLICAS_DISABLED, 1
|
69
84
|
value :READ_REPLICAS_ENABLED, 2
|
70
85
|
end
|
86
|
+
add_message "google.cloud.redis.v1.RescheduleMaintenanceRequest" do
|
87
|
+
optional :name, :string, 1
|
88
|
+
optional :reschedule_type, :enum, 2, "google.cloud.redis.v1.RescheduleMaintenanceRequest.RescheduleType"
|
89
|
+
optional :schedule_time, :message, 3, "google.protobuf.Timestamp"
|
90
|
+
end
|
91
|
+
add_enum "google.cloud.redis.v1.RescheduleMaintenanceRequest.RescheduleType" do
|
92
|
+
value :RESCHEDULE_TYPE_UNSPECIFIED, 0
|
93
|
+
value :IMMEDIATE, 1
|
94
|
+
value :NEXT_AVAILABLE_WINDOW, 2
|
95
|
+
value :SPECIFIC_TIME, 3
|
96
|
+
end
|
97
|
+
add_message "google.cloud.redis.v1.MaintenancePolicy" do
|
98
|
+
optional :create_time, :message, 1, "google.protobuf.Timestamp"
|
99
|
+
optional :update_time, :message, 2, "google.protobuf.Timestamp"
|
100
|
+
optional :description, :string, 3
|
101
|
+
repeated :weekly_maintenance_window, :message, 4, "google.cloud.redis.v1.WeeklyMaintenanceWindow"
|
102
|
+
end
|
103
|
+
add_message "google.cloud.redis.v1.WeeklyMaintenanceWindow" do
|
104
|
+
optional :day, :enum, 1, "google.type.DayOfWeek"
|
105
|
+
optional :start_time, :message, 2, "google.type.TimeOfDay"
|
106
|
+
optional :duration, :message, 3, "google.protobuf.Duration"
|
107
|
+
end
|
108
|
+
add_message "google.cloud.redis.v1.MaintenanceSchedule" do
|
109
|
+
optional :start_time, :message, 1, "google.protobuf.Timestamp"
|
110
|
+
optional :end_time, :message, 2, "google.protobuf.Timestamp"
|
111
|
+
optional :can_reschedule, :bool, 3
|
112
|
+
optional :schedule_deadline_time, :message, 5, "google.protobuf.Timestamp"
|
113
|
+
end
|
71
114
|
add_message "google.cloud.redis.v1.ListInstancesRequest" do
|
72
115
|
optional :parent, :string, 1
|
73
116
|
optional :page_size, :int32, 2
|
@@ -81,6 +124,12 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
81
124
|
add_message "google.cloud.redis.v1.GetInstanceRequest" do
|
82
125
|
optional :name, :string, 1
|
83
126
|
end
|
127
|
+
add_message "google.cloud.redis.v1.GetInstanceAuthStringRequest" do
|
128
|
+
optional :name, :string, 1
|
129
|
+
end
|
130
|
+
add_message "google.cloud.redis.v1.InstanceAuthString" do
|
131
|
+
optional :auth_string, :string, 1
|
132
|
+
end
|
84
133
|
add_message "google.cloud.redis.v1.CreateInstanceRequest" do
|
85
134
|
optional :parent, :string, 1
|
86
135
|
optional :instance_id, :string, 2
|
@@ -144,6 +193,13 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
144
193
|
end
|
145
194
|
add_message "google.cloud.redis.v1.ZoneMetadata" do
|
146
195
|
end
|
196
|
+
add_message "google.cloud.redis.v1.TlsCertificate" do
|
197
|
+
optional :serial_number, :string, 1
|
198
|
+
optional :cert, :string, 2
|
199
|
+
optional :create_time, :message, 3, "google.protobuf.Timestamp"
|
200
|
+
optional :expire_time, :message, 4, "google.protobuf.Timestamp"
|
201
|
+
optional :sha1_fingerprint, :string, 5
|
202
|
+
end
|
147
203
|
end
|
148
204
|
end
|
149
205
|
|
@@ -156,10 +212,18 @@ module Google
|
|
156
212
|
Instance::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.Instance.State").enummodule
|
157
213
|
Instance::Tier = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.Instance.Tier").enummodule
|
158
214
|
Instance::ConnectMode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.Instance.ConnectMode").enummodule
|
215
|
+
Instance::TransitEncryptionMode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.Instance.TransitEncryptionMode").enummodule
|
159
216
|
Instance::ReadReplicasMode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.Instance.ReadReplicasMode").enummodule
|
217
|
+
RescheduleMaintenanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.RescheduleMaintenanceRequest").msgclass
|
218
|
+
RescheduleMaintenanceRequest::RescheduleType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.RescheduleMaintenanceRequest.RescheduleType").enummodule
|
219
|
+
MaintenancePolicy = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.MaintenancePolicy").msgclass
|
220
|
+
WeeklyMaintenanceWindow = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.WeeklyMaintenanceWindow").msgclass
|
221
|
+
MaintenanceSchedule = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.MaintenanceSchedule").msgclass
|
160
222
|
ListInstancesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.ListInstancesRequest").msgclass
|
161
223
|
ListInstancesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.ListInstancesResponse").msgclass
|
162
224
|
GetInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.GetInstanceRequest").msgclass
|
225
|
+
GetInstanceAuthStringRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.GetInstanceAuthStringRequest").msgclass
|
226
|
+
InstanceAuthString = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.InstanceAuthString").msgclass
|
163
227
|
CreateInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.CreateInstanceRequest").msgclass
|
164
228
|
UpdateInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.UpdateInstanceRequest").msgclass
|
165
229
|
UpgradeInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.UpgradeInstanceRequest").msgclass
|
@@ -175,6 +239,7 @@ module Google
|
|
175
239
|
OperationMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.OperationMetadata").msgclass
|
176
240
|
LocationMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.LocationMetadata").msgclass
|
177
241
|
ZoneMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.ZoneMetadata").msgclass
|
242
|
+
TlsCertificate = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.TlsCertificate").msgclass
|
178
243
|
end
|
179
244
|
end
|
180
245
|
end
|
@@ -59,6 +59,10 @@ module Google
|
|
59
59
|
rpc :ListInstances, ::Google::Cloud::Redis::V1::ListInstancesRequest, ::Google::Cloud::Redis::V1::ListInstancesResponse
|
60
60
|
# Gets the details of a specific Redis instance.
|
61
61
|
rpc :GetInstance, ::Google::Cloud::Redis::V1::GetInstanceRequest, ::Google::Cloud::Redis::V1::Instance
|
62
|
+
# Gets the AUTH string for a Redis instance. If AUTH is not enabled for the
|
63
|
+
# instance the response will be empty. This information is not included in
|
64
|
+
# the details returned to GetInstance.
|
65
|
+
rpc :GetInstanceAuthString, ::Google::Cloud::Redis::V1::GetInstanceAuthStringRequest, ::Google::Cloud::Redis::V1::InstanceAuthString
|
62
66
|
# Creates a Redis instance based on the specified tier and memory size.
|
63
67
|
#
|
64
68
|
# By default, the instance is accessible from the project's
|
@@ -103,6 +107,9 @@ module Google
|
|
103
107
|
# Deletes a specific Redis instance. Instance stops serving and data is
|
104
108
|
# deleted.
|
105
109
|
rpc :DeleteInstance, ::Google::Cloud::Redis::V1::DeleteInstanceRequest, ::Google::Longrunning::Operation
|
110
|
+
# Reschedule maintenance for a given instance in a given project and
|
111
|
+
# location.
|
112
|
+
rpc :RescheduleMaintenance, ::Google::Cloud::Redis::V1::RescheduleMaintenanceRequest, ::Google::Longrunning::Operation
|
106
113
|
end
|
107
114
|
|
108
115
|
Stub = Service.rpc_stub_class
|
@@ -33,11 +33,7 @@ module Google
|
|
33
33
|
# // For Kubernetes resources, the format is {api group}/{kind}.
|
34
34
|
# option (google.api.resource) = {
|
35
35
|
# type: "pubsub.googleapis.com/Topic"
|
36
|
-
#
|
37
|
-
# pattern: "projects/{project}/topics/{topic}"
|
38
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
39
|
-
# parent_name_extractor: "projects/{project}"
|
40
|
-
# }
|
36
|
+
# pattern: "projects/{project}/topics/{topic}"
|
41
37
|
# };
|
42
38
|
# }
|
43
39
|
#
|
@@ -45,10 +41,7 @@ module Google
|
|
45
41
|
#
|
46
42
|
# resources:
|
47
43
|
# - type: "pubsub.googleapis.com/Topic"
|
48
|
-
#
|
49
|
-
# - pattern: "projects/{project}/topics/{topic}"
|
50
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
51
|
-
# parent_name_extractor: "projects/{project}"
|
44
|
+
# pattern: "projects/{project}/topics/{topic}"
|
52
45
|
#
|
53
46
|
# Sometimes, resources have multiple patterns, typically because they can
|
54
47
|
# live under multiple parents.
|
@@ -58,26 +51,10 @@ module Google
|
|
58
51
|
# message LogEntry {
|
59
52
|
# option (google.api.resource) = {
|
60
53
|
# type: "logging.googleapis.com/LogEntry"
|
61
|
-
#
|
62
|
-
#
|
63
|
-
#
|
64
|
-
#
|
65
|
-
# }
|
66
|
-
# name_descriptor: {
|
67
|
-
# pattern: "folders/{folder}/logs/{log}"
|
68
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
69
|
-
# parent_name_extractor: "folders/{folder}"
|
70
|
-
# }
|
71
|
-
# name_descriptor: {
|
72
|
-
# pattern: "organizations/{organization}/logs/{log}"
|
73
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Organization"
|
74
|
-
# parent_name_extractor: "organizations/{organization}"
|
75
|
-
# }
|
76
|
-
# name_descriptor: {
|
77
|
-
# pattern: "billingAccounts/{billing_account}/logs/{log}"
|
78
|
-
# parent_type: "billing.googleapis.com/BillingAccount"
|
79
|
-
# parent_name_extractor: "billingAccounts/{billing_account}"
|
80
|
-
# }
|
54
|
+
# pattern: "projects/{project}/logs/{log}"
|
55
|
+
# pattern: "folders/{folder}/logs/{log}"
|
56
|
+
# pattern: "organizations/{organization}/logs/{log}"
|
57
|
+
# pattern: "billingAccounts/{billing_account}/logs/{log}"
|
81
58
|
# };
|
82
59
|
# }
|
83
60
|
#
|
@@ -85,48 +62,10 @@ module Google
|
|
85
62
|
#
|
86
63
|
# resources:
|
87
64
|
# - type: 'logging.googleapis.com/LogEntry'
|
88
|
-
#
|
89
|
-
#
|
90
|
-
#
|
91
|
-
#
|
92
|
-
# - pattern: "folders/{folder}/logs/{log}"
|
93
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
94
|
-
# parent_name_extractor: "folders/{folder}"
|
95
|
-
# - pattern: "organizations/{organization}/logs/{log}"
|
96
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Organization"
|
97
|
-
# parent_name_extractor: "organizations/{organization}"
|
98
|
-
# - pattern: "billingAccounts/{billing_account}/logs/{log}"
|
99
|
-
# parent_type: "billing.googleapis.com/BillingAccount"
|
100
|
-
# parent_name_extractor: "billingAccounts/{billing_account}"
|
101
|
-
#
|
102
|
-
# For flexible resources, the resource name doesn't contain parent names, but
|
103
|
-
# the resource itself has parents for policy evaluation.
|
104
|
-
#
|
105
|
-
# Example:
|
106
|
-
#
|
107
|
-
# message Shelf {
|
108
|
-
# option (google.api.resource) = {
|
109
|
-
# type: "library.googleapis.com/Shelf"
|
110
|
-
# name_descriptor: {
|
111
|
-
# pattern: "shelves/{shelf}"
|
112
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
113
|
-
# }
|
114
|
-
# name_descriptor: {
|
115
|
-
# pattern: "shelves/{shelf}"
|
116
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
117
|
-
# }
|
118
|
-
# };
|
119
|
-
# }
|
120
|
-
#
|
121
|
-
# The ResourceDescriptor Yaml config will look like:
|
122
|
-
#
|
123
|
-
# resources:
|
124
|
-
# - type: 'library.googleapis.com/Shelf'
|
125
|
-
# name_descriptor:
|
126
|
-
# - pattern: "shelves/{shelf}"
|
127
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
128
|
-
# - pattern: "shelves/{shelf}"
|
129
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
65
|
+
# pattern: "projects/{project}/logs/{log}"
|
66
|
+
# pattern: "folders/{folder}/logs/{log}"
|
67
|
+
# pattern: "organizations/{organization}/logs/{log}"
|
68
|
+
# pattern: "billingAccounts/{billing_account}/logs/{log}"
|
130
69
|
# @!attribute [rw] type
|
131
70
|
# @return [::String]
|
132
71
|
# The resource type. It must be in the format of
|
@@ -33,7 +33,7 @@ module Google
|
|
33
33
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
34
34
|
end
|
35
35
|
|
36
|
-
# A
|
36
|
+
# A Memorystore for Redis instance.
|
37
37
|
# @!attribute [rw] name
|
38
38
|
# @return [::String]
|
39
39
|
# Required. Unique name of the resource in this scope including project and
|
@@ -85,6 +85,13 @@ module Google
|
|
85
85
|
# If not provided, the service will choose an unused /29 block, for
|
86
86
|
# example, 10.0.0.0/29 or 192.168.0.0/29. For READ_REPLICAS_ENABLED
|
87
87
|
# the default block size is /28.
|
88
|
+
# @!attribute [rw] secondary_ip_range
|
89
|
+
# @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".
|
88
95
|
# @!attribute [r] host
|
89
96
|
# @return [::String]
|
90
97
|
# Output only. Hostname or IP address of the exposed Redis endpoint used by
|
@@ -152,11 +159,33 @@ module Google
|
|
152
159
|
# @return [::Google::Cloud::Redis::V1::Instance::ConnectMode]
|
153
160
|
# Optional. The network connect mode of the Redis instance.
|
154
161
|
# If not provided, the connect mode defaults to DIRECT_PEERING.
|
162
|
+
# @!attribute [rw] auth_enabled
|
163
|
+
# @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.
|
167
|
+
# @!attribute [r] server_ca_certs
|
168
|
+
# @return [::Array<::Google::Cloud::Redis::V1::TlsCertificate>]
|
169
|
+
# Output only. List of server CA certificates for the instance.
|
170
|
+
# @!attribute [rw] transit_encryption_mode
|
171
|
+
# @return [::Google::Cloud::Redis::V1::Instance::TransitEncryptionMode]
|
172
|
+
# Optional. The TLS mode of the Redis instance.
|
173
|
+
# If not provided, TLS is disabled for the instance.
|
174
|
+
# @!attribute [rw] maintenance_policy
|
175
|
+
# @return [::Google::Cloud::Redis::V1::MaintenancePolicy]
|
176
|
+
# Optional. The maintenance policy for the instance. If not provided,
|
177
|
+
# maintenance events can be performed at any time.
|
178
|
+
# @!attribute [r] maintenance_schedule
|
179
|
+
# @return [::Google::Cloud::Redis::V1::MaintenanceSchedule]
|
180
|
+
# Output only. Date and time of upcoming maintenance events which have been
|
181
|
+
# scheduled.
|
155
182
|
# @!attribute [rw] replica_count
|
156
183
|
# @return [::Integer]
|
157
|
-
# Optional. The number of replica nodes.
|
158
|
-
# is [1-5] and defaults to
|
159
|
-
#
|
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.
|
160
189
|
# @!attribute [r] nodes
|
161
190
|
# @return [::Array<::Google::Cloud::Redis::V1::NodeInfo>]
|
162
191
|
# Output only. Info per node.
|
@@ -172,7 +201,7 @@ module Google
|
|
172
201
|
# endpoint. Standard tier only. Write requests should target 'port'.
|
173
202
|
# @!attribute [rw] read_replicas_mode
|
174
203
|
# @return [::Google::Cloud::Redis::V1::Instance::ReadReplicasMode]
|
175
|
-
# Optional. Read
|
204
|
+
# Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED.
|
176
205
|
class Instance
|
177
206
|
include ::Google::Protobuf::MessageExts
|
178
207
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -253,10 +282,22 @@ module Google
|
|
253
282
|
PRIVATE_SERVICE_ACCESS = 2
|
254
283
|
end
|
255
284
|
|
285
|
+
# Available TLS modes.
|
286
|
+
module TransitEncryptionMode
|
287
|
+
# Not set.
|
288
|
+
TRANSIT_ENCRYPTION_MODE_UNSPECIFIED = 0
|
289
|
+
|
290
|
+
# Client to Server traffic encryption enabled with server authentication.
|
291
|
+
SERVER_AUTHENTICATION = 1
|
292
|
+
|
293
|
+
# TLS is disabled for the instance.
|
294
|
+
DISABLED = 2
|
295
|
+
end
|
296
|
+
|
256
297
|
# Read replicas mode.
|
257
298
|
module ReadReplicasMode
|
258
|
-
# If not set, Memorystore Redis backend will
|
259
|
-
#
|
299
|
+
# If not set, Memorystore Redis backend will default to
|
300
|
+
# READ_REPLICAS_DISABLED.
|
260
301
|
READ_REPLICAS_MODE_UNSPECIFIED = 0
|
261
302
|
|
262
303
|
# If disabled, read endpoint will not be provided and the instance cannot
|
@@ -264,11 +305,103 @@ module Google
|
|
264
305
|
READ_REPLICAS_DISABLED = 1
|
265
306
|
|
266
307
|
# If enabled, read endpoint will be provided and the instance can scale
|
267
|
-
# up and down the number of replicas.
|
308
|
+
# up and down the number of replicas. Not valid for basic tier.
|
268
309
|
READ_REPLICAS_ENABLED = 2
|
269
310
|
end
|
270
311
|
end
|
271
312
|
|
313
|
+
# Request for {::Google::Cloud::Redis::V1::CloudRedis::Client#reschedule_maintenance RescheduleMaintenance}.
|
314
|
+
# @!attribute [rw] name
|
315
|
+
# @return [::String]
|
316
|
+
# Required. Redis instance resource name using the form:
|
317
|
+
# `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
|
318
|
+
# where `location_id` refers to a GCP region.
|
319
|
+
# @!attribute [rw] reschedule_type
|
320
|
+
# @return [::Google::Cloud::Redis::V1::RescheduleMaintenanceRequest::RescheduleType]
|
321
|
+
# Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well.
|
322
|
+
# @!attribute [rw] schedule_time
|
323
|
+
# @return [::Google::Protobuf::Timestamp]
|
324
|
+
# Optional. Timestamp when the maintenance shall be rescheduled to if
|
325
|
+
# reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for
|
326
|
+
# example `2012-11-15T16:19:00.094Z`.
|
327
|
+
class RescheduleMaintenanceRequest
|
328
|
+
include ::Google::Protobuf::MessageExts
|
329
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
330
|
+
|
331
|
+
# Reschedule options.
|
332
|
+
module RescheduleType
|
333
|
+
# Not set.
|
334
|
+
RESCHEDULE_TYPE_UNSPECIFIED = 0
|
335
|
+
|
336
|
+
# If the user wants to schedule the maintenance to happen now.
|
337
|
+
IMMEDIATE = 1
|
338
|
+
|
339
|
+
# If the user wants to use the existing maintenance policy to find the
|
340
|
+
# next available window.
|
341
|
+
NEXT_AVAILABLE_WINDOW = 2
|
342
|
+
|
343
|
+
# If the user wants to reschedule the maintenance to a specific time.
|
344
|
+
SPECIFIC_TIME = 3
|
345
|
+
end
|
346
|
+
end
|
347
|
+
|
348
|
+
# Maintenance policy for an instance.
|
349
|
+
# @!attribute [r] create_time
|
350
|
+
# @return [::Google::Protobuf::Timestamp]
|
351
|
+
# Output only. The time when the policy was created.
|
352
|
+
# @!attribute [r] update_time
|
353
|
+
# @return [::Google::Protobuf::Timestamp]
|
354
|
+
# Output only. The time when the policy was last updated.
|
355
|
+
# @!attribute [rw] description
|
356
|
+
# @return [::String]
|
357
|
+
# Optional. Description of what this policy is for. Create/Update methods
|
358
|
+
# return INVALID_ARGUMENT if the length is greater than 512.
|
359
|
+
# @!attribute [rw] weekly_maintenance_window
|
360
|
+
# @return [::Array<::Google::Cloud::Redis::V1::WeeklyMaintenanceWindow>]
|
361
|
+
# Optional. Maintenance window that is applied to resources covered by this
|
362
|
+
# policy. Minimum 1. For the current version, the maximum number of
|
363
|
+
# weekly_window is expected to be one.
|
364
|
+
class MaintenancePolicy
|
365
|
+
include ::Google::Protobuf::MessageExts
|
366
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
367
|
+
end
|
368
|
+
|
369
|
+
# Time window in which disruptive maintenance updates occur. Non-disruptive
|
370
|
+
# updates can occur inside or outside this window.
|
371
|
+
# @!attribute [rw] day
|
372
|
+
# @return [::Google::Type::DayOfWeek]
|
373
|
+
# Required. The day of week that maintenance updates occur.
|
374
|
+
# @!attribute [rw] start_time
|
375
|
+
# @return [::Google::Type::TimeOfDay]
|
376
|
+
# Required. Start time of the window in UTC time.
|
377
|
+
# @!attribute [r] duration
|
378
|
+
# @return [::Google::Protobuf::Duration]
|
379
|
+
# Output only. Duration of the maintenance window. The current window is fixed at 1 hour.
|
380
|
+
class WeeklyMaintenanceWindow
|
381
|
+
include ::Google::Protobuf::MessageExts
|
382
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
383
|
+
end
|
384
|
+
|
385
|
+
# Upcoming maintenance schedule. If no maintenance is scheduled, fields are not
|
386
|
+
# populated.
|
387
|
+
# @!attribute [r] start_time
|
388
|
+
# @return [::Google::Protobuf::Timestamp]
|
389
|
+
# Output only. The start time of any upcoming scheduled maintenance for this instance.
|
390
|
+
# @!attribute [r] end_time
|
391
|
+
# @return [::Google::Protobuf::Timestamp]
|
392
|
+
# Output only. The end time of any upcoming scheduled maintenance for this instance.
|
393
|
+
# @!attribute [rw] can_reschedule
|
394
|
+
# @return [::Boolean]
|
395
|
+
# If the scheduled maintenance can be rescheduled, default is true.
|
396
|
+
# @!attribute [r] schedule_deadline_time
|
397
|
+
# @return [::Google::Protobuf::Timestamp]
|
398
|
+
# Output only. The deadline that the maintenance schedule start time can not go beyond,
|
399
|
+
# including reschedule.
|
400
|
+
class MaintenanceSchedule
|
401
|
+
include ::Google::Protobuf::MessageExts
|
402
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
403
|
+
end
|
404
|
+
|
272
405
|
# Request for {::Google::Cloud::Redis::V1::CloudRedis::Client#list_instances ListInstances}.
|
273
406
|
# @!attribute [rw] parent
|
274
407
|
# @return [::String]
|
@@ -330,6 +463,26 @@ module Google
|
|
330
463
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
331
464
|
end
|
332
465
|
|
466
|
+
# Request for {::Google::Cloud::Redis::V1::CloudRedis::Client#get_instance_auth_string GetInstanceAuthString}.
|
467
|
+
# @!attribute [rw] name
|
468
|
+
# @return [::String]
|
469
|
+
# Required. Redis instance resource name using the form:
|
470
|
+
# `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
|
471
|
+
# where `location_id` refers to a GCP region.
|
472
|
+
class GetInstanceAuthStringRequest
|
473
|
+
include ::Google::Protobuf::MessageExts
|
474
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
475
|
+
end
|
476
|
+
|
477
|
+
# Instance AUTH string details.
|
478
|
+
# @!attribute [rw] auth_string
|
479
|
+
# @return [::String]
|
480
|
+
# AUTH string set on the instance.
|
481
|
+
class InstanceAuthString
|
482
|
+
include ::Google::Protobuf::MessageExts
|
483
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
484
|
+
end
|
485
|
+
|
333
486
|
# Request for {::Google::Cloud::Redis::V1::CloudRedis::Client#create_instance CreateInstance}.
|
334
487
|
# @!attribute [rw] parent
|
335
488
|
# @return [::String]
|
@@ -553,6 +706,31 @@ module Google
|
|
553
706
|
include ::Google::Protobuf::MessageExts
|
554
707
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
555
708
|
end
|
709
|
+
|
710
|
+
# TlsCertificate Resource
|
711
|
+
# @!attribute [rw] serial_number
|
712
|
+
# @return [::String]
|
713
|
+
# Serial number, as extracted from the certificate.
|
714
|
+
# @!attribute [rw] cert
|
715
|
+
# @return [::String]
|
716
|
+
# PEM representation.
|
717
|
+
# @!attribute [r] create_time
|
718
|
+
# @return [::Google::Protobuf::Timestamp]
|
719
|
+
# Output only. The time when the certificate was created in [RFC
|
720
|
+
# 3339](https://tools.ietf.org/html/rfc3339) format, for example
|
721
|
+
# `2020-05-18T00:00:00.094Z`.
|
722
|
+
# @!attribute [r] expire_time
|
723
|
+
# @return [::Google::Protobuf::Timestamp]
|
724
|
+
# Output only. The time when the certificate expires in [RFC
|
725
|
+
# 3339](https://tools.ietf.org/html/rfc3339) format, for example
|
726
|
+
# `2020-05-18T00:00:00.094Z`.
|
727
|
+
# @!attribute [rw] sha1_fingerprint
|
728
|
+
# @return [::String]
|
729
|
+
# Sha1 Fingerprint of the certificate.
|
730
|
+
class TlsCertificate
|
731
|
+
include ::Google::Protobuf::MessageExts
|
732
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
733
|
+
end
|
556
734
|
end
|
557
735
|
end
|
558
736
|
end
|
@@ -44,7 +44,7 @@ module Google
|
|
44
44
|
# foo = any.unpack(Foo.class);
|
45
45
|
# }
|
46
46
|
#
|
47
|
-
#
|
47
|
+
# Example 3: Pack and unpack a message in Python.
|
48
48
|
#
|
49
49
|
# foo = Foo(...)
|
50
50
|
# any = Any()
|
@@ -54,7 +54,7 @@ module Google
|
|
54
54
|
# any.Unpack(foo)
|
55
55
|
# ...
|
56
56
|
#
|
57
|
-
#
|
57
|
+
# Example 4: Pack and unpack a message in Go
|
58
58
|
#
|
59
59
|
# foo := &pb.Foo{...}
|
60
60
|
# any, err := anypb.New(foo)
|
@@ -75,7 +75,7 @@ module Google
|
|
75
75
|
#
|
76
76
|
#
|
77
77
|
# JSON
|
78
|
-
#
|
78
|
+
#
|
79
79
|
# The JSON representation of an `Any` value uses the regular
|
80
80
|
# representation of the deserialized, embedded message, with an
|
81
81
|
# additional field `@type` which contains the type URL. Example:
|
@@ -0,0 +1,49 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Type
|
22
|
+
# Represents a day of the week.
|
23
|
+
module DayOfWeek
|
24
|
+
# The day of the week is unspecified.
|
25
|
+
DAY_OF_WEEK_UNSPECIFIED = 0
|
26
|
+
|
27
|
+
# Monday
|
28
|
+
MONDAY = 1
|
29
|
+
|
30
|
+
# Tuesday
|
31
|
+
TUESDAY = 2
|
32
|
+
|
33
|
+
# Wednesday
|
34
|
+
WEDNESDAY = 3
|
35
|
+
|
36
|
+
# Thursday
|
37
|
+
THURSDAY = 4
|
38
|
+
|
39
|
+
# Friday
|
40
|
+
FRIDAY = 5
|
41
|
+
|
42
|
+
# Saturday
|
43
|
+
SATURDAY = 6
|
44
|
+
|
45
|
+
# Sunday
|
46
|
+
SUNDAY = 7
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
@@ -0,0 +1,45 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Type
|
22
|
+
# Represents a time of day. The date and time zone are either not significant
|
23
|
+
# or are specified elsewhere. An API may choose to allow leap seconds. Related
|
24
|
+
# types are [google.type.Date][google.type.Date] and
|
25
|
+
# `google.protobuf.Timestamp`.
|
26
|
+
# @!attribute [rw] hours
|
27
|
+
# @return [::Integer]
|
28
|
+
# Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
|
29
|
+
# to allow the value "24:00:00" for scenarios like business closing time.
|
30
|
+
# @!attribute [rw] minutes
|
31
|
+
# @return [::Integer]
|
32
|
+
# Minutes of hour of day. Must be from 0 to 59.
|
33
|
+
# @!attribute [rw] seconds
|
34
|
+
# @return [::Integer]
|
35
|
+
# Seconds of minutes of the time. Must normally be from 0 to 59. An API may
|
36
|
+
# allow the value 60 if it allows leap-seconds.
|
37
|
+
# @!attribute [rw] nanos
|
38
|
+
# @return [::Integer]
|
39
|
+
# Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
|
40
|
+
class TimeOfDay
|
41
|
+
include ::Google::Protobuf::MessageExts
|
42
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
43
|
+
end
|
44
|
+
end
|
45
|
+
end
|
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.
|
4
|
+
version: 0.8.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:
|
11
|
+
date: 2022-07-07 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.10'
|
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.10'
|
30
30
|
- - "<"
|
31
31
|
- !ruby/object:Gem::Version
|
32
32
|
version: 2.a
|
@@ -50,28 +50,28 @@ dependencies:
|
|
50
50
|
requirements:
|
51
51
|
- - "~>"
|
52
52
|
- !ruby/object:Gem::Version
|
53
|
-
version: 1.
|
53
|
+
version: 1.26.1
|
54
54
|
type: :development
|
55
55
|
prerelease: false
|
56
56
|
version_requirements: !ruby/object:Gem::Requirement
|
57
57
|
requirements:
|
58
58
|
- - "~>"
|
59
59
|
- !ruby/object:Gem::Version
|
60
|
-
version: 1.
|
60
|
+
version: 1.26.1
|
61
61
|
- !ruby/object:Gem::Dependency
|
62
62
|
name: minitest
|
63
63
|
requirement: !ruby/object:Gem::Requirement
|
64
64
|
requirements:
|
65
65
|
- - "~>"
|
66
66
|
- !ruby/object:Gem::Version
|
67
|
-
version: '5.
|
67
|
+
version: '5.16'
|
68
68
|
type: :development
|
69
69
|
prerelease: false
|
70
70
|
version_requirements: !ruby/object:Gem::Requirement
|
71
71
|
requirements:
|
72
72
|
- - "~>"
|
73
73
|
- !ruby/object:Gem::Version
|
74
|
-
version: '5.
|
74
|
+
version: '5.16'
|
75
75
|
- !ruby/object:Gem::Dependency
|
76
76
|
name: minitest-focus
|
77
77
|
requirement: !ruby/object:Gem::Requirement
|
@@ -106,14 +106,14 @@ dependencies:
|
|
106
106
|
requirements:
|
107
107
|
- - ">="
|
108
108
|
- !ruby/object:Gem::Version
|
109
|
-
version: '
|
109
|
+
version: '13.0'
|
110
110
|
type: :development
|
111
111
|
prerelease: false
|
112
112
|
version_requirements: !ruby/object:Gem::Requirement
|
113
113
|
requirements:
|
114
114
|
- - ">="
|
115
115
|
- !ruby/object:Gem::Version
|
116
|
-
version: '
|
116
|
+
version: '13.0'
|
117
117
|
- !ruby/object:Gem::Dependency
|
118
118
|
name: redcarpet
|
119
119
|
requirement: !ruby/object:Gem::Requirement
|
@@ -190,6 +190,8 @@ files:
|
|
190
190
|
- proto_docs/google/protobuf/field_mask.rb
|
191
191
|
- proto_docs/google/protobuf/timestamp.rb
|
192
192
|
- proto_docs/google/rpc/status.rb
|
193
|
+
- proto_docs/google/type/dayofweek.rb
|
194
|
+
- proto_docs/google/type/timeofday.rb
|
193
195
|
homepage: https://github.com/googleapis/google-cloud-ruby
|
194
196
|
licenses:
|
195
197
|
- Apache-2.0
|
@@ -202,14 +204,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
202
204
|
requirements:
|
203
205
|
- - ">="
|
204
206
|
- !ruby/object:Gem::Version
|
205
|
-
version: '2.
|
207
|
+
version: '2.6'
|
206
208
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
207
209
|
requirements:
|
208
210
|
- - ">="
|
209
211
|
- !ruby/object:Gem::Version
|
210
212
|
version: '0'
|
211
213
|
requirements: []
|
212
|
-
rubygems_version: 3.
|
214
|
+
rubygems_version: 3.3.14
|
213
215
|
signing_key:
|
214
216
|
specification_version: 4
|
215
217
|
summary: API Client library for the Google Cloud Memorystore for Redis V1 API
|