google-cloud-redis 0.2.2 → 0.2.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +5 -5
- data/lib/google/cloud/redis.rb +11 -11
- data/lib/google/cloud/redis/v1.rb +11 -11
- data/lib/google/cloud/redis/v1/cloud_redis_client.rb +21 -21
- data/lib/google/cloud/redis/v1/cloud_redis_services_pb.rb +2 -2
- data/lib/google/cloud/redis/v1/doc/google/cloud/redis/v1/cloud_redis.rb +20 -20
- data/lib/google/cloud/redis/v1/doc/google/longrunning/operations.rb +9 -9
- data/lib/google/cloud/redis/v1/doc/google/protobuf/any.rb +8 -8
- data/lib/google/cloud/redis/v1/doc/google/protobuf/field_mask.rb +7 -7
- data/lib/google/cloud/redis/v1/doc/google/protobuf/timestamp.rb +7 -7
- data/lib/google/cloud/redis/v1/doc/google/rpc/status.rb +11 -11
- data/lib/google/cloud/redis/v1beta1.rb +11 -11
- data/lib/google/cloud/redis/v1beta1/cloud_redis_client.rb +21 -21
- data/lib/google/cloud/redis/v1beta1/cloud_redis_services_pb.rb +2 -2
- data/lib/google/cloud/redis/v1beta1/doc/google/cloud/redis/v1beta1/cloud_redis.rb +18 -18
- data/lib/google/cloud/redis/v1beta1/doc/google/longrunning/operations.rb +9 -9
- data/lib/google/cloud/redis/v1beta1/doc/google/protobuf/any.rb +8 -8
- data/lib/google/cloud/redis/v1beta1/doc/google/protobuf/field_mask.rb +7 -7
- data/lib/google/cloud/redis/v1beta1/doc/google/protobuf/timestamp.rb +7 -7
- data/lib/google/cloud/redis/v1beta1/doc/google/rpc/status.rb +11 -11
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 978325ee0d21558b615d62b4b5716405bede0027a513a17514121df9eda358b8
|
4
|
+
data.tar.gz: 0ed9772a1c34363a8ff183e8399d33b630e9532d48fac8e65623ab0afbed3563
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c1d40b70a1151c4c670f252985969d04b80eca1a989f29510377276f0a53ddd830e1bc0a179b2009550773126b094669b98f1a3d8f0dc062b0fefa9fb3da915f
|
7
|
+
data.tar.gz: af1b9ad36e27ac1e14637bbe7a695023cd19d9f6c30ef32146ac0690aa78d034a95897352ef5e9ef44b5bce704b47cde238962db5002cc821c71ed981f05499e
|
data/README.md
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
# Ruby Client for Google Cloud Memorystore for Redis API ([Alpha](https://github.com/
|
1
|
+
# Ruby Client for Google Cloud Memorystore for Redis API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
|
2
2
|
|
3
3
|
[Google Cloud Memorystore for Redis API][Product Documentation]:
|
4
4
|
The Google Cloud Memorystore for Redis API is used for creating and managing
|
@@ -13,7 +13,7 @@ steps:
|
|
13
13
|
1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
|
14
14
|
2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
|
15
15
|
3. [Enable the Google Cloud Memorystore for Redis API.](https://console.cloud.google.com/apis/library/redis.googleapis.com)
|
16
|
-
4. [Setup Authentication.](https://
|
16
|
+
4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
|
17
17
|
|
18
18
|
### Installation
|
19
19
|
```
|
@@ -25,17 +25,17 @@ $ gem install google-cloud-redis
|
|
25
25
|
to see other available methods on the client.
|
26
26
|
- Read the [Google Cloud Memorystore for Redis API Product documentation][Product Documentation]
|
27
27
|
to learn more about the product and see How-to Guides.
|
28
|
-
- View this [repository's main README](https://github.com/
|
28
|
+
- View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
|
29
29
|
to see the full list of Cloud APIs that we cover.
|
30
30
|
|
31
|
-
[Client Library Documentation]: https://
|
31
|
+
[Client Library Documentation]: https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-redis/latest/google/cloud/redis/v1
|
32
32
|
[Product Documentation]: https://cloud.google.com/memorystore
|
33
33
|
|
34
34
|
## Enabling Logging
|
35
35
|
|
36
36
|
To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
|
37
37
|
The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
|
38
|
-
or a [`Google::Cloud::Logging::Logger`](https://
|
38
|
+
or a [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
|
39
39
|
that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
|
40
40
|
and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
|
41
41
|
|
data/lib/google/cloud/redis.rb
CHANGED
@@ -21,7 +21,7 @@ module Google
|
|
21
21
|
# rubocop:disable LineLength
|
22
22
|
|
23
23
|
##
|
24
|
-
# # Ruby Client for Google Cloud Memorystore for Redis API ([Alpha](https://github.com/
|
24
|
+
# # Ruby Client for Google Cloud Memorystore for Redis API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
|
25
25
|
#
|
26
26
|
# [Google Cloud Memorystore for Redis API][Product Documentation]:
|
27
27
|
# The Google Cloud Memorystore for Redis API is used for creating and managing
|
@@ -35,7 +35,7 @@ module Google
|
|
35
35
|
# 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
|
36
36
|
# 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
|
37
37
|
# 3. [Enable the Google Cloud Memorystore for Redis API.](https://console.cloud.google.com/apis/library/redis.googleapis.com)
|
38
|
-
# 4. [Setup Authentication.](https://
|
38
|
+
# 4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
|
39
39
|
#
|
40
40
|
# ### Installation
|
41
41
|
# ```
|
@@ -45,7 +45,7 @@ module Google
|
|
45
45
|
# ### Next Steps
|
46
46
|
# - Read the [Google Cloud Memorystore for Redis API Product documentation][Product Documentation]
|
47
47
|
# to learn more about the product and see How-to Guides.
|
48
|
-
# - View this [repository's main README](https://github.com/
|
48
|
+
# - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
|
49
49
|
# to see the full list of Cloud APIs that we cover.
|
50
50
|
#
|
51
51
|
# [Product Documentation]: https://cloud.google.com/memorystore
|
@@ -54,7 +54,7 @@ module Google
|
|
54
54
|
#
|
55
55
|
# To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
|
56
56
|
# The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
|
57
|
-
# or a [`Google::Cloud::Logging::Logger`](https://
|
57
|
+
# or a [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
|
58
58
|
# that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
|
59
59
|
# and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
|
60
60
|
#
|
@@ -92,17 +92,17 @@ module Google
|
|
92
92
|
#
|
93
93
|
# Google Cloud Memorystore for Redis v1
|
94
94
|
#
|
95
|
-
# The
|
95
|
+
# The `redis.googleapis.com` service implements the Google Cloud Memorystore
|
96
96
|
# for Redis API and defines the following resource model for managing Redis
|
97
97
|
# instances:
|
98
|
-
# * The service works with a collection of cloud projects, named:
|
99
|
-
# * Each project has a collection of available locations, named:
|
100
|
-
# * Each location has a collection of Redis instances, named:
|
98
|
+
# * The service works with a collection of cloud projects, named: `/projects/*`
|
99
|
+
# * Each project has a collection of available locations, named: `/locations/*`
|
100
|
+
# * Each location has a collection of Redis instances, named: `/instances/*`
|
101
101
|
# * As such, Redis instances are resources of the form:
|
102
|
-
#
|
102
|
+
# `/projects/{project_id}/locations/{location_id}/instances/{instance_id}`
|
103
103
|
#
|
104
|
-
# Note that location_id must be refering to a GCP
|
105
|
-
# *
|
104
|
+
# Note that location_id must be refering to a GCP `region`; for example:
|
105
|
+
# * `projects/redpepper-1290/locations/us-central1/instances/my-redis`
|
106
106
|
#
|
107
107
|
# @param version [Symbol, String]
|
108
108
|
# The major version of the service to be used. By default :v1
|
@@ -22,7 +22,7 @@ module Google
|
|
22
22
|
# rubocop:disable LineLength
|
23
23
|
|
24
24
|
##
|
25
|
-
# # Ruby Client for Google Cloud Memorystore for Redis API ([Alpha](https://github.com/
|
25
|
+
# # Ruby Client for Google Cloud Memorystore for Redis API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
|
26
26
|
#
|
27
27
|
# [Google Cloud Memorystore for Redis API][Product Documentation]:
|
28
28
|
# The Google Cloud Memorystore for Redis API is used for creating and managing
|
@@ -36,7 +36,7 @@ module Google
|
|
36
36
|
# 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
|
37
37
|
# 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
|
38
38
|
# 3. [Enable the Google Cloud Memorystore for Redis API.](https://console.cloud.google.com/apis/library/redis.googleapis.com)
|
39
|
-
# 4. [Setup Authentication.](https://
|
39
|
+
# 4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
|
40
40
|
#
|
41
41
|
# ### Installation
|
42
42
|
# ```
|
@@ -46,7 +46,7 @@ module Google
|
|
46
46
|
# ### Next Steps
|
47
47
|
# - Read the [Google Cloud Memorystore for Redis API Product documentation][Product Documentation]
|
48
48
|
# to learn more about the product and see How-to Guides.
|
49
|
-
# - View this [repository's main README](https://github.com/
|
49
|
+
# - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
|
50
50
|
# to see the full list of Cloud APIs that we cover.
|
51
51
|
#
|
52
52
|
# [Product Documentation]: https://cloud.google.com/memorystore
|
@@ -55,7 +55,7 @@ module Google
|
|
55
55
|
#
|
56
56
|
# To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
|
57
57
|
# The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
|
58
|
-
# or a [`Google::Cloud::Logging::Logger`](https://
|
58
|
+
# or a [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
|
59
59
|
# that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
|
60
60
|
# and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
|
61
61
|
#
|
@@ -85,17 +85,17 @@ module Google
|
|
85
85
|
#
|
86
86
|
# Google Cloud Memorystore for Redis v1
|
87
87
|
#
|
88
|
-
# The
|
88
|
+
# The `redis.googleapis.com` service implements the Google Cloud Memorystore
|
89
89
|
# for Redis API and defines the following resource model for managing Redis
|
90
90
|
# instances:
|
91
|
-
# * The service works with a collection of cloud projects, named:
|
92
|
-
# * Each project has a collection of available locations, named:
|
93
|
-
# * Each location has a collection of Redis instances, named:
|
91
|
+
# * The service works with a collection of cloud projects, named: `/projects/*`
|
92
|
+
# * Each project has a collection of available locations, named: `/locations/*`
|
93
|
+
# * Each location has a collection of Redis instances, named: `/instances/*`
|
94
94
|
# * As such, Redis instances are resources of the form:
|
95
|
-
#
|
95
|
+
# `/projects/{project_id}/locations/{location_id}/instances/{instance_id}`
|
96
96
|
#
|
97
|
-
# Note that location_id must be refering to a GCP
|
98
|
-
# *
|
97
|
+
# Note that location_id must be refering to a GCP `region`; for example:
|
98
|
+
# * `projects/redpepper-1290/locations/us-central1/instances/my-redis`
|
99
99
|
#
|
100
100
|
# @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
|
101
101
|
# Provides the means for authenticating requests made by the client. This parameter can
|
@@ -38,17 +38,17 @@ module Google
|
|
38
38
|
#
|
39
39
|
# Google Cloud Memorystore for Redis v1
|
40
40
|
#
|
41
|
-
# The
|
41
|
+
# The `redis.googleapis.com` service implements the Google Cloud Memorystore
|
42
42
|
# for Redis API and defines the following resource model for managing Redis
|
43
43
|
# instances:
|
44
|
-
# * The service works with a collection of cloud projects, named:
|
45
|
-
# * Each project has a collection of available locations, named:
|
46
|
-
# * Each location has a collection of Redis instances, named:
|
44
|
+
# * The service works with a collection of cloud projects, named: `/projects/*`
|
45
|
+
# * Each project has a collection of available locations, named: `/locations/*`
|
46
|
+
# * Each location has a collection of Redis instances, named: `/instances/*`
|
47
47
|
# * As such, Redis instances are resources of the form:
|
48
|
-
#
|
48
|
+
# `/projects/{project_id}/locations/{location_id}/instances/{instance_id}`
|
49
49
|
#
|
50
|
-
# Note that location_id must be refering to a GCP
|
51
|
-
# *
|
50
|
+
# Note that location_id must be refering to a GCP `region`; for example:
|
51
|
+
# * `projects/redpepper-1290/locations/us-central1/instances/my-redis`
|
52
52
|
#
|
53
53
|
# @!attribute [r] cloud_redis_stub
|
54
54
|
# @return [Google::Cloud::Redis::V1::CloudRedis::Stub]
|
@@ -269,15 +269,15 @@ module Google
|
|
269
269
|
# location (region) or all locations.
|
270
270
|
#
|
271
271
|
# The location should have the following format:
|
272
|
-
# *
|
272
|
+
# * `projects/{project_id}/locations/{location_id}`
|
273
273
|
#
|
274
|
-
# If
|
274
|
+
# If `location_id` is specified as `-` (wildcard), then all regions
|
275
275
|
# available to the project are queried, and the results are aggregated.
|
276
276
|
#
|
277
277
|
# @param parent [String]
|
278
278
|
# Required. The resource name of the instance location using the form:
|
279
|
-
#
|
280
|
-
# where
|
279
|
+
# `projects/{project_id}/locations/{location_id}`
|
280
|
+
# where `location_id` refers to a GCP region
|
281
281
|
# @param page_size [Integer]
|
282
282
|
# The maximum number of resources contained in the underlying API
|
283
283
|
# response. If page streaming is performed per-resource, this
|
@@ -332,8 +332,8 @@ module Google
|
|
332
332
|
#
|
333
333
|
# @param name [String]
|
334
334
|
# Required. Redis instance resource name using the form:
|
335
|
-
#
|
336
|
-
# where
|
335
|
+
# `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
|
336
|
+
# where `location_id` refers to a GCP region
|
337
337
|
# @param options [Google::Gax::CallOptions]
|
338
338
|
# Overrides the default settings for this call, e.g, timeout,
|
339
339
|
# retries, etc.
|
@@ -375,8 +375,8 @@ module Google
|
|
375
375
|
#
|
376
376
|
# @param parent [String]
|
377
377
|
# Required. The resource name of the instance location using the form:
|
378
|
-
#
|
379
|
-
# where
|
378
|
+
# `projects/{project_id}/locations/{location_id}`
|
379
|
+
# where `location_id` refers to a GCP region
|
380
380
|
# @param instance_id [String]
|
381
381
|
# Required. The logical name of the Redis instance in the customer project
|
382
382
|
# with the following restrictions:
|
@@ -465,10 +465,10 @@ module Google
|
|
465
465
|
# this field. The elements of the repeated paths field may only include these
|
466
466
|
# fields from {CloudRedis::Instance Instance}:
|
467
467
|
#
|
468
|
-
# *
|
469
|
-
# *
|
470
|
-
# *
|
471
|
-
# *
|
468
|
+
# * `displayName`
|
469
|
+
# * `labels`
|
470
|
+
# * `memorySizeGb`
|
471
|
+
# * `redisConfig`
|
472
472
|
# A hash of the same form as `Google::Protobuf::FieldMask`
|
473
473
|
# can also be provided.
|
474
474
|
# @param instance [Google::Cloud::Redis::V1::Instance | Hash]
|
@@ -545,8 +545,8 @@ module Google
|
|
545
545
|
#
|
546
546
|
# @param name [String]
|
547
547
|
# Required. Redis instance resource name using the form:
|
548
|
-
#
|
549
|
-
# where
|
548
|
+
# `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
|
549
|
+
# where `location_id` refers to a GCP region
|
550
550
|
# @param options [Google::Gax::CallOptions]
|
551
551
|
# Overrides the default settings for this call, e.g, timeout,
|
552
552
|
# retries, etc.
|
@@ -36,7 +36,7 @@ module Google
|
|
36
36
|
# * Each project has a collection of available locations, named: `/locations/*`
|
37
37
|
# * Each location has a collection of Redis instances, named: `/instances/*`
|
38
38
|
# * As such, Redis instances are resources of the form:
|
39
|
-
# `/projects
|
39
|
+
# `/projects/{project_id}/locations/{location_id}/instances/{instance_id}`
|
40
40
|
#
|
41
41
|
# Note that location_id must be refering to a GCP `region`; for example:
|
42
42
|
# * `projects/redpepper-1290/locations/us-central1/instances/my-redis`
|
@@ -52,7 +52,7 @@ module Google
|
|
52
52
|
# location (region) or all locations.
|
53
53
|
#
|
54
54
|
# The location should have the following format:
|
55
|
-
# * `projects
|
55
|
+
# * `projects/{project_id}/locations/{location_id}`
|
56
56
|
#
|
57
57
|
# If `location_id` is specified as `-` (wildcard), then all regions
|
58
58
|
# available to the project are queried, and the results are aggregated.
|
@@ -22,7 +22,7 @@ module Google
|
|
22
22
|
# @return [String]
|
23
23
|
# Required. Unique name of the resource in this scope including project and
|
24
24
|
# location using the form:
|
25
|
-
#
|
25
|
+
# `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
|
26
26
|
#
|
27
27
|
# Note: Redis instances are managed and addressed at regional level so
|
28
28
|
# location_id here refers to a GCP region; however, users may choose which
|
@@ -52,7 +52,7 @@ module Google
|
|
52
52
|
# Optional. The version of Redis software.
|
53
53
|
# If not provided, latest supported version will be used. Updating the
|
54
54
|
# version will perform an upgrade/downgrade to the new version. Currently,
|
55
|
-
# the supported values are
|
55
|
+
# the supported values are `REDIS_3_2` for Redis 3.2.
|
56
56
|
# @!attribute [rw] reserved_ip_range
|
57
57
|
# @return [String]
|
58
58
|
# Optional. The CIDR range of internal addresses that are reserved for this
|
@@ -101,7 +101,7 @@ module Google
|
|
101
101
|
# @return [String]
|
102
102
|
# Optional. The full name of the Google Compute Engine
|
103
103
|
# [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the
|
104
|
-
# instance is connected. If left unspecified, the
|
104
|
+
# instance is connected. If left unspecified, the `default` network
|
105
105
|
# will be used.
|
106
106
|
class Instance
|
107
107
|
# Represents the different states of a Redis instance.
|
@@ -124,7 +124,7 @@ module Google
|
|
124
124
|
DELETING = 4
|
125
125
|
|
126
126
|
# Redis instance is being repaired and may be unusable. Details can be
|
127
|
-
# found in the
|
127
|
+
# found in the `status_message` field.
|
128
128
|
REPAIRING = 5
|
129
129
|
|
130
130
|
# Maintenance is being performed on this Redis instance.
|
@@ -148,8 +148,8 @@ module Google
|
|
148
148
|
# @!attribute [rw] parent
|
149
149
|
# @return [String]
|
150
150
|
# Required. The resource name of the instance location using the form:
|
151
|
-
#
|
152
|
-
# where
|
151
|
+
# `projects/{project_id}/locations/{location_id}`
|
152
|
+
# where `location_id` refers to a GCP region
|
153
153
|
# @!attribute [rw] page_size
|
154
154
|
# @return [Integer]
|
155
155
|
# The maximum number of items to return.
|
@@ -171,7 +171,7 @@ module Google
|
|
171
171
|
# A list of Redis instances in the project in the specified location,
|
172
172
|
# or across all locations.
|
173
173
|
#
|
174
|
-
# If the
|
174
|
+
# If the `location_id` in the parent field of the request is "-", all regions
|
175
175
|
# available to the project are queried, and the results aggregated.
|
176
176
|
# If in such an aggregated query a location is unavailable, a dummy Redis
|
177
177
|
# entry is included in the response with the "name" field set to a value of
|
@@ -188,16 +188,16 @@ module Google
|
|
188
188
|
# @!attribute [rw] name
|
189
189
|
# @return [String]
|
190
190
|
# Required. Redis instance resource name using the form:
|
191
|
-
#
|
192
|
-
# where
|
191
|
+
# `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
|
192
|
+
# where `location_id` refers to a GCP region
|
193
193
|
class GetInstanceRequest; end
|
194
194
|
|
195
195
|
# Request for {Google::Cloud::Redis::V1::CloudRedis::CreateInstance CreateInstance}.
|
196
196
|
# @!attribute [rw] parent
|
197
197
|
# @return [String]
|
198
198
|
# Required. The resource name of the instance location using the form:
|
199
|
-
#
|
200
|
-
# where
|
199
|
+
# `projects/{project_id}/locations/{location_id}`
|
200
|
+
# where `location_id` refers to a GCP region
|
201
201
|
# @!attribute [rw] instance_id
|
202
202
|
# @return [String]
|
203
203
|
# Required. The logical name of the Redis instance in the customer project
|
@@ -220,10 +220,10 @@ module Google
|
|
220
220
|
# this field. The elements of the repeated paths field may only include these
|
221
221
|
# fields from {CloudRedis::Instance Instance}:
|
222
222
|
#
|
223
|
-
# *
|
224
|
-
# *
|
225
|
-
# *
|
226
|
-
# *
|
223
|
+
# * `displayName`
|
224
|
+
# * `labels`
|
225
|
+
# * `memorySizeGb`
|
226
|
+
# * `redisConfig`
|
227
227
|
# @!attribute [rw] instance
|
228
228
|
# @return [Google::Cloud::Redis::V1::Instance]
|
229
229
|
# Required. Update description.
|
@@ -234,8 +234,8 @@ module Google
|
|
234
234
|
# @!attribute [rw] name
|
235
235
|
# @return [String]
|
236
236
|
# Required. Redis instance resource name using the form:
|
237
|
-
#
|
238
|
-
# where
|
237
|
+
# `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
|
238
|
+
# where `location_id` refers to a GCP region
|
239
239
|
class DeleteInstanceRequest; end
|
240
240
|
|
241
241
|
# Represents the v1 metadata of the long-running operation.
|
@@ -256,7 +256,7 @@ module Google
|
|
256
256
|
# Operation status details.
|
257
257
|
# @!attribute [rw] cancel_requested
|
258
258
|
# @return [true, false]
|
259
|
-
# Specifies if cancellation was requested for the
|
259
|
+
# Specifies if cancellation was requested for the operation.
|
260
260
|
# @!attribute [rw] api_version
|
261
261
|
# @return [String]
|
262
262
|
# API version.
|
@@ -265,12 +265,12 @@ module Google
|
|
265
265
|
# This location metadata represents additional configuration options for a
|
266
266
|
# given location where a Redis instance may be created. All fields are output
|
267
267
|
# only. It is returned as content of the
|
268
|
-
#
|
268
|
+
# `google.cloud.location.Location.metadata` field.
|
269
269
|
# @!attribute [rw] available_zones
|
270
270
|
# @return [Hash{String => Google::Cloud::Redis::V1::ZoneMetadata}]
|
271
271
|
# Output only. The set of available zones in the location. The map is keyed
|
272
272
|
# by the lowercase ID of each zone, as defined by GCE. These keys can be
|
273
|
-
# specified in
|
273
|
+
# specified in `location_id` or `alternative_location_id` fields when
|
274
274
|
# creating a Redis instance.
|
275
275
|
class LocationMetadata; end
|
276
276
|
|
@@ -21,7 +21,7 @@ module Google
|
|
21
21
|
# @return [String]
|
22
22
|
# The server-assigned name, which is only unique within the same service that
|
23
23
|
# originally returns it. If you use the default HTTP mapping, the
|
24
|
-
#
|
24
|
+
# `name` should have the format of `operations/some/unique/name`.
|
25
25
|
# @!attribute [rw] metadata
|
26
26
|
# @return [Google::Protobuf::Any]
|
27
27
|
# Service-specific metadata associated with the operation. It typically
|
@@ -30,8 +30,8 @@ module Google
|
|
30
30
|
# long-running operation should document the metadata type, if any.
|
31
31
|
# @!attribute [rw] done
|
32
32
|
# @return [true, false]
|
33
|
-
# If the value is
|
34
|
-
# If true, the operation is completed, and either
|
33
|
+
# If the value is `false`, it means the operation is still in progress.
|
34
|
+
# If true, the operation is completed, and either `error` or `response` is
|
35
35
|
# available.
|
36
36
|
# @!attribute [rw] error
|
37
37
|
# @return [Google::Rpc::Status]
|
@@ -39,13 +39,13 @@ module Google
|
|
39
39
|
# @!attribute [rw] response
|
40
40
|
# @return [Google::Protobuf::Any]
|
41
41
|
# The normal response of the operation in case of success. If the original
|
42
|
-
# method returns no data on success, such as
|
43
|
-
#
|
44
|
-
#
|
45
|
-
# methods, the response should have the type
|
42
|
+
# method returns no data on success, such as `Delete`, the response is
|
43
|
+
# `google.protobuf.Empty`. If the original method is standard
|
44
|
+
# `Get`/`Create`/`Update`, the response should be the resource. For other
|
45
|
+
# methods, the response should have the type `XxxResponse`, where `Xxx`
|
46
46
|
# is the original method name. For example, if the original method name
|
47
|
-
# is
|
48
|
-
#
|
47
|
+
# is `TakeSnapshot()`, the inferred response type is
|
48
|
+
# `TakeSnapshotResponse`.
|
49
49
|
class Operation; end
|
50
50
|
|
51
51
|
# The request message for {Google::Longrunning::Operations::GetOperation Operations::GetOperation}.
|
@@ -15,7 +15,7 @@
|
|
15
15
|
|
16
16
|
module Google
|
17
17
|
module Protobuf
|
18
|
-
#
|
18
|
+
# `Any` contains an arbitrary serialized protocol buffer message along with a
|
19
19
|
# URL that describes the type of the serialized message.
|
20
20
|
#
|
21
21
|
# Protobuf library provides support to pack/unpack Any values in the form
|
@@ -69,9 +69,9 @@ module Google
|
|
69
69
|
#
|
70
70
|
# = JSON
|
71
71
|
#
|
72
|
-
# The JSON representation of an
|
72
|
+
# The JSON representation of an `Any` value uses the regular
|
73
73
|
# representation of the deserialized, embedded message, with an
|
74
|
-
# additional field
|
74
|
+
# additional field `@type` which contains the type URL. Example:
|
75
75
|
#
|
76
76
|
# package google.profile;
|
77
77
|
# message Person {
|
@@ -87,7 +87,7 @@ module Google
|
|
87
87
|
#
|
88
88
|
# If the embedded message type is well-known and has a custom JSON
|
89
89
|
# representation, that representation will be embedded adding a field
|
90
|
-
#
|
90
|
+
# `value` which holds the custom JSON in addition to the `@type`
|
91
91
|
# field. Example (for message {Google::Protobuf::Duration}):
|
92
92
|
#
|
93
93
|
# {
|
@@ -99,15 +99,15 @@ module Google
|
|
99
99
|
# A URL/resource name that uniquely identifies the type of the serialized
|
100
100
|
# protocol buffer message. The last segment of the URL's path must represent
|
101
101
|
# the fully qualified name of the type (as in
|
102
|
-
#
|
102
|
+
# `path/google.protobuf.Duration`). The name should be in a canonical form
|
103
103
|
# (e.g., leading "." is not accepted).
|
104
104
|
#
|
105
105
|
# In practice, teams usually precompile into the binary all types that they
|
106
106
|
# expect it to use in the context of Any. However, for URLs which use the
|
107
|
-
# scheme
|
107
|
+
# scheme `http`, `https`, or no scheme, one can optionally set up a type
|
108
108
|
# server that maps type URLs to message definitions as follows:
|
109
109
|
#
|
110
|
-
# * If no scheme is provided,
|
110
|
+
# * If no scheme is provided, `https` is assumed.
|
111
111
|
# * An HTTP GET on the URL must yield a {Google::Protobuf::Type}
|
112
112
|
# value in binary format, or produce an error.
|
113
113
|
# * Applications are allowed to cache lookup results based on the
|
@@ -120,7 +120,7 @@ module Google
|
|
120
120
|
# protobuf release, and it is not used for type URLs beginning with
|
121
121
|
# type.googleapis.com.
|
122
122
|
#
|
123
|
-
# Schemes other than
|
123
|
+
# Schemes other than `http`, `https` (or the empty scheme) might be
|
124
124
|
# used with implementation specific semantics.
|
125
125
|
# @!attribute [rw] value
|
126
126
|
# @return [String]
|