google-cloud-service_directory-v1 0.9.0 → 0.10.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/service_directory/v1/lookup_service/client.rb +32 -8
- data/lib/google/cloud/service_directory/v1/lookup_service/rest/client.rb +34 -7
- data/lib/google/cloud/service_directory/v1/lookup_service/rest/service_stub.rb +14 -2
- data/lib/google/cloud/service_directory/v1/registration_service/client.rb +32 -8
- data/lib/google/cloud/service_directory/v1/registration_service/rest/client.rb +34 -7
- data/lib/google/cloud/service_directory/v1/registration_service/rest/service_stub.rb +14 -2
- data/lib/google/cloud/service_directory/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: 26a77adbf78b39f72358f943b5e20e4889a4e31f897204df3d678e5033f41710
|
|
4
|
+
data.tar.gz: d124a1bb9c7da43a71be3f09c0368611091778be814f60a37155a9c26fe37107
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: acd060c8a0eb9ca855f3e1dbf775db3413abb6252d47b03adf3a0f72d73147f2cae26a4a05e343d87bbc9e467ed2fd1ffe45c1757d547e327610da747a1bb0c4
|
|
7
|
+
data.tar.gz: 8b961270e7cb154559a5d47aa50b73aff044cbb52a475a26c226f4cdb8409ea1b281290dd67b3d25e616db2e688195b0af165880654bdb3c57d92e1d2b883098
|
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-service_directory-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-service_directory-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-service_directory-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::ServiceDirectory::V1::LookupService::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/service_directory/v1"
|
|
77
|
-
|
|
78
|
-
ENV["SERVICE_DIRECTORY_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/service_directory/v1"
|
|
90
58
|
|
|
91
59
|
client = ::Google::Cloud::ServiceDirectory::V1::LookupService::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/service_directory/v1"
|
|
100
68
|
|
|
101
69
|
::Google::Cloud::ServiceDirectory::V1::LookupService::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::ServiceDirectory::V1::LookupService::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-service_directory-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/service_directory/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-service_directory-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::ServiceDirectory::V1::LookupService::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).
|
|
@@ -31,6 +31,9 @@ module Google
|
|
|
31
31
|
# Service Directory API for looking up service data at runtime.
|
|
32
32
|
#
|
|
33
33
|
class Client
|
|
34
|
+
# @private
|
|
35
|
+
DEFAULT_ENDPOINT_TEMPLATE = "servicedirectory.$UNIVERSE_DOMAIN$"
|
|
36
|
+
|
|
34
37
|
include Paths
|
|
35
38
|
|
|
36
39
|
# @private
|
|
@@ -96,6 +99,15 @@ module Google
|
|
|
96
99
|
@config
|
|
97
100
|
end
|
|
98
101
|
|
|
102
|
+
##
|
|
103
|
+
# The effective universe domain
|
|
104
|
+
#
|
|
105
|
+
# @return [String]
|
|
106
|
+
#
|
|
107
|
+
def universe_domain
|
|
108
|
+
@lookup_service_stub.universe_domain
|
|
109
|
+
end
|
|
110
|
+
|
|
99
111
|
##
|
|
100
112
|
# Create a new LookupService client object.
|
|
101
113
|
#
|
|
@@ -129,8 +141,9 @@ module Google
|
|
|
129
141
|
credentials = @config.credentials
|
|
130
142
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
131
143
|
# but only if the default endpoint does not have a region prefix.
|
|
132
|
-
enable_self_signed_jwt = @config.endpoint
|
|
133
|
-
|
|
144
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
145
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
146
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
134
147
|
credentials ||= Credentials.default scope: @config.scope,
|
|
135
148
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
136
149
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -143,12 +156,15 @@ module Google
|
|
|
143
156
|
config.credentials = credentials
|
|
144
157
|
config.quota_project = @quota_project_id
|
|
145
158
|
config.endpoint = @config.endpoint
|
|
159
|
+
config.universe_domain = @config.universe_domain
|
|
146
160
|
end
|
|
147
161
|
|
|
148
162
|
@lookup_service_stub = ::Gapic::ServiceStub.new(
|
|
149
163
|
::Google::Cloud::ServiceDirectory::V1::LookupService::Stub,
|
|
150
|
-
credentials:
|
|
151
|
-
endpoint:
|
|
164
|
+
credentials: credentials,
|
|
165
|
+
endpoint: @config.endpoint,
|
|
166
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
167
|
+
universe_domain: @config.universe_domain,
|
|
152
168
|
channel_args: @config.channel_args,
|
|
153
169
|
interceptors: @config.interceptors,
|
|
154
170
|
channel_pool_config: @config.channel_pool
|
|
@@ -322,9 +338,9 @@ module Google
|
|
|
322
338
|
# end
|
|
323
339
|
#
|
|
324
340
|
# @!attribute [rw] endpoint
|
|
325
|
-
#
|
|
326
|
-
#
|
|
327
|
-
# @return [::String]
|
|
341
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
342
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
343
|
+
# @return [::String,nil]
|
|
328
344
|
# @!attribute [rw] credentials
|
|
329
345
|
# Credentials to send with calls. You may provide any of the following types:
|
|
330
346
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -370,13 +386,20 @@ module Google
|
|
|
370
386
|
# @!attribute [rw] quota_project
|
|
371
387
|
# A separate project against which to charge quota.
|
|
372
388
|
# @return [::String]
|
|
389
|
+
# @!attribute [rw] universe_domain
|
|
390
|
+
# The universe domain within which to make requests. This determines the
|
|
391
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
392
|
+
# universe (usually the default "googleapis.com" universe).
|
|
393
|
+
# @return [::String,nil]
|
|
373
394
|
#
|
|
374
395
|
class Configuration
|
|
375
396
|
extend ::Gapic::Config
|
|
376
397
|
|
|
398
|
+
# @private
|
|
399
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
377
400
|
DEFAULT_ENDPOINT = "servicedirectory.googleapis.com"
|
|
378
401
|
|
|
379
|
-
config_attr :endpoint,
|
|
402
|
+
config_attr :endpoint, nil, ::String, nil
|
|
380
403
|
config_attr :credentials, nil do |value|
|
|
381
404
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
382
405
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -391,6 +414,7 @@ module Google
|
|
|
391
414
|
config_attr :metadata, nil, ::Hash, nil
|
|
392
415
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
393
416
|
config_attr :quota_project, nil, ::String, nil
|
|
417
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
394
418
|
|
|
395
419
|
# @private
|
|
396
420
|
def initialize parent_config = nil
|
|
@@ -33,6 +33,9 @@ module Google
|
|
|
33
33
|
# Service Directory API for looking up service data at runtime.
|
|
34
34
|
#
|
|
35
35
|
class Client
|
|
36
|
+
# @private
|
|
37
|
+
DEFAULT_ENDPOINT_TEMPLATE = "servicedirectory.$UNIVERSE_DOMAIN$"
|
|
38
|
+
|
|
36
39
|
include Paths
|
|
37
40
|
|
|
38
41
|
# @private
|
|
@@ -98,6 +101,15 @@ module Google
|
|
|
98
101
|
@config
|
|
99
102
|
end
|
|
100
103
|
|
|
104
|
+
##
|
|
105
|
+
# The effective universe domain
|
|
106
|
+
#
|
|
107
|
+
# @return [String]
|
|
108
|
+
#
|
|
109
|
+
def universe_domain
|
|
110
|
+
@lookup_service_stub.universe_domain
|
|
111
|
+
end
|
|
112
|
+
|
|
101
113
|
##
|
|
102
114
|
# Create a new LookupService REST client object.
|
|
103
115
|
#
|
|
@@ -125,8 +137,9 @@ module Google
|
|
|
125
137
|
credentials = @config.credentials
|
|
126
138
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
127
139
|
# but only if the default endpoint does not have a region prefix.
|
|
128
|
-
enable_self_signed_jwt = @config.endpoint
|
|
129
|
-
|
|
140
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
141
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
142
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
130
143
|
credentials ||= Credentials.default scope: @config.scope,
|
|
131
144
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
132
145
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -140,10 +153,16 @@ module Google
|
|
|
140
153
|
config.credentials = credentials
|
|
141
154
|
config.quota_project = @quota_project_id
|
|
142
155
|
config.endpoint = @config.endpoint
|
|
156
|
+
config.universe_domain = @config.universe_domain
|
|
143
157
|
config.bindings_override = @config.bindings_override
|
|
144
158
|
end
|
|
145
159
|
|
|
146
|
-
@lookup_service_stub = ::Google::Cloud::ServiceDirectory::V1::LookupService::Rest::ServiceStub.new
|
|
160
|
+
@lookup_service_stub = ::Google::Cloud::ServiceDirectory::V1::LookupService::Rest::ServiceStub.new(
|
|
161
|
+
endpoint: @config.endpoint,
|
|
162
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
163
|
+
universe_domain: @config.universe_domain,
|
|
164
|
+
credentials: credentials
|
|
165
|
+
)
|
|
147
166
|
end
|
|
148
167
|
|
|
149
168
|
##
|
|
@@ -306,9 +325,9 @@ module Google
|
|
|
306
325
|
# end
|
|
307
326
|
#
|
|
308
327
|
# @!attribute [rw] endpoint
|
|
309
|
-
#
|
|
310
|
-
#
|
|
311
|
-
# @return [::String]
|
|
328
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
329
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
330
|
+
# @return [::String,nil]
|
|
312
331
|
# @!attribute [rw] credentials
|
|
313
332
|
# Credentials to send with calls. You may provide any of the following types:
|
|
314
333
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -345,13 +364,20 @@ module Google
|
|
|
345
364
|
# @!attribute [rw] quota_project
|
|
346
365
|
# A separate project against which to charge quota.
|
|
347
366
|
# @return [::String]
|
|
367
|
+
# @!attribute [rw] universe_domain
|
|
368
|
+
# The universe domain within which to make requests. This determines the
|
|
369
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
370
|
+
# universe (usually the default "googleapis.com" universe).
|
|
371
|
+
# @return [::String,nil]
|
|
348
372
|
#
|
|
349
373
|
class Configuration
|
|
350
374
|
extend ::Gapic::Config
|
|
351
375
|
|
|
376
|
+
# @private
|
|
377
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
352
378
|
DEFAULT_ENDPOINT = "servicedirectory.googleapis.com"
|
|
353
379
|
|
|
354
|
-
config_attr :endpoint,
|
|
380
|
+
config_attr :endpoint, nil, ::String, nil
|
|
355
381
|
config_attr :credentials, nil do |value|
|
|
356
382
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
357
383
|
allowed.any? { |klass| klass === value }
|
|
@@ -363,6 +389,7 @@ module Google
|
|
|
363
389
|
config_attr :metadata, nil, ::Hash, nil
|
|
364
390
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
365
391
|
config_attr :quota_project, nil, ::String, nil
|
|
392
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
366
393
|
|
|
367
394
|
# @private
|
|
368
395
|
# Overrides for http bindings for the RPCs of this service
|
|
@@ -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 resolve_service REST call
|
|
45
57
|
#
|
|
@@ -45,6 +45,9 @@ module Google
|
|
|
45
45
|
# `projects/*/locations/*/namespaces/*/services/*/endpoints/*`.
|
|
46
46
|
#
|
|
47
47
|
class Client
|
|
48
|
+
# @private
|
|
49
|
+
DEFAULT_ENDPOINT_TEMPLATE = "servicedirectory.$UNIVERSE_DOMAIN$"
|
|
50
|
+
|
|
48
51
|
include Paths
|
|
49
52
|
|
|
50
53
|
# @private
|
|
@@ -110,6 +113,15 @@ module Google
|
|
|
110
113
|
@config
|
|
111
114
|
end
|
|
112
115
|
|
|
116
|
+
##
|
|
117
|
+
# The effective universe domain
|
|
118
|
+
#
|
|
119
|
+
# @return [String]
|
|
120
|
+
#
|
|
121
|
+
def universe_domain
|
|
122
|
+
@registration_service_stub.universe_domain
|
|
123
|
+
end
|
|
124
|
+
|
|
113
125
|
##
|
|
114
126
|
# Create a new RegistrationService client object.
|
|
115
127
|
#
|
|
@@ -143,8 +155,9 @@ module Google
|
|
|
143
155
|
credentials = @config.credentials
|
|
144
156
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
145
157
|
# but only if the default endpoint does not have a region prefix.
|
|
146
|
-
enable_self_signed_jwt = @config.endpoint
|
|
147
|
-
|
|
158
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
159
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
160
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
148
161
|
credentials ||= Credentials.default scope: @config.scope,
|
|
149
162
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
150
163
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -157,12 +170,15 @@ module Google
|
|
|
157
170
|
config.credentials = credentials
|
|
158
171
|
config.quota_project = @quota_project_id
|
|
159
172
|
config.endpoint = @config.endpoint
|
|
173
|
+
config.universe_domain = @config.universe_domain
|
|
160
174
|
end
|
|
161
175
|
|
|
162
176
|
@registration_service_stub = ::Gapic::ServiceStub.new(
|
|
163
177
|
::Google::Cloud::ServiceDirectory::V1::RegistrationService::Stub,
|
|
164
|
-
credentials:
|
|
165
|
-
endpoint:
|
|
178
|
+
credentials: credentials,
|
|
179
|
+
endpoint: @config.endpoint,
|
|
180
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
181
|
+
universe_domain: @config.universe_domain,
|
|
166
182
|
channel_args: @config.channel_args,
|
|
167
183
|
interceptors: @config.interceptors,
|
|
168
184
|
channel_pool_config: @config.channel_pool
|
|
@@ -1959,9 +1975,9 @@ module Google
|
|
|
1959
1975
|
# end
|
|
1960
1976
|
#
|
|
1961
1977
|
# @!attribute [rw] endpoint
|
|
1962
|
-
#
|
|
1963
|
-
#
|
|
1964
|
-
# @return [::String]
|
|
1978
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
1979
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
1980
|
+
# @return [::String,nil]
|
|
1965
1981
|
# @!attribute [rw] credentials
|
|
1966
1982
|
# Credentials to send with calls. You may provide any of the following types:
|
|
1967
1983
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -2007,13 +2023,20 @@ module Google
|
|
|
2007
2023
|
# @!attribute [rw] quota_project
|
|
2008
2024
|
# A separate project against which to charge quota.
|
|
2009
2025
|
# @return [::String]
|
|
2026
|
+
# @!attribute [rw] universe_domain
|
|
2027
|
+
# The universe domain within which to make requests. This determines the
|
|
2028
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
2029
|
+
# universe (usually the default "googleapis.com" universe).
|
|
2030
|
+
# @return [::String,nil]
|
|
2010
2031
|
#
|
|
2011
2032
|
class Configuration
|
|
2012
2033
|
extend ::Gapic::Config
|
|
2013
2034
|
|
|
2035
|
+
# @private
|
|
2036
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
2014
2037
|
DEFAULT_ENDPOINT = "servicedirectory.googleapis.com"
|
|
2015
2038
|
|
|
2016
|
-
config_attr :endpoint,
|
|
2039
|
+
config_attr :endpoint, nil, ::String, nil
|
|
2017
2040
|
config_attr :credentials, nil do |value|
|
|
2018
2041
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
2019
2042
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -2028,6 +2051,7 @@ module Google
|
|
|
2028
2051
|
config_attr :metadata, nil, ::Hash, nil
|
|
2029
2052
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
2030
2053
|
config_attr :quota_project, nil, ::String, nil
|
|
2054
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
2031
2055
|
|
|
2032
2056
|
# @private
|
|
2033
2057
|
def initialize parent_config = nil
|
|
@@ -47,6 +47,9 @@ module Google
|
|
|
47
47
|
# `projects/*/locations/*/namespaces/*/services/*/endpoints/*`.
|
|
48
48
|
#
|
|
49
49
|
class Client
|
|
50
|
+
# @private
|
|
51
|
+
DEFAULT_ENDPOINT_TEMPLATE = "servicedirectory.$UNIVERSE_DOMAIN$"
|
|
52
|
+
|
|
50
53
|
include Paths
|
|
51
54
|
|
|
52
55
|
# @private
|
|
@@ -112,6 +115,15 @@ module Google
|
|
|
112
115
|
@config
|
|
113
116
|
end
|
|
114
117
|
|
|
118
|
+
##
|
|
119
|
+
# The effective universe domain
|
|
120
|
+
#
|
|
121
|
+
# @return [String]
|
|
122
|
+
#
|
|
123
|
+
def universe_domain
|
|
124
|
+
@registration_service_stub.universe_domain
|
|
125
|
+
end
|
|
126
|
+
|
|
115
127
|
##
|
|
116
128
|
# Create a new RegistrationService REST client object.
|
|
117
129
|
#
|
|
@@ -139,8 +151,9 @@ module Google
|
|
|
139
151
|
credentials = @config.credentials
|
|
140
152
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
141
153
|
# but only if the default endpoint does not have a region prefix.
|
|
142
|
-
enable_self_signed_jwt = @config.endpoint
|
|
143
|
-
|
|
154
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
155
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
156
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
144
157
|
credentials ||= Credentials.default scope: @config.scope,
|
|
145
158
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
146
159
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -154,10 +167,16 @@ module Google
|
|
|
154
167
|
config.credentials = credentials
|
|
155
168
|
config.quota_project = @quota_project_id
|
|
156
169
|
config.endpoint = @config.endpoint
|
|
170
|
+
config.universe_domain = @config.universe_domain
|
|
157
171
|
config.bindings_override = @config.bindings_override
|
|
158
172
|
end
|
|
159
173
|
|
|
160
|
-
@registration_service_stub = ::Google::Cloud::ServiceDirectory::V1::RegistrationService::Rest::ServiceStub.new
|
|
174
|
+
@registration_service_stub = ::Google::Cloud::ServiceDirectory::V1::RegistrationService::Rest::ServiceStub.new(
|
|
175
|
+
endpoint: @config.endpoint,
|
|
176
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
177
|
+
universe_domain: @config.universe_domain,
|
|
178
|
+
credentials: credentials
|
|
179
|
+
)
|
|
161
180
|
end
|
|
162
181
|
|
|
163
182
|
##
|
|
@@ -1824,9 +1843,9 @@ module Google
|
|
|
1824
1843
|
# end
|
|
1825
1844
|
#
|
|
1826
1845
|
# @!attribute [rw] endpoint
|
|
1827
|
-
#
|
|
1828
|
-
#
|
|
1829
|
-
# @return [::String]
|
|
1846
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
1847
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
1848
|
+
# @return [::String,nil]
|
|
1830
1849
|
# @!attribute [rw] credentials
|
|
1831
1850
|
# Credentials to send with calls. You may provide any of the following types:
|
|
1832
1851
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -1863,13 +1882,20 @@ module Google
|
|
|
1863
1882
|
# @!attribute [rw] quota_project
|
|
1864
1883
|
# A separate project against which to charge quota.
|
|
1865
1884
|
# @return [::String]
|
|
1885
|
+
# @!attribute [rw] universe_domain
|
|
1886
|
+
# The universe domain within which to make requests. This determines the
|
|
1887
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
1888
|
+
# universe (usually the default "googleapis.com" universe).
|
|
1889
|
+
# @return [::String,nil]
|
|
1866
1890
|
#
|
|
1867
1891
|
class Configuration
|
|
1868
1892
|
extend ::Gapic::Config
|
|
1869
1893
|
|
|
1894
|
+
# @private
|
|
1895
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
1870
1896
|
DEFAULT_ENDPOINT = "servicedirectory.googleapis.com"
|
|
1871
1897
|
|
|
1872
|
-
config_attr :endpoint,
|
|
1898
|
+
config_attr :endpoint, nil, ::String, nil
|
|
1873
1899
|
config_attr :credentials, nil do |value|
|
|
1874
1900
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
1875
1901
|
allowed.any? { |klass| klass === value }
|
|
@@ -1881,6 +1907,7 @@ module Google
|
|
|
1881
1907
|
config_attr :metadata, nil, ::Hash, nil
|
|
1882
1908
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
1883
1909
|
config_attr :quota_project, nil, ::String, nil
|
|
1910
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
1884
1911
|
|
|
1885
1912
|
# @private
|
|
1886
1913
|
# Overrides for http bindings for the RPCs of this service
|
|
@@ -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 create_namespace 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
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-service_directory-v1
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.10.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
|
|
@@ -266,7 +266,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
266
266
|
- !ruby/object:Gem::Version
|
|
267
267
|
version: '0'
|
|
268
268
|
requirements: []
|
|
269
|
-
rubygems_version: 3.
|
|
269
|
+
rubygems_version: 3.5.3
|
|
270
270
|
signing_key:
|
|
271
271
|
specification_version: 4
|
|
272
272
|
summary: Service Directory is a platform for discovering, publishing, and connecting
|