google-cloud-spanner-admin-database-v1 0.15.0 → 0.16.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/spanner/admin/database/v1/database_admin/client.rb +32 -8
- data/lib/google/cloud/spanner/admin/database/v1/database_admin/operations.rb +28 -6
- data/lib/google/cloud/spanner/admin/database/v1/database_admin/rest/client.rb +34 -7
- data/lib/google/cloud/spanner/admin/database/v1/database_admin/rest/operations.rb +33 -8
- data/lib/google/cloud/spanner/admin/database/v1/database_admin/rest/service_stub.rb +14 -2
- data/lib/google/cloud/spanner/admin/database/v1/version.rb +1 -1
- data/proto_docs/google/api/client.rb +14 -0
- metadata +5 -5
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 246f59e94b842fdf2e56a865d288b2e954bf3a87d7b09371281e0042ba1ab21b
|
|
4
|
+
data.tar.gz: 71b795598568217a0b6484947100937341b0514bb65b5de9933b1f4459b8fc99
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: b1dde40f06e9c7f08aeba60d29c5cc687ab9a9e1ddbfd733c70a4ddd56542c6be3a3bd882a644457f6d83ac62c75a81ecada20deb0e17ad897b9dff5ccd4c3df
|
|
7
|
+
data.tar.gz: a6520b8bc7072910479af7904908c0c8cc25c29f5ab8a04af508b5a8d22ca77806a6b49fc6d824790b85c3980fa17110706391ae118bcef1e6ff04bb239f91b6
|
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-spanner-admin-database-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-spanner-admin-database-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-spanner-admin-database-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::Spanner::Admin::Database::V1::DatabaseAdmin::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/spanner/admin/database/v1"
|
|
77
|
-
|
|
78
|
-
ENV["SPANNER_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/spanner/admin/database/v1"
|
|
90
58
|
|
|
91
59
|
client = ::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::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/spanner/admin/database/v1"
|
|
100
68
|
|
|
101
69
|
::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::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::Spanner::Admin::Database::V1::DatabaseAdmin::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-spanner-admin-database-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/spanner/admin/database/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-spanner-admin-database-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::Spanner::Admin::Database::V1::DatabaseAdmin::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).
|
|
@@ -38,6 +38,9 @@ module Google
|
|
|
38
38
|
# * restore a database from an existing backup
|
|
39
39
|
#
|
|
40
40
|
class Client
|
|
41
|
+
# @private
|
|
42
|
+
DEFAULT_ENDPOINT_TEMPLATE = "spanner.$UNIVERSE_DOMAIN$"
|
|
43
|
+
|
|
41
44
|
include Paths
|
|
42
45
|
|
|
43
46
|
# @private
|
|
@@ -180,6 +183,15 @@ module Google
|
|
|
180
183
|
@config
|
|
181
184
|
end
|
|
182
185
|
|
|
186
|
+
##
|
|
187
|
+
# The effective universe domain
|
|
188
|
+
#
|
|
189
|
+
# @return [String]
|
|
190
|
+
#
|
|
191
|
+
def universe_domain
|
|
192
|
+
@database_admin_stub.universe_domain
|
|
193
|
+
end
|
|
194
|
+
|
|
183
195
|
##
|
|
184
196
|
# Create a new DatabaseAdmin client object.
|
|
185
197
|
#
|
|
@@ -213,8 +225,9 @@ module Google
|
|
|
213
225
|
credentials = @config.credentials
|
|
214
226
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
215
227
|
# but only if the default endpoint does not have a region prefix.
|
|
216
|
-
enable_self_signed_jwt = @config.endpoint
|
|
217
|
-
|
|
228
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
229
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
230
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
218
231
|
credentials ||= Credentials.default scope: @config.scope,
|
|
219
232
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
220
233
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -227,12 +240,15 @@ module Google
|
|
|
227
240
|
config.credentials = credentials
|
|
228
241
|
config.quota_project = @quota_project_id
|
|
229
242
|
config.endpoint = @config.endpoint
|
|
243
|
+
config.universe_domain = @config.universe_domain
|
|
230
244
|
end
|
|
231
245
|
|
|
232
246
|
@database_admin_stub = ::Gapic::ServiceStub.new(
|
|
233
247
|
::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Stub,
|
|
234
|
-
credentials:
|
|
235
|
-
endpoint:
|
|
248
|
+
credentials: credentials,
|
|
249
|
+
endpoint: @config.endpoint,
|
|
250
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
251
|
+
universe_domain: @config.universe_domain,
|
|
236
252
|
channel_args: @config.channel_args,
|
|
237
253
|
interceptors: @config.interceptors,
|
|
238
254
|
channel_pool_config: @config.channel_pool
|
|
@@ -2518,9 +2534,9 @@ module Google
|
|
|
2518
2534
|
# end
|
|
2519
2535
|
#
|
|
2520
2536
|
# @!attribute [rw] endpoint
|
|
2521
|
-
#
|
|
2522
|
-
#
|
|
2523
|
-
# @return [::String]
|
|
2537
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
2538
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
2539
|
+
# @return [::String,nil]
|
|
2524
2540
|
# @!attribute [rw] credentials
|
|
2525
2541
|
# Credentials to send with calls. You may provide any of the following types:
|
|
2526
2542
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -2566,13 +2582,20 @@ module Google
|
|
|
2566
2582
|
# @!attribute [rw] quota_project
|
|
2567
2583
|
# A separate project against which to charge quota.
|
|
2568
2584
|
# @return [::String]
|
|
2585
|
+
# @!attribute [rw] universe_domain
|
|
2586
|
+
# The universe domain within which to make requests. This determines the
|
|
2587
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
2588
|
+
# universe (usually the default "googleapis.com" universe).
|
|
2589
|
+
# @return [::String,nil]
|
|
2569
2590
|
#
|
|
2570
2591
|
class Configuration
|
|
2571
2592
|
extend ::Gapic::Config
|
|
2572
2593
|
|
|
2594
|
+
# @private
|
|
2595
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
2573
2596
|
DEFAULT_ENDPOINT = "spanner.googleapis.com"
|
|
2574
2597
|
|
|
2575
|
-
config_attr :endpoint,
|
|
2598
|
+
config_attr :endpoint, nil, ::String, nil
|
|
2576
2599
|
config_attr :credentials, nil do |value|
|
|
2577
2600
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
2578
2601
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -2587,6 +2610,7 @@ module Google
|
|
|
2587
2610
|
config_attr :metadata, nil, ::Hash, nil
|
|
2588
2611
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
2589
2612
|
config_attr :quota_project, nil, ::String, nil
|
|
2613
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
2590
2614
|
|
|
2591
2615
|
# @private
|
|
2592
2616
|
def initialize parent_config = nil
|
|
@@ -28,6 +28,9 @@ module Google
|
|
|
28
28
|
module DatabaseAdmin
|
|
29
29
|
# Service that implements Longrunning Operations API.
|
|
30
30
|
class Operations
|
|
31
|
+
# @private
|
|
32
|
+
DEFAULT_ENDPOINT_TEMPLATE = "spanner.$UNIVERSE_DOMAIN$"
|
|
33
|
+
|
|
31
34
|
# @private
|
|
32
35
|
attr_reader :operations_stub
|
|
33
36
|
|
|
@@ -62,6 +65,15 @@ module Google
|
|
|
62
65
|
@config
|
|
63
66
|
end
|
|
64
67
|
|
|
68
|
+
##
|
|
69
|
+
# The effective universe domain
|
|
70
|
+
#
|
|
71
|
+
# @return [String]
|
|
72
|
+
#
|
|
73
|
+
def universe_domain
|
|
74
|
+
@operations_stub.universe_domain
|
|
75
|
+
end
|
|
76
|
+
|
|
65
77
|
##
|
|
66
78
|
# Create a new Operations client object.
|
|
67
79
|
#
|
|
@@ -92,8 +104,10 @@ module Google
|
|
|
92
104
|
|
|
93
105
|
@operations_stub = ::Gapic::ServiceStub.new(
|
|
94
106
|
::Google::Longrunning::Operations::Stub,
|
|
95
|
-
credentials:
|
|
96
|
-
endpoint:
|
|
107
|
+
credentials: credentials,
|
|
108
|
+
endpoint: @config.endpoint,
|
|
109
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
110
|
+
universe_domain: @config.universe_domain,
|
|
97
111
|
channel_args: @config.channel_args,
|
|
98
112
|
interceptors: @config.interceptors,
|
|
99
113
|
channel_pool_config: @config.channel_pool
|
|
@@ -615,9 +629,9 @@ module Google
|
|
|
615
629
|
# end
|
|
616
630
|
#
|
|
617
631
|
# @!attribute [rw] endpoint
|
|
618
|
-
#
|
|
619
|
-
#
|
|
620
|
-
# @return [::String]
|
|
632
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
633
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
634
|
+
# @return [::String,nil]
|
|
621
635
|
# @!attribute [rw] credentials
|
|
622
636
|
# Credentials to send with calls. You may provide any of the following types:
|
|
623
637
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -663,13 +677,20 @@ module Google
|
|
|
663
677
|
# @!attribute [rw] quota_project
|
|
664
678
|
# A separate project against which to charge quota.
|
|
665
679
|
# @return [::String]
|
|
680
|
+
# @!attribute [rw] universe_domain
|
|
681
|
+
# The universe domain within which to make requests. This determines the
|
|
682
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
683
|
+
# universe (usually the default "googleapis.com" universe).
|
|
684
|
+
# @return [::String,nil]
|
|
666
685
|
#
|
|
667
686
|
class Configuration
|
|
668
687
|
extend ::Gapic::Config
|
|
669
688
|
|
|
689
|
+
# @private
|
|
690
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
670
691
|
DEFAULT_ENDPOINT = "spanner.googleapis.com"
|
|
671
692
|
|
|
672
|
-
config_attr :endpoint,
|
|
693
|
+
config_attr :endpoint, nil, ::String, nil
|
|
673
694
|
config_attr :credentials, nil do |value|
|
|
674
695
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
675
696
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -684,6 +705,7 @@ module Google
|
|
|
684
705
|
config_attr :metadata, nil, ::Hash, nil
|
|
685
706
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
686
707
|
config_attr :quota_project, nil, ::String, nil
|
|
708
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
687
709
|
|
|
688
710
|
# @private
|
|
689
711
|
def initialize parent_config = nil
|
|
@@ -40,6 +40,9 @@ module Google
|
|
|
40
40
|
# * restore a database from an existing backup
|
|
41
41
|
#
|
|
42
42
|
class Client
|
|
43
|
+
# @private
|
|
44
|
+
DEFAULT_ENDPOINT_TEMPLATE = "spanner.$UNIVERSE_DOMAIN$"
|
|
45
|
+
|
|
43
46
|
include Paths
|
|
44
47
|
|
|
45
48
|
# @private
|
|
@@ -182,6 +185,15 @@ module Google
|
|
|
182
185
|
@config
|
|
183
186
|
end
|
|
184
187
|
|
|
188
|
+
##
|
|
189
|
+
# The effective universe domain
|
|
190
|
+
#
|
|
191
|
+
# @return [String]
|
|
192
|
+
#
|
|
193
|
+
def universe_domain
|
|
194
|
+
@database_admin_stub.universe_domain
|
|
195
|
+
end
|
|
196
|
+
|
|
185
197
|
##
|
|
186
198
|
# Create a new DatabaseAdmin REST client object.
|
|
187
199
|
#
|
|
@@ -209,8 +221,9 @@ module Google
|
|
|
209
221
|
credentials = @config.credentials
|
|
210
222
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
211
223
|
# but only if the default endpoint does not have a region prefix.
|
|
212
|
-
enable_self_signed_jwt = @config.endpoint
|
|
213
|
-
|
|
224
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
225
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
226
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
214
227
|
credentials ||= Credentials.default scope: @config.scope,
|
|
215
228
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
216
229
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -224,9 +237,15 @@ module Google
|
|
|
224
237
|
config.credentials = credentials
|
|
225
238
|
config.quota_project = @quota_project_id
|
|
226
239
|
config.endpoint = @config.endpoint
|
|
240
|
+
config.universe_domain = @config.universe_domain
|
|
227
241
|
end
|
|
228
242
|
|
|
229
|
-
@database_admin_stub = ::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Rest::ServiceStub.new
|
|
243
|
+
@database_admin_stub = ::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Rest::ServiceStub.new(
|
|
244
|
+
endpoint: @config.endpoint,
|
|
245
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
246
|
+
universe_domain: @config.universe_domain,
|
|
247
|
+
credentials: credentials
|
|
248
|
+
)
|
|
230
249
|
end
|
|
231
250
|
|
|
232
251
|
##
|
|
@@ -2366,9 +2385,9 @@ module Google
|
|
|
2366
2385
|
# end
|
|
2367
2386
|
#
|
|
2368
2387
|
# @!attribute [rw] endpoint
|
|
2369
|
-
#
|
|
2370
|
-
#
|
|
2371
|
-
# @return [::String]
|
|
2388
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
2389
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
2390
|
+
# @return [::String,nil]
|
|
2372
2391
|
# @!attribute [rw] credentials
|
|
2373
2392
|
# Credentials to send with calls. You may provide any of the following types:
|
|
2374
2393
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -2405,13 +2424,20 @@ module Google
|
|
|
2405
2424
|
# @!attribute [rw] quota_project
|
|
2406
2425
|
# A separate project against which to charge quota.
|
|
2407
2426
|
# @return [::String]
|
|
2427
|
+
# @!attribute [rw] universe_domain
|
|
2428
|
+
# The universe domain within which to make requests. This determines the
|
|
2429
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
2430
|
+
# universe (usually the default "googleapis.com" universe).
|
|
2431
|
+
# @return [::String,nil]
|
|
2408
2432
|
#
|
|
2409
2433
|
class Configuration
|
|
2410
2434
|
extend ::Gapic::Config
|
|
2411
2435
|
|
|
2436
|
+
# @private
|
|
2437
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
2412
2438
|
DEFAULT_ENDPOINT = "spanner.googleapis.com"
|
|
2413
2439
|
|
|
2414
|
-
config_attr :endpoint,
|
|
2440
|
+
config_attr :endpoint, nil, ::String, nil
|
|
2415
2441
|
config_attr :credentials, nil do |value|
|
|
2416
2442
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
2417
2443
|
allowed.any? { |klass| klass === value }
|
|
@@ -2423,6 +2449,7 @@ module Google
|
|
|
2423
2449
|
config_attr :metadata, nil, ::Hash, nil
|
|
2424
2450
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
2425
2451
|
config_attr :quota_project, nil, ::String, nil
|
|
2452
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
2426
2453
|
|
|
2427
2454
|
# @private
|
|
2428
2455
|
def initialize parent_config = nil
|
|
@@ -28,6 +28,9 @@ module Google
|
|
|
28
28
|
module Rest
|
|
29
29
|
# Service that implements Longrunning Operations API.
|
|
30
30
|
class Operations
|
|
31
|
+
# @private
|
|
32
|
+
DEFAULT_ENDPOINT_TEMPLATE = "spanner.$UNIVERSE_DOMAIN$"
|
|
33
|
+
|
|
31
34
|
# @private
|
|
32
35
|
attr_reader :operations_stub
|
|
33
36
|
|
|
@@ -62,6 +65,15 @@ module Google
|
|
|
62
65
|
@config
|
|
63
66
|
end
|
|
64
67
|
|
|
68
|
+
##
|
|
69
|
+
# The effective universe domain
|
|
70
|
+
#
|
|
71
|
+
# @return [String]
|
|
72
|
+
#
|
|
73
|
+
def universe_domain
|
|
74
|
+
@operations_stub.universe_domain
|
|
75
|
+
end
|
|
76
|
+
|
|
65
77
|
##
|
|
66
78
|
# Create a new Operations client object.
|
|
67
79
|
#
|
|
@@ -86,8 +98,10 @@ module Google
|
|
|
86
98
|
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
|
87
99
|
|
|
88
100
|
@operations_stub = OperationsServiceStub.new(
|
|
89
|
-
endpoint:
|
|
90
|
-
|
|
101
|
+
endpoint: @config.endpoint,
|
|
102
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
103
|
+
universe_domain: @config.universe_domain,
|
|
104
|
+
credentials: credentials
|
|
91
105
|
)
|
|
92
106
|
|
|
93
107
|
# Used by an LRO wrapper for some methods of this service
|
|
@@ -480,9 +494,9 @@ module Google
|
|
|
480
494
|
# end
|
|
481
495
|
#
|
|
482
496
|
# @!attribute [rw] endpoint
|
|
483
|
-
#
|
|
484
|
-
#
|
|
485
|
-
# @return [::String]
|
|
497
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
498
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
499
|
+
# @return [::String,nil]
|
|
486
500
|
# @!attribute [rw] credentials
|
|
487
501
|
# Credentials to send with calls. You may provide any of the following types:
|
|
488
502
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -519,13 +533,20 @@ module Google
|
|
|
519
533
|
# @!attribute [rw] quota_project
|
|
520
534
|
# A separate project against which to charge quota.
|
|
521
535
|
# @return [::String]
|
|
536
|
+
# @!attribute [rw] universe_domain
|
|
537
|
+
# The universe domain within which to make requests. This determines the
|
|
538
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
539
|
+
# universe (usually the default "googleapis.com" universe).
|
|
540
|
+
# @return [::String,nil]
|
|
522
541
|
#
|
|
523
542
|
class Configuration
|
|
524
543
|
extend ::Gapic::Config
|
|
525
544
|
|
|
545
|
+
# @private
|
|
546
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
526
547
|
DEFAULT_ENDPOINT = "spanner.googleapis.com"
|
|
527
548
|
|
|
528
|
-
config_attr :endpoint,
|
|
549
|
+
config_attr :endpoint, nil, ::String, nil
|
|
529
550
|
config_attr :credentials, nil do |value|
|
|
530
551
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
531
552
|
allowed.any? { |klass| klass === value }
|
|
@@ -537,6 +558,7 @@ module Google
|
|
|
537
558
|
config_attr :metadata, nil, ::Hash, nil
|
|
538
559
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
539
560
|
config_attr :quota_project, nil, ::String, nil
|
|
561
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
540
562
|
|
|
541
563
|
# @private
|
|
542
564
|
def initialize parent_config = nil
|
|
@@ -619,12 +641,15 @@ module Google
|
|
|
619
641
|
# Service stub contains baseline method implementations
|
|
620
642
|
# including transcoding, making the REST call, and deserialing the response.
|
|
621
643
|
class OperationsServiceStub
|
|
622
|
-
def initialize endpoint:, credentials:
|
|
644
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
|
623
645
|
# These require statements are intentionally placed here to initialize
|
|
624
646
|
# the REST modules only when it's required.
|
|
625
647
|
require "gapic/rest"
|
|
626
648
|
|
|
627
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
649
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
650
|
+
endpoint_template: endpoint_template,
|
|
651
|
+
universe_domain: universe_domain,
|
|
652
|
+
credentials: credentials
|
|
628
653
|
end
|
|
629
654
|
|
|
630
655
|
##
|
|
@@ -32,16 +32,28 @@ module Google
|
|
|
32
32
|
# including transcoding, making the REST call, and deserialing the response.
|
|
33
33
|
#
|
|
34
34
|
class ServiceStub
|
|
35
|
-
def initialize endpoint:, credentials:
|
|
35
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
|
36
36
|
# These require statements are intentionally placed here to initialize
|
|
37
37
|
# the REST modules only when it's required.
|
|
38
38
|
require "gapic/rest"
|
|
39
39
|
|
|
40
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
40
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
41
|
+
endpoint_template: endpoint_template,
|
|
42
|
+
universe_domain: universe_domain,
|
|
43
|
+
credentials: credentials,
|
|
41
44
|
numeric_enums: true,
|
|
42
45
|
raise_faraday_errors: false
|
|
43
46
|
end
|
|
44
47
|
|
|
48
|
+
##
|
|
49
|
+
# The effective universe domain
|
|
50
|
+
#
|
|
51
|
+
# @return [String]
|
|
52
|
+
#
|
|
53
|
+
def universe_domain
|
|
54
|
+
@client_stub.universe_domain
|
|
55
|
+
end
|
|
56
|
+
|
|
45
57
|
##
|
|
46
58
|
# Baseline implementation for the list_databases REST call
|
|
47
59
|
#
|
|
@@ -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-spanner-admin-database-v1
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.16.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
|
|
@@ -238,7 +238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
238
238
|
- !ruby/object:Gem::Version
|
|
239
239
|
version: '0'
|
|
240
240
|
requirements: []
|
|
241
|
-
rubygems_version: 3.
|
|
241
|
+
rubygems_version: 3.5.3
|
|
242
242
|
signing_key:
|
|
243
243
|
specification_version: 4
|
|
244
244
|
summary: Cloud Spanner is a managed, mission-critical, globally consistent and scalable
|