google-cloud-redis-cluster-v1 0.1.0 → 0.2.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 -99
- data/lib/google/cloud/redis/cluster/v1/cloud_redis_cluster/client.rb +33 -8
- data/lib/google/cloud/redis/cluster/v1/cloud_redis_cluster/operations.rb +28 -6
- data/lib/google/cloud/redis/cluster/v1/cloud_redis_cluster/rest/client.rb +35 -7
- data/lib/google/cloud/redis/cluster/v1/cloud_redis_cluster/rest/operations.rb +33 -8
- data/lib/google/cloud/redis/cluster/v1/cloud_redis_cluster/rest/service_stub.rb +14 -2
- data/lib/google/cloud/redis/cluster/v1/version.rb +1 -1
- data/proto_docs/google/api/client.rb +14 -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: e21f4857642c5368e96f728506b96185d95e84b2a017a13923755c83d3bc9073
|
|
4
|
+
data.tar.gz: f56f03b1dbb12bcaacfe953b9db711b09eaf26c7bcb1a77685da55fe97e6fc50
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 050e0acae3104bc4161d688f972880c82c8c4a501f192bb56275f32540e076cf610acaeb9a510e2909e9b80136e727b22d3d68a1ac870946778f19fe6ffd6e7a
|
|
7
|
+
data.tar.gz: fac33201bf6f4b1a8d4d7ed59685b4f7e023e9af7a2e8663ad42c4e7dbde24f674d087e0d6689020f05a971c9b0e2eed55e68b1c5fdef724c205c4c18ce09b28
|
data/AUTHENTICATION.md
CHANGED
|
@@ -1,149 +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-cluster-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-cluster-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-cluster-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::Cluster::V1::CloudRedisCluster::Credentials}):
|
|
34
|
+
Credentials are accepted in the following ways, in the following order or precedence:
|
|
68
35
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
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)
|
|
72
41
|
|
|
73
|
-
|
|
74
|
-
require "google/cloud/redis/cluster/v1"
|
|
75
|
-
|
|
76
|
-
ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
|
|
42
|
+
### Configuration
|
|
77
43
|
|
|
78
|
-
client
|
|
79
|
-
|
|
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).
|
|
80
49
|
|
|
81
|
-
|
|
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.
|
|
82
53
|
|
|
83
|
-
|
|
84
|
-
it in an environment variable. Either on an individual client initialization:
|
|
54
|
+
To configure a credentials file for an individual client initialization:
|
|
85
55
|
|
|
86
56
|
```ruby
|
|
87
57
|
require "google/cloud/redis/cluster/v1"
|
|
88
58
|
|
|
89
59
|
client = ::Google::Cloud::Redis::Cluster::V1::CloudRedisCluster::Client.new do |config|
|
|
90
|
-
config.credentials = "path/to/
|
|
60
|
+
config.credentials = "path/to/credentialfile.json"
|
|
91
61
|
end
|
|
92
62
|
```
|
|
93
63
|
|
|
94
|
-
|
|
64
|
+
To configure a credentials file globally for all clients:
|
|
95
65
|
|
|
96
66
|
```ruby
|
|
97
67
|
require "google/cloud/redis/cluster/v1"
|
|
98
68
|
|
|
99
69
|
::Google::Cloud::Redis::Cluster::V1::CloudRedisCluster::Client.configure do |config|
|
|
100
|
-
config.credentials = "path/to/
|
|
70
|
+
config.credentials = "path/to/credentialfile.json"
|
|
101
71
|
end
|
|
102
72
|
|
|
103
73
|
client = ::Google::Cloud::Redis::Cluster::V1::CloudRedisCluster::Client.new
|
|
104
74
|
```
|
|
105
75
|
|
|
106
|
-
###
|
|
76
|
+
### Environment Variables
|
|
107
77
|
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
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.
|
|
111
82
|
|
|
112
|
-
|
|
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).
|
|
113
87
|
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
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-cluster-v1
|
|
93
|
+
checks for credentials are:
|
|
117
94
|
|
|
118
|
-
|
|
119
|
-
*
|
|
95
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
|
96
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
|
120
97
|
|
|
121
|
-
|
|
98
|
+
```ruby
|
|
99
|
+
require "google/cloud/redis/cluster/v1"
|
|
122
100
|
|
|
123
|
-
|
|
124
|
-
connect to the APIs. You will use the **JSON key file** to
|
|
125
|
-
connect to most services with google-cloud-redis-cluster-v1.
|
|
101
|
+
ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
|
|
126
102
|
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
need a Google Developers service account.
|
|
103
|
+
client = ::Google::Cloud::Redis::Cluster::V1::CloudRedisCluster::Client.new
|
|
104
|
+
```
|
|
130
105
|
|
|
131
|
-
|
|
132
|
-
2. Create a new project or click on an existing project.
|
|
133
|
-
3. Activate the menu in the upper left and select **APIs & Services**. From
|
|
134
|
-
here, you will enable the APIs that your application requires.
|
|
106
|
+
### Local ADC file
|
|
135
107
|
|
|
136
|
-
|
|
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.
|
|
137
111
|
|
|
138
|
-
|
|
112
|
+
Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
|
|
139
113
|
|
|
140
|
-
|
|
141
|
-
"Service account" to be guided through downloading a new JSON key file.
|
|
114
|
+
### Google Cloud Platform environments
|
|
142
115
|
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
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.
|
|
147
120
|
|
|
148
|
-
|
|
149
|
-
|
|
121
|
+
For more information, see
|
|
122
|
+
[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
|
|
@@ -52,6 +52,9 @@ module Google
|
|
|
52
52
|
# * More details in go/redis-flex-api-versioning
|
|
53
53
|
#
|
|
54
54
|
class Client
|
|
55
|
+
# @private
|
|
56
|
+
DEFAULT_ENDPOINT_TEMPLATE = "redis.$UNIVERSE_DOMAIN$"
|
|
57
|
+
|
|
55
58
|
include Paths
|
|
56
59
|
|
|
57
60
|
# @private
|
|
@@ -122,6 +125,15 @@ module Google
|
|
|
122
125
|
@config
|
|
123
126
|
end
|
|
124
127
|
|
|
128
|
+
##
|
|
129
|
+
# The effective universe domain
|
|
130
|
+
#
|
|
131
|
+
# @return [String]
|
|
132
|
+
#
|
|
133
|
+
def universe_domain
|
|
134
|
+
@cloud_redis_cluster_stub.universe_domain
|
|
135
|
+
end
|
|
136
|
+
|
|
125
137
|
##
|
|
126
138
|
# Create a new CloudRedisCluster client object.
|
|
127
139
|
#
|
|
@@ -155,8 +167,9 @@ module Google
|
|
|
155
167
|
credentials = @config.credentials
|
|
156
168
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
157
169
|
# but only if the default endpoint does not have a region prefix.
|
|
158
|
-
enable_self_signed_jwt = @config.endpoint
|
|
159
|
-
|
|
170
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
171
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
172
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
160
173
|
credentials ||= Credentials.default scope: @config.scope,
|
|
161
174
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
162
175
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -169,18 +182,22 @@ module Google
|
|
|
169
182
|
config.credentials = credentials
|
|
170
183
|
config.quota_project = @quota_project_id
|
|
171
184
|
config.endpoint = @config.endpoint
|
|
185
|
+
config.universe_domain = @config.universe_domain
|
|
172
186
|
end
|
|
173
187
|
|
|
174
188
|
@location_client = Google::Cloud::Location::Locations::Client.new do |config|
|
|
175
189
|
config.credentials = credentials
|
|
176
190
|
config.quota_project = @quota_project_id
|
|
177
191
|
config.endpoint = @config.endpoint
|
|
192
|
+
config.universe_domain = @config.universe_domain
|
|
178
193
|
end
|
|
179
194
|
|
|
180
195
|
@cloud_redis_cluster_stub = ::Gapic::ServiceStub.new(
|
|
181
196
|
::Google::Cloud::Redis::Cluster::V1::CloudRedisCluster::Stub,
|
|
182
|
-
credentials:
|
|
183
|
-
endpoint:
|
|
197
|
+
credentials: credentials,
|
|
198
|
+
endpoint: @config.endpoint,
|
|
199
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
200
|
+
universe_domain: @config.universe_domain,
|
|
184
201
|
channel_args: @config.channel_args,
|
|
185
202
|
interceptors: @config.interceptors,
|
|
186
203
|
channel_pool_config: @config.channel_pool
|
|
@@ -751,9 +768,9 @@ module Google
|
|
|
751
768
|
# end
|
|
752
769
|
#
|
|
753
770
|
# @!attribute [rw] endpoint
|
|
754
|
-
#
|
|
755
|
-
#
|
|
756
|
-
# @return [::String]
|
|
771
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
772
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
773
|
+
# @return [::String,nil]
|
|
757
774
|
# @!attribute [rw] credentials
|
|
758
775
|
# Credentials to send with calls. You may provide any of the following types:
|
|
759
776
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -799,13 +816,20 @@ module Google
|
|
|
799
816
|
# @!attribute [rw] quota_project
|
|
800
817
|
# A separate project against which to charge quota.
|
|
801
818
|
# @return [::String]
|
|
819
|
+
# @!attribute [rw] universe_domain
|
|
820
|
+
# The universe domain within which to make requests. This determines the
|
|
821
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
822
|
+
# universe (usually the default "googleapis.com" universe).
|
|
823
|
+
# @return [::String,nil]
|
|
802
824
|
#
|
|
803
825
|
class Configuration
|
|
804
826
|
extend ::Gapic::Config
|
|
805
827
|
|
|
828
|
+
# @private
|
|
829
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
806
830
|
DEFAULT_ENDPOINT = "redis.googleapis.com"
|
|
807
831
|
|
|
808
|
-
config_attr :endpoint,
|
|
832
|
+
config_attr :endpoint, nil, ::String, nil
|
|
809
833
|
config_attr :credentials, nil do |value|
|
|
810
834
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
811
835
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -820,6 +844,7 @@ module Google
|
|
|
820
844
|
config_attr :metadata, nil, ::Hash, nil
|
|
821
845
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
822
846
|
config_attr :quota_project, nil, ::String, nil
|
|
847
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
823
848
|
|
|
824
849
|
# @private
|
|
825
850
|
def initialize parent_config = nil
|
|
@@ -27,6 +27,9 @@ module Google
|
|
|
27
27
|
module CloudRedisCluster
|
|
28
28
|
# Service that implements Longrunning Operations API.
|
|
29
29
|
class Operations
|
|
30
|
+
# @private
|
|
31
|
+
DEFAULT_ENDPOINT_TEMPLATE = "redis.$UNIVERSE_DOMAIN$"
|
|
32
|
+
|
|
30
33
|
# @private
|
|
31
34
|
attr_reader :operations_stub
|
|
32
35
|
|
|
@@ -61,6 +64,15 @@ module Google
|
|
|
61
64
|
@config
|
|
62
65
|
end
|
|
63
66
|
|
|
67
|
+
##
|
|
68
|
+
# The effective universe domain
|
|
69
|
+
#
|
|
70
|
+
# @return [String]
|
|
71
|
+
#
|
|
72
|
+
def universe_domain
|
|
73
|
+
@operations_stub.universe_domain
|
|
74
|
+
end
|
|
75
|
+
|
|
64
76
|
##
|
|
65
77
|
# Create a new Operations client object.
|
|
66
78
|
#
|
|
@@ -91,8 +103,10 @@ module Google
|
|
|
91
103
|
|
|
92
104
|
@operations_stub = ::Gapic::ServiceStub.new(
|
|
93
105
|
::Google::Longrunning::Operations::Stub,
|
|
94
|
-
credentials:
|
|
95
|
-
endpoint:
|
|
106
|
+
credentials: credentials,
|
|
107
|
+
endpoint: @config.endpoint,
|
|
108
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
109
|
+
universe_domain: @config.universe_domain,
|
|
96
110
|
channel_args: @config.channel_args,
|
|
97
111
|
interceptors: @config.interceptors,
|
|
98
112
|
channel_pool_config: @config.channel_pool
|
|
@@ -614,9 +628,9 @@ module Google
|
|
|
614
628
|
# end
|
|
615
629
|
#
|
|
616
630
|
# @!attribute [rw] endpoint
|
|
617
|
-
#
|
|
618
|
-
#
|
|
619
|
-
# @return [::String]
|
|
631
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
632
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
633
|
+
# @return [::String,nil]
|
|
620
634
|
# @!attribute [rw] credentials
|
|
621
635
|
# Credentials to send with calls. You may provide any of the following types:
|
|
622
636
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -662,13 +676,20 @@ module Google
|
|
|
662
676
|
# @!attribute [rw] quota_project
|
|
663
677
|
# A separate project against which to charge quota.
|
|
664
678
|
# @return [::String]
|
|
679
|
+
# @!attribute [rw] universe_domain
|
|
680
|
+
# The universe domain within which to make requests. This determines the
|
|
681
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
682
|
+
# universe (usually the default "googleapis.com" universe).
|
|
683
|
+
# @return [::String,nil]
|
|
665
684
|
#
|
|
666
685
|
class Configuration
|
|
667
686
|
extend ::Gapic::Config
|
|
668
687
|
|
|
688
|
+
# @private
|
|
689
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
669
690
|
DEFAULT_ENDPOINT = "redis.googleapis.com"
|
|
670
691
|
|
|
671
|
-
config_attr :endpoint,
|
|
692
|
+
config_attr :endpoint, nil, ::String, nil
|
|
672
693
|
config_attr :credentials, nil do |value|
|
|
673
694
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
674
695
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -683,6 +704,7 @@ module Google
|
|
|
683
704
|
config_attr :metadata, nil, ::Hash, nil
|
|
684
705
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
685
706
|
config_attr :quota_project, nil, ::String, nil
|
|
707
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
686
708
|
|
|
687
709
|
# @private
|
|
688
710
|
def initialize parent_config = nil
|
|
@@ -54,6 +54,9 @@ module Google
|
|
|
54
54
|
# * More details in go/redis-flex-api-versioning
|
|
55
55
|
#
|
|
56
56
|
class Client
|
|
57
|
+
# @private
|
|
58
|
+
DEFAULT_ENDPOINT_TEMPLATE = "redis.$UNIVERSE_DOMAIN$"
|
|
59
|
+
|
|
57
60
|
include Paths
|
|
58
61
|
|
|
59
62
|
# @private
|
|
@@ -124,6 +127,15 @@ module Google
|
|
|
124
127
|
@config
|
|
125
128
|
end
|
|
126
129
|
|
|
130
|
+
##
|
|
131
|
+
# The effective universe domain
|
|
132
|
+
#
|
|
133
|
+
# @return [String]
|
|
134
|
+
#
|
|
135
|
+
def universe_domain
|
|
136
|
+
@cloud_redis_cluster_stub.universe_domain
|
|
137
|
+
end
|
|
138
|
+
|
|
127
139
|
##
|
|
128
140
|
# Create a new CloudRedisCluster REST client object.
|
|
129
141
|
#
|
|
@@ -151,8 +163,9 @@ module Google
|
|
|
151
163
|
credentials = @config.credentials
|
|
152
164
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
153
165
|
# but only if the default endpoint does not have a region prefix.
|
|
154
|
-
enable_self_signed_jwt = @config.endpoint
|
|
155
|
-
|
|
166
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
167
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
168
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
156
169
|
credentials ||= Credentials.default scope: @config.scope,
|
|
157
170
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
158
171
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -166,16 +179,23 @@ module Google
|
|
|
166
179
|
config.credentials = credentials
|
|
167
180
|
config.quota_project = @quota_project_id
|
|
168
181
|
config.endpoint = @config.endpoint
|
|
182
|
+
config.universe_domain = @config.universe_domain
|
|
169
183
|
end
|
|
170
184
|
|
|
171
185
|
@location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
|
|
172
186
|
config.credentials = credentials
|
|
173
187
|
config.quota_project = @quota_project_id
|
|
174
188
|
config.endpoint = @config.endpoint
|
|
189
|
+
config.universe_domain = @config.universe_domain
|
|
175
190
|
config.bindings_override = @config.bindings_override
|
|
176
191
|
end
|
|
177
192
|
|
|
178
|
-
@cloud_redis_cluster_stub = ::Google::Cloud::Redis::Cluster::V1::CloudRedisCluster::Rest::ServiceStub.new
|
|
193
|
+
@cloud_redis_cluster_stub = ::Google::Cloud::Redis::Cluster::V1::CloudRedisCluster::Rest::ServiceStub.new(
|
|
194
|
+
endpoint: @config.endpoint,
|
|
195
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
196
|
+
universe_domain: @config.universe_domain,
|
|
197
|
+
credentials: credentials
|
|
198
|
+
)
|
|
179
199
|
end
|
|
180
200
|
|
|
181
201
|
##
|
|
@@ -706,9 +726,9 @@ module Google
|
|
|
706
726
|
# end
|
|
707
727
|
#
|
|
708
728
|
# @!attribute [rw] endpoint
|
|
709
|
-
#
|
|
710
|
-
#
|
|
711
|
-
# @return [::String]
|
|
729
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
730
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
731
|
+
# @return [::String,nil]
|
|
712
732
|
# @!attribute [rw] credentials
|
|
713
733
|
# Credentials to send with calls. You may provide any of the following types:
|
|
714
734
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -745,13 +765,20 @@ module Google
|
|
|
745
765
|
# @!attribute [rw] quota_project
|
|
746
766
|
# A separate project against which to charge quota.
|
|
747
767
|
# @return [::String]
|
|
768
|
+
# @!attribute [rw] universe_domain
|
|
769
|
+
# The universe domain within which to make requests. This determines the
|
|
770
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
771
|
+
# universe (usually the default "googleapis.com" universe).
|
|
772
|
+
# @return [::String,nil]
|
|
748
773
|
#
|
|
749
774
|
class Configuration
|
|
750
775
|
extend ::Gapic::Config
|
|
751
776
|
|
|
777
|
+
# @private
|
|
778
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
752
779
|
DEFAULT_ENDPOINT = "redis.googleapis.com"
|
|
753
780
|
|
|
754
|
-
config_attr :endpoint,
|
|
781
|
+
config_attr :endpoint, nil, ::String, nil
|
|
755
782
|
config_attr :credentials, nil do |value|
|
|
756
783
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
757
784
|
allowed.any? { |klass| klass === value }
|
|
@@ -763,6 +790,7 @@ module Google
|
|
|
763
790
|
config_attr :metadata, nil, ::Hash, nil
|
|
764
791
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
765
792
|
config_attr :quota_project, nil, ::String, nil
|
|
793
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
766
794
|
|
|
767
795
|
# @private
|
|
768
796
|
# Overrides for http bindings for the RPCs of this service
|
|
@@ -27,6 +27,9 @@ module Google
|
|
|
27
27
|
module Rest
|
|
28
28
|
# Service that implements Longrunning Operations API.
|
|
29
29
|
class Operations
|
|
30
|
+
# @private
|
|
31
|
+
DEFAULT_ENDPOINT_TEMPLATE = "redis.$UNIVERSE_DOMAIN$"
|
|
32
|
+
|
|
30
33
|
# @private
|
|
31
34
|
attr_reader :operations_stub
|
|
32
35
|
|
|
@@ -61,6 +64,15 @@ module Google
|
|
|
61
64
|
@config
|
|
62
65
|
end
|
|
63
66
|
|
|
67
|
+
##
|
|
68
|
+
# The effective universe domain
|
|
69
|
+
#
|
|
70
|
+
# @return [String]
|
|
71
|
+
#
|
|
72
|
+
def universe_domain
|
|
73
|
+
@operations_stub.universe_domain
|
|
74
|
+
end
|
|
75
|
+
|
|
64
76
|
##
|
|
65
77
|
# Create a new Operations client object.
|
|
66
78
|
#
|
|
@@ -85,8 +97,10 @@ module Google
|
|
|
85
97
|
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
|
86
98
|
|
|
87
99
|
@operations_stub = OperationsServiceStub.new(
|
|
88
|
-
endpoint:
|
|
89
|
-
|
|
100
|
+
endpoint: @config.endpoint,
|
|
101
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
102
|
+
universe_domain: @config.universe_domain,
|
|
103
|
+
credentials: credentials
|
|
90
104
|
)
|
|
91
105
|
|
|
92
106
|
# Used by an LRO wrapper for some methods of this service
|
|
@@ -479,9 +493,9 @@ module Google
|
|
|
479
493
|
# end
|
|
480
494
|
#
|
|
481
495
|
# @!attribute [rw] endpoint
|
|
482
|
-
#
|
|
483
|
-
#
|
|
484
|
-
# @return [::String]
|
|
496
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
497
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
498
|
+
# @return [::String,nil]
|
|
485
499
|
# @!attribute [rw] credentials
|
|
486
500
|
# Credentials to send with calls. You may provide any of the following types:
|
|
487
501
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -518,13 +532,20 @@ module Google
|
|
|
518
532
|
# @!attribute [rw] quota_project
|
|
519
533
|
# A separate project against which to charge quota.
|
|
520
534
|
# @return [::String]
|
|
535
|
+
# @!attribute [rw] universe_domain
|
|
536
|
+
# The universe domain within which to make requests. This determines the
|
|
537
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
538
|
+
# universe (usually the default "googleapis.com" universe).
|
|
539
|
+
# @return [::String,nil]
|
|
521
540
|
#
|
|
522
541
|
class Configuration
|
|
523
542
|
extend ::Gapic::Config
|
|
524
543
|
|
|
544
|
+
# @private
|
|
545
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
525
546
|
DEFAULT_ENDPOINT = "redis.googleapis.com"
|
|
526
547
|
|
|
527
|
-
config_attr :endpoint,
|
|
548
|
+
config_attr :endpoint, nil, ::String, nil
|
|
528
549
|
config_attr :credentials, nil do |value|
|
|
529
550
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
530
551
|
allowed.any? { |klass| klass === value }
|
|
@@ -536,6 +557,7 @@ module Google
|
|
|
536
557
|
config_attr :metadata, nil, ::Hash, nil
|
|
537
558
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
538
559
|
config_attr :quota_project, nil, ::String, nil
|
|
560
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
539
561
|
|
|
540
562
|
# @private
|
|
541
563
|
def initialize parent_config = nil
|
|
@@ -618,12 +640,15 @@ module Google
|
|
|
618
640
|
# Service stub contains baseline method implementations
|
|
619
641
|
# including transcoding, making the REST call, and deserialing the response.
|
|
620
642
|
class OperationsServiceStub
|
|
621
|
-
def initialize endpoint:, credentials:
|
|
643
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
|
622
644
|
# These require statements are intentionally placed here to initialize
|
|
623
645
|
# the REST modules only when it's required.
|
|
624
646
|
require "gapic/rest"
|
|
625
647
|
|
|
626
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
648
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
649
|
+
endpoint_template: endpoint_template,
|
|
650
|
+
universe_domain: universe_domain,
|
|
651
|
+
credentials: credentials
|
|
627
652
|
end
|
|
628
653
|
|
|
629
654
|
##
|
|
@@ -31,16 +31,28 @@ module Google
|
|
|
31
31
|
# including transcoding, making the REST call, and deserialing the response.
|
|
32
32
|
#
|
|
33
33
|
class ServiceStub
|
|
34
|
-
def initialize endpoint:, credentials:
|
|
34
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
|
35
35
|
# These require statements are intentionally placed here to initialize
|
|
36
36
|
# the REST modules only when it's required.
|
|
37
37
|
require "gapic/rest"
|
|
38
38
|
|
|
39
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
39
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
40
|
+
endpoint_template: endpoint_template,
|
|
41
|
+
universe_domain: universe_domain,
|
|
42
|
+
credentials: credentials,
|
|
40
43
|
numeric_enums: true,
|
|
41
44
|
raise_faraday_errors: false
|
|
42
45
|
end
|
|
43
46
|
|
|
47
|
+
##
|
|
48
|
+
# The effective universe domain
|
|
49
|
+
#
|
|
50
|
+
# @return [String]
|
|
51
|
+
#
|
|
52
|
+
def universe_domain
|
|
53
|
+
@client_stub.universe_domain
|
|
54
|
+
end
|
|
55
|
+
|
|
44
56
|
##
|
|
45
57
|
# Baseline implementation for the list_clusters REST call
|
|
46
58
|
#
|
|
@@ -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
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-redis-cluster-v1
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.2.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
|
|
@@ -237,7 +237,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
237
237
|
- !ruby/object:Gem::Version
|
|
238
238
|
version: '0'
|
|
239
239
|
requirements: []
|
|
240
|
-
rubygems_version: 3.
|
|
240
|
+
rubygems_version: 3.5.3
|
|
241
241
|
signing_key:
|
|
242
242
|
specification_version: 4
|
|
243
243
|
summary: Creates and manages Redis instances on the Google Cloud Platform.
|