google-cloud-service_directory-v1beta1 0.13.0 → 0.14.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 29777dcf865afc43e88f92da452a14469d852aa2661861f488d4eac502108588
4
- data.tar.gz: 405597213a886c382dd0a9d0a7ceb85080b5413405de0056896a3512c9fd88da
3
+ metadata.gz: 3fc78ffe660af2d108f1f4c383f389e5e9e13326dc212aba780a8dfa6761d312
4
+ data.tar.gz: 2536db0177c3d54cc5b26729859dfb14c303763e19c0dd0394a00d978322c333
5
5
  SHA512:
6
- metadata.gz: 54b3157d0ac2b8f702199f5a541db56eae06c4492bd61a0a9c5a996918398b5f10f97c14ac957643fe0498222fb731c9d38cfe6c19abc6faad6c8f0b8c1ffb2c
7
- data.tar.gz: 3a9fa46878d828325792aa6f4340d2f7a86ad6bdff3d1cac030b3e8e978c686384384959036c9834562333950ad136ec64ace5cd0bc13d9b5f3946f2ae401d2f
6
+ metadata.gz: 428d72e3e84a5b14bb3674e958a706c685640cf3d801b98b6c8e9f6c0a4bcf8f515db760c4c8b892795cef38100087cd28db185b74786eeaf679b3648a5f4498
7
+ data.tar.gz: 825b5e7dd04acd23744c7dca05cd9c013e02f40f5f753cab79483ca77124e4d323c3febe23ccfdf7bdaef9a74ad87048e93800ca651dc3d532f5c9786ee8a17d
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-service_directory-v1beta1 library uses
4
- [Service Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
5
- credentials to connect to Google Cloud services. When running within
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-v1beta1 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
- 1. [Create a service account and credentials](#creating-a-service-account).
19
- 2. Set the [environment variable](#environment-variables).
9
+ The following example shows how to set up authentication for a local development
10
+ environment with your user credentials.
20
11
 
21
- ```sh
22
- export SERVICE_DIRECTORY_CREDENTIALS=path/to/keyfile.json
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
- ```ruby
28
- require "google/cloud/service_directory/v1beta1"
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
- client = ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-service_directory-v1beta1 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
- When running on Google Cloud Platform (GCP), including Google Compute Engine
51
- (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
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
- ### Environment Variables
27
+ ## Credential Lookup
56
28
 
57
- The **Credentials JSON** can be placed in environment variables instead of
58
- declaring them directly in code. Each service has its own environment variable,
59
- allowing for different service accounts to be used for different services. (See
60
- the READMEs for the individual service gems for details.) The path to the
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-v1beta1 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
- The environment variables that google-cloud-service_directory-v1beta1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `SERVICE_DIRECTORY_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `SERVICE_DIRECTORY_KEYFILE` - Path to JSON file, or JSON contents
71
- * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
- * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
- * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
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
- ```ruby
76
- require "google/cloud/service_directory/v1beta1"
77
-
78
- ENV["SERVICE_DIRECTORY_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new
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
- ### Configuration
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
- The path to the **Credentials JSON** file can be configured instead of storing
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/v1beta1"
90
58
 
91
59
  client = ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new do |config|
92
- config.credentials = "path/to/keyfile.json"
60
+ config.credentials = "path/to/credentialfile.json"
93
61
  end
94
62
  ```
95
63
 
96
- Or globally for all clients:
64
+ To configure a credentials file globally for all clients:
97
65
 
98
66
  ```ruby
99
67
  require "google/cloud/service_directory/v1beta1"
100
68
 
101
69
  ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.configure do |config|
102
- config.credentials = "path/to/keyfile.json"
70
+ config.credentials = "path/to/credentialfile.json"
103
71
  end
104
72
 
105
73
  client = ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new
106
74
  ```
107
75
 
108
- ### Cloud SDK
76
+ ### Environment Variables
109
77
 
110
- This option allows for an easy way to authenticate during development. If
111
- credentials are not provided in code or in environment variables, then Cloud SDK
112
- credentials are discovered.
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
- To configure your system for this, simply:
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
- 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
117
- 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
118
- 3. Write code as if already authenticated.
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-v1beta1
93
+ checks for credentials are:
119
94
 
120
- **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
121
- *should* only be used during development.
95
+ * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
96
+ * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
122
97
 
123
- ## Creating a Service Account
98
+ ```ruby
99
+ require "google/cloud/service_directory/v1beta1"
124
100
 
125
- Google Cloud requires **Service Account Credentials** to
126
- connect to the APIs. You will use the **JSON key file** to
127
- connect to most services with google-cloud-service_directory-v1beta1.
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
128
102
 
129
- If you are not running this client within
130
- [Google Cloud Platform environments](#google-cloud-platform-environments), you
131
- need a Google Developers service account.
103
+ client = ::Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new
104
+ ```
132
105
 
133
- 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
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
- *Note: You may need to enable billing in order to use these services.*
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
- 4. Select **Credentials** from the side navigation.
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
141
113
 
142
- Find the "Create credentials" drop down near the top of the page, and select
143
- "Service account" to be guided through downloading a new JSON key file.
114
+ ### Google Cloud Platform environments
144
115
 
145
- If you want to re-use an existing service account, you can easily generate a
146
- new key file. Just select the account you wish to re-use, click the pencil
147
- tool on the right side to edit the service account, select the **Keys** tab,
148
- and then select **Add Key**.
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
- The key file you download will be used by this library to authenticate API
151
- requests and should be stored in a secure location.
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 == Configuration::DEFAULT_ENDPOINT &&
133
- !@config.endpoint.split(".").first.include?("-")
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::V1beta1::LookupService::Stub,
150
- credentials: credentials,
151
- endpoint: @config.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
- # The hostname or hostname:port of the service endpoint.
326
- # Defaults to `"servicedirectory.googleapis.com"`.
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, DEFAULT_ENDPOINT, ::String
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 == Configuration::DEFAULT_ENDPOINT &&
129
- !@config.endpoint.split(".").first.include?("-")
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::V1beta1::LookupService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
160
+ @lookup_service_stub = ::Google::Cloud::ServiceDirectory::V1beta1::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
- # The hostname or hostname:port of the service endpoint.
310
- # Defaults to `"servicedirectory.googleapis.com"`.
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, DEFAULT_ENDPOINT, ::String
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, credentials: credentials,
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 == Configuration::DEFAULT_ENDPOINT &&
147
- !@config.endpoint.split(".").first.include?("-")
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::V1beta1::RegistrationService::Stub,
164
- credentials: credentials,
165
- endpoint: @config.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
@@ -1967,9 +1983,9 @@ module Google
1967
1983
  # end
1968
1984
  #
1969
1985
  # @!attribute [rw] endpoint
1970
- # The hostname or hostname:port of the service endpoint.
1971
- # Defaults to `"servicedirectory.googleapis.com"`.
1972
- # @return [::String]
1986
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1987
+ # nil, indicating to use the default endpoint in the current universe domain.
1988
+ # @return [::String,nil]
1973
1989
  # @!attribute [rw] credentials
1974
1990
  # Credentials to send with calls. You may provide any of the following types:
1975
1991
  # * (`String`) The path to a service account key file in JSON format
@@ -2015,13 +2031,20 @@ module Google
2015
2031
  # @!attribute [rw] quota_project
2016
2032
  # A separate project against which to charge quota.
2017
2033
  # @return [::String]
2034
+ # @!attribute [rw] universe_domain
2035
+ # The universe domain within which to make requests. This determines the
2036
+ # default endpoint URL. The default value of nil uses the environment
2037
+ # universe (usually the default "googleapis.com" universe).
2038
+ # @return [::String,nil]
2018
2039
  #
2019
2040
  class Configuration
2020
2041
  extend ::Gapic::Config
2021
2042
 
2043
+ # @private
2044
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
2022
2045
  DEFAULT_ENDPOINT = "servicedirectory.googleapis.com"
2023
2046
 
2024
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
2047
+ config_attr :endpoint, nil, ::String, nil
2025
2048
  config_attr :credentials, nil do |value|
2026
2049
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
2027
2050
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -2036,6 +2059,7 @@ module Google
2036
2059
  config_attr :metadata, nil, ::Hash, nil
2037
2060
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
2038
2061
  config_attr :quota_project, nil, ::String, nil
2062
+ config_attr :universe_domain, nil, ::String, nil
2039
2063
 
2040
2064
  # @private
2041
2065
  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 == Configuration::DEFAULT_ENDPOINT &&
143
- !@config.endpoint.split(".").first.include?("-")
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::V1beta1::RegistrationService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
174
+ @registration_service_stub = ::Google::Cloud::ServiceDirectory::V1beta1::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
  ##
@@ -1832,9 +1851,9 @@ module Google
1832
1851
  # end
1833
1852
  #
1834
1853
  # @!attribute [rw] endpoint
1835
- # The hostname or hostname:port of the service endpoint.
1836
- # Defaults to `"servicedirectory.googleapis.com"`.
1837
- # @return [::String]
1854
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1855
+ # nil, indicating to use the default endpoint in the current universe domain.
1856
+ # @return [::String,nil]
1838
1857
  # @!attribute [rw] credentials
1839
1858
  # Credentials to send with calls. You may provide any of the following types:
1840
1859
  # * (`String`) The path to a service account key file in JSON format
@@ -1871,13 +1890,20 @@ module Google
1871
1890
  # @!attribute [rw] quota_project
1872
1891
  # A separate project against which to charge quota.
1873
1892
  # @return [::String]
1893
+ # @!attribute [rw] universe_domain
1894
+ # The universe domain within which to make requests. This determines the
1895
+ # default endpoint URL. The default value of nil uses the environment
1896
+ # universe (usually the default "googleapis.com" universe).
1897
+ # @return [::String,nil]
1874
1898
  #
1875
1899
  class Configuration
1876
1900
  extend ::Gapic::Config
1877
1901
 
1902
+ # @private
1903
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1878
1904
  DEFAULT_ENDPOINT = "servicedirectory.googleapis.com"
1879
1905
 
1880
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1906
+ config_attr :endpoint, nil, ::String, nil
1881
1907
  config_attr :credentials, nil do |value|
1882
1908
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1883
1909
  allowed.any? { |klass| klass === value }
@@ -1889,6 +1915,7 @@ module Google
1889
1915
  config_attr :metadata, nil, ::Hash, nil
1890
1916
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1891
1917
  config_attr :quota_project, nil, ::String, nil
1918
+ config_attr :universe_domain, nil, ::String, nil
1892
1919
 
1893
1920
  # @private
1894
1921
  # 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, credentials: credentials,
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,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module ServiceDirectory
23
23
  module V1beta1
24
- VERSION = "0.13.0"
24
+ VERSION = "0.14.0"
25
25
  end
26
26
  end
27
27
  end
@@ -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-v1beta1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.13.0
4
+ version: 0.14.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: 2023-09-12 00:00:00.000000000 Z
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.20.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.20.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.4'
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.4'
63
+ version: '0.7'
64
64
  - - "<"
65
65
  - !ruby/object:Gem::Version
66
66
  version: 2.a
@@ -267,7 +267,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
267
267
  - !ruby/object:Gem::Version
268
268
  version: '0'
269
269
  requirements: []
270
- rubygems_version: 3.4.19
270
+ rubygems_version: 3.5.3
271
271
  signing_key:
272
272
  specification_version: 4
273
273
  summary: Service Directory is a platform for discovering, publishing, and connecting