google-cloud-dataproc-v1 0.22.0 → 0.23.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (33) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -101
  3. data/lib/google/cloud/dataproc/v1/autoscaling_policy_service/client.rb +32 -8
  4. data/lib/google/cloud/dataproc/v1/autoscaling_policy_service/rest/client.rb +34 -7
  5. data/lib/google/cloud/dataproc/v1/autoscaling_policy_service/rest/service_stub.rb +14 -2
  6. data/lib/google/cloud/dataproc/v1/batch_controller/client.rb +33 -8
  7. data/lib/google/cloud/dataproc/v1/batch_controller/operations.rb +28 -6
  8. data/lib/google/cloud/dataproc/v1/batch_controller/rest/client.rb +35 -7
  9. data/lib/google/cloud/dataproc/v1/batch_controller/rest/operations.rb +33 -8
  10. data/lib/google/cloud/dataproc/v1/batch_controller/rest/service_stub.rb +14 -2
  11. data/lib/google/cloud/dataproc/v1/cluster_controller/client.rb +33 -8
  12. data/lib/google/cloud/dataproc/v1/cluster_controller/operations.rb +28 -6
  13. data/lib/google/cloud/dataproc/v1/cluster_controller/rest/client.rb +35 -7
  14. data/lib/google/cloud/dataproc/v1/cluster_controller/rest/operations.rb +33 -8
  15. data/lib/google/cloud/dataproc/v1/cluster_controller/rest/service_stub.rb +14 -2
  16. data/lib/google/cloud/dataproc/v1/job_controller/client.rb +33 -8
  17. data/lib/google/cloud/dataproc/v1/job_controller/operations.rb +28 -6
  18. data/lib/google/cloud/dataproc/v1/job_controller/rest/client.rb +35 -7
  19. data/lib/google/cloud/dataproc/v1/job_controller/rest/operations.rb +33 -8
  20. data/lib/google/cloud/dataproc/v1/job_controller/rest/service_stub.rb +14 -2
  21. data/lib/google/cloud/dataproc/v1/node_group_controller/client.rb +33 -8
  22. data/lib/google/cloud/dataproc/v1/node_group_controller/operations.rb +28 -6
  23. data/lib/google/cloud/dataproc/v1/node_group_controller/rest/client.rb +35 -7
  24. data/lib/google/cloud/dataproc/v1/node_group_controller/rest/operations.rb +33 -8
  25. data/lib/google/cloud/dataproc/v1/node_group_controller/rest/service_stub.rb +14 -2
  26. data/lib/google/cloud/dataproc/v1/version.rb +1 -1
  27. data/lib/google/cloud/dataproc/v1/workflow_template_service/client.rb +33 -8
  28. data/lib/google/cloud/dataproc/v1/workflow_template_service/operations.rb +28 -6
  29. data/lib/google/cloud/dataproc/v1/workflow_template_service/rest/client.rb +35 -7
  30. data/lib/google/cloud/dataproc/v1/workflow_template_service/rest/operations.rb +33 -8
  31. data/lib/google/cloud/dataproc/v1/workflow_template_service/rest/service_stub.rb +14 -2
  32. data/proto_docs/google/api/client.rb +14 -0
  33. metadata +7 -7
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a93d1004c32b74db7272d5b2a7b5d670017134238f8be5ce26da28e23b34b30f
4
- data.tar.gz: 5340b443df62d1033216285f26c5bcc71de265eb62c6010782f5cf152f6e48df
3
+ metadata.gz: 3ff0adc451ea58e4382f8436da4afc721aa414aac48c1df127218478af19c17f
4
+ data.tar.gz: 5c2cf105ec2e0fd75ccbfa68905bee27fe17bb394568a7f5b19e4dd4895c9b5f
5
5
  SHA512:
6
- metadata.gz: 4762d6f44e5b338dd65c9845a7c9b02bb1bb8b18464890f5231601520db63f793d237a37607ce7fb8fa707059bd025cab98dfc760b14533ace36eace96ed38cc
7
- data.tar.gz: 8c8e8f293dfa25525286039c503282931fbb673dce7c680cc256a8ac9c42a98ab1f42be7b48ac0365f282c7a865479d88fd13852be955646a3ee0917860b45ce
6
+ metadata.gz: a89770aa5737fd43963ef5b71732d8e95fd5c746224a4eb90460da326338676863de9fd6f7ed5e91c7297515b7e14fc5cb2fd92ec81d63ce8a9c88b31b2675b1
7
+ data.tar.gz: dc7b00db380bbec754551500dc335a458ed9fe4996597556312f1e913d3dff212cd41bf77430e2b5888fa48e70a191b8a7a213bd3b74e136c8f44daaa3b10855
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-dataproc-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-dataproc-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 DATAPROC_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/dataproc/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::Dataproc::V1::AutoscalingPolicyService::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-dataproc-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-dataproc-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-dataproc-v1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::Dataproc::V1::AutoscalingPolicyService::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `DATAPROC_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `DATAPROC_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/dataproc/v1"
77
-
78
- ENV["DATAPROC_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::Dataproc::V1::AutoscalingPolicyService::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/dataproc/v1"
90
58
 
91
59
  client = ::Google::Cloud::Dataproc::V1::AutoscalingPolicyService::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/dataproc/v1"
100
68
 
101
69
  ::Google::Cloud::Dataproc::V1::AutoscalingPolicyService::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::Dataproc::V1::AutoscalingPolicyService::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-dataproc-v1
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/dataproc/v1"
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-dataproc-v1.
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::Dataproc::V1::AutoscalingPolicyService::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
  # Dataproc API.
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "dataproc.$UNIVERSE_DOMAIN$"
37
+
35
38
  include Paths
36
39
 
37
40
  # @private
@@ -111,6 +114,15 @@ module Google
111
114
  @config
112
115
  end
113
116
 
117
+ ##
118
+ # The effective universe domain
119
+ #
120
+ # @return [String]
121
+ #
122
+ def universe_domain
123
+ @autoscaling_policy_service_stub.universe_domain
124
+ end
125
+
114
126
  ##
115
127
  # Create a new AutoscalingPolicyService client object.
116
128
  #
@@ -144,8 +156,9 @@ module Google
144
156
  credentials = @config.credentials
145
157
  # Use self-signed JWT if the endpoint is unchanged from default,
146
158
  # but only if the default endpoint does not have a region prefix.
147
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
148
- !@config.endpoint.split(".").first.include?("-")
159
+ enable_self_signed_jwt = @config.endpoint.nil? ||
160
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
161
+ !@config.endpoint.split(".").first.include?("-"))
149
162
  credentials ||= Credentials.default scope: @config.scope,
150
163
  enable_self_signed_jwt: enable_self_signed_jwt
151
164
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -158,12 +171,15 @@ module Google
158
171
  config.credentials = credentials
159
172
  config.quota_project = @quota_project_id
160
173
  config.endpoint = @config.endpoint
174
+ config.universe_domain = @config.universe_domain
161
175
  end
162
176
 
163
177
  @autoscaling_policy_service_stub = ::Gapic::ServiceStub.new(
164
178
  ::Google::Cloud::Dataproc::V1::AutoscalingPolicyService::Stub,
165
- credentials: credentials,
166
- endpoint: @config.endpoint,
179
+ credentials: credentials,
180
+ endpoint: @config.endpoint,
181
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
182
+ universe_domain: @config.universe_domain,
167
183
  channel_args: @config.channel_args,
168
184
  interceptors: @config.interceptors,
169
185
  channel_pool_config: @config.channel_pool
@@ -687,9 +703,9 @@ module Google
687
703
  # end
688
704
  #
689
705
  # @!attribute [rw] endpoint
690
- # The hostname or hostname:port of the service endpoint.
691
- # Defaults to `"dataproc.googleapis.com"`.
692
- # @return [::String]
706
+ # A custom service endpoint, as a hostname or hostname:port. The default is
707
+ # nil, indicating to use the default endpoint in the current universe domain.
708
+ # @return [::String,nil]
693
709
  # @!attribute [rw] credentials
694
710
  # Credentials to send with calls. You may provide any of the following types:
695
711
  # * (`String`) The path to a service account key file in JSON format
@@ -735,13 +751,20 @@ module Google
735
751
  # @!attribute [rw] quota_project
736
752
  # A separate project against which to charge quota.
737
753
  # @return [::String]
754
+ # @!attribute [rw] universe_domain
755
+ # The universe domain within which to make requests. This determines the
756
+ # default endpoint URL. The default value of nil uses the environment
757
+ # universe (usually the default "googleapis.com" universe).
758
+ # @return [::String,nil]
738
759
  #
739
760
  class Configuration
740
761
  extend ::Gapic::Config
741
762
 
763
+ # @private
764
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
742
765
  DEFAULT_ENDPOINT = "dataproc.googleapis.com"
743
766
 
744
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
767
+ config_attr :endpoint, nil, ::String, nil
745
768
  config_attr :credentials, nil do |value|
746
769
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
747
770
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -756,6 +779,7 @@ module Google
756
779
  config_attr :metadata, nil, ::Hash, nil
757
780
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
758
781
  config_attr :quota_project, nil, ::String, nil
782
+ config_attr :universe_domain, nil, ::String, nil
759
783
 
760
784
  # @private
761
785
  def initialize parent_config = nil
@@ -34,6 +34,9 @@ module Google
34
34
  # Dataproc API.
35
35
  #
36
36
  class Client
37
+ # @private
38
+ DEFAULT_ENDPOINT_TEMPLATE = "dataproc.$UNIVERSE_DOMAIN$"
39
+
37
40
  include Paths
38
41
 
39
42
  # @private
@@ -113,6 +116,15 @@ module Google
113
116
  @config
114
117
  end
115
118
 
119
+ ##
120
+ # The effective universe domain
121
+ #
122
+ # @return [String]
123
+ #
124
+ def universe_domain
125
+ @autoscaling_policy_service_stub.universe_domain
126
+ end
127
+
116
128
  ##
117
129
  # Create a new AutoscalingPolicyService REST client object.
118
130
  #
@@ -140,8 +152,9 @@ module Google
140
152
  credentials = @config.credentials
141
153
  # Use self-signed JWT if the endpoint is unchanged from default,
142
154
  # but only if the default endpoint does not have a region prefix.
143
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
144
- !@config.endpoint.split(".").first.include?("-")
155
+ enable_self_signed_jwt = @config.endpoint.nil? ||
156
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
157
+ !@config.endpoint.split(".").first.include?("-"))
145
158
  credentials ||= Credentials.default scope: @config.scope,
146
159
  enable_self_signed_jwt: enable_self_signed_jwt
147
160
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -155,10 +168,16 @@ module Google
155
168
  config.credentials = credentials
156
169
  config.quota_project = @quota_project_id
157
170
  config.endpoint = @config.endpoint
171
+ config.universe_domain = @config.universe_domain
158
172
  config.bindings_override = @config.bindings_override
159
173
  end
160
174
 
161
- @autoscaling_policy_service_stub = ::Google::Cloud::Dataproc::V1::AutoscalingPolicyService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
175
+ @autoscaling_policy_service_stub = ::Google::Cloud::Dataproc::V1::AutoscalingPolicyService::Rest::ServiceStub.new(
176
+ endpoint: @config.endpoint,
177
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
178
+ universe_domain: @config.universe_domain,
179
+ credentials: credentials
180
+ )
162
181
  end
163
182
 
164
183
  ##
@@ -643,9 +662,9 @@ module Google
643
662
  # end
644
663
  #
645
664
  # @!attribute [rw] endpoint
646
- # The hostname or hostname:port of the service endpoint.
647
- # Defaults to `"dataproc.googleapis.com"`.
648
- # @return [::String]
665
+ # A custom service endpoint, as a hostname or hostname:port. The default is
666
+ # nil, indicating to use the default endpoint in the current universe domain.
667
+ # @return [::String,nil]
649
668
  # @!attribute [rw] credentials
650
669
  # Credentials to send with calls. You may provide any of the following types:
651
670
  # * (`String`) The path to a service account key file in JSON format
@@ -682,13 +701,20 @@ module Google
682
701
  # @!attribute [rw] quota_project
683
702
  # A separate project against which to charge quota.
684
703
  # @return [::String]
704
+ # @!attribute [rw] universe_domain
705
+ # The universe domain within which to make requests. This determines the
706
+ # default endpoint URL. The default value of nil uses the environment
707
+ # universe (usually the default "googleapis.com" universe).
708
+ # @return [::String,nil]
685
709
  #
686
710
  class Configuration
687
711
  extend ::Gapic::Config
688
712
 
713
+ # @private
714
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
689
715
  DEFAULT_ENDPOINT = "dataproc.googleapis.com"
690
716
 
691
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
717
+ config_attr :endpoint, nil, ::String, nil
692
718
  config_attr :credentials, nil do |value|
693
719
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
694
720
  allowed.any? { |klass| klass === value }
@@ -700,6 +726,7 @@ module Google
700
726
  config_attr :metadata, nil, ::Hash, nil
701
727
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
702
728
  config_attr :quota_project, nil, ::String, nil
729
+ config_attr :universe_domain, nil, ::String, nil
703
730
 
704
731
  # @private
705
732
  # 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_autoscaling_policy REST call
45
57
  #
@@ -31,6 +31,9 @@ module Google
31
31
  # The BatchController provides methods to manage batch workloads.
32
32
  #
33
33
  class Client
34
+ # @private
35
+ DEFAULT_ENDPOINT_TEMPLATE = "dataproc.$UNIVERSE_DOMAIN$"
36
+
34
37
  include Paths
35
38
 
36
39
  # @private
@@ -91,6 +94,15 @@ module Google
91
94
  @config
92
95
  end
93
96
 
97
+ ##
98
+ # The effective universe domain
99
+ #
100
+ # @return [String]
101
+ #
102
+ def universe_domain
103
+ @batch_controller_stub.universe_domain
104
+ end
105
+
94
106
  ##
95
107
  # Create a new BatchController client object.
96
108
  #
@@ -124,8 +136,9 @@ module Google
124
136
  credentials = @config.credentials
125
137
  # Use self-signed JWT if the endpoint is unchanged from default,
126
138
  # but only if the default endpoint does not have a region prefix.
127
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
128
- !@config.endpoint.split(".").first.include?("-")
139
+ enable_self_signed_jwt = @config.endpoint.nil? ||
140
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
141
+ !@config.endpoint.split(".").first.include?("-"))
129
142
  credentials ||= Credentials.default scope: @config.scope,
130
143
  enable_self_signed_jwt: enable_self_signed_jwt
131
144
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -138,18 +151,22 @@ module Google
138
151
  config.credentials = credentials
139
152
  config.quota_project = @quota_project_id
140
153
  config.endpoint = @config.endpoint
154
+ config.universe_domain = @config.universe_domain
141
155
  end
142
156
 
143
157
  @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
144
158
  config.credentials = credentials
145
159
  config.quota_project = @quota_project_id
146
160
  config.endpoint = @config.endpoint
161
+ config.universe_domain = @config.universe_domain
147
162
  end
148
163
 
149
164
  @batch_controller_stub = ::Gapic::ServiceStub.new(
150
165
  ::Google::Cloud::Dataproc::V1::BatchController::Stub,
151
- credentials: credentials,
152
- endpoint: @config.endpoint,
166
+ credentials: credentials,
167
+ endpoint: @config.endpoint,
168
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
169
+ universe_domain: @config.universe_domain,
153
170
  channel_args: @config.channel_args,
154
171
  interceptors: @config.interceptors,
155
172
  channel_pool_config: @config.channel_pool
@@ -607,9 +624,9 @@ module Google
607
624
  # end
608
625
  #
609
626
  # @!attribute [rw] endpoint
610
- # The hostname or hostname:port of the service endpoint.
611
- # Defaults to `"dataproc.googleapis.com"`.
612
- # @return [::String]
627
+ # A custom service endpoint, as a hostname or hostname:port. The default is
628
+ # nil, indicating to use the default endpoint in the current universe domain.
629
+ # @return [::String,nil]
613
630
  # @!attribute [rw] credentials
614
631
  # Credentials to send with calls. You may provide any of the following types:
615
632
  # * (`String`) The path to a service account key file in JSON format
@@ -655,13 +672,20 @@ module Google
655
672
  # @!attribute [rw] quota_project
656
673
  # A separate project against which to charge quota.
657
674
  # @return [::String]
675
+ # @!attribute [rw] universe_domain
676
+ # The universe domain within which to make requests. This determines the
677
+ # default endpoint URL. The default value of nil uses the environment
678
+ # universe (usually the default "googleapis.com" universe).
679
+ # @return [::String,nil]
658
680
  #
659
681
  class Configuration
660
682
  extend ::Gapic::Config
661
683
 
684
+ # @private
685
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
662
686
  DEFAULT_ENDPOINT = "dataproc.googleapis.com"
663
687
 
664
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
688
+ config_attr :endpoint, nil, ::String, nil
665
689
  config_attr :credentials, nil do |value|
666
690
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
667
691
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -676,6 +700,7 @@ module Google
676
700
  config_attr :metadata, nil, ::Hash, nil
677
701
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
678
702
  config_attr :quota_project, nil, ::String, nil
703
+ config_attr :universe_domain, nil, ::String, nil
679
704
 
680
705
  # @private
681
706
  def initialize parent_config = nil
@@ -26,6 +26,9 @@ module Google
26
26
  module BatchController
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "dataproc.$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 `"dataproc.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 = "dataproc.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