google-cloud-gke_multi_cloud-v1 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 (20) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -99
  3. data/lib/google/cloud/gke_multi_cloud/v1/attached_clusters/client.rb +32 -8
  4. data/lib/google/cloud/gke_multi_cloud/v1/attached_clusters/operations.rb +28 -6
  5. data/lib/google/cloud/gke_multi_cloud/v1/attached_clusters/rest/client.rb +34 -7
  6. data/lib/google/cloud/gke_multi_cloud/v1/attached_clusters/rest/operations.rb +33 -8
  7. data/lib/google/cloud/gke_multi_cloud/v1/attached_clusters/rest/service_stub.rb +14 -2
  8. data/lib/google/cloud/gke_multi_cloud/v1/aws_clusters/client.rb +32 -8
  9. data/lib/google/cloud/gke_multi_cloud/v1/aws_clusters/operations.rb +28 -6
  10. data/lib/google/cloud/gke_multi_cloud/v1/aws_clusters/rest/client.rb +34 -7
  11. data/lib/google/cloud/gke_multi_cloud/v1/aws_clusters/rest/operations.rb +33 -8
  12. data/lib/google/cloud/gke_multi_cloud/v1/aws_clusters/rest/service_stub.rb +14 -2
  13. data/lib/google/cloud/gke_multi_cloud/v1/azure_clusters/client.rb +32 -8
  14. data/lib/google/cloud/gke_multi_cloud/v1/azure_clusters/operations.rb +28 -6
  15. data/lib/google/cloud/gke_multi_cloud/v1/azure_clusters/rest/client.rb +34 -7
  16. data/lib/google/cloud/gke_multi_cloud/v1/azure_clusters/rest/operations.rb +33 -8
  17. data/lib/google/cloud/gke_multi_cloud/v1/azure_clusters/rest/service_stub.rb +14 -2
  18. data/lib/google/cloud/gke_multi_cloud/v1/version.rb +1 -1
  19. data/proto_docs/google/api/client.rb +1 -0
  20. metadata +4 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 33d790060021dc68aad275efdd67f8ed8191cf6039aa55cef10ef69ade0e962f
4
- data.tar.gz: 55c5495abbae0fa324cf86b5ec1ef42e4cb752e1da8d298b5eef7a6a0aa243bc
3
+ metadata.gz: 782e4c122c49a845c185c1e49ccc466e8569f87fde4eec9dd5c082ad8aa9ce17
4
+ data.tar.gz: 6abe39678674ce39f11d093c32873297e474d50d783e52b07f97ecd76d95fb5c
5
5
  SHA512:
6
- metadata.gz: 82f8d6f24c1bb395da87c0e6b63540552bea623d9d950b33864297b0a9eed5fa5be44f5f52b2a7ef8e6cd2b0b4f2044b2d334d4d446ce3b202a60c3c51f6fadd
7
- data.tar.gz: eaeef267808d6c54d2cd8ef52d74d44e36df6b841301e5dfd5904fa4727eb93ec53b75cca50db72d080b0f94d485d7d6937b7ae712854aaccf75f3f24945ca1f
6
+ metadata.gz: 1b4a6ec7c4cc6ff271e595c2495a7a216bca9a6aa4229c48102255e324aa6551c43c12b87c3cdfef2a13f59752ca541dac12abdd1336760701cf55729e25f08f
7
+ data.tar.gz: 971f38f021000a6bc5534c30b37f30fdf107114ac485ecee4c3b61dca6506d19e6849964aa3db6be0c3fa5daa01b79037876dcfa3376bb3be3b6901019cc1202
data/AUTHENTICATION.md CHANGED
@@ -1,149 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-gke_multi_cloud-v1 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-gke_multi_cloud-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
- 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 GOOGLE_CLOUD_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/gke_multi_cloud/v1"
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::GkeMultiCloud::V1::AttachedClusters::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-gke_multi_cloud-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
- 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-gke_multi_cloud-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
- The environment variables that google-cloud-gke_multi_cloud-v1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::GkeMultiCloud::V1::AttachedClusters::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
71
- * `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)
72
41
 
73
- ```ruby
74
- require "google/cloud/gke_multi_cloud/v1"
75
-
76
- ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
77
43
 
78
- client = ::Google::Cloud::GkeMultiCloud::V1::AttachedClusters::Client.new
79
- ```
44
+ You can configure a path to a JSON credentials file, either for an individual client object or
45
+ globally, for all client objects. The JSON file can contain credentials created for
46
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
47
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
48
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
80
49
 
81
- ### 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.
82
53
 
83
- The path to the **Credentials JSON** file can be configured instead of storing
84
- it in an environment variable. Either on an individual client initialization:
54
+ To configure a credentials file for an individual client initialization:
85
55
 
86
56
  ```ruby
87
57
  require "google/cloud/gke_multi_cloud/v1"
88
58
 
89
59
  client = ::Google::Cloud::GkeMultiCloud::V1::AttachedClusters::Client.new do |config|
90
- config.credentials = "path/to/keyfile.json"
60
+ config.credentials = "path/to/credentialfile.json"
91
61
  end
92
62
  ```
93
63
 
94
- Or globally for all clients:
64
+ To configure a credentials file globally for all clients:
95
65
 
96
66
  ```ruby
97
67
  require "google/cloud/gke_multi_cloud/v1"
98
68
 
99
69
  ::Google::Cloud::GkeMultiCloud::V1::AttachedClusters::Client.configure do |config|
100
- config.credentials = "path/to/keyfile.json"
70
+ config.credentials = "path/to/credentialfile.json"
101
71
  end
102
72
 
103
73
  client = ::Google::Cloud::GkeMultiCloud::V1::AttachedClusters::Client.new
104
74
  ```
105
75
 
106
- ### Cloud SDK
76
+ ### Environment Variables
107
77
 
108
- This option allows for an easy way to authenticate during development. If
109
- credentials are not provided in code or in environment variables, then Cloud SDK
110
- 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.
111
82
 
112
- 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).
113
87
 
114
- 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
115
- 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
116
- 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-gke_multi_cloud-v1
93
+ checks for credentials are:
117
94
 
118
- **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
119
- *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
120
97
 
121
- ## Creating a Service Account
98
+ ```ruby
99
+ require "google/cloud/gke_multi_cloud/v1"
122
100
 
123
- Google Cloud requires **Service Account Credentials** to
124
- connect to the APIs. You will use the **JSON key file** to
125
- connect to most services with google-cloud-gke_multi_cloud-v1.
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
126
102
 
127
- If you are not running this client within
128
- [Google Cloud Platform environments](#google-cloud-platform-environments), you
129
- need a Google Developers service account.
103
+ client = ::Google::Cloud::GkeMultiCloud::V1::AttachedClusters::Client.new
104
+ ```
130
105
 
131
- 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
132
- 2. Create a new project or click on an existing project.
133
- 3. Activate the menu in the upper left and select **APIs & Services**. From
134
- here, you will enable the APIs that your application requires.
106
+ ### Local ADC file
135
107
 
136
- *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.
137
111
 
138
- 4. Select **Credentials** from the side navigation.
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
139
113
 
140
- Find the "Create credentials" drop down near the top of the page, and select
141
- "Service account" to be guided through downloading a new JSON key file.
114
+ ### Google Cloud Platform environments
142
115
 
143
- If you want to re-use an existing service account, you can easily generate a
144
- new key file. Just select the account you wish to re-use, click the pencil
145
- tool on the right side to edit the service account, select the **Keys** tab,
146
- 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.
147
120
 
148
- The key file you download will be used by this library to authenticate API
149
- 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).
data/lib/google/cloud/gke_multi_cloud/v1/attached_clusters/client.rb CHANGED
@@ -32,6 +32,9 @@ module Google
32
32
  # infrastructure.
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "gkemulticloud.$UNIVERSE_DOMAIN$"
37
+
35
38
  include Paths
36
39
 
37
40
  # @private
@@ -125,6 +128,15 @@ module Google
125
128
  @config
126
129
  end
127
130
 
131
+ ##
132
+ # The effective universe domain
133
+ #
134
+ # @return [String]
135
+ #
136
+ def universe_domain
137
+ @attached_clusters_stub.universe_domain
138
+ end
139
+
128
140
  ##
129
141
  # Create a new AttachedClusters client object.
130
142
  #
@@ -158,8 +170,9 @@ module Google
158
170
  credentials = @config.credentials
159
171
  # Use self-signed JWT if the endpoint is unchanged from default,
160
172
  # but only if the default endpoint does not have a region prefix.
161
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
162
- !@config.endpoint.split(".").first.include?("-")
173
+ enable_self_signed_jwt = @config.endpoint.nil? ||
174
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
175
+ !@config.endpoint.split(".").first.include?("-"))
163
176
  credentials ||= Credentials.default scope: @config.scope,
164
177
  enable_self_signed_jwt: enable_self_signed_jwt
165
178
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -172,12 +185,15 @@ module Google
172
185
  config.credentials = credentials
173
186
  config.quota_project = @quota_project_id
174
187
  config.endpoint = @config.endpoint
188
+ config.universe_domain = @config.universe_domain
175
189
  end
176
190
 
177
191
  @attached_clusters_stub = ::Gapic::ServiceStub.new(
178
192
  ::Google::Cloud::GkeMultiCloud::V1::AttachedClusters::Stub,
179
- credentials: credentials,
180
- endpoint: @config.endpoint,
193
+ credentials: credentials,
194
+ endpoint: @config.endpoint,
195
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
196
+ universe_domain: @config.universe_domain,
181
197
  channel_args: @config.channel_args,
182
198
  interceptors: @config.interceptors,
183
199
  channel_pool_config: @config.channel_pool
@@ -1225,9 +1241,9 @@ module Google
1225
1241
  # end
1226
1242
  #
1227
1243
  # @!attribute [rw] endpoint
1228
- # The hostname or hostname:port of the service endpoint.
1229
- # Defaults to `"gkemulticloud.googleapis.com"`.
1230
- # @return [::String]
1244
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1245
+ # nil, indicating to use the default endpoint in the current universe domain.
1246
+ # @return [::String,nil]
1231
1247
  # @!attribute [rw] credentials
1232
1248
  # Credentials to send with calls. You may provide any of the following types:
1233
1249
  # * (`String`) The path to a service account key file in JSON format
@@ -1273,13 +1289,20 @@ module Google
1273
1289
  # @!attribute [rw] quota_project
1274
1290
  # A separate project against which to charge quota.
1275
1291
  # @return [::String]
1292
+ # @!attribute [rw] universe_domain
1293
+ # The universe domain within which to make requests. This determines the
1294
+ # default endpoint URL. The default value of nil uses the environment
1295
+ # universe (usually the default "googleapis.com" universe).
1296
+ # @return [::String,nil]
1276
1297
  #
1277
1298
  class Configuration
1278
1299
  extend ::Gapic::Config
1279
1300
 
1301
+ # @private
1302
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1280
1303
  DEFAULT_ENDPOINT = "gkemulticloud.googleapis.com"
1281
1304
 
1282
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1305
+ config_attr :endpoint, nil, ::String, nil
1283
1306
  config_attr :credentials, nil do |value|
1284
1307
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1285
1308
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -1294,6 +1317,7 @@ module Google
1294
1317
  config_attr :metadata, nil, ::Hash, nil
1295
1318
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1296
1319
  config_attr :quota_project, nil, ::String, nil
1320
+ config_attr :universe_domain, nil, ::String, nil
1297
1321
 
1298
1322
  # @private
1299
1323
  def initialize parent_config = nil
data/lib/google/cloud/gke_multi_cloud/v1/attached_clusters/operations.rb CHANGED
@@ -26,6 +26,9 @@ module Google
26
26
  module AttachedClusters
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "gkemulticloud.$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 `"gkemulticloud.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 = "gkemulticloud.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
data/lib/google/cloud/gke_multi_cloud/v1/attached_clusters/rest/client.rb CHANGED
@@ -34,6 +34,9 @@ module Google
34
34
  # infrastructure.
35
35
  #
36
36
  class Client
37
+ # @private
38
+ DEFAULT_ENDPOINT_TEMPLATE = "gkemulticloud.$UNIVERSE_DOMAIN$"
39
+
37
40
  include Paths
38
41
 
39
42
  # @private
@@ -127,6 +130,15 @@ module Google
127
130
  @config
128
131
  end
129
132
 
133
+ ##
134
+ # The effective universe domain
135
+ #
136
+ # @return [String]
137
+ #
138
+ def universe_domain
139
+ @attached_clusters_stub.universe_domain
140
+ end
141
+
130
142
  ##
131
143
  # Create a new AttachedClusters REST client object.
132
144
  #
@@ -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)
@@ -169,9 +182,15 @@ module Google
169
182
  config.credentials = credentials
170
183
  config.quota_project = @quota_project_id
171
184
  config.endpoint = @config.endpoint
185
+ config.universe_domain = @config.universe_domain
172
186
  end
173
187
 
174
- @attached_clusters_stub = ::Google::Cloud::GkeMultiCloud::V1::AttachedClusters::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
188
+ @attached_clusters_stub = ::Google::Cloud::GkeMultiCloud::V1::AttachedClusters::Rest::ServiceStub.new(
189
+ endpoint: @config.endpoint,
190
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
191
+ universe_domain: @config.universe_domain,
192
+ credentials: credentials
193
+ )
175
194
  end
176
195
 
177
196
  ##
@@ -1152,9 +1171,9 @@ module Google
1152
1171
  # end
1153
1172
  #
1154
1173
  # @!attribute [rw] endpoint
1155
- # The hostname or hostname:port of the service endpoint.
1156
- # Defaults to `"gkemulticloud.googleapis.com"`.
1157
- # @return [::String]
1174
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1175
+ # nil, indicating to use the default endpoint in the current universe domain.
1176
+ # @return [::String,nil]
1158
1177
  # @!attribute [rw] credentials
1159
1178
  # Credentials to send with calls. You may provide any of the following types:
1160
1179
  # * (`String`) The path to a service account key file in JSON format
@@ -1191,13 +1210,20 @@ module Google
1191
1210
  # @!attribute [rw] quota_project
1192
1211
  # A separate project against which to charge quota.
1193
1212
  # @return [::String]
1213
+ # @!attribute [rw] universe_domain
1214
+ # The universe domain within which to make requests. This determines the
1215
+ # default endpoint URL. The default value of nil uses the environment
1216
+ # universe (usually the default "googleapis.com" universe).
1217
+ # @return [::String,nil]
1194
1218
  #
1195
1219
  class Configuration
1196
1220
  extend ::Gapic::Config
1197
1221
 
1222
+ # @private
1223
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1198
1224
  DEFAULT_ENDPOINT = "gkemulticloud.googleapis.com"
1199
1225
 
1200
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1226
+ config_attr :endpoint, nil, ::String, nil
1201
1227
  config_attr :credentials, nil do |value|
1202
1228
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1203
1229
  allowed.any? { |klass| klass === value }
@@ -1209,6 +1235,7 @@ module Google
1209
1235
  config_attr :metadata, nil, ::Hash, nil
1210
1236
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1211
1237
  config_attr :quota_project, nil, ::String, nil
1238
+ config_attr :universe_domain, nil, ::String, nil
1212
1239
 
1213
1240
  # @private
1214
1241
  def initialize parent_config = nil
data/lib/google/cloud/gke_multi_cloud/v1/attached_clusters/rest/operations.rb CHANGED
@@ -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 = "gkemulticloud.$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 `"gkemulticloud.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 = "gkemulticloud.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
  ##
data/lib/google/cloud/gke_multi_cloud/v1/attached_clusters/rest/service_stub.rb CHANGED
@@ -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: false,
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_attached_cluster REST call
45
57
  #