google-cloud-alloy_db-v1beta 0.5.0 → 0.6.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/alloy_db/v1beta/alloy_db_admin/client.rb +34 -8
- data/lib/google/cloud/alloy_db/v1beta/alloy_db_admin/operations.rb +28 -6
- data/lib/google/cloud/alloy_db/v1beta/alloy_db_admin/rest/client.rb +36 -7
- data/lib/google/cloud/alloy_db/v1beta/alloy_db_admin/rest/operations.rb +33 -8
- data/lib/google/cloud/alloy_db/v1beta/alloy_db_admin/rest/service_stub.rb +14 -2
- data/lib/google/cloud/alloy_db/v1beta/version.rb +1 -1
- data/proto_docs/google/api/client.rb +14 -0
- data/proto_docs/google/cloud/alloydb/v1beta/resources.rb +3 -0
- data/proto_docs/google/cloud/alloydb/v1beta/service.rb +1 -0
- metadata +9 -9
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 00e0d2e5a1e3b17fc45ec22013cfd5dc4d2198d35941fd717dfd96919bbd6f22
|
|
4
|
+
data.tar.gz: 6a528e30376b8619449acaad8c1c1cfede018ffaef3b52ce3c007283d25adc2e
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 7abde37f3c54f3e05bfebe0ccd3f434a06154baaf22c105dbbe703fc57e83f5e930aa053c830ea183e922ac38c3e92431772801c54ad559700944905170b16e2
|
|
7
|
+
data.tar.gz: e1afe92a731c663825bae9a5fe8e460d6df11ca09abbfbc9ae66c8625fd6a55e0227ee5eca6c10317752ae25be321c48dd41ff5c8b6b3bef572ead08b1cffbbb
|
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-alloy_db-v1beta 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-alloy_db-v1beta 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-alloy_db-v1beta 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::AlloyDB::V1beta::AlloyDBAdmin::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/alloy_db/v1beta"
|
|
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/alloy_db/v1beta"
|
|
88
58
|
|
|
89
59
|
client = ::Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::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/alloy_db/v1beta"
|
|
98
68
|
|
|
99
69
|
::Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::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::AlloyDB::V1beta::AlloyDBAdmin::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-alloy_db-v1beta
|
|
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/alloy_db/v1beta"
|
|
122
100
|
|
|
123
|
-
|
|
124
|
-
connect to the APIs. You will use the **JSON key file** to
|
|
125
|
-
connect to most services with google-cloud-alloy_db-v1beta.
|
|
101
|
+
ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
|
|
126
102
|
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
need a Google Developers service account.
|
|
103
|
+
client = ::Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::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).
|
|
@@ -32,6 +32,9 @@ module Google
|
|
|
32
32
|
# Service describing handlers for resources
|
|
33
33
|
#
|
|
34
34
|
class Client
|
|
35
|
+
# @private
|
|
36
|
+
DEFAULT_ENDPOINT_TEMPLATE = "alloydb.$UNIVERSE_DOMAIN$"
|
|
37
|
+
|
|
35
38
|
include Paths
|
|
36
39
|
|
|
37
40
|
# @private
|
|
@@ -149,6 +152,15 @@ module Google
|
|
|
149
152
|
@config
|
|
150
153
|
end
|
|
151
154
|
|
|
155
|
+
##
|
|
156
|
+
# The effective universe domain
|
|
157
|
+
#
|
|
158
|
+
# @return [String]
|
|
159
|
+
#
|
|
160
|
+
def universe_domain
|
|
161
|
+
@alloy_db_admin_stub.universe_domain
|
|
162
|
+
end
|
|
163
|
+
|
|
152
164
|
##
|
|
153
165
|
# Create a new AlloyDBAdmin client object.
|
|
154
166
|
#
|
|
@@ -182,8 +194,9 @@ module Google
|
|
|
182
194
|
credentials = @config.credentials
|
|
183
195
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
184
196
|
# but only if the default endpoint does not have a region prefix.
|
|
185
|
-
enable_self_signed_jwt = @config.endpoint
|
|
186
|
-
|
|
197
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
198
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
199
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
187
200
|
credentials ||= Credentials.default scope: @config.scope,
|
|
188
201
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
189
202
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -196,24 +209,29 @@ module Google
|
|
|
196
209
|
config.credentials = credentials
|
|
197
210
|
config.quota_project = @quota_project_id
|
|
198
211
|
config.endpoint = @config.endpoint
|
|
212
|
+
config.universe_domain = @config.universe_domain
|
|
199
213
|
end
|
|
200
214
|
|
|
201
215
|
@location_client = Google::Cloud::Location::Locations::Client.new do |config|
|
|
202
216
|
config.credentials = credentials
|
|
203
217
|
config.quota_project = @quota_project_id
|
|
204
218
|
config.endpoint = @config.endpoint
|
|
219
|
+
config.universe_domain = @config.universe_domain
|
|
205
220
|
end
|
|
206
221
|
|
|
207
222
|
@iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
|
|
208
223
|
config.credentials = credentials
|
|
209
224
|
config.quota_project = @quota_project_id
|
|
210
225
|
config.endpoint = @config.endpoint
|
|
226
|
+
config.universe_domain = @config.universe_domain
|
|
211
227
|
end
|
|
212
228
|
|
|
213
229
|
@alloy_db_admin_stub = ::Gapic::ServiceStub.new(
|
|
214
230
|
::Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Stub,
|
|
215
|
-
credentials:
|
|
216
|
-
endpoint:
|
|
231
|
+
credentials: credentials,
|
|
232
|
+
endpoint: @config.endpoint,
|
|
233
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
234
|
+
universe_domain: @config.universe_domain,
|
|
217
235
|
channel_args: @config.channel_args,
|
|
218
236
|
interceptors: @config.interceptors,
|
|
219
237
|
channel_pool_config: @config.channel_pool
|
|
@@ -3647,9 +3665,9 @@ module Google
|
|
|
3647
3665
|
# end
|
|
3648
3666
|
#
|
|
3649
3667
|
# @!attribute [rw] endpoint
|
|
3650
|
-
#
|
|
3651
|
-
#
|
|
3652
|
-
# @return [::String]
|
|
3668
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
3669
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
3670
|
+
# @return [::String,nil]
|
|
3653
3671
|
# @!attribute [rw] credentials
|
|
3654
3672
|
# Credentials to send with calls. You may provide any of the following types:
|
|
3655
3673
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -3695,13 +3713,20 @@ module Google
|
|
|
3695
3713
|
# @!attribute [rw] quota_project
|
|
3696
3714
|
# A separate project against which to charge quota.
|
|
3697
3715
|
# @return [::String]
|
|
3716
|
+
# @!attribute [rw] universe_domain
|
|
3717
|
+
# The universe domain within which to make requests. This determines the
|
|
3718
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
3719
|
+
# universe (usually the default "googleapis.com" universe).
|
|
3720
|
+
# @return [::String,nil]
|
|
3698
3721
|
#
|
|
3699
3722
|
class Configuration
|
|
3700
3723
|
extend ::Gapic::Config
|
|
3701
3724
|
|
|
3725
|
+
# @private
|
|
3726
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
3702
3727
|
DEFAULT_ENDPOINT = "alloydb.googleapis.com"
|
|
3703
3728
|
|
|
3704
|
-
config_attr :endpoint,
|
|
3729
|
+
config_attr :endpoint, nil, ::String, nil
|
|
3705
3730
|
config_attr :credentials, nil do |value|
|
|
3706
3731
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
3707
3732
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -3716,6 +3741,7 @@ module Google
|
|
|
3716
3741
|
config_attr :metadata, nil, ::Hash, nil
|
|
3717
3742
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
3718
3743
|
config_attr :quota_project, nil, ::String, nil
|
|
3744
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
3719
3745
|
|
|
3720
3746
|
# @private
|
|
3721
3747
|
def initialize parent_config = nil
|
|
@@ -26,6 +26,9 @@ module Google
|
|
|
26
26
|
module AlloyDBAdmin
|
|
27
27
|
# Service that implements Longrunning Operations API.
|
|
28
28
|
class Operations
|
|
29
|
+
# @private
|
|
30
|
+
DEFAULT_ENDPOINT_TEMPLATE = "alloydb.$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,8 +102,10 @@ 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
110
|
interceptors: @config.interceptors,
|
|
97
111
|
channel_pool_config: @config.channel_pool
|
|
@@ -613,9 +627,9 @@ module Google
|
|
|
613
627
|
# end
|
|
614
628
|
#
|
|
615
629
|
# @!attribute [rw] endpoint
|
|
616
|
-
#
|
|
617
|
-
#
|
|
618
|
-
# @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]
|
|
619
633
|
# @!attribute [rw] credentials
|
|
620
634
|
# Credentials to send with calls. You may provide any of the following types:
|
|
621
635
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -661,13 +675,20 @@ module Google
|
|
|
661
675
|
# @!attribute [rw] quota_project
|
|
662
676
|
# A separate project against which to charge quota.
|
|
663
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]
|
|
664
683
|
#
|
|
665
684
|
class Configuration
|
|
666
685
|
extend ::Gapic::Config
|
|
667
686
|
|
|
687
|
+
# @private
|
|
688
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
668
689
|
DEFAULT_ENDPOINT = "alloydb.googleapis.com"
|
|
669
690
|
|
|
670
|
-
config_attr :endpoint,
|
|
691
|
+
config_attr :endpoint, nil, ::String, nil
|
|
671
692
|
config_attr :credentials, nil do |value|
|
|
672
693
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
673
694
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -682,6 +703,7 @@ module Google
|
|
|
682
703
|
config_attr :metadata, nil, ::Hash, nil
|
|
683
704
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
684
705
|
config_attr :quota_project, nil, ::String, nil
|
|
706
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
685
707
|
|
|
686
708
|
# @private
|
|
687
709
|
def initialize parent_config = nil
|
|
@@ -34,6 +34,9 @@ module Google
|
|
|
34
34
|
# Service describing handlers for resources
|
|
35
35
|
#
|
|
36
36
|
class Client
|
|
37
|
+
# @private
|
|
38
|
+
DEFAULT_ENDPOINT_TEMPLATE = "alloydb.$UNIVERSE_DOMAIN$"
|
|
39
|
+
|
|
37
40
|
include Paths
|
|
38
41
|
|
|
39
42
|
# @private
|
|
@@ -151,6 +154,15 @@ module Google
|
|
|
151
154
|
@config
|
|
152
155
|
end
|
|
153
156
|
|
|
157
|
+
##
|
|
158
|
+
# The effective universe domain
|
|
159
|
+
#
|
|
160
|
+
# @return [String]
|
|
161
|
+
#
|
|
162
|
+
def universe_domain
|
|
163
|
+
@alloy_db_admin_stub.universe_domain
|
|
164
|
+
end
|
|
165
|
+
|
|
154
166
|
##
|
|
155
167
|
# Create a new AlloyDBAdmin REST client object.
|
|
156
168
|
#
|
|
@@ -178,8 +190,9 @@ module Google
|
|
|
178
190
|
credentials = @config.credentials
|
|
179
191
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
180
192
|
# but only if the default endpoint does not have a region prefix.
|
|
181
|
-
enable_self_signed_jwt = @config.endpoint
|
|
182
|
-
|
|
193
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
194
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
195
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
183
196
|
credentials ||= Credentials.default scope: @config.scope,
|
|
184
197
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
185
198
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -193,12 +206,14 @@ module Google
|
|
|
193
206
|
config.credentials = credentials
|
|
194
207
|
config.quota_project = @quota_project_id
|
|
195
208
|
config.endpoint = @config.endpoint
|
|
209
|
+
config.universe_domain = @config.universe_domain
|
|
196
210
|
end
|
|
197
211
|
|
|
198
212
|
@location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
|
|
199
213
|
config.credentials = credentials
|
|
200
214
|
config.quota_project = @quota_project_id
|
|
201
215
|
config.endpoint = @config.endpoint
|
|
216
|
+
config.universe_domain = @config.universe_domain
|
|
202
217
|
config.bindings_override = @config.bindings_override
|
|
203
218
|
end
|
|
204
219
|
|
|
@@ -206,9 +221,15 @@ module Google
|
|
|
206
221
|
config.credentials = credentials
|
|
207
222
|
config.quota_project = @quota_project_id
|
|
208
223
|
config.endpoint = @config.endpoint
|
|
224
|
+
config.universe_domain = @config.universe_domain
|
|
209
225
|
end
|
|
210
226
|
|
|
211
|
-
@alloy_db_admin_stub = ::Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::ServiceStub.new
|
|
227
|
+
@alloy_db_admin_stub = ::Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::ServiceStub.new(
|
|
228
|
+
endpoint: @config.endpoint,
|
|
229
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
230
|
+
universe_domain: @config.universe_domain,
|
|
231
|
+
credentials: credentials
|
|
232
|
+
)
|
|
212
233
|
end
|
|
213
234
|
|
|
214
235
|
##
|
|
@@ -3417,9 +3438,9 @@ module Google
|
|
|
3417
3438
|
# end
|
|
3418
3439
|
#
|
|
3419
3440
|
# @!attribute [rw] endpoint
|
|
3420
|
-
#
|
|
3421
|
-
#
|
|
3422
|
-
# @return [::String]
|
|
3441
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
3442
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
3443
|
+
# @return [::String,nil]
|
|
3423
3444
|
# @!attribute [rw] credentials
|
|
3424
3445
|
# Credentials to send with calls. You may provide any of the following types:
|
|
3425
3446
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -3456,13 +3477,20 @@ module Google
|
|
|
3456
3477
|
# @!attribute [rw] quota_project
|
|
3457
3478
|
# A separate project against which to charge quota.
|
|
3458
3479
|
# @return [::String]
|
|
3480
|
+
# @!attribute [rw] universe_domain
|
|
3481
|
+
# The universe domain within which to make requests. This determines the
|
|
3482
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
3483
|
+
# universe (usually the default "googleapis.com" universe).
|
|
3484
|
+
# @return [::String,nil]
|
|
3459
3485
|
#
|
|
3460
3486
|
class Configuration
|
|
3461
3487
|
extend ::Gapic::Config
|
|
3462
3488
|
|
|
3489
|
+
# @private
|
|
3490
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
3463
3491
|
DEFAULT_ENDPOINT = "alloydb.googleapis.com"
|
|
3464
3492
|
|
|
3465
|
-
config_attr :endpoint,
|
|
3493
|
+
config_attr :endpoint, nil, ::String, nil
|
|
3466
3494
|
config_attr :credentials, nil do |value|
|
|
3467
3495
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
3468
3496
|
allowed.any? { |klass| klass === value }
|
|
@@ -3474,6 +3502,7 @@ module Google
|
|
|
3474
3502
|
config_attr :metadata, nil, ::Hash, nil
|
|
3475
3503
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
3476
3504
|
config_attr :quota_project, nil, ::String, nil
|
|
3505
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
3477
3506
|
|
|
3478
3507
|
# @private
|
|
3479
3508
|
# 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 = "alloydb.$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
|
|
@@ -478,9 +492,9 @@ module Google
|
|
|
478
492
|
# end
|
|
479
493
|
#
|
|
480
494
|
# @!attribute [rw] endpoint
|
|
481
|
-
#
|
|
482
|
-
#
|
|
483
|
-
# @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]
|
|
484
498
|
# @!attribute [rw] credentials
|
|
485
499
|
# Credentials to send with calls. You may provide any of the following types:
|
|
486
500
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -517,13 +531,20 @@ module Google
|
|
|
517
531
|
# @!attribute [rw] quota_project
|
|
518
532
|
# A separate project against which to charge quota.
|
|
519
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]
|
|
520
539
|
#
|
|
521
540
|
class Configuration
|
|
522
541
|
extend ::Gapic::Config
|
|
523
542
|
|
|
543
|
+
# @private
|
|
544
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
524
545
|
DEFAULT_ENDPOINT = "alloydb.googleapis.com"
|
|
525
546
|
|
|
526
|
-
config_attr :endpoint,
|
|
547
|
+
config_attr :endpoint, nil, ::String, nil
|
|
527
548
|
config_attr :credentials, nil do |value|
|
|
528
549
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
529
550
|
allowed.any? { |klass| klass === value }
|
|
@@ -535,6 +556,7 @@ module Google
|
|
|
535
556
|
config_attr :metadata, nil, ::Hash, nil
|
|
536
557
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
537
558
|
config_attr :quota_project, nil, ::String, nil
|
|
559
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
538
560
|
|
|
539
561
|
# @private
|
|
540
562
|
def initialize parent_config = nil
|
|
@@ -617,12 +639,15 @@ module Google
|
|
|
617
639
|
# Service stub contains baseline method implementations
|
|
618
640
|
# including transcoding, making the REST call, and deserialing the response.
|
|
619
641
|
class OperationsServiceStub
|
|
620
|
-
def initialize endpoint:, credentials:
|
|
642
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
|
621
643
|
# These require statements are intentionally placed here to initialize
|
|
622
644
|
# the REST modules only when it's required.
|
|
623
645
|
require "gapic/rest"
|
|
624
646
|
|
|
625
|
-
@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
|
|
626
651
|
end
|
|
627
652
|
|
|
628
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_clusters 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
|
|
@@ -374,6 +374,7 @@ module Google
|
|
|
374
374
|
# @!attribute [rw] network_config
|
|
375
375
|
# @return [::Google::Cloud::AlloyDB::V1beta::Cluster::NetworkConfig]
|
|
376
376
|
# @!attribute [rw] network
|
|
377
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
377
378
|
# @return [::String]
|
|
378
379
|
# Required. The resource link for the VPC network in which cluster resources
|
|
379
380
|
# are created and from which they are accessible via Private IP. The network
|
|
@@ -409,6 +410,7 @@ module Google
|
|
|
409
410
|
# For more information on the defaults, consult the
|
|
410
411
|
# documentation for the message type.
|
|
411
412
|
# @!attribute [rw] ssl_config
|
|
413
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
412
414
|
# @return [::Google::Cloud::AlloyDB::V1beta::SslConfig]
|
|
413
415
|
# SSL configuration for this AlloyDB cluster.
|
|
414
416
|
# @!attribute [rw] encryption_config
|
|
@@ -889,6 +891,7 @@ module Google
|
|
|
889
891
|
# default IP for the instance and is always created (even if enable_public_ip
|
|
890
892
|
# is set). This is the connection endpoint for an end-user application.
|
|
891
893
|
# @!attribute [r] pem_certificate_chain
|
|
894
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
892
895
|
# @return [::Array<::String>]
|
|
893
896
|
# Output only. The pem-encoded chain that may be used to verify the X.509
|
|
894
897
|
# certificate. Expected to be in issuer-to-root order according to RFC 5246.
|
|
@@ -956,6 +956,7 @@ module Google
|
|
|
956
956
|
# The request ID must be a valid UUID with the exception that zero UUID is
|
|
957
957
|
# not supported (00000000-0000-0000-0000-000000000000).
|
|
958
958
|
# @!attribute [rw] pem_csr
|
|
959
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
959
960
|
# @return [::String]
|
|
960
961
|
# Optional. A pem-encoded X.509 certificate signing request (CSR).
|
|
961
962
|
# @!attribute [rw] cert_duration
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-alloy_db-v1beta
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.6.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
|
|
@@ -70,7 +70,7 @@ dependencies:
|
|
|
70
70
|
requirements:
|
|
71
71
|
- - ">="
|
|
72
72
|
- !ruby/object:Gem::Version
|
|
73
|
-
version: '0.
|
|
73
|
+
version: '0.7'
|
|
74
74
|
- - "<"
|
|
75
75
|
- !ruby/object:Gem::Version
|
|
76
76
|
version: 2.a
|
|
@@ -80,7 +80,7 @@ dependencies:
|
|
|
80
80
|
requirements:
|
|
81
81
|
- - ">="
|
|
82
82
|
- !ruby/object:Gem::Version
|
|
83
|
-
version: '0.
|
|
83
|
+
version: '0.7'
|
|
84
84
|
- - "<"
|
|
85
85
|
- !ruby/object:Gem::Version
|
|
86
86
|
version: 2.a
|
|
@@ -271,7 +271,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
271
271
|
- !ruby/object:Gem::Version
|
|
272
272
|
version: '0'
|
|
273
273
|
requirements: []
|
|
274
|
-
rubygems_version: 3.
|
|
274
|
+
rubygems_version: 3.5.3
|
|
275
275
|
signing_key:
|
|
276
276
|
specification_version: 4
|
|
277
277
|
summary: AlloyDB for PostgreSQL is an open source-compatible database service that
|