google-cloud-location 0.6.0 → 1.4.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/README.md +5 -5
- data/lib/google/cloud/location/locations/client.rb +94 -17
- data/lib/google/cloud/location/locations/rest/client.rb +75 -12
- data/lib/google/cloud/location/locations/rest/service_stub.rb +52 -15
- data/lib/google/cloud/location/locations_pb.rb +2 -24
- data/lib/google/cloud/location/version.rb +1 -1
- data/proto_docs/google/api/client.rb +231 -19
- data/proto_docs/google/api/resource.rb +7 -2
- data/proto_docs/google/protobuf/any.rb +2 -1
- metadata +8 -129
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: fe3d2e306a2ebffe063fadf22cb7d2fe040f959647187a076ce244b43dadf056
|
|
4
|
+
data.tar.gz: '08a00481d13e46203f0e0c253d8544f86b28a1a1b5106ec72ad85038a891270f'
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a425dc06fb410a1ce2eb521a7deb66f22fb38c659ab916e6bc7285442599d34a4e27093ccaad22cdc1e57632f1415443d6168b0860c876385af556488d35c05e
|
|
7
|
+
data.tar.gz: 31bb7cfe233b42a51a32b0f2da18f2c490bcc65b6147d87ff7d4ad80df8dbe3492b882f7bf7876a31ad599f01c539e8375c3f90b842617abd970aaf644bd58e5
|
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-location 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-location 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-location 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::Location::Locations::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/location"
|
|
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/location"
|
|
88
58
|
|
|
89
59
|
client = ::Google::Cloud::Location::Locations::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/location"
|
|
98
68
|
|
|
99
69
|
::Google::Cloud::Location::Locations::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::Location::Locations::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-location
|
|
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/location"
|
|
122
100
|
|
|
123
|
-
|
|
124
|
-
connect to the APIs. You will use the **JSON key file** to
|
|
125
|
-
connect to most services with google-cloud-location.
|
|
101
|
+
ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
|
|
126
102
|
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
need a Google Developers service account.
|
|
103
|
+
client = ::Google::Cloud::Location::Locations::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).
|
data/README.md
CHANGED
|
@@ -5,11 +5,11 @@ management calls. You generally do not need to invoke this gem directly.
|
|
|
5
5
|
|
|
6
6
|
## Supported Ruby Versions
|
|
7
7
|
|
|
8
|
-
This library is supported on Ruby 2.
|
|
8
|
+
This library is supported on Ruby 2.7+.
|
|
9
9
|
|
|
10
10
|
Google provides official support for Ruby versions that are actively supported
|
|
11
11
|
by Ruby Core—that is, Ruby versions that are either in normal maintenance or
|
|
12
|
-
in security maintenance, and not end of life.
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
12
|
+
in security maintenance, and not end of life. Older versions of Ruby _may_
|
|
13
|
+
still work, but are unsupported and not recommended. See
|
|
14
|
+
https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby
|
|
15
|
+
support schedule.
|
|
@@ -31,6 +31,12 @@ module Google
|
|
|
31
31
|
# {::Google::Cloud::Location::Location#metadata Location.metadata} field.
|
|
32
32
|
#
|
|
33
33
|
class Client
|
|
34
|
+
# @private
|
|
35
|
+
API_VERSION = ""
|
|
36
|
+
|
|
37
|
+
# @private
|
|
38
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloud.$UNIVERSE_DOMAIN$"
|
|
39
|
+
|
|
34
40
|
# @private
|
|
35
41
|
attr_reader :locations_stub
|
|
36
42
|
|
|
@@ -89,6 +95,15 @@ module Google
|
|
|
89
95
|
@config
|
|
90
96
|
end
|
|
91
97
|
|
|
98
|
+
##
|
|
99
|
+
# The effective universe domain
|
|
100
|
+
#
|
|
101
|
+
# @return [String]
|
|
102
|
+
#
|
|
103
|
+
def universe_domain
|
|
104
|
+
@locations_stub.universe_domain
|
|
105
|
+
end
|
|
106
|
+
|
|
92
107
|
##
|
|
93
108
|
# Create a new Locations client object.
|
|
94
109
|
#
|
|
@@ -122,8 +137,9 @@ module Google
|
|
|
122
137
|
credentials = @config.credentials
|
|
123
138
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
124
139
|
# but only if the default endpoint does not have a region prefix.
|
|
125
|
-
enable_self_signed_jwt = @config.endpoint
|
|
126
|
-
|
|
140
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
141
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
142
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
127
143
|
credentials ||= Credentials.default scope: @config.scope,
|
|
128
144
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
129
145
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -134,12 +150,34 @@ module Google
|
|
|
134
150
|
|
|
135
151
|
@locations_stub = ::Gapic::ServiceStub.new(
|
|
136
152
|
::Google::Cloud::Location::Locations::Stub,
|
|
137
|
-
credentials:
|
|
138
|
-
endpoint:
|
|
153
|
+
credentials: credentials,
|
|
154
|
+
endpoint: @config.endpoint,
|
|
155
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
156
|
+
universe_domain: @config.universe_domain,
|
|
139
157
|
channel_args: @config.channel_args,
|
|
140
158
|
interceptors: @config.interceptors,
|
|
141
|
-
channel_pool_config: @config.channel_pool
|
|
159
|
+
channel_pool_config: @config.channel_pool,
|
|
160
|
+
logger: @config.logger
|
|
142
161
|
)
|
|
162
|
+
|
|
163
|
+
@locations_stub.stub_logger&.info do |entry|
|
|
164
|
+
entry.set_system_name
|
|
165
|
+
entry.set_service
|
|
166
|
+
entry.message = "Created client for #{entry.service}"
|
|
167
|
+
entry.set_credentials_fields credentials
|
|
168
|
+
entry.set "customEndpoint", @config.endpoint if @config.endpoint
|
|
169
|
+
entry.set "defaultTimeout", @config.timeout if @config.timeout
|
|
170
|
+
entry.set "quotaProject", @quota_project_id if @quota_project_id
|
|
171
|
+
end
|
|
172
|
+
end
|
|
173
|
+
|
|
174
|
+
##
|
|
175
|
+
# The logger used for request/response debug logging.
|
|
176
|
+
#
|
|
177
|
+
# @return [Logger]
|
|
178
|
+
#
|
|
179
|
+
def logger
|
|
180
|
+
@locations_stub.logger
|
|
143
181
|
end
|
|
144
182
|
|
|
145
183
|
# Service calls
|
|
@@ -209,10 +247,11 @@ module Google
|
|
|
209
247
|
# Customize the options with defaults
|
|
210
248
|
metadata = @config.rpcs.list_locations.metadata.to_h
|
|
211
249
|
|
|
212
|
-
# Set x-goog-api-client
|
|
250
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
|
213
251
|
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
214
252
|
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
215
253
|
gapic_version: ::Google::Cloud::Location::VERSION
|
|
254
|
+
metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
|
216
255
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
217
256
|
|
|
218
257
|
header_params = {}
|
|
@@ -234,7 +273,7 @@ module Google
|
|
|
234
273
|
@locations_stub.call_rpc :list_locations, request, options: options do |response, operation|
|
|
235
274
|
response = ::Gapic::PagedEnumerable.new @locations_stub, :list_locations, request, response, operation, options
|
|
236
275
|
yield response, operation if block_given?
|
|
237
|
-
|
|
276
|
+
throw :response, response
|
|
238
277
|
end
|
|
239
278
|
rescue ::GRPC::BadStatus => e
|
|
240
279
|
raise ::Google::Cloud::Error.from_error(e)
|
|
@@ -295,10 +334,11 @@ module Google
|
|
|
295
334
|
# Customize the options with defaults
|
|
296
335
|
metadata = @config.rpcs.get_location.metadata.to_h
|
|
297
336
|
|
|
298
|
-
# Set x-goog-api-client
|
|
337
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
|
299
338
|
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
300
339
|
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
301
340
|
gapic_version: ::Google::Cloud::Location::VERSION
|
|
341
|
+
metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
|
302
342
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
303
343
|
|
|
304
344
|
header_params = {}
|
|
@@ -319,7 +359,6 @@ module Google
|
|
|
319
359
|
|
|
320
360
|
@locations_stub.call_rpc :get_location, request, options: options do |response, operation|
|
|
321
361
|
yield response, operation if block_given?
|
|
322
|
-
return response
|
|
323
362
|
end
|
|
324
363
|
rescue ::GRPC::BadStatus => e
|
|
325
364
|
raise ::Google::Cloud::Error.from_error(e)
|
|
@@ -355,13 +394,11 @@ module Google
|
|
|
355
394
|
# end
|
|
356
395
|
#
|
|
357
396
|
# @!attribute [rw] endpoint
|
|
358
|
-
#
|
|
359
|
-
#
|
|
360
|
-
# @return [::String]
|
|
397
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
398
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
399
|
+
# @return [::String,nil]
|
|
361
400
|
# @!attribute [rw] credentials
|
|
362
401
|
# Credentials to send with calls. You may provide any of the following types:
|
|
363
|
-
# * (`String`) The path to a service account key file in JSON format
|
|
364
|
-
# * (`Hash`) A service account key as a Hash
|
|
365
402
|
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
|
366
403
|
# (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
|
|
367
404
|
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
|
@@ -369,6 +406,32 @@ module Google
|
|
|
369
406
|
# * (`GRPC::Core::Channel`) a gRPC channel with included credentials
|
|
370
407
|
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
|
|
371
408
|
# * (`nil`) indicating no credentials
|
|
409
|
+
#
|
|
410
|
+
# @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
|
|
411
|
+
# is deprecated. Providing an unvalidated credential configuration to
|
|
412
|
+
# Google APIs can compromise the security of your systems and data.
|
|
413
|
+
#
|
|
414
|
+
# @example
|
|
415
|
+
#
|
|
416
|
+
# # The recommended way to provide credentials is to use the `make_creds` method
|
|
417
|
+
# # on the appropriate credentials class for your environment.
|
|
418
|
+
#
|
|
419
|
+
# require "googleauth"
|
|
420
|
+
#
|
|
421
|
+
# credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
|
|
422
|
+
# json_key_io: ::File.open("/path/to/keyfile.json")
|
|
423
|
+
# )
|
|
424
|
+
#
|
|
425
|
+
# client = ::Google::Cloud::Location::Locations::Client.new do |config|
|
|
426
|
+
# config.credentials = credentials
|
|
427
|
+
# end
|
|
428
|
+
#
|
|
429
|
+
# @note Warning: If you accept a credential configuration (JSON file or Hash) from an
|
|
430
|
+
# external source for authentication to Google Cloud, you must validate it before
|
|
431
|
+
# providing it to a Google API client library. Providing an unvalidated credential
|
|
432
|
+
# configuration to Google APIs can compromise the security of your systems and data.
|
|
433
|
+
# For more information, refer to [Validate credential configurations from external
|
|
434
|
+
# sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
|
|
372
435
|
# @return [::Object]
|
|
373
436
|
# @!attribute [rw] scope
|
|
374
437
|
# The OAuth scopes
|
|
@@ -403,16 +466,28 @@ module Google
|
|
|
403
466
|
# @!attribute [rw] quota_project
|
|
404
467
|
# A separate project against which to charge quota.
|
|
405
468
|
# @return [::String]
|
|
469
|
+
# @!attribute [rw] universe_domain
|
|
470
|
+
# The universe domain within which to make requests. This determines the
|
|
471
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
472
|
+
# universe (usually the default "googleapis.com" universe).
|
|
473
|
+
# @return [::String,nil]
|
|
474
|
+
# @!attribute [rw] logger
|
|
475
|
+
# A custom logger to use for request/response debug logging, or the value
|
|
476
|
+
# `:default` (the default) to construct a default logger, or `nil` to
|
|
477
|
+
# explicitly disable logging.
|
|
478
|
+
# @return [::Logger,:default,nil]
|
|
406
479
|
#
|
|
407
480
|
class Configuration
|
|
408
481
|
extend ::Gapic::Config
|
|
409
482
|
|
|
483
|
+
# @private
|
|
484
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
410
485
|
DEFAULT_ENDPOINT = "cloud.googleapis.com"
|
|
411
486
|
|
|
412
|
-
config_attr :endpoint,
|
|
487
|
+
config_attr :endpoint, nil, ::String, nil
|
|
413
488
|
config_attr :credentials, nil do |value|
|
|
414
|
-
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
415
|
-
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
489
|
+
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
|
|
490
|
+
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC::Core::Channel
|
|
416
491
|
allowed.any? { |klass| klass === value }
|
|
417
492
|
end
|
|
418
493
|
config_attr :scope, nil, ::String, ::Array, nil
|
|
@@ -424,6 +499,8 @@ module Google
|
|
|
424
499
|
config_attr :metadata, nil, ::Hash, nil
|
|
425
500
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
426
501
|
config_attr :quota_project, nil, ::String, nil
|
|
502
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
503
|
+
config_attr :logger, :default, ::Logger, nil, :default
|
|
427
504
|
|
|
428
505
|
# @private
|
|
429
506
|
def initialize parent_config = nil
|