google-cloud-redis-v1 0.11.1 → 0.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +72 -101
- data/lib/google/cloud/redis/v1/cloud_redis/client.rb +43 -9
- data/lib/google/cloud/redis/v1/cloud_redis/operations.rb +38 -7
- data/lib/google/cloud/redis/v1/cloud_redis/rest/client.rb +271 -7
- data/lib/google/cloud/redis/v1/cloud_redis/rest/operations.rb +108 -8
- data/lib/google/cloud/redis/v1/cloud_redis/rest/service_stub.rb +14 -2
- data/lib/google/cloud/redis/v1/version.rb +1 -1
- data/proto_docs/google/api/client.rb +14 -0
- data/proto_docs/google/api/field_behavior.rb +14 -0
- data/proto_docs/google/cloud/redis/v1/cloud_redis.rb +1 -0
- metadata +7 -7
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 1f6d263f35fbc9dbbecfca0d649ad9c4d13ab78975b65af6b0d99d636922dd1e
|
|
4
|
+
data.tar.gz: 55fa45601cd4351b0f722134abd87adf3661f4133187d6b87958499ea711fc8f
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 40d1649ba0dd767ee261b3d8a310c3b2920958b63eb835d491eaa7b4119db71a0b8dc26299c4728fd1448aeb7854e03b6e8378a882b20288b5434ed002b0d33b
|
|
7
|
+
data.tar.gz: 75450c326045567631c5c1eb768177d572f3d175586215c7d8a16f11352436c63cd5946d254beb39df758fa88805aa27097920b8ec66bb1c58a399e4ac7c7329
|
data/AUTHENTICATION.md
CHANGED
|
@@ -1,151 +1,122 @@
|
|
|
1
1
|
# Authentication
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
[
|
|
5
|
-
|
|
6
|
-
[Google Cloud Platform environments](#google-cloud-platform-environments) the
|
|
7
|
-
credentials will be discovered automatically. When running on other
|
|
8
|
-
environments, the Service Account credentials can be specified by providing the
|
|
9
|
-
path to the
|
|
10
|
-
[JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
|
|
11
|
-
for the account (or the JSON itself) in
|
|
12
|
-
[environment variables](#environment-variables). Additionally, Cloud SDK
|
|
13
|
-
credentials can also be discovered automatically, but this is only recommended
|
|
14
|
-
during development.
|
|
3
|
+
The recommended way to authenticate to the google-cloud-redis-v1 library is to use
|
|
4
|
+
[Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
|
|
5
|
+
To review all of your authentication options, see [Credentials lookup](#credential-lookup).
|
|
15
6
|
|
|
16
7
|
## Quickstart
|
|
17
8
|
|
|
18
|
-
|
|
19
|
-
|
|
9
|
+
The following example shows how to set up authentication for a local development
|
|
10
|
+
environment with your user credentials.
|
|
20
11
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
3. Initialize the client.
|
|
12
|
+
**NOTE:** This method is _not_ recommended for running in production. User credentials
|
|
13
|
+
should be used only during development.
|
|
26
14
|
|
|
27
|
-
|
|
28
|
-
|
|
15
|
+
1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
|
|
16
|
+
2. Set up a local ADC file with your user credentials:
|
|
29
17
|
|
|
30
|
-
|
|
18
|
+
```sh
|
|
19
|
+
gcloud auth application-default login
|
|
31
20
|
```
|
|
32
21
|
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
The google-cloud-redis-v1 library aims to make authentication
|
|
36
|
-
as simple as possible, and provides several mechanisms to configure your system
|
|
37
|
-
without requiring **Service Account Credentials** directly in code.
|
|
38
|
-
|
|
39
|
-
**Credentials** are discovered in the following order:
|
|
40
|
-
|
|
41
|
-
1. Specify credentials in method arguments
|
|
42
|
-
2. Specify credentials in configuration
|
|
43
|
-
3. Discover credentials path in environment variables
|
|
44
|
-
4. Discover credentials JSON in environment variables
|
|
45
|
-
5. Discover credentials file in the Cloud SDK's path
|
|
46
|
-
6. Discover GCP credentials
|
|
47
|
-
|
|
48
|
-
### Google Cloud Platform environments
|
|
22
|
+
3. Write code as if already authenticated.
|
|
49
23
|
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
|
|
53
|
-
Code should be written as if already authenticated.
|
|
24
|
+
For more information about setting up authentication for a local development environment, see
|
|
25
|
+
[Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
|
|
54
26
|
|
|
55
|
-
|
|
27
|
+
## Credential Lookup
|
|
56
28
|
|
|
57
|
-
The
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
**Credentials JSON** file can be stored in the environment variable, or the
|
|
62
|
-
**Credentials JSON** itself can be stored for environments such as Docker
|
|
63
|
-
containers where writing files is difficult or not encouraged.
|
|
29
|
+
The google-cloud-redis-v1 library provides several mechanisms to configure your system.
|
|
30
|
+
Generally, using Application Default Credentials to facilitate automatic
|
|
31
|
+
credentials discovery is the easist method. But if you need to explicitly specify
|
|
32
|
+
credentials, there are several methods available to you.
|
|
64
33
|
|
|
65
|
-
|
|
66
|
-
checks for credentials are configured on the service Credentials class (such as
|
|
67
|
-
{::Google::Cloud::Redis::V1::CloudRedis::Credentials}):
|
|
34
|
+
Credentials are accepted in the following ways, in the following order or precedence:
|
|
68
35
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
36
|
+
1. Credentials specified in method arguments
|
|
37
|
+
2. Credentials specified in configuration
|
|
38
|
+
3. Credentials pointed to or included in environment variables
|
|
39
|
+
4. Credentials found in local ADC file
|
|
40
|
+
5. Credentials returned by the metadata server for the attached service account (GCP)
|
|
74
41
|
|
|
75
|
-
|
|
76
|
-
require "google/cloud/redis/v1"
|
|
77
|
-
|
|
78
|
-
ENV["REDIS_CREDENTIALS"] = "path/to/keyfile.json"
|
|
42
|
+
### Configuration
|
|
79
43
|
|
|
80
|
-
client
|
|
81
|
-
|
|
44
|
+
You can configure a path to a JSON credentials file, either for an individual client object or
|
|
45
|
+
globally, for all client objects. The JSON file can contain credentials created for
|
|
46
|
+
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
|
|
47
|
+
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
|
|
48
|
+
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
|
|
82
49
|
|
|
83
|
-
|
|
50
|
+
Note: Service account keys are a security risk if not managed correctly. You should
|
|
51
|
+
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
|
|
52
|
+
whenever possible.
|
|
84
53
|
|
|
85
|
-
|
|
86
|
-
it in an environment variable. Either on an individual client initialization:
|
|
54
|
+
To configure a credentials file for an individual client initialization:
|
|
87
55
|
|
|
88
56
|
```ruby
|
|
89
57
|
require "google/cloud/redis/v1"
|
|
90
58
|
|
|
91
59
|
client = ::Google::Cloud::Redis::V1::CloudRedis::Client.new do |config|
|
|
92
|
-
config.credentials = "path/to/
|
|
60
|
+
config.credentials = "path/to/credentialfile.json"
|
|
93
61
|
end
|
|
94
62
|
```
|
|
95
63
|
|
|
96
|
-
|
|
64
|
+
To configure a credentials file globally for all clients:
|
|
97
65
|
|
|
98
66
|
```ruby
|
|
99
67
|
require "google/cloud/redis/v1"
|
|
100
68
|
|
|
101
69
|
::Google::Cloud::Redis::V1::CloudRedis::Client.configure do |config|
|
|
102
|
-
config.credentials = "path/to/
|
|
70
|
+
config.credentials = "path/to/credentialfile.json"
|
|
103
71
|
end
|
|
104
72
|
|
|
105
73
|
client = ::Google::Cloud::Redis::V1::CloudRedis::Client.new
|
|
106
74
|
```
|
|
107
75
|
|
|
108
|
-
###
|
|
76
|
+
### Environment Variables
|
|
109
77
|
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
78
|
+
You can also use an environment variable to provide a JSON credentials file.
|
|
79
|
+
The environment variable can contain a path to the credentials file or, for
|
|
80
|
+
environments such as Docker containers where writing files is not encouraged,
|
|
81
|
+
you can include the credentials file itself.
|
|
113
82
|
|
|
114
|
-
|
|
83
|
+
The JSON file can contain credentials created for
|
|
84
|
+
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
|
|
85
|
+
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
|
|
86
|
+
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
|
|
115
87
|
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
88
|
+
Note: Service account keys are a security risk if not managed correctly. You should
|
|
89
|
+
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
|
|
90
|
+
whenever possible.
|
|
91
|
+
|
|
92
|
+
The environment variables that google-cloud-redis-v1
|
|
93
|
+
checks for credentials are:
|
|
119
94
|
|
|
120
|
-
|
|
121
|
-
*
|
|
95
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
|
96
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
|
122
97
|
|
|
123
|
-
|
|
98
|
+
```ruby
|
|
99
|
+
require "google/cloud/redis/v1"
|
|
124
100
|
|
|
125
|
-
|
|
126
|
-
connect to the APIs. You will use the **JSON key file** to
|
|
127
|
-
connect to most services with google-cloud-redis-v1.
|
|
101
|
+
ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
|
|
128
102
|
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
need a Google Developers service account.
|
|
103
|
+
client = ::Google::Cloud::Redis::V1::CloudRedis::Client.new
|
|
104
|
+
```
|
|
132
105
|
|
|
133
|
-
|
|
134
|
-
2. Create a new project or click on an existing project.
|
|
135
|
-
3. Activate the menu in the upper left and select **APIs & Services**. From
|
|
136
|
-
here, you will enable the APIs that your application requires.
|
|
106
|
+
### Local ADC file
|
|
137
107
|
|
|
138
|
-
|
|
108
|
+
You can set up a local ADC file with your user credentials for authentication during
|
|
109
|
+
development. If credentials are not provided in code or in environment variables,
|
|
110
|
+
then the local ADC credentials are discovered.
|
|
139
111
|
|
|
140
|
-
|
|
112
|
+
Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
|
|
141
113
|
|
|
142
|
-
|
|
143
|
-
"Service account" to be guided through downloading a new JSON key file.
|
|
114
|
+
### Google Cloud Platform environments
|
|
144
115
|
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
116
|
+
When running on Google Cloud Platform (GCP), including Google Compute Engine
|
|
117
|
+
(GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
|
|
118
|
+
Functions (GCF) and Cloud Run, credentials are retrieved from the attached
|
|
119
|
+
service account automatically. Code should be written as if already authenticated.
|
|
149
120
|
|
|
150
|
-
|
|
151
|
-
|
|
121
|
+
For more information, see
|
|
122
|
+
[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
|
|
@@ -45,6 +45,9 @@ module Google
|
|
|
45
45
|
# * `projects/redpepper-1290/locations/us-central1/instances/my-redis`
|
|
46
46
|
#
|
|
47
47
|
class Client
|
|
48
|
+
# @private
|
|
49
|
+
DEFAULT_ENDPOINT_TEMPLATE = "redis.$UNIVERSE_DOMAIN$"
|
|
50
|
+
|
|
48
51
|
include Paths
|
|
49
52
|
|
|
50
53
|
# @private
|
|
@@ -127,6 +130,15 @@ module Google
|
|
|
127
130
|
@config
|
|
128
131
|
end
|
|
129
132
|
|
|
133
|
+
##
|
|
134
|
+
# The effective universe domain
|
|
135
|
+
#
|
|
136
|
+
# @return [String]
|
|
137
|
+
#
|
|
138
|
+
def universe_domain
|
|
139
|
+
@cloud_redis_stub.universe_domain
|
|
140
|
+
end
|
|
141
|
+
|
|
130
142
|
##
|
|
131
143
|
# Create a new CloudRedis client object.
|
|
132
144
|
#
|
|
@@ -160,8 +172,9 @@ module Google
|
|
|
160
172
|
credentials = @config.credentials
|
|
161
173
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
162
174
|
# but only if the default endpoint does not have a region prefix.
|
|
163
|
-
enable_self_signed_jwt = @config.endpoint
|
|
164
|
-
|
|
175
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
176
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
177
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
165
178
|
credentials ||= Credentials.default scope: @config.scope,
|
|
166
179
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
167
180
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -174,20 +187,25 @@ module Google
|
|
|
174
187
|
config.credentials = credentials
|
|
175
188
|
config.quota_project = @quota_project_id
|
|
176
189
|
config.endpoint = @config.endpoint
|
|
190
|
+
config.universe_domain = @config.universe_domain
|
|
177
191
|
end
|
|
178
192
|
|
|
179
193
|
@location_client = Google::Cloud::Location::Locations::Client.new do |config|
|
|
180
194
|
config.credentials = credentials
|
|
181
195
|
config.quota_project = @quota_project_id
|
|
182
196
|
config.endpoint = @config.endpoint
|
|
197
|
+
config.universe_domain = @config.universe_domain
|
|
183
198
|
end
|
|
184
199
|
|
|
185
200
|
@cloud_redis_stub = ::Gapic::ServiceStub.new(
|
|
186
201
|
::Google::Cloud::Redis::V1::CloudRedis::Stub,
|
|
187
|
-
credentials:
|
|
188
|
-
endpoint:
|
|
202
|
+
credentials: credentials,
|
|
203
|
+
endpoint: @config.endpoint,
|
|
204
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
205
|
+
universe_domain: @config.universe_domain,
|
|
189
206
|
channel_args: @config.channel_args,
|
|
190
|
-
interceptors: @config.interceptors
|
|
207
|
+
interceptors: @config.interceptors,
|
|
208
|
+
channel_pool_config: @config.channel_pool
|
|
191
209
|
)
|
|
192
210
|
end
|
|
193
211
|
|
|
@@ -1352,9 +1370,9 @@ module Google
|
|
|
1352
1370
|
# end
|
|
1353
1371
|
#
|
|
1354
1372
|
# @!attribute [rw] endpoint
|
|
1355
|
-
#
|
|
1356
|
-
#
|
|
1357
|
-
# @return [::String]
|
|
1373
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
1374
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
1375
|
+
# @return [::String,nil]
|
|
1358
1376
|
# @!attribute [rw] credentials
|
|
1359
1377
|
# Credentials to send with calls. You may provide any of the following types:
|
|
1360
1378
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -1400,13 +1418,20 @@ module Google
|
|
|
1400
1418
|
# @!attribute [rw] quota_project
|
|
1401
1419
|
# A separate project against which to charge quota.
|
|
1402
1420
|
# @return [::String]
|
|
1421
|
+
# @!attribute [rw] universe_domain
|
|
1422
|
+
# The universe domain within which to make requests. This determines the
|
|
1423
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
1424
|
+
# universe (usually the default "googleapis.com" universe).
|
|
1425
|
+
# @return [::String,nil]
|
|
1403
1426
|
#
|
|
1404
1427
|
class Configuration
|
|
1405
1428
|
extend ::Gapic::Config
|
|
1406
1429
|
|
|
1430
|
+
# @private
|
|
1431
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
1407
1432
|
DEFAULT_ENDPOINT = "redis.googleapis.com"
|
|
1408
1433
|
|
|
1409
|
-
config_attr :endpoint,
|
|
1434
|
+
config_attr :endpoint, nil, ::String, nil
|
|
1410
1435
|
config_attr :credentials, nil do |value|
|
|
1411
1436
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
1412
1437
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -1421,6 +1446,7 @@ module Google
|
|
|
1421
1446
|
config_attr :metadata, nil, ::Hash, nil
|
|
1422
1447
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
1423
1448
|
config_attr :quota_project, nil, ::String, nil
|
|
1449
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
1424
1450
|
|
|
1425
1451
|
# @private
|
|
1426
1452
|
def initialize parent_config = nil
|
|
@@ -1441,6 +1467,14 @@ module Google
|
|
|
1441
1467
|
end
|
|
1442
1468
|
end
|
|
1443
1469
|
|
|
1470
|
+
##
|
|
1471
|
+
# Configuration for the channel pool
|
|
1472
|
+
# @return [::Gapic::ServiceStub::ChannelPool::Configuration]
|
|
1473
|
+
#
|
|
1474
|
+
def channel_pool
|
|
1475
|
+
@channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
|
|
1476
|
+
end
|
|
1477
|
+
|
|
1444
1478
|
##
|
|
1445
1479
|
# Configuration RPC class for the CloudRedis API.
|
|
1446
1480
|
#
|
|
@@ -26,6 +26,9 @@ module Google
|
|
|
26
26
|
module CloudRedis
|
|
27
27
|
# Service that implements Longrunning Operations API.
|
|
28
28
|
class Operations
|
|
29
|
+
# @private
|
|
30
|
+
DEFAULT_ENDPOINT_TEMPLATE = "redis.$UNIVERSE_DOMAIN$"
|
|
31
|
+
|
|
29
32
|
# @private
|
|
30
33
|
attr_reader :operations_stub
|
|
31
34
|
|
|
@@ -60,6 +63,15 @@ module Google
|
|
|
60
63
|
@config
|
|
61
64
|
end
|
|
62
65
|
|
|
66
|
+
##
|
|
67
|
+
# The effective universe domain
|
|
68
|
+
#
|
|
69
|
+
# @return [String]
|
|
70
|
+
#
|
|
71
|
+
def universe_domain
|
|
72
|
+
@operations_stub.universe_domain
|
|
73
|
+
end
|
|
74
|
+
|
|
63
75
|
##
|
|
64
76
|
# Create a new Operations client object.
|
|
65
77
|
#
|
|
@@ -90,10 +102,13 @@ module Google
|
|
|
90
102
|
|
|
91
103
|
@operations_stub = ::Gapic::ServiceStub.new(
|
|
92
104
|
::Google::Longrunning::Operations::Stub,
|
|
93
|
-
credentials:
|
|
94
|
-
endpoint:
|
|
105
|
+
credentials: credentials,
|
|
106
|
+
endpoint: @config.endpoint,
|
|
107
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
108
|
+
universe_domain: @config.universe_domain,
|
|
95
109
|
channel_args: @config.channel_args,
|
|
96
|
-
interceptors: @config.interceptors
|
|
110
|
+
interceptors: @config.interceptors,
|
|
111
|
+
channel_pool_config: @config.channel_pool
|
|
97
112
|
)
|
|
98
113
|
|
|
99
114
|
# Used by an LRO wrapper for some methods of this service
|
|
@@ -612,9 +627,9 @@ module Google
|
|
|
612
627
|
# end
|
|
613
628
|
#
|
|
614
629
|
# @!attribute [rw] endpoint
|
|
615
|
-
#
|
|
616
|
-
#
|
|
617
|
-
# @return [::String]
|
|
630
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
631
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
632
|
+
# @return [::String,nil]
|
|
618
633
|
# @!attribute [rw] credentials
|
|
619
634
|
# Credentials to send with calls. You may provide any of the following types:
|
|
620
635
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -660,13 +675,20 @@ module Google
|
|
|
660
675
|
# @!attribute [rw] quota_project
|
|
661
676
|
# A separate project against which to charge quota.
|
|
662
677
|
# @return [::String]
|
|
678
|
+
# @!attribute [rw] universe_domain
|
|
679
|
+
# The universe domain within which to make requests. This determines the
|
|
680
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
681
|
+
# universe (usually the default "googleapis.com" universe).
|
|
682
|
+
# @return [::String,nil]
|
|
663
683
|
#
|
|
664
684
|
class Configuration
|
|
665
685
|
extend ::Gapic::Config
|
|
666
686
|
|
|
687
|
+
# @private
|
|
688
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
667
689
|
DEFAULT_ENDPOINT = "redis.googleapis.com"
|
|
668
690
|
|
|
669
|
-
config_attr :endpoint,
|
|
691
|
+
config_attr :endpoint, nil, ::String, nil
|
|
670
692
|
config_attr :credentials, nil do |value|
|
|
671
693
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
672
694
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -681,6 +703,7 @@ module Google
|
|
|
681
703
|
config_attr :metadata, nil, ::Hash, nil
|
|
682
704
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
683
705
|
config_attr :quota_project, nil, ::String, nil
|
|
706
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
684
707
|
|
|
685
708
|
# @private
|
|
686
709
|
def initialize parent_config = nil
|
|
@@ -701,6 +724,14 @@ module Google
|
|
|
701
724
|
end
|
|
702
725
|
end
|
|
703
726
|
|
|
727
|
+
##
|
|
728
|
+
# Configuration for the channel pool
|
|
729
|
+
# @return [::Gapic::ServiceStub::ChannelPool::Configuration]
|
|
730
|
+
#
|
|
731
|
+
def channel_pool
|
|
732
|
+
@channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
|
|
733
|
+
end
|
|
734
|
+
|
|
704
735
|
##
|
|
705
736
|
# Configuration RPC class for the Operations API.
|
|
706
737
|
#
|
|
@@ -47,6 +47,9 @@ module Google
|
|
|
47
47
|
# * `projects/redpepper-1290/locations/us-central1/instances/my-redis`
|
|
48
48
|
#
|
|
49
49
|
class Client
|
|
50
|
+
# @private
|
|
51
|
+
DEFAULT_ENDPOINT_TEMPLATE = "redis.$UNIVERSE_DOMAIN$"
|
|
52
|
+
|
|
50
53
|
include Paths
|
|
51
54
|
|
|
52
55
|
# @private
|
|
@@ -129,6 +132,15 @@ module Google
|
|
|
129
132
|
@config
|
|
130
133
|
end
|
|
131
134
|
|
|
135
|
+
##
|
|
136
|
+
# The effective universe domain
|
|
137
|
+
#
|
|
138
|
+
# @return [String]
|
|
139
|
+
#
|
|
140
|
+
def universe_domain
|
|
141
|
+
@cloud_redis_stub.universe_domain
|
|
142
|
+
end
|
|
143
|
+
|
|
132
144
|
##
|
|
133
145
|
# Create a new CloudRedis REST client object.
|
|
134
146
|
#
|
|
@@ -156,8 +168,9 @@ module Google
|
|
|
156
168
|
credentials = @config.credentials
|
|
157
169
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
158
170
|
# but only if the default endpoint does not have a region prefix.
|
|
159
|
-
enable_self_signed_jwt = @config.endpoint
|
|
160
|
-
|
|
171
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
172
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
173
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
161
174
|
credentials ||= Credentials.default scope: @config.scope,
|
|
162
175
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
163
176
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -171,16 +184,23 @@ module Google
|
|
|
171
184
|
config.credentials = credentials
|
|
172
185
|
config.quota_project = @quota_project_id
|
|
173
186
|
config.endpoint = @config.endpoint
|
|
187
|
+
config.universe_domain = @config.universe_domain
|
|
174
188
|
end
|
|
175
189
|
|
|
176
190
|
@location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
|
|
177
191
|
config.credentials = credentials
|
|
178
192
|
config.quota_project = @quota_project_id
|
|
179
193
|
config.endpoint = @config.endpoint
|
|
194
|
+
config.universe_domain = @config.universe_domain
|
|
180
195
|
config.bindings_override = @config.bindings_override
|
|
181
196
|
end
|
|
182
197
|
|
|
183
|
-
@cloud_redis_stub = ::Google::Cloud::Redis::V1::CloudRedis::Rest::ServiceStub.new
|
|
198
|
+
@cloud_redis_stub = ::Google::Cloud::Redis::V1::CloudRedis::Rest::ServiceStub.new(
|
|
199
|
+
endpoint: @config.endpoint,
|
|
200
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
201
|
+
universe_domain: @config.universe_domain,
|
|
202
|
+
credentials: credentials
|
|
203
|
+
)
|
|
184
204
|
end
|
|
185
205
|
|
|
186
206
|
##
|
|
@@ -248,6 +268,26 @@ module Google
|
|
|
248
268
|
# @return [::Google::Cloud::Redis::V1::ListInstancesResponse]
|
|
249
269
|
#
|
|
250
270
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
271
|
+
#
|
|
272
|
+
# @example Basic example
|
|
273
|
+
# require "google/cloud/redis/v1"
|
|
274
|
+
#
|
|
275
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
276
|
+
# client = Google::Cloud::Redis::V1::CloudRedis::Rest::Client.new
|
|
277
|
+
#
|
|
278
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
279
|
+
# request = Google::Cloud::Redis::V1::ListInstancesRequest.new
|
|
280
|
+
#
|
|
281
|
+
# # Call the list_instances method.
|
|
282
|
+
# result = client.list_instances request
|
|
283
|
+
#
|
|
284
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
|
285
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
|
286
|
+
# result.each do |item|
|
|
287
|
+
# # Each element is of type ::Google::Cloud::Redis::V1::Instance.
|
|
288
|
+
# p item
|
|
289
|
+
# end
|
|
290
|
+
#
|
|
251
291
|
def list_instances request, options = nil
|
|
252
292
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
253
293
|
|
|
@@ -312,6 +352,22 @@ module Google
|
|
|
312
352
|
# @return [::Google::Cloud::Redis::V1::Instance]
|
|
313
353
|
#
|
|
314
354
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
355
|
+
#
|
|
356
|
+
# @example Basic example
|
|
357
|
+
# require "google/cloud/redis/v1"
|
|
358
|
+
#
|
|
359
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
360
|
+
# client = Google::Cloud::Redis::V1::CloudRedis::Rest::Client.new
|
|
361
|
+
#
|
|
362
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
363
|
+
# request = Google::Cloud::Redis::V1::GetInstanceRequest.new
|
|
364
|
+
#
|
|
365
|
+
# # Call the get_instance method.
|
|
366
|
+
# result = client.get_instance request
|
|
367
|
+
#
|
|
368
|
+
# # The returned object is of type Google::Cloud::Redis::V1::Instance.
|
|
369
|
+
# p result
|
|
370
|
+
#
|
|
315
371
|
def get_instance request, options = nil
|
|
316
372
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
317
373
|
|
|
@@ -378,6 +434,22 @@ module Google
|
|
|
378
434
|
# @return [::Google::Cloud::Redis::V1::InstanceAuthString]
|
|
379
435
|
#
|
|
380
436
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
437
|
+
#
|
|
438
|
+
# @example Basic example
|
|
439
|
+
# require "google/cloud/redis/v1"
|
|
440
|
+
#
|
|
441
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
442
|
+
# client = Google::Cloud::Redis::V1::CloudRedis::Rest::Client.new
|
|
443
|
+
#
|
|
444
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
445
|
+
# request = Google::Cloud::Redis::V1::GetInstanceAuthStringRequest.new
|
|
446
|
+
#
|
|
447
|
+
# # Call the get_instance_auth_string method.
|
|
448
|
+
# result = client.get_instance_auth_string request
|
|
449
|
+
#
|
|
450
|
+
# # The returned object is of type Google::Cloud::Redis::V1::InstanceAuthString.
|
|
451
|
+
# p result
|
|
452
|
+
#
|
|
381
453
|
def get_instance_auth_string request, options = nil
|
|
382
454
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
383
455
|
|
|
@@ -464,6 +536,29 @@ module Google
|
|
|
464
536
|
# @return [::Gapic::Operation]
|
|
465
537
|
#
|
|
466
538
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
539
|
+
#
|
|
540
|
+
# @example Basic example
|
|
541
|
+
# require "google/cloud/redis/v1"
|
|
542
|
+
#
|
|
543
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
544
|
+
# client = Google::Cloud::Redis::V1::CloudRedis::Rest::Client.new
|
|
545
|
+
#
|
|
546
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
547
|
+
# request = Google::Cloud::Redis::V1::CreateInstanceRequest.new
|
|
548
|
+
#
|
|
549
|
+
# # Call the create_instance method.
|
|
550
|
+
# result = client.create_instance request
|
|
551
|
+
#
|
|
552
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
|
553
|
+
# # check the status of an operation, cancel it, or wait for results.
|
|
554
|
+
# # Here is how to wait for a response.
|
|
555
|
+
# result.wait_until_done! timeout: 60
|
|
556
|
+
# if result.response?
|
|
557
|
+
# p result.response
|
|
558
|
+
# else
|
|
559
|
+
# puts "No response received."
|
|
560
|
+
# end
|
|
561
|
+
#
|
|
467
562
|
def create_instance request, options = nil
|
|
468
563
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
469
564
|
|
|
@@ -542,6 +637,29 @@ module Google
|
|
|
542
637
|
# @return [::Gapic::Operation]
|
|
543
638
|
#
|
|
544
639
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
640
|
+
#
|
|
641
|
+
# @example Basic example
|
|
642
|
+
# require "google/cloud/redis/v1"
|
|
643
|
+
#
|
|
644
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
645
|
+
# client = Google::Cloud::Redis::V1::CloudRedis::Rest::Client.new
|
|
646
|
+
#
|
|
647
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
648
|
+
# request = Google::Cloud::Redis::V1::UpdateInstanceRequest.new
|
|
649
|
+
#
|
|
650
|
+
# # Call the update_instance method.
|
|
651
|
+
# result = client.update_instance request
|
|
652
|
+
#
|
|
653
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
|
654
|
+
# # check the status of an operation, cancel it, or wait for results.
|
|
655
|
+
# # Here is how to wait for a response.
|
|
656
|
+
# result.wait_until_done! timeout: 60
|
|
657
|
+
# if result.response?
|
|
658
|
+
# p result.response
|
|
659
|
+
# else
|
|
660
|
+
# puts "No response received."
|
|
661
|
+
# end
|
|
662
|
+
#
|
|
545
663
|
def update_instance request, options = nil
|
|
546
664
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
547
665
|
|
|
@@ -610,6 +728,29 @@ module Google
|
|
|
610
728
|
# @return [::Gapic::Operation]
|
|
611
729
|
#
|
|
612
730
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
731
|
+
#
|
|
732
|
+
# @example Basic example
|
|
733
|
+
# require "google/cloud/redis/v1"
|
|
734
|
+
#
|
|
735
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
736
|
+
# client = Google::Cloud::Redis::V1::CloudRedis::Rest::Client.new
|
|
737
|
+
#
|
|
738
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
739
|
+
# request = Google::Cloud::Redis::V1::UpgradeInstanceRequest.new
|
|
740
|
+
#
|
|
741
|
+
# # Call the upgrade_instance method.
|
|
742
|
+
# result = client.upgrade_instance request
|
|
743
|
+
#
|
|
744
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
|
745
|
+
# # check the status of an operation, cancel it, or wait for results.
|
|
746
|
+
# # Here is how to wait for a response.
|
|
747
|
+
# result.wait_until_done! timeout: 60
|
|
748
|
+
# if result.response?
|
|
749
|
+
# p result.response
|
|
750
|
+
# else
|
|
751
|
+
# puts "No response received."
|
|
752
|
+
# end
|
|
753
|
+
#
|
|
613
754
|
def upgrade_instance request, options = nil
|
|
614
755
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
615
756
|
|
|
@@ -684,6 +825,29 @@ module Google
|
|
|
684
825
|
# @return [::Gapic::Operation]
|
|
685
826
|
#
|
|
686
827
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
828
|
+
#
|
|
829
|
+
# @example Basic example
|
|
830
|
+
# require "google/cloud/redis/v1"
|
|
831
|
+
#
|
|
832
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
833
|
+
# client = Google::Cloud::Redis::V1::CloudRedis::Rest::Client.new
|
|
834
|
+
#
|
|
835
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
836
|
+
# request = Google::Cloud::Redis::V1::ImportInstanceRequest.new
|
|
837
|
+
#
|
|
838
|
+
# # Call the import_instance method.
|
|
839
|
+
# result = client.import_instance request
|
|
840
|
+
#
|
|
841
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
|
842
|
+
# # check the status of an operation, cancel it, or wait for results.
|
|
843
|
+
# # Here is how to wait for a response.
|
|
844
|
+
# result.wait_until_done! timeout: 60
|
|
845
|
+
# if result.response?
|
|
846
|
+
# p result.response
|
|
847
|
+
# else
|
|
848
|
+
# puts "No response received."
|
|
849
|
+
# end
|
|
850
|
+
#
|
|
687
851
|
def import_instance request, options = nil
|
|
688
852
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
689
853
|
|
|
@@ -756,6 +920,29 @@ module Google
|
|
|
756
920
|
# @return [::Gapic::Operation]
|
|
757
921
|
#
|
|
758
922
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
923
|
+
#
|
|
924
|
+
# @example Basic example
|
|
925
|
+
# require "google/cloud/redis/v1"
|
|
926
|
+
#
|
|
927
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
928
|
+
# client = Google::Cloud::Redis::V1::CloudRedis::Rest::Client.new
|
|
929
|
+
#
|
|
930
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
931
|
+
# request = Google::Cloud::Redis::V1::ExportInstanceRequest.new
|
|
932
|
+
#
|
|
933
|
+
# # Call the export_instance method.
|
|
934
|
+
# result = client.export_instance request
|
|
935
|
+
#
|
|
936
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
|
937
|
+
# # check the status of an operation, cancel it, or wait for results.
|
|
938
|
+
# # Here is how to wait for a response.
|
|
939
|
+
# result.wait_until_done! timeout: 60
|
|
940
|
+
# if result.response?
|
|
941
|
+
# p result.response
|
|
942
|
+
# else
|
|
943
|
+
# puts "No response received."
|
|
944
|
+
# end
|
|
945
|
+
#
|
|
759
946
|
def export_instance request, options = nil
|
|
760
947
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
761
948
|
|
|
@@ -825,6 +1012,29 @@ module Google
|
|
|
825
1012
|
# @return [::Gapic::Operation]
|
|
826
1013
|
#
|
|
827
1014
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
1015
|
+
#
|
|
1016
|
+
# @example Basic example
|
|
1017
|
+
# require "google/cloud/redis/v1"
|
|
1018
|
+
#
|
|
1019
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
1020
|
+
# client = Google::Cloud::Redis::V1::CloudRedis::Rest::Client.new
|
|
1021
|
+
#
|
|
1022
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
1023
|
+
# request = Google::Cloud::Redis::V1::FailoverInstanceRequest.new
|
|
1024
|
+
#
|
|
1025
|
+
# # Call the failover_instance method.
|
|
1026
|
+
# result = client.failover_instance request
|
|
1027
|
+
#
|
|
1028
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
|
1029
|
+
# # check the status of an operation, cancel it, or wait for results.
|
|
1030
|
+
# # Here is how to wait for a response.
|
|
1031
|
+
# result.wait_until_done! timeout: 60
|
|
1032
|
+
# if result.response?
|
|
1033
|
+
# p result.response
|
|
1034
|
+
# else
|
|
1035
|
+
# puts "No response received."
|
|
1036
|
+
# end
|
|
1037
|
+
#
|
|
828
1038
|
def failover_instance request, options = nil
|
|
829
1039
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
830
1040
|
|
|
@@ -891,6 +1101,29 @@ module Google
|
|
|
891
1101
|
# @return [::Gapic::Operation]
|
|
892
1102
|
#
|
|
893
1103
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
1104
|
+
#
|
|
1105
|
+
# @example Basic example
|
|
1106
|
+
# require "google/cloud/redis/v1"
|
|
1107
|
+
#
|
|
1108
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
1109
|
+
# client = Google::Cloud::Redis::V1::CloudRedis::Rest::Client.new
|
|
1110
|
+
#
|
|
1111
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
1112
|
+
# request = Google::Cloud::Redis::V1::DeleteInstanceRequest.new
|
|
1113
|
+
#
|
|
1114
|
+
# # Call the delete_instance method.
|
|
1115
|
+
# result = client.delete_instance request
|
|
1116
|
+
#
|
|
1117
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
|
1118
|
+
# # check the status of an operation, cancel it, or wait for results.
|
|
1119
|
+
# # Here is how to wait for a response.
|
|
1120
|
+
# result.wait_until_done! timeout: 60
|
|
1121
|
+
# if result.response?
|
|
1122
|
+
# p result.response
|
|
1123
|
+
# else
|
|
1124
|
+
# puts "No response received."
|
|
1125
|
+
# end
|
|
1126
|
+
#
|
|
894
1127
|
def delete_instance request, options = nil
|
|
895
1128
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
896
1129
|
|
|
@@ -964,6 +1197,29 @@ module Google
|
|
|
964
1197
|
# @return [::Gapic::Operation]
|
|
965
1198
|
#
|
|
966
1199
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
1200
|
+
#
|
|
1201
|
+
# @example Basic example
|
|
1202
|
+
# require "google/cloud/redis/v1"
|
|
1203
|
+
#
|
|
1204
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
1205
|
+
# client = Google::Cloud::Redis::V1::CloudRedis::Rest::Client.new
|
|
1206
|
+
#
|
|
1207
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
1208
|
+
# request = Google::Cloud::Redis::V1::RescheduleMaintenanceRequest.new
|
|
1209
|
+
#
|
|
1210
|
+
# # Call the reschedule_maintenance method.
|
|
1211
|
+
# result = client.reschedule_maintenance request
|
|
1212
|
+
#
|
|
1213
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
|
1214
|
+
# # check the status of an operation, cancel it, or wait for results.
|
|
1215
|
+
# # Here is how to wait for a response.
|
|
1216
|
+
# result.wait_until_done! timeout: 60
|
|
1217
|
+
# if result.response?
|
|
1218
|
+
# p result.response
|
|
1219
|
+
# else
|
|
1220
|
+
# puts "No response received."
|
|
1221
|
+
# end
|
|
1222
|
+
#
|
|
967
1223
|
def reschedule_maintenance request, options = nil
|
|
968
1224
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
969
1225
|
|
|
@@ -1030,9 +1286,9 @@ module Google
|
|
|
1030
1286
|
# end
|
|
1031
1287
|
#
|
|
1032
1288
|
# @!attribute [rw] endpoint
|
|
1033
|
-
#
|
|
1034
|
-
#
|
|
1035
|
-
# @return [::String]
|
|
1289
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
1290
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
1291
|
+
# @return [::String,nil]
|
|
1036
1292
|
# @!attribute [rw] credentials
|
|
1037
1293
|
# Credentials to send with calls. You may provide any of the following types:
|
|
1038
1294
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -1069,13 +1325,20 @@ module Google
|
|
|
1069
1325
|
# @!attribute [rw] quota_project
|
|
1070
1326
|
# A separate project against which to charge quota.
|
|
1071
1327
|
# @return [::String]
|
|
1328
|
+
# @!attribute [rw] universe_domain
|
|
1329
|
+
# The universe domain within which to make requests. This determines the
|
|
1330
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
1331
|
+
# universe (usually the default "googleapis.com" universe).
|
|
1332
|
+
# @return [::String,nil]
|
|
1072
1333
|
#
|
|
1073
1334
|
class Configuration
|
|
1074
1335
|
extend ::Gapic::Config
|
|
1075
1336
|
|
|
1337
|
+
# @private
|
|
1338
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
1076
1339
|
DEFAULT_ENDPOINT = "redis.googleapis.com"
|
|
1077
1340
|
|
|
1078
|
-
config_attr :endpoint,
|
|
1341
|
+
config_attr :endpoint, nil, ::String, nil
|
|
1079
1342
|
config_attr :credentials, nil do |value|
|
|
1080
1343
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
1081
1344
|
allowed.any? { |klass| klass === value }
|
|
@@ -1087,6 +1350,7 @@ module Google
|
|
|
1087
1350
|
config_attr :metadata, nil, ::Hash, nil
|
|
1088
1351
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
1089
1352
|
config_attr :quota_project, nil, ::String, nil
|
|
1353
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
1090
1354
|
|
|
1091
1355
|
# @private
|
|
1092
1356
|
# Overrides for http bindings for the RPCs of this service
|
|
@@ -26,6 +26,9 @@ module Google
|
|
|
26
26
|
module Rest
|
|
27
27
|
# Service that implements Longrunning Operations API.
|
|
28
28
|
class Operations
|
|
29
|
+
# @private
|
|
30
|
+
DEFAULT_ENDPOINT_TEMPLATE = "redis.$UNIVERSE_DOMAIN$"
|
|
31
|
+
|
|
29
32
|
# @private
|
|
30
33
|
attr_reader :operations_stub
|
|
31
34
|
|
|
@@ -60,6 +63,15 @@ module Google
|
|
|
60
63
|
@config
|
|
61
64
|
end
|
|
62
65
|
|
|
66
|
+
##
|
|
67
|
+
# The effective universe domain
|
|
68
|
+
#
|
|
69
|
+
# @return [String]
|
|
70
|
+
#
|
|
71
|
+
def universe_domain
|
|
72
|
+
@operations_stub.universe_domain
|
|
73
|
+
end
|
|
74
|
+
|
|
63
75
|
##
|
|
64
76
|
# Create a new Operations client object.
|
|
65
77
|
#
|
|
@@ -84,8 +96,10 @@ module Google
|
|
|
84
96
|
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
|
85
97
|
|
|
86
98
|
@operations_stub = OperationsServiceStub.new(
|
|
87
|
-
endpoint:
|
|
88
|
-
|
|
99
|
+
endpoint: @config.endpoint,
|
|
100
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
101
|
+
universe_domain: @config.universe_domain,
|
|
102
|
+
credentials: credentials
|
|
89
103
|
)
|
|
90
104
|
|
|
91
105
|
# Used by an LRO wrapper for some methods of this service
|
|
@@ -136,6 +150,26 @@ module Google
|
|
|
136
150
|
# @return [::Gapic::Operation]
|
|
137
151
|
#
|
|
138
152
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
153
|
+
#
|
|
154
|
+
# @example Basic example
|
|
155
|
+
# require "google/longrunning"
|
|
156
|
+
#
|
|
157
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
158
|
+
# client = Google::Longrunning::Operations::Rest::Client.new
|
|
159
|
+
#
|
|
160
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
161
|
+
# request = Google::Longrunning::ListOperationsRequest.new
|
|
162
|
+
#
|
|
163
|
+
# # Call the list_operations method.
|
|
164
|
+
# result = client.list_operations request
|
|
165
|
+
#
|
|
166
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
|
167
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
|
168
|
+
# result.each do |item|
|
|
169
|
+
# # Each element is of type ::Google::Longrunning::Operation.
|
|
170
|
+
# p item
|
|
171
|
+
# end
|
|
172
|
+
#
|
|
139
173
|
def list_operations request, options = nil
|
|
140
174
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
141
175
|
|
|
@@ -201,6 +235,29 @@ module Google
|
|
|
201
235
|
# @return [::Gapic::Operation]
|
|
202
236
|
#
|
|
203
237
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
238
|
+
#
|
|
239
|
+
# @example Basic example
|
|
240
|
+
# require "google/longrunning"
|
|
241
|
+
#
|
|
242
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
243
|
+
# client = Google::Longrunning::Operations::Rest::Client.new
|
|
244
|
+
#
|
|
245
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
246
|
+
# request = Google::Longrunning::GetOperationRequest.new
|
|
247
|
+
#
|
|
248
|
+
# # Call the get_operation method.
|
|
249
|
+
# result = client.get_operation request
|
|
250
|
+
#
|
|
251
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
|
252
|
+
# # check the status of an operation, cancel it, or wait for results.
|
|
253
|
+
# # Here is how to wait for a response.
|
|
254
|
+
# result.wait_until_done! timeout: 60
|
|
255
|
+
# if result.response?
|
|
256
|
+
# p result.response
|
|
257
|
+
# else
|
|
258
|
+
# puts "No response received."
|
|
259
|
+
# end
|
|
260
|
+
#
|
|
204
261
|
def get_operation request, options = nil
|
|
205
262
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
206
263
|
|
|
@@ -267,6 +324,22 @@ module Google
|
|
|
267
324
|
# @return [::Google::Protobuf::Empty]
|
|
268
325
|
#
|
|
269
326
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
327
|
+
#
|
|
328
|
+
# @example Basic example
|
|
329
|
+
# require "google/longrunning"
|
|
330
|
+
#
|
|
331
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
332
|
+
# client = Google::Longrunning::Operations::Rest::Client.new
|
|
333
|
+
#
|
|
334
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
335
|
+
# request = Google::Longrunning::DeleteOperationRequest.new
|
|
336
|
+
#
|
|
337
|
+
# # Call the delete_operation method.
|
|
338
|
+
# result = client.delete_operation request
|
|
339
|
+
#
|
|
340
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
|
341
|
+
# p result
|
|
342
|
+
#
|
|
270
343
|
def delete_operation request, options = nil
|
|
271
344
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
272
345
|
|
|
@@ -338,6 +411,22 @@ module Google
|
|
|
338
411
|
# @return [::Google::Protobuf::Empty]
|
|
339
412
|
#
|
|
340
413
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
414
|
+
#
|
|
415
|
+
# @example Basic example
|
|
416
|
+
# require "google/longrunning"
|
|
417
|
+
#
|
|
418
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
419
|
+
# client = Google::Longrunning::Operations::Rest::Client.new
|
|
420
|
+
#
|
|
421
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
422
|
+
# request = Google::Longrunning::CancelOperationRequest.new
|
|
423
|
+
#
|
|
424
|
+
# # Call the cancel_operation method.
|
|
425
|
+
# result = client.cancel_operation request
|
|
426
|
+
#
|
|
427
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
|
428
|
+
# p result
|
|
429
|
+
#
|
|
341
430
|
def cancel_operation request, options = nil
|
|
342
431
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
343
432
|
|
|
@@ -403,9 +492,9 @@ module Google
|
|
|
403
492
|
# end
|
|
404
493
|
#
|
|
405
494
|
# @!attribute [rw] endpoint
|
|
406
|
-
#
|
|
407
|
-
#
|
|
408
|
-
# @return [::String]
|
|
495
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
496
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
497
|
+
# @return [::String,nil]
|
|
409
498
|
# @!attribute [rw] credentials
|
|
410
499
|
# Credentials to send with calls. You may provide any of the following types:
|
|
411
500
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -442,13 +531,20 @@ module Google
|
|
|
442
531
|
# @!attribute [rw] quota_project
|
|
443
532
|
# A separate project against which to charge quota.
|
|
444
533
|
# @return [::String]
|
|
534
|
+
# @!attribute [rw] universe_domain
|
|
535
|
+
# The universe domain within which to make requests. This determines the
|
|
536
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
537
|
+
# universe (usually the default "googleapis.com" universe).
|
|
538
|
+
# @return [::String,nil]
|
|
445
539
|
#
|
|
446
540
|
class Configuration
|
|
447
541
|
extend ::Gapic::Config
|
|
448
542
|
|
|
543
|
+
# @private
|
|
544
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
449
545
|
DEFAULT_ENDPOINT = "redis.googleapis.com"
|
|
450
546
|
|
|
451
|
-
config_attr :endpoint,
|
|
547
|
+
config_attr :endpoint, nil, ::String, nil
|
|
452
548
|
config_attr :credentials, nil do |value|
|
|
453
549
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
454
550
|
allowed.any? { |klass| klass === value }
|
|
@@ -460,6 +556,7 @@ module Google
|
|
|
460
556
|
config_attr :metadata, nil, ::Hash, nil
|
|
461
557
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
462
558
|
config_attr :quota_project, nil, ::String, nil
|
|
559
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
463
560
|
|
|
464
561
|
# @private
|
|
465
562
|
def initialize parent_config = nil
|
|
@@ -542,12 +639,15 @@ module Google
|
|
|
542
639
|
# Service stub contains baseline method implementations
|
|
543
640
|
# including transcoding, making the REST call, and deserialing the response.
|
|
544
641
|
class OperationsServiceStub
|
|
545
|
-
def initialize endpoint:, credentials:
|
|
642
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
|
546
643
|
# These require statements are intentionally placed here to initialize
|
|
547
644
|
# the REST modules only when it's required.
|
|
548
645
|
require "gapic/rest"
|
|
549
646
|
|
|
550
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
647
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
648
|
+
endpoint_template: endpoint_template,
|
|
649
|
+
universe_domain: universe_domain,
|
|
650
|
+
credentials: credentials
|
|
551
651
|
end
|
|
552
652
|
|
|
553
653
|
##
|
|
@@ -30,16 +30,28 @@ module Google
|
|
|
30
30
|
# including transcoding, making the REST call, and deserialing the response.
|
|
31
31
|
#
|
|
32
32
|
class ServiceStub
|
|
33
|
-
def initialize endpoint:, credentials:
|
|
33
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
|
34
34
|
# These require statements are intentionally placed here to initialize
|
|
35
35
|
# the REST modules only when it's required.
|
|
36
36
|
require "gapic/rest"
|
|
37
37
|
|
|
38
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
38
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
39
|
+
endpoint_template: endpoint_template,
|
|
40
|
+
universe_domain: universe_domain,
|
|
41
|
+
credentials: credentials,
|
|
39
42
|
numeric_enums: true,
|
|
40
43
|
raise_faraday_errors: false
|
|
41
44
|
end
|
|
42
45
|
|
|
46
|
+
##
|
|
47
|
+
# The effective universe domain
|
|
48
|
+
#
|
|
49
|
+
# @return [String]
|
|
50
|
+
#
|
|
51
|
+
def universe_domain
|
|
52
|
+
@client_stub.universe_domain
|
|
53
|
+
end
|
|
54
|
+
|
|
43
55
|
##
|
|
44
56
|
# Baseline implementation for the list_instances REST call
|
|
45
57
|
#
|
|
@@ -21,6 +21,7 @@ module Google
|
|
|
21
21
|
module Api
|
|
22
22
|
# Required information for every language.
|
|
23
23
|
# @!attribute [rw] reference_docs_uri
|
|
24
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
24
25
|
# @return [::String]
|
|
25
26
|
# Link to automatically generated reference documentation. Example:
|
|
26
27
|
# https://cloud.google.com/nodejs/docs/reference/asset/latest
|
|
@@ -304,6 +305,19 @@ module Google
|
|
|
304
305
|
# seconds: 360 # 6 minutes
|
|
305
306
|
# total_poll_timeout:
|
|
306
307
|
# seconds: 54000 # 90 minutes
|
|
308
|
+
# @!attribute [rw] auto_populated_fields
|
|
309
|
+
# @return [::Array<::String>]
|
|
310
|
+
# List of top-level fields of the request message, that should be
|
|
311
|
+
# automatically populated by the client libraries based on their
|
|
312
|
+
# (google.api.field_info).format. Currently supported format: UUID4.
|
|
313
|
+
#
|
|
314
|
+
# Example of a YAML configuration:
|
|
315
|
+
#
|
|
316
|
+
# publishing:
|
|
317
|
+
# method_settings:
|
|
318
|
+
# - selector: google.example.v1.ExampleService.CreateExample
|
|
319
|
+
# auto_populated_fields:
|
|
320
|
+
# - request_id
|
|
307
321
|
class MethodSettings
|
|
308
322
|
include ::Google::Protobuf::MessageExts
|
|
309
323
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -66,6 +66,20 @@ module Google
|
|
|
66
66
|
# a non-empty value will be returned. The user will not be aware of what
|
|
67
67
|
# non-empty value to expect.
|
|
68
68
|
NON_EMPTY_DEFAULT = 7
|
|
69
|
+
|
|
70
|
+
# Denotes that the field in a resource (a message annotated with
|
|
71
|
+
# google.api.resource) is used in the resource name to uniquely identify the
|
|
72
|
+
# resource. For AIP-compliant APIs, this should only be applied to the
|
|
73
|
+
# `name` field on the resource.
|
|
74
|
+
#
|
|
75
|
+
# This behavior should not be applied to references to other resources within
|
|
76
|
+
# the message.
|
|
77
|
+
#
|
|
78
|
+
# The identifier field of resources often have different field behavior
|
|
79
|
+
# depending on the request it is embedded in (e.g. for Create methods name
|
|
80
|
+
# is optional and unused, while for Update methods it is required). Instead
|
|
81
|
+
# of method-specific annotations, only `IDENTIFIER` is required.
|
|
82
|
+
IDENTIFIER = 8
|
|
69
83
|
end
|
|
70
84
|
end
|
|
71
85
|
end
|
|
@@ -483,6 +483,7 @@ module Google
|
|
|
483
483
|
# Output only. The end time of any upcoming scheduled maintenance for this
|
|
484
484
|
# instance.
|
|
485
485
|
# @!attribute [rw] can_reschedule
|
|
486
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
486
487
|
# @return [::Boolean]
|
|
487
488
|
# If the scheduled maintenance can be rescheduled, default is true.
|
|
488
489
|
# @!attribute [r] schedule_deadline_time
|
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.13.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: 2024-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.21.1
|
|
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.21.1
|
|
30
30
|
- - "<"
|
|
31
31
|
- !ruby/object:Gem::Version
|
|
32
32
|
version: 2.a
|
|
@@ -50,7 +50,7 @@ dependencies:
|
|
|
50
50
|
requirements:
|
|
51
51
|
- - ">="
|
|
52
52
|
- !ruby/object:Gem::Version
|
|
53
|
-
version: '0.
|
|
53
|
+
version: '0.7'
|
|
54
54
|
- - "<"
|
|
55
55
|
- !ruby/object:Gem::Version
|
|
56
56
|
version: 2.a
|
|
@@ -60,7 +60,7 @@ dependencies:
|
|
|
60
60
|
requirements:
|
|
61
61
|
- - ">="
|
|
62
62
|
- !ruby/object:Gem::Version
|
|
63
|
-
version: '0.
|
|
63
|
+
version: '0.7'
|
|
64
64
|
- - "<"
|
|
65
65
|
- !ruby/object:Gem::Version
|
|
66
66
|
version: 2.a
|
|
@@ -239,7 +239,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
239
239
|
- !ruby/object:Gem::Version
|
|
240
240
|
version: '0'
|
|
241
241
|
requirements: []
|
|
242
|
-
rubygems_version: 3.
|
|
242
|
+
rubygems_version: 3.5.3
|
|
243
243
|
signing_key:
|
|
244
244
|
specification_version: 4
|
|
245
245
|
summary: Creates and manages Redis instances on the Google Cloud Platform.
|