google-cloud-dataflow-v1beta3 0.7.0 → 0.8.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (25) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -101
  3. data/lib/google/cloud/dataflow/v1beta3/flex_templates_service/client.rb +31 -8
  4. data/lib/google/cloud/dataflow/v1beta3/flex_templates_service/rest/client.rb +33 -7
  5. data/lib/google/cloud/dataflow/v1beta3/flex_templates_service/rest/service_stub.rb +14 -2
  6. data/lib/google/cloud/dataflow/v1beta3/jobs/client.rb +31 -8
  7. data/lib/google/cloud/dataflow/v1beta3/jobs/rest/client.rb +33 -7
  8. data/lib/google/cloud/dataflow/v1beta3/jobs/rest/service_stub.rb +14 -2
  9. data/lib/google/cloud/dataflow/v1beta3/messages/client.rb +31 -8
  10. data/lib/google/cloud/dataflow/v1beta3/messages/rest/client.rb +33 -7
  11. data/lib/google/cloud/dataflow/v1beta3/messages/rest/service_stub.rb +14 -2
  12. data/lib/google/cloud/dataflow/v1beta3/metrics/client.rb +31 -8
  13. data/lib/google/cloud/dataflow/v1beta3/metrics/rest/client.rb +33 -7
  14. data/lib/google/cloud/dataflow/v1beta3/metrics/rest/service_stub.rb +14 -2
  15. data/lib/google/cloud/dataflow/v1beta3/snapshots/client.rb +31 -8
  16. data/lib/google/cloud/dataflow/v1beta3/snapshots/rest/client.rb +33 -7
  17. data/lib/google/cloud/dataflow/v1beta3/snapshots/rest/service_stub.rb +14 -2
  18. data/lib/google/cloud/dataflow/v1beta3/templates_service/client.rb +31 -8
  19. data/lib/google/cloud/dataflow/v1beta3/templates_service/rest/client.rb +33 -7
  20. data/lib/google/cloud/dataflow/v1beta3/templates_service/rest/service_stub.rb +14 -2
  21. data/lib/google/cloud/dataflow/v1beta3/version.rb +1 -1
  22. data/proto_docs/google/api/client.rb +14 -0
  23. data/proto_docs/google/dataflow/v1beta3/jobs.rb +1 -0
  24. data/proto_docs/google/dataflow/v1beta3/streaming.rb +1 -0
  25. metadata +5 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: aac45754ceeb7b28c97bb2316ecc1641170275974260f79e17a2c881b4f5e4b2
4
- data.tar.gz: 58c6b4c7b1081e04d740087ae215017ec59fde042e2e0eff963e7fdcc2b33699
3
+ metadata.gz: 89ba13402bde37f8199605e37a7786494e336db965599cbf7f283a3474b8aa16
4
+ data.tar.gz: 975ae0779f8bd7a979f2c6558f073de0d4100452b5b4610d8c81ea7c98973e9a
5
5
  SHA512:
6
- metadata.gz: c278af553319fea37823484ec531529c49b4087fb73865d4614447d4016db27dcfa3366ecb2127b8f9b71d01ab795b937147736fd422e1ae0898e4c93713f7e9
7
- data.tar.gz: ebec15a0de7022b7e946142c1fc49d319504ef7fc4afd7209f30faa9b4241dd20a7475391282eb9f5294de7d20c44de1afa2980ea5e3f28319b962c91e13f78a
6
+ metadata.gz: fb65f780053358952bf2d7bad75df2e1518539f5dcb7f700eae1d949820f613c62140349d74453970c6fef9c5df3d53252f1ff0af73e3ca19b658e3e04c0016b
7
+ data.tar.gz: 0c2ede8fe46b84cf208e41597db97d58746345fe1e751c98c2d139a1cc37e0cd36fb9382d059fb8ef81a65554a23000e8aa8500c25e74646342415e922d6bed0
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-dataflow-v1beta3 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-dataflow-v1beta3 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 DATAFLOW_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/dataflow/v1beta3"
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::Dataflow::V1beta3::Snapshots::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-dataflow-v1beta3 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-dataflow-v1beta3 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-dataflow-v1beta3
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::Dataflow::V1beta3::Snapshots::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `DATAFLOW_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `DATAFLOW_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/dataflow/v1beta3"
77
-
78
- ENV["DATAFLOW_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::Dataflow::V1beta3::Snapshots::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/dataflow/v1beta3"
90
58
 
91
59
  client = ::Google::Cloud::Dataflow::V1beta3::Snapshots::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/dataflow/v1beta3"
100
68
 
101
69
  ::Google::Cloud::Dataflow::V1beta3::Snapshots::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::Dataflow::V1beta3::Snapshots::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-dataflow-v1beta3
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/dataflow/v1beta3"
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-dataflow-v1beta3.
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::Dataflow::V1beta3::Snapshots::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).
data/lib/google/cloud/dataflow/v1beta3/flex_templates_service/client.rb CHANGED
@@ -30,6 +30,9 @@ module Google
30
30
  # Provides a service for Flex templates. This feature is not ready yet.
31
31
  #
32
32
  class Client
33
+ # @private
34
+ DEFAULT_ENDPOINT_TEMPLATE = "dataflow.$UNIVERSE_DOMAIN$"
35
+
33
36
  # @private
34
37
  attr_reader :flex_templates_service_stub
35
38
 
@@ -88,6 +91,15 @@ module Google
88
91
  @config
89
92
  end
90
93
 
94
+ ##
95
+ # The effective universe domain
96
+ #
97
+ # @return [String]
98
+ #
99
+ def universe_domain
100
+ @flex_templates_service_stub.universe_domain
101
+ end
102
+
91
103
  ##
92
104
  # Create a new FlexTemplatesService client object.
93
105
  #
@@ -121,8 +133,9 @@ module Google
121
133
  credentials = @config.credentials
122
134
  # Use self-signed JWT if the endpoint is unchanged from default,
123
135
  # but only if the default endpoint does not have a region prefix.
124
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
125
- !@config.endpoint.split(".").first.include?("-")
136
+ enable_self_signed_jwt = @config.endpoint.nil? ||
137
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
138
+ !@config.endpoint.split(".").first.include?("-"))
126
139
  credentials ||= Credentials.default scope: @config.scope,
127
140
  enable_self_signed_jwt: enable_self_signed_jwt
128
141
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -133,8 +146,10 @@ module Google
133
146
 
134
147
  @flex_templates_service_stub = ::Gapic::ServiceStub.new(
135
148
  ::Google::Cloud::Dataflow::V1beta3::FlexTemplatesService::Stub,
136
- credentials: credentials,
137
- endpoint: @config.endpoint,
149
+ credentials: credentials,
150
+ endpoint: @config.endpoint,
151
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
152
+ universe_domain: @config.universe_domain,
138
153
  channel_args: @config.channel_args,
139
154
  interceptors: @config.interceptors,
140
155
  channel_pool_config: @config.channel_pool
@@ -270,9 +285,9 @@ module Google
270
285
  # end
271
286
  #
272
287
  # @!attribute [rw] endpoint
273
- # The hostname or hostname:port of the service endpoint.
274
- # Defaults to `"dataflow.googleapis.com"`.
275
- # @return [::String]
288
+ # A custom service endpoint, as a hostname or hostname:port. The default is
289
+ # nil, indicating to use the default endpoint in the current universe domain.
290
+ # @return [::String,nil]
276
291
  # @!attribute [rw] credentials
277
292
  # Credentials to send with calls. You may provide any of the following types:
278
293
  # * (`String`) The path to a service account key file in JSON format
@@ -318,13 +333,20 @@ module Google
318
333
  # @!attribute [rw] quota_project
319
334
  # A separate project against which to charge quota.
320
335
  # @return [::String]
336
+ # @!attribute [rw] universe_domain
337
+ # The universe domain within which to make requests. This determines the
338
+ # default endpoint URL. The default value of nil uses the environment
339
+ # universe (usually the default "googleapis.com" universe).
340
+ # @return [::String,nil]
321
341
  #
322
342
  class Configuration
323
343
  extend ::Gapic::Config
324
344
 
345
+ # @private
346
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
325
347
  DEFAULT_ENDPOINT = "dataflow.googleapis.com"
326
348
 
327
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
349
+ config_attr :endpoint, nil, ::String, nil
328
350
  config_attr :credentials, nil do |value|
329
351
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
330
352
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -339,6 +361,7 @@ module Google
339
361
  config_attr :metadata, nil, ::Hash, nil
340
362
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
341
363
  config_attr :quota_project, nil, ::String, nil
364
+ config_attr :universe_domain, nil, ::String, nil
342
365
 
343
366
  # @private
344
367
  def initialize parent_config = nil
data/lib/google/cloud/dataflow/v1beta3/flex_templates_service/rest/client.rb CHANGED
@@ -32,6 +32,9 @@ module Google
32
32
  # Provides a service for Flex templates. This feature is not ready yet.
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "dataflow.$UNIVERSE_DOMAIN$"
37
+
35
38
  # @private
36
39
  attr_reader :flex_templates_service_stub
37
40
 
@@ -90,6 +93,15 @@ module Google
90
93
  @config
91
94
  end
92
95
 
96
+ ##
97
+ # The effective universe domain
98
+ #
99
+ # @return [String]
100
+ #
101
+ def universe_domain
102
+ @flex_templates_service_stub.universe_domain
103
+ end
104
+
93
105
  ##
94
106
  # Create a new FlexTemplatesService REST client object.
95
107
  #
@@ -117,8 +129,9 @@ module Google
117
129
  credentials = @config.credentials
118
130
  # Use self-signed JWT if the endpoint is unchanged from default,
119
131
  # but only if the default endpoint does not have a region prefix.
120
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
121
- !@config.endpoint.split(".").first.include?("-")
132
+ enable_self_signed_jwt = @config.endpoint.nil? ||
133
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
134
+ !@config.endpoint.split(".").first.include?("-"))
122
135
  credentials ||= Credentials.default scope: @config.scope,
123
136
  enable_self_signed_jwt: enable_self_signed_jwt
124
137
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -128,7 +141,12 @@ module Google
128
141
  @quota_project_id = @config.quota_project
129
142
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
130
143
 
131
- @flex_templates_service_stub = ::Google::Cloud::Dataflow::V1beta3::FlexTemplatesService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
144
+ @flex_templates_service_stub = ::Google::Cloud::Dataflow::V1beta3::FlexTemplatesService::Rest::ServiceStub.new(
145
+ endpoint: @config.endpoint,
146
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
147
+ universe_domain: @config.universe_domain,
148
+ credentials: credentials
149
+ )
132
150
  end
133
151
 
134
152
  # Service calls
@@ -250,9 +268,9 @@ module Google
250
268
  # end
251
269
  #
252
270
  # @!attribute [rw] endpoint
253
- # The hostname or hostname:port of the service endpoint.
254
- # Defaults to `"dataflow.googleapis.com"`.
255
- # @return [::String]
271
+ # A custom service endpoint, as a hostname or hostname:port. The default is
272
+ # nil, indicating to use the default endpoint in the current universe domain.
273
+ # @return [::String,nil]
256
274
  # @!attribute [rw] credentials
257
275
  # Credentials to send with calls. You may provide any of the following types:
258
276
  # * (`String`) The path to a service account key file in JSON format
@@ -289,13 +307,20 @@ module Google
289
307
  # @!attribute [rw] quota_project
290
308
  # A separate project against which to charge quota.
291
309
  # @return [::String]
310
+ # @!attribute [rw] universe_domain
311
+ # The universe domain within which to make requests. This determines the
312
+ # default endpoint URL. The default value of nil uses the environment
313
+ # universe (usually the default "googleapis.com" universe).
314
+ # @return [::String,nil]
292
315
  #
293
316
  class Configuration
294
317
  extend ::Gapic::Config
295
318
 
319
+ # @private
320
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
296
321
  DEFAULT_ENDPOINT = "dataflow.googleapis.com"
297
322
 
298
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
323
+ config_attr :endpoint, nil, ::String, nil
299
324
  config_attr :credentials, nil do |value|
300
325
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
301
326
  allowed.any? { |klass| klass === value }
@@ -307,6 +332,7 @@ module Google
307
332
  config_attr :metadata, nil, ::Hash, nil
308
333
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
309
334
  config_attr :quota_project, nil, ::String, nil
335
+ config_attr :universe_domain, nil, ::String, nil
310
336
 
311
337
  # @private
312
338
  def initialize parent_config = nil
data/lib/google/cloud/dataflow/v1beta3/flex_templates_service/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: 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 launch_flex_template REST call
45
57
  #
data/lib/google/cloud/dataflow/v1beta3/jobs/client.rb CHANGED
@@ -31,6 +31,9 @@ module Google
31
31
  # A Job is a multi-stage computation graph run by the Cloud Dataflow service.
32
32
  #
33
33
  class Client
34
+ # @private
35
+ DEFAULT_ENDPOINT_TEMPLATE = "dataflow.$UNIVERSE_DOMAIN$"
36
+
34
37
  # @private
35
38
  attr_reader :jobs_stub
36
39
 
@@ -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
+ @jobs_stub.universe_domain
104
+ end
105
+
94
106
  ##
95
107
  # Create a new Jobs 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)
@@ -136,8 +149,10 @@ module Google
136
149
 
137
150
  @jobs_stub = ::Gapic::ServiceStub.new(
138
151
  ::Google::Cloud::Dataflow::V1beta3::JobsV1Beta3::Stub,
139
- credentials: credentials,
140
- endpoint: @config.endpoint,
152
+ credentials: credentials,
153
+ endpoint: @config.endpoint,
154
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
155
+ universe_domain: @config.universe_domain,
141
156
  channel_args: @config.channel_args,
142
157
  interceptors: @config.interceptors,
143
158
  channel_pool_config: @config.channel_pool
@@ -891,9 +906,9 @@ module Google
891
906
  # end
892
907
  #
893
908
  # @!attribute [rw] endpoint
894
- # The hostname or hostname:port of the service endpoint.
895
- # Defaults to `"dataflow.googleapis.com"`.
896
- # @return [::String]
909
+ # A custom service endpoint, as a hostname or hostname:port. The default is
910
+ # nil, indicating to use the default endpoint in the current universe domain.
911
+ # @return [::String,nil]
897
912
  # @!attribute [rw] credentials
898
913
  # Credentials to send with calls. You may provide any of the following types:
899
914
  # * (`String`) The path to a service account key file in JSON format
@@ -939,13 +954,20 @@ module Google
939
954
  # @!attribute [rw] quota_project
940
955
  # A separate project against which to charge quota.
941
956
  # @return [::String]
957
+ # @!attribute [rw] universe_domain
958
+ # The universe domain within which to make requests. This determines the
959
+ # default endpoint URL. The default value of nil uses the environment
960
+ # universe (usually the default "googleapis.com" universe).
961
+ # @return [::String,nil]
942
962
  #
943
963
  class Configuration
944
964
  extend ::Gapic::Config
945
965
 
966
+ # @private
967
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
946
968
  DEFAULT_ENDPOINT = "dataflow.googleapis.com"
947
969
 
948
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
970
+ config_attr :endpoint, nil, ::String, nil
949
971
  config_attr :credentials, nil do |value|
950
972
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
951
973
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -960,6 +982,7 @@ module Google
960
982
  config_attr :metadata, nil, ::Hash, nil
961
983
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
962
984
  config_attr :quota_project, nil, ::String, nil
985
+ config_attr :universe_domain, nil, ::String, nil
963
986
 
964
987
  # @private
965
988
  def initialize parent_config = nil
data/lib/google/cloud/dataflow/v1beta3/jobs/rest/client.rb CHANGED
@@ -33,6 +33,9 @@ module Google
33
33
  # A Job is a multi-stage computation graph run by the Cloud Dataflow service.
34
34
  #
35
35
  class Client
36
+ # @private
37
+ DEFAULT_ENDPOINT_TEMPLATE = "dataflow.$UNIVERSE_DOMAIN$"
38
+
36
39
  # @private
37
40
  attr_reader :jobs_stub
38
41
 
@@ -93,6 +96,15 @@ module Google
93
96
  @config
94
97
  end
95
98
 
99
+ ##
100
+ # The effective universe domain
101
+ #
102
+ # @return [String]
103
+ #
104
+ def universe_domain
105
+ @jobs_stub.universe_domain
106
+ end
107
+
96
108
  ##
97
109
  # Create a new Jobs REST client object.
98
110
  #
@@ -120,8 +132,9 @@ module Google
120
132
  credentials = @config.credentials
121
133
  # Use self-signed JWT if the endpoint is unchanged from default,
122
134
  # but only if the default endpoint does not have a region prefix.
123
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
124
- !@config.endpoint.split(".").first.include?("-")
135
+ enable_self_signed_jwt = @config.endpoint.nil? ||
136
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
137
+ !@config.endpoint.split(".").first.include?("-"))
125
138
  credentials ||= Credentials.default scope: @config.scope,
126
139
  enable_self_signed_jwt: enable_self_signed_jwt
127
140
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -131,7 +144,12 @@ module Google
131
144
  @quota_project_id = @config.quota_project
132
145
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
133
146
 
134
- @jobs_stub = ::Google::Cloud::Dataflow::V1beta3::Jobs::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
147
+ @jobs_stub = ::Google::Cloud::Dataflow::V1beta3::Jobs::Rest::ServiceStub.new(
148
+ endpoint: @config.endpoint,
149
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
150
+ universe_domain: @config.universe_domain,
151
+ credentials: credentials
152
+ )
135
153
  end
136
154
 
137
155
  # Service calls
@@ -736,9 +754,9 @@ module Google
736
754
  # end
737
755
  #
738
756
  # @!attribute [rw] endpoint
739
- # The hostname or hostname:port of the service endpoint.
740
- # Defaults to `"dataflow.googleapis.com"`.
741
- # @return [::String]
757
+ # A custom service endpoint, as a hostname or hostname:port. The default is
758
+ # nil, indicating to use the default endpoint in the current universe domain.
759
+ # @return [::String,nil]
742
760
  # @!attribute [rw] credentials
743
761
  # Credentials to send with calls. You may provide any of the following types:
744
762
  # * (`String`) The path to a service account key file in JSON format
@@ -775,13 +793,20 @@ module Google
775
793
  # @!attribute [rw] quota_project
776
794
  # A separate project against which to charge quota.
777
795
  # @return [::String]
796
+ # @!attribute [rw] universe_domain
797
+ # The universe domain within which to make requests. This determines the
798
+ # default endpoint URL. The default value of nil uses the environment
799
+ # universe (usually the default "googleapis.com" universe).
800
+ # @return [::String,nil]
778
801
  #
779
802
  class Configuration
780
803
  extend ::Gapic::Config
781
804
 
805
+ # @private
806
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
782
807
  DEFAULT_ENDPOINT = "dataflow.googleapis.com"
783
808
 
784
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
809
+ config_attr :endpoint, nil, ::String, nil
785
810
  config_attr :credentials, nil do |value|
786
811
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
787
812
  allowed.any? { |klass| klass === value }
@@ -793,6 +818,7 @@ module Google
793
818
  config_attr :metadata, nil, ::Hash, nil
794
819
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
795
820
  config_attr :quota_project, nil, ::String, nil
821
+ config_attr :universe_domain, nil, ::String, nil
796
822
 
797
823
  # @private
798
824
  def initialize parent_config = nil