google-cloud-dataflow 0.2.0 → 0.4.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (6) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -101
  3. data/README.md +1 -27
  4. data/lib/google/cloud/dataflow/version.rb +1 -1
  5. data/lib/google/cloud/dataflow.rb +69 -44
  6. metadata +5 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6d44153b504241ac848163751168ce5c57790e9e8eb53609ac8dec9ba55c468f
4
- data.tar.gz: 6c7fd912b1d0b8b6e20f4cefa25e8220ae4a7a8a56d474fb501a476909c57402
3
+ metadata.gz: e0535b7d34fac4a76a75f4fd7f3bf54de11670eaef6366f0e08806522e0de192
4
+ data.tar.gz: 145a8d2665fa02e6df48a77209daaf5934db939ebc89bfcd359a5975bd10efcd
5
5
  SHA512:
6
- metadata.gz: b47dc87f50459ff6c0942cf76c2fd7fd824ad3fdc8a2d4d2010e30f1c707d4a37292c54f21ca35be9d079c8b3fb3e4ee79a756f92160e1349d4dad1b2f30e061
7
- data.tar.gz: e51f5aa8a66509a108ab4bc144e20e1a226dbba61873e2d5693bc1c4cbfb91804544039f5447d787e29c82a9f9cc3ba345866ceaaa0a891138294ef170187ae1
6
+ metadata.gz: d6b6e6f7c5803e6855452a9b6bfaa6a2bf69bb10fef6ee96f912ce516d5331b01b736cc377d213f84dca715a09f21ce45bd8ca3953817bb908f2bd14298aa3d7
7
+ data.tar.gz: 2309609746af937d7a76a912d35063467c25d3d9ad110907ed628f88e1b165dd095d85cd9e21fd29d10d7b17d69760369f8fd811df823a148263fb3509dd2c7c
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-dataflow 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 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"
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.snapshots
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-dataflow 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 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
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"
77
-
78
- ENV["DATAFLOW_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = Google::Cloud::Dataflow.snapshots
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"
90
58
 
91
59
  client = Google::Cloud::Dataflow.snapshots 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"
100
68
 
101
69
  Google::Cloud::Dataflow.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.snapshots
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 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
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"
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.
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.snapshots
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/README.md CHANGED
@@ -16,7 +16,7 @@ for this library, google-cloud-dataflow, to see the convenience methods for
16
16
  constructing client objects. Reference documentation for the client objects
17
17
  themselves can be found in the client library documentation for the versioned
18
18
  client gems:
19
- [google-cloud-dataflow-v1beta3](https://googleapis.dev/ruby/google-cloud-dataflow-v1beta3/latest).
19
+ [google-cloud-dataflow-v1beta3](https://cloud.google.com/ruby/docs/reference/google-cloud-dataflow-v1beta3/latest).
20
20
 
21
21
  See also the [Product Documentation](https://cloud.google.com/dataflow)
22
22
  for more usage information.
@@ -34,32 +34,6 @@ In order to use this library, you first need to go through the following steps:
34
34
  1. [Enable the API.](https://console.cloud.google.com/apis/library/dataflow.googleapis.com)
35
35
  1. {file:AUTHENTICATION.md Set up authentication.}
36
36
 
37
- ## Enabling Logging
38
-
39
- To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
40
- The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
41
- or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
42
- that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
43
- and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
44
-
45
- Configuring a Ruby stdlib logger:
46
-
47
- ```ruby
48
- require "logger"
49
-
50
- module MyLogger
51
- LOGGER = Logger.new $stderr, level: Logger::WARN
52
- def logger
53
- LOGGER
54
- end
55
- end
56
-
57
- # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
58
- module GRPC
59
- extend MyLogger
60
- end
61
- ```
62
-
63
37
  ## Supported Ruby Versions
64
38
 
65
39
  This library is supported on Ruby 2.6+.
data/lib/google/cloud/dataflow/version.rb CHANGED
@@ -20,7 +20,7 @@
20
20
  module Google
21
21
  module Cloud
22
22
  module Dataflow
23
- VERSION = "0.2.0"
23
+ VERSION = "0.4.0"
24
24
  end
25
25
  end
26
26
  end
data/lib/google/cloud/dataflow.rb CHANGED
@@ -29,7 +29,7 @@ require "google/cloud/config"
29
29
 
30
30
  # Set the default configuration
31
31
  ::Google::Cloud.configure.add_config! :dataflow do |config|
32
- config.add_field! :endpoint, "dataflow.googleapis.com", match: ::String
32
+ config.add_field! :endpoint, nil, match: ::String
33
33
  config.add_field! :credentials, nil, match: [::String, ::Hash, ::Google::Auth::Credentials]
34
34
  config.add_field! :scope, nil, match: [::Array, ::String]
35
35
  config.add_field! :lib_name, nil, match: ::String
@@ -39,6 +39,7 @@ require "google/cloud/config"
39
39
  config.add_field! :metadata, nil, match: ::Hash
40
40
  config.add_field! :retry_policy, nil, match: [::Hash, ::Proc]
41
41
  config.add_field! :quota_project, nil, match: ::String
42
+ config.add_field! :universe_domain, nil, match: ::String
42
43
  end
43
44
 
44
45
  module Google
@@ -48,12 +49,14 @@ module Google
48
49
  # Create a new client object for Snapshots.
49
50
  #
50
51
  # By default, this returns an instance of
51
- # [Google::Cloud::Dataflow::V1beta3::Snapshots::Client](https://googleapis.dev/ruby/google-cloud-dataflow-v1beta3/latest/Google/Cloud/Dataflow/V1beta3/Snapshots/Client.html)
52
- # for version V1beta3 of the API.
53
- # However, you can specify specify a different API version by passing it in the
52
+ # [Google::Cloud::Dataflow::V1beta3::Snapshots::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-dataflow-v1beta3/latest/Google-Cloud-Dataflow-V1beta3-Snapshots-Client)
53
+ # for a gRPC client for version V1beta3 of the API.
54
+ # However, you can specify a different API version by passing it in the
54
55
  # `version` parameter. If the Snapshots service is
55
56
  # supported by that API version, and the corresponding gem is available, the
56
57
  # appropriate versioned client will be returned.
58
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
59
+ # the `transport` parameter.
57
60
  #
58
61
  # ## About Snapshots
59
62
  #
@@ -61,29 +64,33 @@ module Google
61
64
  #
62
65
  # @param version [::String, ::Symbol] The API version to connect to. Optional.
63
66
  # Defaults to `:v1beta3`.
64
- # @return [Snapshots::Client] A client object for the specified version.
67
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
68
+ # @return [::Object] A client object for the specified version.
65
69
  #
66
- def self.snapshots version: :v1beta3, &block
70
+ def self.snapshots version: :v1beta3, transport: :grpc, &block
67
71
  require "google/cloud/dataflow/#{version.to_s.downcase}"
68
72
 
69
73
  package_name = Google::Cloud::Dataflow
70
74
  .constants
71
75
  .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
72
76
  .first
73
- package_module = Google::Cloud::Dataflow.const_get package_name
74
- package_module.const_get(:Snapshots).const_get(:Client).new(&block)
77
+ service_module = Google::Cloud::Dataflow.const_get(package_name).const_get(:Snapshots)
78
+ service_module = service_module.const_get(:Rest) if transport == :rest
79
+ service_module.const_get(:Client).new(&block)
75
80
  end
76
81
 
77
82
  ##
78
83
  # Create a new client object for Jobs.
79
84
  #
80
85
  # By default, this returns an instance of
81
- # [Google::Cloud::Dataflow::V1beta3::Jobs::Client](https://googleapis.dev/ruby/google-cloud-dataflow-v1beta3/latest/Google/Cloud/Dataflow/V1beta3/Jobs/Client.html)
82
- # for version V1beta3 of the API.
83
- # However, you can specify specify a different API version by passing it in the
86
+ # [Google::Cloud::Dataflow::V1beta3::Jobs::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-dataflow-v1beta3/latest/Google-Cloud-Dataflow-V1beta3-Jobs-Client)
87
+ # for a gRPC client for version V1beta3 of the API.
88
+ # However, you can specify a different API version by passing it in the
84
89
  # `version` parameter. If the Jobs service is
85
90
  # supported by that API version, and the corresponding gem is available, the
86
91
  # appropriate versioned client will be returned.
92
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
93
+ # the `transport` parameter.
87
94
  #
88
95
  # ## About Jobs
89
96
  #
@@ -92,29 +99,33 @@ module Google
92
99
  #
93
100
  # @param version [::String, ::Symbol] The API version to connect to. Optional.
94
101
  # Defaults to `:v1beta3`.
95
- # @return [Jobs::Client] A client object for the specified version.
102
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
103
+ # @return [::Object] A client object for the specified version.
96
104
  #
97
- def self.jobs version: :v1beta3, &block
105
+ def self.jobs version: :v1beta3, transport: :grpc, &block
98
106
  require "google/cloud/dataflow/#{version.to_s.downcase}"
99
107
 
100
108
  package_name = Google::Cloud::Dataflow
101
109
  .constants
102
110
  .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
103
111
  .first
104
- package_module = Google::Cloud::Dataflow.const_get package_name
105
- package_module.const_get(:Jobs).const_get(:Client).new(&block)
112
+ service_module = Google::Cloud::Dataflow.const_get(package_name).const_get(:Jobs)
113
+ service_module = service_module.const_get(:Rest) if transport == :rest
114
+ service_module.const_get(:Client).new(&block)
106
115
  end
107
116
 
108
117
  ##
109
118
  # Create a new client object for Messages.
110
119
  #
111
120
  # By default, this returns an instance of
112
- # [Google::Cloud::Dataflow::V1beta3::Messages::Client](https://googleapis.dev/ruby/google-cloud-dataflow-v1beta3/latest/Google/Cloud/Dataflow/V1beta3/Messages/Client.html)
113
- # for version V1beta3 of the API.
114
- # However, you can specify specify a different API version by passing it in the
121
+ # [Google::Cloud::Dataflow::V1beta3::Messages::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-dataflow-v1beta3/latest/Google-Cloud-Dataflow-V1beta3-Messages-Client)
122
+ # for a gRPC client for version V1beta3 of the API.
123
+ # However, you can specify a different API version by passing it in the
115
124
  # `version` parameter. If the Messages service is
116
125
  # supported by that API version, and the corresponding gem is available, the
117
126
  # appropriate versioned client will be returned.
127
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
128
+ # the `transport` parameter.
118
129
  #
119
130
  # ## About Messages
120
131
  #
@@ -123,29 +134,33 @@ module Google
123
134
  #
124
135
  # @param version [::String, ::Symbol] The API version to connect to. Optional.
125
136
  # Defaults to `:v1beta3`.
126
- # @return [Messages::Client] A client object for the specified version.
137
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
138
+ # @return [::Object] A client object for the specified version.
127
139
  #
128
- def self.messages version: :v1beta3, &block
140
+ def self.messages version: :v1beta3, transport: :grpc, &block
129
141
  require "google/cloud/dataflow/#{version.to_s.downcase}"
130
142
 
131
143
  package_name = Google::Cloud::Dataflow
132
144
  .constants
133
145
  .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
134
146
  .first
135
- package_module = Google::Cloud::Dataflow.const_get package_name
136
- package_module.const_get(:Messages).const_get(:Client).new(&block)
147
+ service_module = Google::Cloud::Dataflow.const_get(package_name).const_get(:Messages)
148
+ service_module = service_module.const_get(:Rest) if transport == :rest
149
+ service_module.const_get(:Client).new(&block)
137
150
  end
138
151
 
139
152
  ##
140
153
  # Create a new client object for Metrics.
141
154
  #
142
155
  # By default, this returns an instance of
143
- # [Google::Cloud::Dataflow::V1beta3::Metrics::Client](https://googleapis.dev/ruby/google-cloud-dataflow-v1beta3/latest/Google/Cloud/Dataflow/V1beta3/Metrics/Client.html)
144
- # for version V1beta3 of the API.
145
- # However, you can specify specify a different API version by passing it in the
156
+ # [Google::Cloud::Dataflow::V1beta3::Metrics::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-dataflow-v1beta3/latest/Google-Cloud-Dataflow-V1beta3-Metrics-Client)
157
+ # for a gRPC client for version V1beta3 of the API.
158
+ # However, you can specify a different API version by passing it in the
146
159
  # `version` parameter. If the Metrics service is
147
160
  # supported by that API version, and the corresponding gem is available, the
148
161
  # appropriate versioned client will be returned.
162
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
163
+ # the `transport` parameter.
149
164
  #
150
165
  # ## About Metrics
151
166
  #
@@ -154,29 +169,33 @@ module Google
154
169
  #
155
170
  # @param version [::String, ::Symbol] The API version to connect to. Optional.
156
171
  # Defaults to `:v1beta3`.
157
- # @return [Metrics::Client] A client object for the specified version.
172
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
173
+ # @return [::Object] A client object for the specified version.
158
174
  #
159
- def self.metrics version: :v1beta3, &block
175
+ def self.metrics version: :v1beta3, transport: :grpc, &block
160
176
  require "google/cloud/dataflow/#{version.to_s.downcase}"
161
177
 
162
178
  package_name = Google::Cloud::Dataflow
163
179
  .constants
164
180
  .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
165
181
  .first
166
- package_module = Google::Cloud::Dataflow.const_get package_name
167
- package_module.const_get(:Metrics).const_get(:Client).new(&block)
182
+ service_module = Google::Cloud::Dataflow.const_get(package_name).const_get(:Metrics)
183
+ service_module = service_module.const_get(:Rest) if transport == :rest
184
+ service_module.const_get(:Client).new(&block)
168
185
  end
169
186
 
170
187
  ##
171
188
  # Create a new client object for TemplatesService.
172
189
  #
173
190
  # By default, this returns an instance of
174
- # [Google::Cloud::Dataflow::V1beta3::TemplatesService::Client](https://googleapis.dev/ruby/google-cloud-dataflow-v1beta3/latest/Google/Cloud/Dataflow/V1beta3/TemplatesService/Client.html)
175
- # for version V1beta3 of the API.
176
- # However, you can specify specify a different API version by passing it in the
191
+ # [Google::Cloud::Dataflow::V1beta3::TemplatesService::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-dataflow-v1beta3/latest/Google-Cloud-Dataflow-V1beta3-TemplatesService-Client)
192
+ # for a gRPC client for version V1beta3 of the API.
193
+ # However, you can specify a different API version by passing it in the
177
194
  # `version` parameter. If the TemplatesService service is
178
195
  # supported by that API version, and the corresponding gem is available, the
179
196
  # appropriate versioned client will be returned.
197
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
198
+ # the `transport` parameter.
180
199
  #
181
200
  # ## About TemplatesService
182
201
  #
@@ -184,29 +203,33 @@ module Google
184
203
  #
185
204
  # @param version [::String, ::Symbol] The API version to connect to. Optional.
186
205
  # Defaults to `:v1beta3`.
187
- # @return [TemplatesService::Client] A client object for the specified version.
206
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
207
+ # @return [::Object] A client object for the specified version.
188
208
  #
189
- def self.templates_service version: :v1beta3, &block
209
+ def self.templates_service version: :v1beta3, transport: :grpc, &block
190
210
  require "google/cloud/dataflow/#{version.to_s.downcase}"
191
211
 
192
212
  package_name = Google::Cloud::Dataflow
193
213
  .constants
194
214
  .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
195
215
  .first
196
- package_module = Google::Cloud::Dataflow.const_get package_name
197
- package_module.const_get(:TemplatesService).const_get(:Client).new(&block)
216
+ service_module = Google::Cloud::Dataflow.const_get(package_name).const_get(:TemplatesService)
217
+ service_module = service_module.const_get(:Rest) if transport == :rest
218
+ service_module.const_get(:Client).new(&block)
198
219
  end
199
220
 
200
221
  ##
201
222
  # Create a new client object for FlexTemplatesService.
202
223
  #
203
224
  # By default, this returns an instance of
204
- # [Google::Cloud::Dataflow::V1beta3::FlexTemplatesService::Client](https://googleapis.dev/ruby/google-cloud-dataflow-v1beta3/latest/Google/Cloud/Dataflow/V1beta3/FlexTemplatesService/Client.html)
205
- # for version V1beta3 of the API.
206
- # However, you can specify specify a different API version by passing it in the
225
+ # [Google::Cloud::Dataflow::V1beta3::FlexTemplatesService::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-dataflow-v1beta3/latest/Google-Cloud-Dataflow-V1beta3-FlexTemplatesService-Client)
226
+ # for a gRPC client for version V1beta3 of the API.
227
+ # However, you can specify a different API version by passing it in the
207
228
  # `version` parameter. If the FlexTemplatesService service is
208
229
  # supported by that API version, and the corresponding gem is available, the
209
230
  # appropriate versioned client will be returned.
231
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
232
+ # the `transport` parameter.
210
233
  #
211
234
  # ## About FlexTemplatesService
212
235
  #
@@ -214,17 +237,19 @@ module Google
214
237
  #
215
238
  # @param version [::String, ::Symbol] The API version to connect to. Optional.
216
239
  # Defaults to `:v1beta3`.
217
- # @return [FlexTemplatesService::Client] A client object for the specified version.
240
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
241
+ # @return [::Object] A client object for the specified version.
218
242
  #
219
- def self.flex_templates_service version: :v1beta3, &block
243
+ def self.flex_templates_service version: :v1beta3, transport: :grpc, &block
220
244
  require "google/cloud/dataflow/#{version.to_s.downcase}"
221
245
 
222
246
  package_name = Google::Cloud::Dataflow
223
247
  .constants
224
248
  .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
225
249
  .first
226
- package_module = Google::Cloud::Dataflow.const_get package_name
227
- package_module.const_get(:FlexTemplatesService).const_get(:Client).new(&block)
250
+ service_module = Google::Cloud::Dataflow.const_get(package_name).const_get(:FlexTemplatesService)
251
+ service_module = service_module.const_get(:Rest) if transport == :rest
252
+ service_module.const_get(:Client).new(&block)
228
253
  end
229
254
 
230
255
  ##
@@ -244,7 +269,7 @@ module Google
244
269
  # * `timeout` (*type:* `Numeric`) -
245
270
  # Default timeout in seconds.
246
271
  # * `metadata` (*type:* `Hash{Symbol=>String}`) -
247
- # Additional gRPC headers to be sent with the call.
272
+ # Additional headers to be sent with the call.
248
273
  # * `retry_policy` (*type:* `Hash`) -
249
274
  # The retry policy. The value is a hash with the following keys:
250
275
  # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-dataflow
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.0
4
+ version: 0.4.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-07-02 00:00:00.000000000 Z
11
+ date: 2024-01-15 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-cloud-core
@@ -30,7 +30,7 @@ dependencies:
30
30
  requirements:
31
31
  - - ">="
32
32
  - !ruby/object:Gem::Version
33
- version: '0.0'
33
+ version: '0.8'
34
34
  - - "<"
35
35
  - !ruby/object:Gem::Version
36
36
  version: 2.a
@@ -40,7 +40,7 @@ dependencies:
40
40
  requirements:
41
41
  - - ">="
42
42
  - !ruby/object:Gem::Version
43
- version: '0.0'
43
+ version: '0.8'
44
44
  - - "<"
45
45
  - !ruby/object:Gem::Version
46
46
  version: 2.a
@@ -189,7 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
189
189
  - !ruby/object:Gem::Version
190
190
  version: '0'
191
191
  requirements: []
192
- rubygems_version: 3.3.14
192
+ rubygems_version: 3.5.3
193
193
  signing_key:
194
194
  specification_version: 4
195
195
  summary: API Client library for the Dataflow API