google-cloud-resource_manager-v3 0.7.0 → 0.8.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.
Files changed (38) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -101
  3. data/lib/google/cloud/resource_manager/v3/folders/client.rb +32 -8
  4. data/lib/google/cloud/resource_manager/v3/folders/operations.rb +28 -6
  5. data/lib/google/cloud/resource_manager/v3/folders/rest/client.rb +34 -7
  6. data/lib/google/cloud/resource_manager/v3/folders/rest/operations.rb +33 -8
  7. data/lib/google/cloud/resource_manager/v3/folders/rest/service_stub.rb +14 -2
  8. data/lib/google/cloud/resource_manager/v3/organizations/client.rb +31 -8
  9. data/lib/google/cloud/resource_manager/v3/organizations/rest/client.rb +33 -7
  10. data/lib/google/cloud/resource_manager/v3/organizations/rest/service_stub.rb +14 -2
  11. data/lib/google/cloud/resource_manager/v3/projects/client.rb +32 -8
  12. data/lib/google/cloud/resource_manager/v3/projects/operations.rb +28 -6
  13. data/lib/google/cloud/resource_manager/v3/projects/rest/client.rb +34 -7
  14. data/lib/google/cloud/resource_manager/v3/projects/rest/operations.rb +33 -8
  15. data/lib/google/cloud/resource_manager/v3/projects/rest/service_stub.rb +14 -2
  16. data/lib/google/cloud/resource_manager/v3/tag_bindings/client.rb +32 -8
  17. data/lib/google/cloud/resource_manager/v3/tag_bindings/operations.rb +28 -6
  18. data/lib/google/cloud/resource_manager/v3/tag_bindings/rest/client.rb +34 -7
  19. data/lib/google/cloud/resource_manager/v3/tag_bindings/rest/operations.rb +33 -8
  20. data/lib/google/cloud/resource_manager/v3/tag_bindings/rest/service_stub.rb +14 -2
  21. data/lib/google/cloud/resource_manager/v3/tag_holds/client.rb +32 -8
  22. data/lib/google/cloud/resource_manager/v3/tag_holds/operations.rb +28 -6
  23. data/lib/google/cloud/resource_manager/v3/tag_holds/rest/client.rb +34 -7
  24. data/lib/google/cloud/resource_manager/v3/tag_holds/rest/operations.rb +33 -8
  25. data/lib/google/cloud/resource_manager/v3/tag_holds/rest/service_stub.rb +14 -2
  26. data/lib/google/cloud/resource_manager/v3/tag_keys/client.rb +32 -8
  27. data/lib/google/cloud/resource_manager/v3/tag_keys/operations.rb +28 -6
  28. data/lib/google/cloud/resource_manager/v3/tag_keys/rest/client.rb +34 -7
  29. data/lib/google/cloud/resource_manager/v3/tag_keys/rest/operations.rb +33 -8
  30. data/lib/google/cloud/resource_manager/v3/tag_keys/rest/service_stub.rb +14 -2
  31. data/lib/google/cloud/resource_manager/v3/tag_values/client.rb +32 -8
  32. data/lib/google/cloud/resource_manager/v3/tag_values/operations.rb +28 -6
  33. data/lib/google/cloud/resource_manager/v3/tag_values/rest/client.rb +34 -7
  34. data/lib/google/cloud/resource_manager/v3/tag_values/rest/operations.rb +33 -8
  35. data/lib/google/cloud/resource_manager/v3/tag_values/rest/service_stub.rb +14 -2
  36. data/lib/google/cloud/resource_manager/v3/version.rb +1 -1
  37. data/proto_docs/google/api/client.rb +14 -0
  38. metadata +5 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c2a4f2c27230d996ef2765cba70c99d32d426fe4e33bc4c919ba7dc67fea613c
4
- data.tar.gz: '09f0c45b06ded6556bab3f8ab18567c0c541dc51884eae9f171d082e8f11d8d1'
3
+ metadata.gz: 6ba96064b31f2fa2cea41d7ec3e7b249ffb017c5abf524c73a272e6b02bbee9a
4
+ data.tar.gz: dcfbf61721b11aac37e0347db50d0514621b02b84bd30cede84af6a5e007964f
5
5
  SHA512:
6
- metadata.gz: 6c08cbe706fcd00e6f53e7b9b95cde400a44f70350fca1a6155c122d6948883bf5c315f2f39b6821bf8faecbcd1e94db54008f9e53fa60910bd2dd20b5d2a6ac
7
- data.tar.gz: 53d2303f0a5d778bd506c3d0307e4070b55230c13eef550203fddfb53b1e75b809eb1bdf6a2824646fff8ecc183764895df1692592a7e710c4d9ab04d70139a9
6
+ metadata.gz: d96c4b0447e82066534b988b2f0c514bd0043ef140e332425ca4fb79b233ebfc1b15e46496c4f2544c35dd209917cc3610abb04d43e39bcc30215add14c7a33b
7
+ data.tar.gz: 801b6e73c51eb0e33cbdccfc6be4f14e2b1d8b2be714eab118d9d387924dc785fb5fac8005f0588655bbfa39a1bf1a834b0b536504d7517640ad541590674254
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-resource_manager-v3 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-resource_manager-v3 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 RESOURCE_MANAGER_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/resource_manager/v3"
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::ResourceManager::V3::Folders::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-resource_manager-v3 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-resource_manager-v3 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-resource_manager-v3
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::ResourceManager::V3::Folders::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `RESOURCE_MANAGER_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `RESOURCE_MANAGER_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/resource_manager/v3"
77
-
78
- ENV["RESOURCE_MANAGER_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::ResourceManager::V3::Folders::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/resource_manager/v3"
90
58
 
91
59
  client = ::Google::Cloud::ResourceManager::V3::Folders::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/resource_manager/v3"
100
68
 
101
69
  ::Google::Cloud::ResourceManager::V3::Folders::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::ResourceManager::V3::Folders::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-resource_manager-v3
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/resource_manager/v3"
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-resource_manager-v3.
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::ResourceManager::V3::Folders::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).
@@ -32,6 +32,9 @@ module Google
32
32
  # organization and to control the policies applied to groups of resources.
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "cloudresourcemanager.$UNIVERSE_DOMAIN$"
37
+
35
38
  include Paths
36
39
 
37
40
  # @private
@@ -121,6 +124,15 @@ module Google
121
124
  @config
122
125
  end
123
126
 
127
+ ##
128
+ # The effective universe domain
129
+ #
130
+ # @return [String]
131
+ #
132
+ def universe_domain
133
+ @folders_stub.universe_domain
134
+ end
135
+
124
136
  ##
125
137
  # Create a new Folders client object.
126
138
  #
@@ -154,8 +166,9 @@ module Google
154
166
  credentials = @config.credentials
155
167
  # Use self-signed JWT if the endpoint is unchanged from default,
156
168
  # but only if the default endpoint does not have a region prefix.
157
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
158
- !@config.endpoint.split(".").first.include?("-")
169
+ enable_self_signed_jwt = @config.endpoint.nil? ||
170
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
171
+ !@config.endpoint.split(".").first.include?("-"))
159
172
  credentials ||= Credentials.default scope: @config.scope,
160
173
  enable_self_signed_jwt: enable_self_signed_jwt
161
174
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -168,12 +181,15 @@ module Google
168
181
  config.credentials = credentials
169
182
  config.quota_project = @quota_project_id
170
183
  config.endpoint = @config.endpoint
184
+ config.universe_domain = @config.universe_domain
171
185
  end
172
186
 
173
187
  @folders_stub = ::Gapic::ServiceStub.new(
174
188
  ::Google::Cloud::ResourceManager::V3::Folders::Stub,
175
- credentials: credentials,
176
- endpoint: @config.endpoint,
189
+ credentials: credentials,
190
+ endpoint: @config.endpoint,
191
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
192
+ universe_domain: @config.universe_domain,
177
193
  channel_args: @config.channel_args,
178
194
  interceptors: @config.interceptors,
179
195
  channel_pool_config: @config.channel_pool
@@ -1376,9 +1392,9 @@ module Google
1376
1392
  # end
1377
1393
  #
1378
1394
  # @!attribute [rw] endpoint
1379
- # The hostname or hostname:port of the service endpoint.
1380
- # Defaults to `"cloudresourcemanager.googleapis.com"`.
1381
- # @return [::String]
1395
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1396
+ # nil, indicating to use the default endpoint in the current universe domain.
1397
+ # @return [::String,nil]
1382
1398
  # @!attribute [rw] credentials
1383
1399
  # Credentials to send with calls. You may provide any of the following types:
1384
1400
  # * (`String`) The path to a service account key file in JSON format
@@ -1424,13 +1440,20 @@ module Google
1424
1440
  # @!attribute [rw] quota_project
1425
1441
  # A separate project against which to charge quota.
1426
1442
  # @return [::String]
1443
+ # @!attribute [rw] universe_domain
1444
+ # The universe domain within which to make requests. This determines the
1445
+ # default endpoint URL. The default value of nil uses the environment
1446
+ # universe (usually the default "googleapis.com" universe).
1447
+ # @return [::String,nil]
1427
1448
  #
1428
1449
  class Configuration
1429
1450
  extend ::Gapic::Config
1430
1451
 
1452
+ # @private
1453
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1431
1454
  DEFAULT_ENDPOINT = "cloudresourcemanager.googleapis.com"
1432
1455
 
1433
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1456
+ config_attr :endpoint, nil, ::String, nil
1434
1457
  config_attr :credentials, nil do |value|
1435
1458
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1436
1459
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -1445,6 +1468,7 @@ module Google
1445
1468
  config_attr :metadata, nil, ::Hash, nil
1446
1469
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1447
1470
  config_attr :quota_project, nil, ::String, nil
1471
+ config_attr :universe_domain, nil, ::String, nil
1448
1472
 
1449
1473
  # @private
1450
1474
  def initialize parent_config = nil
@@ -26,6 +26,9 @@ module Google
26
26
  module Folders
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "cloudresourcemanager.$UNIVERSE_DOMAIN$"
31
+
29
32
  # @private
30
33
  attr_reader :operations_stub
31
34
 
@@ -60,6 +63,15 @@ module Google
60
63
  @config
61
64
  end
62
65
 
66
+ ##
67
+ # The effective universe domain
68
+ #
69
+ # @return [String]
70
+ #
71
+ def universe_domain
72
+ @operations_stub.universe_domain
73
+ end
74
+
63
75
  ##
64
76
  # Create a new Operations client object.
65
77
  #
@@ -90,8 +102,10 @@ module Google
90
102
 
91
103
  @operations_stub = ::Gapic::ServiceStub.new(
92
104
  ::Google::Longrunning::Operations::Stub,
93
- credentials: credentials,
94
- endpoint: @config.endpoint,
105
+ credentials: credentials,
106
+ endpoint: @config.endpoint,
107
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
108
+ universe_domain: @config.universe_domain,
95
109
  channel_args: @config.channel_args,
96
110
  interceptors: @config.interceptors,
97
111
  channel_pool_config: @config.channel_pool
@@ -613,9 +627,9 @@ module Google
613
627
  # end
614
628
  #
615
629
  # @!attribute [rw] endpoint
616
- # The hostname or hostname:port of the service endpoint.
617
- # Defaults to `"cloudresourcemanager.googleapis.com"`.
618
- # @return [::String]
630
+ # A custom service endpoint, as a hostname or hostname:port. The default is
631
+ # nil, indicating to use the default endpoint in the current universe domain.
632
+ # @return [::String,nil]
619
633
  # @!attribute [rw] credentials
620
634
  # Credentials to send with calls. You may provide any of the following types:
621
635
  # * (`String`) The path to a service account key file in JSON format
@@ -661,13 +675,20 @@ module Google
661
675
  # @!attribute [rw] quota_project
662
676
  # A separate project against which to charge quota.
663
677
  # @return [::String]
678
+ # @!attribute [rw] universe_domain
679
+ # The universe domain within which to make requests. This determines the
680
+ # default endpoint URL. The default value of nil uses the environment
681
+ # universe (usually the default "googleapis.com" universe).
682
+ # @return [::String,nil]
664
683
  #
665
684
  class Configuration
666
685
  extend ::Gapic::Config
667
686
 
687
+ # @private
688
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
668
689
  DEFAULT_ENDPOINT = "cloudresourcemanager.googleapis.com"
669
690
 
670
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
691
+ config_attr :endpoint, nil, ::String, nil
671
692
  config_attr :credentials, nil do |value|
672
693
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
673
694
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -682,6 +703,7 @@ module Google
682
703
  config_attr :metadata, nil, ::Hash, nil
683
704
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
684
705
  config_attr :quota_project, nil, ::String, nil
706
+ config_attr :universe_domain, nil, ::String, nil
685
707
 
686
708
  # @private
687
709
  def initialize parent_config = nil
@@ -34,6 +34,9 @@ module Google
34
34
  # organization and to control the policies applied to groups of resources.
35
35
  #
36
36
  class Client
37
+ # @private
38
+ DEFAULT_ENDPOINT_TEMPLATE = "cloudresourcemanager.$UNIVERSE_DOMAIN$"
39
+
37
40
  include Paths
38
41
 
39
42
  # @private
@@ -123,6 +126,15 @@ module Google
123
126
  @config
124
127
  end
125
128
 
129
+ ##
130
+ # The effective universe domain
131
+ #
132
+ # @return [String]
133
+ #
134
+ def universe_domain
135
+ @folders_stub.universe_domain
136
+ end
137
+
126
138
  ##
127
139
  # Create a new Folders REST client object.
128
140
  #
@@ -150,8 +162,9 @@ module Google
150
162
  credentials = @config.credentials
151
163
  # Use self-signed JWT if the endpoint is unchanged from default,
152
164
  # but only if the default endpoint does not have a region prefix.
153
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
154
- !@config.endpoint.split(".").first.include?("-")
165
+ enable_self_signed_jwt = @config.endpoint.nil? ||
166
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
167
+ !@config.endpoint.split(".").first.include?("-"))
155
168
  credentials ||= Credentials.default scope: @config.scope,
156
169
  enable_self_signed_jwt: enable_self_signed_jwt
157
170
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -165,9 +178,15 @@ module Google
165
178
  config.credentials = credentials
166
179
  config.quota_project = @quota_project_id
167
180
  config.endpoint = @config.endpoint
181
+ config.universe_domain = @config.universe_domain
168
182
  end
169
183
 
170
- @folders_stub = ::Google::Cloud::ResourceManager::V3::Folders::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
184
+ @folders_stub = ::Google::Cloud::ResourceManager::V3::Folders::Rest::ServiceStub.new(
185
+ endpoint: @config.endpoint,
186
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
187
+ universe_domain: @config.universe_domain,
188
+ credentials: credentials
189
+ )
171
190
  end
172
191
 
173
192
  ##
@@ -1313,9 +1332,9 @@ module Google
1313
1332
  # end
1314
1333
  #
1315
1334
  # @!attribute [rw] endpoint
1316
- # The hostname or hostname:port of the service endpoint.
1317
- # Defaults to `"cloudresourcemanager.googleapis.com"`.
1318
- # @return [::String]
1335
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1336
+ # nil, indicating to use the default endpoint in the current universe domain.
1337
+ # @return [::String,nil]
1319
1338
  # @!attribute [rw] credentials
1320
1339
  # Credentials to send with calls. You may provide any of the following types:
1321
1340
  # * (`String`) The path to a service account key file in JSON format
@@ -1352,13 +1371,20 @@ module Google
1352
1371
  # @!attribute [rw] quota_project
1353
1372
  # A separate project against which to charge quota.
1354
1373
  # @return [::String]
1374
+ # @!attribute [rw] universe_domain
1375
+ # The universe domain within which to make requests. This determines the
1376
+ # default endpoint URL. The default value of nil uses the environment
1377
+ # universe (usually the default "googleapis.com" universe).
1378
+ # @return [::String,nil]
1355
1379
  #
1356
1380
  class Configuration
1357
1381
  extend ::Gapic::Config
1358
1382
 
1383
+ # @private
1384
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1359
1385
  DEFAULT_ENDPOINT = "cloudresourcemanager.googleapis.com"
1360
1386
 
1361
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1387
+ config_attr :endpoint, nil, ::String, nil
1362
1388
  config_attr :credentials, nil do |value|
1363
1389
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1364
1390
  allowed.any? { |klass| klass === value }
@@ -1370,6 +1396,7 @@ module Google
1370
1396
  config_attr :metadata, nil, ::Hash, nil
1371
1397
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1372
1398
  config_attr :quota_project, nil, ::String, nil
1399
+ config_attr :universe_domain, nil, ::String, nil
1373
1400
 
1374
1401
  # @private
1375
1402
  def initialize parent_config = nil
@@ -26,6 +26,9 @@ module Google
26
26
  module Rest
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "cloudresourcemanager.$UNIVERSE_DOMAIN$"
31
+
29
32
  # @private
30
33
  attr_reader :operations_stub
31
34
 
@@ -60,6 +63,15 @@ module Google
60
63
  @config
61
64
  end
62
65
 
66
+ ##
67
+ # The effective universe domain
68
+ #
69
+ # @return [String]
70
+ #
71
+ def universe_domain
72
+ @operations_stub.universe_domain
73
+ end
74
+
63
75
  ##
64
76
  # Create a new Operations client object.
65
77
  #
@@ -84,8 +96,10 @@ module Google
84
96
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
85
97
 
86
98
  @operations_stub = OperationsServiceStub.new(
87
- endpoint: @config.endpoint,
88
- credentials: credentials
99
+ endpoint: @config.endpoint,
100
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
101
+ universe_domain: @config.universe_domain,
102
+ credentials: credentials
89
103
  )
90
104
 
91
105
  # Used by an LRO wrapper for some methods of this service
@@ -478,9 +492,9 @@ module Google
478
492
  # end
479
493
  #
480
494
  # @!attribute [rw] endpoint
481
- # The hostname or hostname:port of the service endpoint.
482
- # Defaults to `"cloudresourcemanager.googleapis.com"`.
483
- # @return [::String]
495
+ # A custom service endpoint, as a hostname or hostname:port. The default is
496
+ # nil, indicating to use the default endpoint in the current universe domain.
497
+ # @return [::String,nil]
484
498
  # @!attribute [rw] credentials
485
499
  # Credentials to send with calls. You may provide any of the following types:
486
500
  # * (`String`) The path to a service account key file in JSON format
@@ -517,13 +531,20 @@ module Google
517
531
  # @!attribute [rw] quota_project
518
532
  # A separate project against which to charge quota.
519
533
  # @return [::String]
534
+ # @!attribute [rw] universe_domain
535
+ # The universe domain within which to make requests. This determines the
536
+ # default endpoint URL. The default value of nil uses the environment
537
+ # universe (usually the default "googleapis.com" universe).
538
+ # @return [::String,nil]
520
539
  #
521
540
  class Configuration
522
541
  extend ::Gapic::Config
523
542
 
543
+ # @private
544
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
524
545
  DEFAULT_ENDPOINT = "cloudresourcemanager.googleapis.com"
525
546
 
526
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
547
+ config_attr :endpoint, nil, ::String, nil
527
548
  config_attr :credentials, nil do |value|
528
549
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
529
550
  allowed.any? { |klass| klass === value }
@@ -535,6 +556,7 @@ module Google
535
556
  config_attr :metadata, nil, ::Hash, nil
536
557
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
537
558
  config_attr :quota_project, nil, ::String, nil
559
+ config_attr :universe_domain, nil, ::String, nil
538
560
 
539
561
  # @private
540
562
  def initialize parent_config = nil
@@ -617,12 +639,15 @@ module Google
617
639
  # Service stub contains baseline method implementations
618
640
  # including transcoding, making the REST call, and deserialing the response.
619
641
  class OperationsServiceStub
620
- def initialize endpoint:, credentials:
642
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
621
643
  # These require statements are intentionally placed here to initialize
622
644
  # the REST modules only when it's required.
623
645
  require "gapic/rest"
624
646
 
625
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials
647
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
648
+ endpoint_template: endpoint_template,
649
+ universe_domain: universe_domain,
650
+ credentials: credentials
626
651
  end
627
652
 
628
653
  ##
@@ -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 get_folder REST call
45
57
  #