google-cloud-service_directory-v1 0.8.1 → 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 +42 -9
- data/lib/google/cloud/service_directory/v1/lookup_service/rest/client.rb +50 -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 +42 -9
- data/lib/google/cloud/service_directory/v1/registration_service/rest/client.rb +334 -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
- data/proto_docs/google/api/field_behavior.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,14 +156,18 @@ 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
|
-
interceptors: @config.interceptors
|
169
|
+
interceptors: @config.interceptors,
|
170
|
+
channel_pool_config: @config.channel_pool
|
154
171
|
)
|
155
172
|
end
|
156
173
|
|
@@ -321,9 +338,9 @@ module Google
|
|
321
338
|
# end
|
322
339
|
#
|
323
340
|
# @!attribute [rw] endpoint
|
324
|
-
#
|
325
|
-
#
|
326
|
-
# @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]
|
327
344
|
# @!attribute [rw] credentials
|
328
345
|
# Credentials to send with calls. You may provide any of the following types:
|
329
346
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -369,13 +386,20 @@ module Google
|
|
369
386
|
# @!attribute [rw] quota_project
|
370
387
|
# A separate project against which to charge quota.
|
371
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]
|
372
394
|
#
|
373
395
|
class Configuration
|
374
396
|
extend ::Gapic::Config
|
375
397
|
|
398
|
+
# @private
|
399
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
376
400
|
DEFAULT_ENDPOINT = "servicedirectory.googleapis.com"
|
377
401
|
|
378
|
-
config_attr :endpoint,
|
402
|
+
config_attr :endpoint, nil, ::String, nil
|
379
403
|
config_attr :credentials, nil do |value|
|
380
404
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
381
405
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
@@ -390,6 +414,7 @@ module Google
|
|
390
414
|
config_attr :metadata, nil, ::Hash, nil
|
391
415
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
392
416
|
config_attr :quota_project, nil, ::String, nil
|
417
|
+
config_attr :universe_domain, nil, ::String, nil
|
393
418
|
|
394
419
|
# @private
|
395
420
|
def initialize parent_config = nil
|
@@ -410,6 +435,14 @@ module Google
|
|
410
435
|
end
|
411
436
|
end
|
412
437
|
|
438
|
+
##
|
439
|
+
# Configuration for the channel pool
|
440
|
+
# @return [::Gapic::ServiceStub::ChannelPool::Configuration]
|
441
|
+
#
|
442
|
+
def channel_pool
|
443
|
+
@channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
|
444
|
+
end
|
445
|
+
|
413
446
|
##
|
414
447
|
# Configuration RPC class for the LookupService API.
|
415
448
|
#
|
@@ -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
|
##
|
@@ -225,6 +244,22 @@ module Google
|
|
225
244
|
# @return [::Google::Cloud::ServiceDirectory::V1::ResolveServiceResponse]
|
226
245
|
#
|
227
246
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
247
|
+
#
|
248
|
+
# @example Basic example
|
249
|
+
# require "google/cloud/service_directory/v1"
|
250
|
+
#
|
251
|
+
# # Create a client object. The client can be reused for multiple calls.
|
252
|
+
# client = Google::Cloud::ServiceDirectory::V1::LookupService::Rest::Client.new
|
253
|
+
#
|
254
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
255
|
+
# request = Google::Cloud::ServiceDirectory::V1::ResolveServiceRequest.new
|
256
|
+
#
|
257
|
+
# # Call the resolve_service method.
|
258
|
+
# result = client.resolve_service request
|
259
|
+
#
|
260
|
+
# # The returned object is of type Google::Cloud::ServiceDirectory::V1::ResolveServiceResponse.
|
261
|
+
# p result
|
262
|
+
#
|
228
263
|
def resolve_service request, options = nil
|
229
264
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
230
265
|
|
@@ -290,9 +325,9 @@ module Google
|
|
290
325
|
# end
|
291
326
|
#
|
292
327
|
# @!attribute [rw] endpoint
|
293
|
-
#
|
294
|
-
#
|
295
|
-
# @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]
|
296
331
|
# @!attribute [rw] credentials
|
297
332
|
# Credentials to send with calls. You may provide any of the following types:
|
298
333
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -329,13 +364,20 @@ module Google
|
|
329
364
|
# @!attribute [rw] quota_project
|
330
365
|
# A separate project against which to charge quota.
|
331
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]
|
332
372
|
#
|
333
373
|
class Configuration
|
334
374
|
extend ::Gapic::Config
|
335
375
|
|
376
|
+
# @private
|
377
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
336
378
|
DEFAULT_ENDPOINT = "servicedirectory.googleapis.com"
|
337
379
|
|
338
|
-
config_attr :endpoint,
|
380
|
+
config_attr :endpoint, nil, ::String, nil
|
339
381
|
config_attr :credentials, nil do |value|
|
340
382
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
341
383
|
allowed.any? { |klass| klass === value }
|
@@ -347,6 +389,7 @@ module Google
|
|
347
389
|
config_attr :metadata, nil, ::Hash, nil
|
348
390
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
349
391
|
config_attr :quota_project, nil, ::String, nil
|
392
|
+
config_attr :universe_domain, nil, ::String, nil
|
350
393
|
|
351
394
|
# @private
|
352
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,14 +170,18 @@ 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
|
-
interceptors: @config.interceptors
|
183
|
+
interceptors: @config.interceptors,
|
184
|
+
channel_pool_config: @config.channel_pool
|
168
185
|
)
|
169
186
|
end
|
170
187
|
|
@@ -1958,9 +1975,9 @@ module Google
|
|
1958
1975
|
# end
|
1959
1976
|
#
|
1960
1977
|
# @!attribute [rw] endpoint
|
1961
|
-
#
|
1962
|
-
#
|
1963
|
-
# @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]
|
1964
1981
|
# @!attribute [rw] credentials
|
1965
1982
|
# Credentials to send with calls. You may provide any of the following types:
|
1966
1983
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -2006,13 +2023,20 @@ module Google
|
|
2006
2023
|
# @!attribute [rw] quota_project
|
2007
2024
|
# A separate project against which to charge quota.
|
2008
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]
|
2009
2031
|
#
|
2010
2032
|
class Configuration
|
2011
2033
|
extend ::Gapic::Config
|
2012
2034
|
|
2035
|
+
# @private
|
2036
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
2013
2037
|
DEFAULT_ENDPOINT = "servicedirectory.googleapis.com"
|
2014
2038
|
|
2015
|
-
config_attr :endpoint,
|
2039
|
+
config_attr :endpoint, nil, ::String, nil
|
2016
2040
|
config_attr :credentials, nil do |value|
|
2017
2041
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
2018
2042
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
@@ -2027,6 +2051,7 @@ module Google
|
|
2027
2051
|
config_attr :metadata, nil, ::Hash, nil
|
2028
2052
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
2029
2053
|
config_attr :quota_project, nil, ::String, nil
|
2054
|
+
config_attr :universe_domain, nil, ::String, nil
|
2030
2055
|
|
2031
2056
|
# @private
|
2032
2057
|
def initialize parent_config = nil
|
@@ -2047,6 +2072,14 @@ module Google
|
|
2047
2072
|
end
|
2048
2073
|
end
|
2049
2074
|
|
2075
|
+
##
|
2076
|
+
# Configuration for the channel pool
|
2077
|
+
# @return [::Gapic::ServiceStub::ChannelPool::Configuration]
|
2078
|
+
#
|
2079
|
+
def channel_pool
|
2080
|
+
@channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
|
2081
|
+
end
|
2082
|
+
|
2050
2083
|
##
|
2051
2084
|
# Configuration RPC class for the RegistrationService API.
|
2052
2085
|
#
|
@@ -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
|
##
|
@@ -207,6 +226,22 @@ module Google
|
|
207
226
|
# @return [::Google::Cloud::ServiceDirectory::V1::Namespace]
|
208
227
|
#
|
209
228
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
229
|
+
#
|
230
|
+
# @example Basic example
|
231
|
+
# require "google/cloud/service_directory/v1"
|
232
|
+
#
|
233
|
+
# # Create a client object. The client can be reused for multiple calls.
|
234
|
+
# client = Google::Cloud::ServiceDirectory::V1::RegistrationService::Rest::Client.new
|
235
|
+
#
|
236
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
237
|
+
# request = Google::Cloud::ServiceDirectory::V1::CreateNamespaceRequest.new
|
238
|
+
#
|
239
|
+
# # Call the create_namespace method.
|
240
|
+
# result = client.create_namespace request
|
241
|
+
#
|
242
|
+
# # The returned object is of type Google::Cloud::ServiceDirectory::V1::Namespace.
|
243
|
+
# p result
|
244
|
+
#
|
210
245
|
def create_namespace request, options = nil
|
211
246
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
212
247
|
|
@@ -315,6 +350,26 @@ module Google
|
|
315
350
|
# @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::ServiceDirectory::V1::Namespace>]
|
316
351
|
#
|
317
352
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
353
|
+
#
|
354
|
+
# @example Basic example
|
355
|
+
# require "google/cloud/service_directory/v1"
|
356
|
+
#
|
357
|
+
# # Create a client object. The client can be reused for multiple calls.
|
358
|
+
# client = Google::Cloud::ServiceDirectory::V1::RegistrationService::Rest::Client.new
|
359
|
+
#
|
360
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
361
|
+
# request = Google::Cloud::ServiceDirectory::V1::ListNamespacesRequest.new
|
362
|
+
#
|
363
|
+
# # Call the list_namespaces method.
|
364
|
+
# result = client.list_namespaces request
|
365
|
+
#
|
366
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
367
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
368
|
+
# result.each do |item|
|
369
|
+
# # Each element is of type ::Google::Cloud::ServiceDirectory::V1::Namespace.
|
370
|
+
# p item
|
371
|
+
# end
|
372
|
+
#
|
318
373
|
def list_namespaces request, options = nil
|
319
374
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
320
375
|
|
@@ -378,6 +433,22 @@ module Google
|
|
378
433
|
# @return [::Google::Cloud::ServiceDirectory::V1::Namespace]
|
379
434
|
#
|
380
435
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
436
|
+
#
|
437
|
+
# @example Basic example
|
438
|
+
# require "google/cloud/service_directory/v1"
|
439
|
+
#
|
440
|
+
# # Create a client object. The client can be reused for multiple calls.
|
441
|
+
# client = Google::Cloud::ServiceDirectory::V1::RegistrationService::Rest::Client.new
|
442
|
+
#
|
443
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
444
|
+
# request = Google::Cloud::ServiceDirectory::V1::GetNamespaceRequest.new
|
445
|
+
#
|
446
|
+
# # Call the get_namespace method.
|
447
|
+
# result = client.get_namespace request
|
448
|
+
#
|
449
|
+
# # The returned object is of type Google::Cloud::ServiceDirectory::V1::Namespace.
|
450
|
+
# p result
|
451
|
+
#
|
381
452
|
def get_namespace request, options = nil
|
382
453
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
383
454
|
|
@@ -442,6 +513,22 @@ module Google
|
|
442
513
|
# @return [::Google::Cloud::ServiceDirectory::V1::Namespace]
|
443
514
|
#
|
444
515
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
516
|
+
#
|
517
|
+
# @example Basic example
|
518
|
+
# require "google/cloud/service_directory/v1"
|
519
|
+
#
|
520
|
+
# # Create a client object. The client can be reused for multiple calls.
|
521
|
+
# client = Google::Cloud::ServiceDirectory::V1::RegistrationService::Rest::Client.new
|
522
|
+
#
|
523
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
524
|
+
# request = Google::Cloud::ServiceDirectory::V1::UpdateNamespaceRequest.new
|
525
|
+
#
|
526
|
+
# # Call the update_namespace method.
|
527
|
+
# result = client.update_namespace request
|
528
|
+
#
|
529
|
+
# # The returned object is of type Google::Cloud::ServiceDirectory::V1::Namespace.
|
530
|
+
# p result
|
531
|
+
#
|
445
532
|
def update_namespace request, options = nil
|
446
533
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
447
534
|
|
@@ -505,6 +592,22 @@ module Google
|
|
505
592
|
# @return [::Google::Protobuf::Empty]
|
506
593
|
#
|
507
594
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
595
|
+
#
|
596
|
+
# @example Basic example
|
597
|
+
# require "google/cloud/service_directory/v1"
|
598
|
+
#
|
599
|
+
# # Create a client object. The client can be reused for multiple calls.
|
600
|
+
# client = Google::Cloud::ServiceDirectory::V1::RegistrationService::Rest::Client.new
|
601
|
+
#
|
602
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
603
|
+
# request = Google::Cloud::ServiceDirectory::V1::DeleteNamespaceRequest.new
|
604
|
+
#
|
605
|
+
# # Call the delete_namespace method.
|
606
|
+
# result = client.delete_namespace request
|
607
|
+
#
|
608
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
609
|
+
# p result
|
610
|
+
#
|
508
611
|
def delete_namespace request, options = nil
|
509
612
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
510
613
|
|
@@ -577,6 +680,22 @@ module Google
|
|
577
680
|
# @return [::Google::Cloud::ServiceDirectory::V1::Service]
|
578
681
|
#
|
579
682
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
683
|
+
#
|
684
|
+
# @example Basic example
|
685
|
+
# require "google/cloud/service_directory/v1"
|
686
|
+
#
|
687
|
+
# # Create a client object. The client can be reused for multiple calls.
|
688
|
+
# client = Google::Cloud::ServiceDirectory::V1::RegistrationService::Rest::Client.new
|
689
|
+
#
|
690
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
691
|
+
# request = Google::Cloud::ServiceDirectory::V1::CreateServiceRequest.new
|
692
|
+
#
|
693
|
+
# # Call the create_service method.
|
694
|
+
# result = client.create_service request
|
695
|
+
#
|
696
|
+
# # The returned object is of type Google::Cloud::ServiceDirectory::V1::Service.
|
697
|
+
# p result
|
698
|
+
#
|
580
699
|
def create_service request, options = nil
|
581
700
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
582
701
|
|
@@ -687,6 +806,26 @@ module Google
|
|
687
806
|
# @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::ServiceDirectory::V1::Service>]
|
688
807
|
#
|
689
808
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
809
|
+
#
|
810
|
+
# @example Basic example
|
811
|
+
# require "google/cloud/service_directory/v1"
|
812
|
+
#
|
813
|
+
# # Create a client object. The client can be reused for multiple calls.
|
814
|
+
# client = Google::Cloud::ServiceDirectory::V1::RegistrationService::Rest::Client.new
|
815
|
+
#
|
816
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
817
|
+
# request = Google::Cloud::ServiceDirectory::V1::ListServicesRequest.new
|
818
|
+
#
|
819
|
+
# # Call the list_services method.
|
820
|
+
# result = client.list_services request
|
821
|
+
#
|
822
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
823
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
824
|
+
# result.each do |item|
|
825
|
+
# # Each element is of type ::Google::Cloud::ServiceDirectory::V1::Service.
|
826
|
+
# p item
|
827
|
+
# end
|
828
|
+
#
|
690
829
|
def list_services request, options = nil
|
691
830
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
692
831
|
|
@@ -750,6 +889,22 @@ module Google
|
|
750
889
|
# @return [::Google::Cloud::ServiceDirectory::V1::Service]
|
751
890
|
#
|
752
891
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
892
|
+
#
|
893
|
+
# @example Basic example
|
894
|
+
# require "google/cloud/service_directory/v1"
|
895
|
+
#
|
896
|
+
# # Create a client object. The client can be reused for multiple calls.
|
897
|
+
# client = Google::Cloud::ServiceDirectory::V1::RegistrationService::Rest::Client.new
|
898
|
+
#
|
899
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
900
|
+
# request = Google::Cloud::ServiceDirectory::V1::GetServiceRequest.new
|
901
|
+
#
|
902
|
+
# # Call the get_service method.
|
903
|
+
# result = client.get_service request
|
904
|
+
#
|
905
|
+
# # The returned object is of type Google::Cloud::ServiceDirectory::V1::Service.
|
906
|
+
# p result
|
907
|
+
#
|
753
908
|
def get_service request, options = nil
|
754
909
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
755
910
|
|
@@ -814,6 +969,22 @@ module Google
|
|
814
969
|
# @return [::Google::Cloud::ServiceDirectory::V1::Service]
|
815
970
|
#
|
816
971
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
972
|
+
#
|
973
|
+
# @example Basic example
|
974
|
+
# require "google/cloud/service_directory/v1"
|
975
|
+
#
|
976
|
+
# # Create a client object. The client can be reused for multiple calls.
|
977
|
+
# client = Google::Cloud::ServiceDirectory::V1::RegistrationService::Rest::Client.new
|
978
|
+
#
|
979
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
980
|
+
# request = Google::Cloud::ServiceDirectory::V1::UpdateServiceRequest.new
|
981
|
+
#
|
982
|
+
# # Call the update_service method.
|
983
|
+
# result = client.update_service request
|
984
|
+
#
|
985
|
+
# # The returned object is of type Google::Cloud::ServiceDirectory::V1::Service.
|
986
|
+
# p result
|
987
|
+
#
|
817
988
|
def update_service request, options = nil
|
818
989
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
819
990
|
|
@@ -877,6 +1048,22 @@ module Google
|
|
877
1048
|
# @return [::Google::Protobuf::Empty]
|
878
1049
|
#
|
879
1050
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1051
|
+
#
|
1052
|
+
# @example Basic example
|
1053
|
+
# require "google/cloud/service_directory/v1"
|
1054
|
+
#
|
1055
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1056
|
+
# client = Google::Cloud::ServiceDirectory::V1::RegistrationService::Rest::Client.new
|
1057
|
+
#
|
1058
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1059
|
+
# request = Google::Cloud::ServiceDirectory::V1::DeleteServiceRequest.new
|
1060
|
+
#
|
1061
|
+
# # Call the delete_service method.
|
1062
|
+
# result = client.delete_service request
|
1063
|
+
#
|
1064
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
1065
|
+
# p result
|
1066
|
+
#
|
880
1067
|
def delete_service request, options = nil
|
881
1068
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
882
1069
|
|
@@ -949,6 +1136,22 @@ module Google
|
|
949
1136
|
# @return [::Google::Cloud::ServiceDirectory::V1::Endpoint]
|
950
1137
|
#
|
951
1138
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1139
|
+
#
|
1140
|
+
# @example Basic example
|
1141
|
+
# require "google/cloud/service_directory/v1"
|
1142
|
+
#
|
1143
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1144
|
+
# client = Google::Cloud::ServiceDirectory::V1::RegistrationService::Rest::Client.new
|
1145
|
+
#
|
1146
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1147
|
+
# request = Google::Cloud::ServiceDirectory::V1::CreateEndpointRequest.new
|
1148
|
+
#
|
1149
|
+
# # Call the create_endpoint method.
|
1150
|
+
# result = client.create_endpoint request
|
1151
|
+
#
|
1152
|
+
# # The returned object is of type Google::Cloud::ServiceDirectory::V1::Endpoint.
|
1153
|
+
# p result
|
1154
|
+
#
|
952
1155
|
def create_endpoint request, options = nil
|
953
1156
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
954
1157
|
|
@@ -1062,6 +1265,26 @@ module Google
|
|
1062
1265
|
# @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::ServiceDirectory::V1::Endpoint>]
|
1063
1266
|
#
|
1064
1267
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1268
|
+
#
|
1269
|
+
# @example Basic example
|
1270
|
+
# require "google/cloud/service_directory/v1"
|
1271
|
+
#
|
1272
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1273
|
+
# client = Google::Cloud::ServiceDirectory::V1::RegistrationService::Rest::Client.new
|
1274
|
+
#
|
1275
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1276
|
+
# request = Google::Cloud::ServiceDirectory::V1::ListEndpointsRequest.new
|
1277
|
+
#
|
1278
|
+
# # Call the list_endpoints method.
|
1279
|
+
# result = client.list_endpoints request
|
1280
|
+
#
|
1281
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
1282
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
1283
|
+
# result.each do |item|
|
1284
|
+
# # Each element is of type ::Google::Cloud::ServiceDirectory::V1::Endpoint.
|
1285
|
+
# p item
|
1286
|
+
# end
|
1287
|
+
#
|
1065
1288
|
def list_endpoints request, options = nil
|
1066
1289
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
1067
1290
|
|
@@ -1125,6 +1348,22 @@ module Google
|
|
1125
1348
|
# @return [::Google::Cloud::ServiceDirectory::V1::Endpoint]
|
1126
1349
|
#
|
1127
1350
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1351
|
+
#
|
1352
|
+
# @example Basic example
|
1353
|
+
# require "google/cloud/service_directory/v1"
|
1354
|
+
#
|
1355
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1356
|
+
# client = Google::Cloud::ServiceDirectory::V1::RegistrationService::Rest::Client.new
|
1357
|
+
#
|
1358
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1359
|
+
# request = Google::Cloud::ServiceDirectory::V1::GetEndpointRequest.new
|
1360
|
+
#
|
1361
|
+
# # Call the get_endpoint method.
|
1362
|
+
# result = client.get_endpoint request
|
1363
|
+
#
|
1364
|
+
# # The returned object is of type Google::Cloud::ServiceDirectory::V1::Endpoint.
|
1365
|
+
# p result
|
1366
|
+
#
|
1128
1367
|
def get_endpoint request, options = nil
|
1129
1368
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
1130
1369
|
|
@@ -1189,6 +1428,22 @@ module Google
|
|
1189
1428
|
# @return [::Google::Cloud::ServiceDirectory::V1::Endpoint]
|
1190
1429
|
#
|
1191
1430
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1431
|
+
#
|
1432
|
+
# @example Basic example
|
1433
|
+
# require "google/cloud/service_directory/v1"
|
1434
|
+
#
|
1435
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1436
|
+
# client = Google::Cloud::ServiceDirectory::V1::RegistrationService::Rest::Client.new
|
1437
|
+
#
|
1438
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1439
|
+
# request = Google::Cloud::ServiceDirectory::V1::UpdateEndpointRequest.new
|
1440
|
+
#
|
1441
|
+
# # Call the update_endpoint method.
|
1442
|
+
# result = client.update_endpoint request
|
1443
|
+
#
|
1444
|
+
# # The returned object is of type Google::Cloud::ServiceDirectory::V1::Endpoint.
|
1445
|
+
# p result
|
1446
|
+
#
|
1192
1447
|
def update_endpoint request, options = nil
|
1193
1448
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
1194
1449
|
|
@@ -1251,6 +1506,22 @@ module Google
|
|
1251
1506
|
# @return [::Google::Protobuf::Empty]
|
1252
1507
|
#
|
1253
1508
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1509
|
+
#
|
1510
|
+
# @example Basic example
|
1511
|
+
# require "google/cloud/service_directory/v1"
|
1512
|
+
#
|
1513
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1514
|
+
# client = Google::Cloud::ServiceDirectory::V1::RegistrationService::Rest::Client.new
|
1515
|
+
#
|
1516
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1517
|
+
# request = Google::Cloud::ServiceDirectory::V1::DeleteEndpointRequest.new
|
1518
|
+
#
|
1519
|
+
# # Call the delete_endpoint method.
|
1520
|
+
# result = client.delete_endpoint request
|
1521
|
+
#
|
1522
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
1523
|
+
# p result
|
1524
|
+
#
|
1254
1525
|
def delete_endpoint request, options = nil
|
1255
1526
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
1256
1527
|
|
@@ -1317,6 +1588,22 @@ module Google
|
|
1317
1588
|
# @return [::Google::Iam::V1::Policy]
|
1318
1589
|
#
|
1319
1590
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1591
|
+
#
|
1592
|
+
# @example Basic example
|
1593
|
+
# require "google/cloud/service_directory/v1"
|
1594
|
+
#
|
1595
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1596
|
+
# client = Google::Cloud::ServiceDirectory::V1::RegistrationService::Rest::Client.new
|
1597
|
+
#
|
1598
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1599
|
+
# request = Google::Iam::V1::GetIamPolicyRequest.new
|
1600
|
+
#
|
1601
|
+
# # Call the get_iam_policy method.
|
1602
|
+
# result = client.get_iam_policy request
|
1603
|
+
#
|
1604
|
+
# # The returned object is of type Google::Iam::V1::Policy.
|
1605
|
+
# p result
|
1606
|
+
#
|
1320
1607
|
def get_iam_policy request, options = nil
|
1321
1608
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
1322
1609
|
|
@@ -1391,6 +1678,22 @@ module Google
|
|
1391
1678
|
# @return [::Google::Iam::V1::Policy]
|
1392
1679
|
#
|
1393
1680
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1681
|
+
#
|
1682
|
+
# @example Basic example
|
1683
|
+
# require "google/cloud/service_directory/v1"
|
1684
|
+
#
|
1685
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1686
|
+
# client = Google::Cloud::ServiceDirectory::V1::RegistrationService::Rest::Client.new
|
1687
|
+
#
|
1688
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1689
|
+
# request = Google::Iam::V1::SetIamPolicyRequest.new
|
1690
|
+
#
|
1691
|
+
# # Call the set_iam_policy method.
|
1692
|
+
# result = client.set_iam_policy request
|
1693
|
+
#
|
1694
|
+
# # The returned object is of type Google::Iam::V1::Policy.
|
1695
|
+
# p result
|
1696
|
+
#
|
1394
1697
|
def set_iam_policy request, options = nil
|
1395
1698
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
1396
1699
|
|
@@ -1459,6 +1762,22 @@ module Google
|
|
1459
1762
|
# @return [::Google::Iam::V1::TestIamPermissionsResponse]
|
1460
1763
|
#
|
1461
1764
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1765
|
+
#
|
1766
|
+
# @example Basic example
|
1767
|
+
# require "google/cloud/service_directory/v1"
|
1768
|
+
#
|
1769
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1770
|
+
# client = Google::Cloud::ServiceDirectory::V1::RegistrationService::Rest::Client.new
|
1771
|
+
#
|
1772
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1773
|
+
# request = Google::Iam::V1::TestIamPermissionsRequest.new
|
1774
|
+
#
|
1775
|
+
# # Call the test_iam_permissions method.
|
1776
|
+
# result = client.test_iam_permissions request
|
1777
|
+
#
|
1778
|
+
# # The returned object is of type Google::Iam::V1::TestIamPermissionsResponse.
|
1779
|
+
# p result
|
1780
|
+
#
|
1462
1781
|
def test_iam_permissions request, options = nil
|
1463
1782
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
1464
1783
|
|
@@ -1524,9 +1843,9 @@ module Google
|
|
1524
1843
|
# end
|
1525
1844
|
#
|
1526
1845
|
# @!attribute [rw] endpoint
|
1527
|
-
#
|
1528
|
-
#
|
1529
|
-
# @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]
|
1530
1849
|
# @!attribute [rw] credentials
|
1531
1850
|
# Credentials to send with calls. You may provide any of the following types:
|
1532
1851
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -1563,13 +1882,20 @@ module Google
|
|
1563
1882
|
# @!attribute [rw] quota_project
|
1564
1883
|
# A separate project against which to charge quota.
|
1565
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]
|
1566
1890
|
#
|
1567
1891
|
class Configuration
|
1568
1892
|
extend ::Gapic::Config
|
1569
1893
|
|
1894
|
+
# @private
|
1895
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
1570
1896
|
DEFAULT_ENDPOINT = "servicedirectory.googleapis.com"
|
1571
1897
|
|
1572
|
-
config_attr :endpoint,
|
1898
|
+
config_attr :endpoint, nil, ::String, nil
|
1573
1899
|
config_attr :credentials, nil do |value|
|
1574
1900
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
1575
1901
|
allowed.any? { |klass| klass === value }
|
@@ -1581,6 +1907,7 @@ module Google
|
|
1581
1907
|
config_attr :metadata, nil, ::Hash, nil
|
1582
1908
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
1583
1909
|
config_attr :quota_project, nil, ::String, nil
|
1910
|
+
config_attr :universe_domain, nil, ::String, nil
|
1584
1911
|
|
1585
1912
|
# @private
|
1586
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
|
@@ -66,6 +66,20 @@ module Google
|
|
66
66
|
# a non-empty value will be returned. The user will not be aware of what
|
67
67
|
# non-empty value to expect.
|
68
68
|
NON_EMPTY_DEFAULT = 7
|
69
|
+
|
70
|
+
# Denotes that the field in a resource (a message annotated with
|
71
|
+
# google.api.resource) is used in the resource name to uniquely identify the
|
72
|
+
# resource. For AIP-compliant APIs, this should only be applied to the
|
73
|
+
# `name` field on the resource.
|
74
|
+
#
|
75
|
+
# This behavior should not be applied to references to other resources within
|
76
|
+
# the message.
|
77
|
+
#
|
78
|
+
# The identifier field of resources often have different field behavior
|
79
|
+
# depending on the request it is embedded in (e.g. for Create methods name
|
80
|
+
# is optional and unused, while for Update methods it is required). Instead
|
81
|
+
# of method-specific annotations, only `IDENTIFIER` is required.
|
82
|
+
IDENTIFIER = 8
|
69
83
|
end
|
70
84
|
end
|
71
85
|
end
|
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
|