google-apis-dataflow_v1b3 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,2091 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/core/base_service'
16
+ require 'google/apis/core/json_representation'
17
+ require 'google/apis/core/hashable'
18
+ require 'google/apis/errors'
19
+
20
+ module Google
21
+ module Apis
22
+ module DataflowV1b3
23
+ # Dataflow API
24
+ #
25
+ # Manages Google Cloud Dataflow projects on Google Cloud Platform.
26
+ #
27
+ # @example
28
+ # require 'google/apis/dataflow_v1b3'
29
+ #
30
+ # Dataflow = Google::Apis::DataflowV1b3 # Alias the module
31
+ # service = Dataflow::DataflowService.new
32
+ #
33
+ # @see https://cloud.google.com/dataflow
34
+ class DataflowService < Google::Apis::Core::BaseService
35
+ # @return [String]
36
+ # API key. Your API key identifies your project and provides you with API access,
37
+ # quota, and reports. Required unless you provide an OAuth 2.0 token.
38
+ attr_accessor :key
39
+
40
+ # @return [String]
41
+ # Available to use for quota purposes for server-side applications. Can be any
42
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
43
+ attr_accessor :quota_user
44
+
45
+ def initialize
46
+ super('https://dataflow.googleapis.com/', '',
47
+ client_name: 'google-apis-dataflow_v1b3',
48
+ client_version: Google::Apis::DataflowV1b3::GEM_VERSION)
49
+ @batch_path = 'batch'
50
+ end
51
+
52
+ # Deletes a snapshot.
53
+ # @param [String] project_id
54
+ # The ID of the Cloud Platform project that the snapshot belongs to.
55
+ # @param [String] location
56
+ # The location that contains this snapshot.
57
+ # @param [String] snapshot_id
58
+ # The ID of the snapshot.
59
+ # @param [String] fields
60
+ # Selector specifying which fields to include in a partial response.
61
+ # @param [String] quota_user
62
+ # Available to use for quota purposes for server-side applications. Can be any
63
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
64
+ # @param [Google::Apis::RequestOptions] options
65
+ # Request-specific options
66
+ #
67
+ # @yield [result, err] Result & error if block supplied
68
+ # @yieldparam result [Google::Apis::DataflowV1b3::DeleteSnapshotResponse] parsed result object
69
+ # @yieldparam err [StandardError] error object if request failed
70
+ #
71
+ # @return [Google::Apis::DataflowV1b3::DeleteSnapshotResponse]
72
+ #
73
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
74
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
75
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
76
+ def delete_project_snapshots(project_id, location: nil, snapshot_id: nil, fields: nil, quota_user: nil, options: nil, &block)
77
+ command = make_simple_command(:delete, 'v1b3/projects/{projectId}/snapshots', options)
78
+ command.response_representation = Google::Apis::DataflowV1b3::DeleteSnapshotResponse::Representation
79
+ command.response_class = Google::Apis::DataflowV1b3::DeleteSnapshotResponse
80
+ command.params['projectId'] = project_id unless project_id.nil?
81
+ command.query['location'] = location unless location.nil?
82
+ command.query['snapshotId'] = snapshot_id unless snapshot_id.nil?
83
+ command.query['fields'] = fields unless fields.nil?
84
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
85
+ execute_or_queue_command(command, &block)
86
+ end
87
+
88
+ # Send a worker_message to the service.
89
+ # @param [String] project_id
90
+ # The project to send the WorkerMessages to.
91
+ # @param [Google::Apis::DataflowV1b3::SendWorkerMessagesRequest] send_worker_messages_request_object
92
+ # @param [String] fields
93
+ # Selector specifying which fields to include in a partial response.
94
+ # @param [String] quota_user
95
+ # Available to use for quota purposes for server-side applications. Can be any
96
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
97
+ # @param [Google::Apis::RequestOptions] options
98
+ # Request-specific options
99
+ #
100
+ # @yield [result, err] Result & error if block supplied
101
+ # @yieldparam result [Google::Apis::DataflowV1b3::SendWorkerMessagesResponse] parsed result object
102
+ # @yieldparam err [StandardError] error object if request failed
103
+ #
104
+ # @return [Google::Apis::DataflowV1b3::SendWorkerMessagesResponse]
105
+ #
106
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
107
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
108
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
109
+ def worker_project_messages(project_id, send_worker_messages_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
110
+ command = make_simple_command(:post, 'v1b3/projects/{projectId}/WorkerMessages', options)
111
+ command.request_representation = Google::Apis::DataflowV1b3::SendWorkerMessagesRequest::Representation
112
+ command.request_object = send_worker_messages_request_object
113
+ command.response_representation = Google::Apis::DataflowV1b3::SendWorkerMessagesResponse::Representation
114
+ command.response_class = Google::Apis::DataflowV1b3::SendWorkerMessagesResponse
115
+ command.params['projectId'] = project_id unless project_id.nil?
116
+ command.query['fields'] = fields unless fields.nil?
117
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
118
+ execute_or_queue_command(command, &block)
119
+ end
120
+
121
+ # Creates a new TemplateVersion (Important: not new Template) entry in the
122
+ # spanner table. Requires project_id and display_name (template).
123
+ # @param [String] name
124
+ # The location of the template, name includes project_id and display_name.
125
+ # Commit using project_id(pid1) and display_name(tid1). Format: projects/`pid1`/
126
+ # catalogTemplates/`tid1`
127
+ # @param [Google::Apis::DataflowV1b3::CommitTemplateVersionRequest] commit_template_version_request_object
128
+ # @param [String] fields
129
+ # Selector specifying which fields to include in a partial response.
130
+ # @param [String] quota_user
131
+ # Available to use for quota purposes for server-side applications. Can be any
132
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
133
+ # @param [Google::Apis::RequestOptions] options
134
+ # Request-specific options
135
+ #
136
+ # @yield [result, err] Result & error if block supplied
137
+ # @yieldparam result [Google::Apis::DataflowV1b3::TemplateVersion] parsed result object
138
+ # @yieldparam err [StandardError] error object if request failed
139
+ #
140
+ # @return [Google::Apis::DataflowV1b3::TemplateVersion]
141
+ #
142
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
143
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
144
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
145
+ def commit_catalog_template_template_version(name, commit_template_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
146
+ command = make_simple_command(:post, 'v1b3/{+name}:commit', options)
147
+ command.request_representation = Google::Apis::DataflowV1b3::CommitTemplateVersionRequest::Representation
148
+ command.request_object = commit_template_version_request_object
149
+ command.response_representation = Google::Apis::DataflowV1b3::TemplateVersion::Representation
150
+ command.response_class = Google::Apis::DataflowV1b3::TemplateVersion
151
+ command.params['name'] = name unless name.nil?
152
+ command.query['fields'] = fields unless fields.nil?
153
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
154
+ execute_or_queue_command(command, &block)
155
+ end
156
+
157
+ # Deletes an existing Template. Do nothing if Template does not exist.
158
+ # @param [String] name
159
+ # name includes project_id and display_name. Delete by project_id(pid1) and
160
+ # display_name(tid1). Format: projects/`pid1`/catalogTemplates/`tid1`
161
+ # @param [String] fields
162
+ # Selector specifying which fields to include in a partial response.
163
+ # @param [String] quota_user
164
+ # Available to use for quota purposes for server-side applications. Can be any
165
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
166
+ # @param [Google::Apis::RequestOptions] options
167
+ # Request-specific options
168
+ #
169
+ # @yield [result, err] Result & error if block supplied
170
+ # @yieldparam result [Google::Apis::DataflowV1b3::Empty] parsed result object
171
+ # @yieldparam err [StandardError] error object if request failed
172
+ #
173
+ # @return [Google::Apis::DataflowV1b3::Empty]
174
+ #
175
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
176
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
177
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
178
+ def delete_project_catalog_template(name, fields: nil, quota_user: nil, options: nil, &block)
179
+ command = make_simple_command(:delete, 'v1b3/{+name}', options)
180
+ command.response_representation = Google::Apis::DataflowV1b3::Empty::Representation
181
+ command.response_class = Google::Apis::DataflowV1b3::Empty
182
+ command.params['name'] = name unless name.nil?
183
+ command.query['fields'] = fields unless fields.nil?
184
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
185
+ execute_or_queue_command(command, &block)
186
+ end
187
+
188
+ # Get TemplateVersion using project_id and display_name with an optional
189
+ # version_id field. Get latest (has tag "latest") TemplateVersion if version_id
190
+ # not set.
191
+ # @param [String] name
192
+ # Resource name includes project_id and display_name. version_id is optional.
193
+ # Get the latest TemplateVersion if version_id not set. Get by project_id(pid1)
194
+ # and display_name(tid1): Format: projects/`pid1`/catalogTemplates/`tid1` Get by
195
+ # project_id(pid1), display_name(tid1), and version_id(vid1): Format: projects/`
196
+ # pid1`/catalogTemplates/`tid1@vid`
197
+ # @param [String] fields
198
+ # Selector specifying which fields to include in a partial response.
199
+ # @param [String] quota_user
200
+ # Available to use for quota purposes for server-side applications. Can be any
201
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
202
+ # @param [Google::Apis::RequestOptions] options
203
+ # Request-specific options
204
+ #
205
+ # @yield [result, err] Result & error if block supplied
206
+ # @yieldparam result [Google::Apis::DataflowV1b3::TemplateVersion] parsed result object
207
+ # @yieldparam err [StandardError] error object if request failed
208
+ #
209
+ # @return [Google::Apis::DataflowV1b3::TemplateVersion]
210
+ #
211
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
212
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
213
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
214
+ def get_project_catalog_template(name, fields: nil, quota_user: nil, options: nil, &block)
215
+ command = make_simple_command(:get, 'v1b3/{+name}', options)
216
+ command.response_representation = Google::Apis::DataflowV1b3::TemplateVersion::Representation
217
+ command.response_class = Google::Apis::DataflowV1b3::TemplateVersion
218
+ command.params['name'] = name unless name.nil?
219
+ command.query['fields'] = fields unless fields.nil?
220
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
221
+ execute_or_queue_command(command, &block)
222
+ end
223
+
224
+ # Updates the label of the TemplateVersion. Label can be duplicated in Template,
225
+ # so either add or remove the label in the TemplateVersion.
226
+ # @param [String] name
227
+ # Resource name includes project_id, display_name, and version_id. Updates by
228
+ # project_id(pid1), display_name(tid1), and version_id(vid1): Format: projects/`
229
+ # pid1`/catalogTemplates/`tid1@vid`
230
+ # @param [Google::Apis::DataflowV1b3::ModifyTemplateVersionLabelRequest] modify_template_version_label_request_object
231
+ # @param [String] fields
232
+ # Selector specifying which fields to include in a partial response.
233
+ # @param [String] quota_user
234
+ # Available to use for quota purposes for server-side applications. Can be any
235
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
236
+ # @param [Google::Apis::RequestOptions] options
237
+ # Request-specific options
238
+ #
239
+ # @yield [result, err] Result & error if block supplied
240
+ # @yieldparam result [Google::Apis::DataflowV1b3::ModifyTemplateVersionLabelResponse] parsed result object
241
+ # @yieldparam err [StandardError] error object if request failed
242
+ #
243
+ # @return [Google::Apis::DataflowV1b3::ModifyTemplateVersionLabelResponse]
244
+ #
245
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
246
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
247
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
248
+ def label_project_catalog_template(name, modify_template_version_label_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
249
+ command = make_simple_command(:post, 'v1b3/{+name}:label', options)
250
+ command.request_representation = Google::Apis::DataflowV1b3::ModifyTemplateVersionLabelRequest::Representation
251
+ command.request_object = modify_template_version_label_request_object
252
+ command.response_representation = Google::Apis::DataflowV1b3::ModifyTemplateVersionLabelResponse::Representation
253
+ command.response_class = Google::Apis::DataflowV1b3::ModifyTemplateVersionLabelResponse
254
+ command.params['name'] = name unless name.nil?
255
+ command.query['fields'] = fields unless fields.nil?
256
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
257
+ execute_or_queue_command(command, &block)
258
+ end
259
+
260
+ # Updates the tag of the TemplateVersion, and tag is unique in Template. If tag
261
+ # exists in another TemplateVersion in the Template, updates the tag to this
262
+ # TemplateVersion will remove it from the old TemplateVersion and add it to this
263
+ # TemplateVersion. If request is remove_only (remove_only = true), remove the
264
+ # tag from this TemplateVersion.
265
+ # @param [String] name
266
+ # Resource name includes project_id, display_name, and version_id. Updates by
267
+ # project_id(pid1), display_name(tid1), and version_id(vid1): Format: projects/`
268
+ # pid1`/catalogTemplates/`tid1@vid`
269
+ # @param [Google::Apis::DataflowV1b3::ModifyTemplateVersionTagRequest] modify_template_version_tag_request_object
270
+ # @param [String] fields
271
+ # Selector specifying which fields to include in a partial response.
272
+ # @param [String] quota_user
273
+ # Available to use for quota purposes for server-side applications. Can be any
274
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
275
+ # @param [Google::Apis::RequestOptions] options
276
+ # Request-specific options
277
+ #
278
+ # @yield [result, err] Result & error if block supplied
279
+ # @yieldparam result [Google::Apis::DataflowV1b3::ModifyTemplateVersionTagResponse] parsed result object
280
+ # @yieldparam err [StandardError] error object if request failed
281
+ #
282
+ # @return [Google::Apis::DataflowV1b3::ModifyTemplateVersionTagResponse]
283
+ #
284
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
285
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
286
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
287
+ def tag_project_catalog_template(name, modify_template_version_tag_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
288
+ command = make_simple_command(:post, 'v1b3/{+name}:tag', options)
289
+ command.request_representation = Google::Apis::DataflowV1b3::ModifyTemplateVersionTagRequest::Representation
290
+ command.request_object = modify_template_version_tag_request_object
291
+ command.response_representation = Google::Apis::DataflowV1b3::ModifyTemplateVersionTagResponse::Representation
292
+ command.response_class = Google::Apis::DataflowV1b3::ModifyTemplateVersionTagResponse
293
+ command.params['name'] = name unless name.nil?
294
+ command.query['fields'] = fields unless fields.nil?
295
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
296
+ execute_or_queue_command(command, &block)
297
+ end
298
+
299
+ # Creates a new Template with TemplateVersion. Requires project_id(projects) and
300
+ # template display_name(catalogTemplates). The template display_name is set by
301
+ # the user.
302
+ # @param [String] parent
303
+ # The parent project and template that the TemplateVersion will be created under.
304
+ # Create using project_id(pid1) and display_name(tid1). Format: projects/`pid1`/
305
+ # catalogTemplates/`tid1`
306
+ # @param [Google::Apis::DataflowV1b3::CreateTemplateVersionRequest] create_template_version_request_object
307
+ # @param [String] fields
308
+ # Selector specifying which fields to include in a partial response.
309
+ # @param [String] quota_user
310
+ # Available to use for quota purposes for server-side applications. Can be any
311
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
312
+ # @param [Google::Apis::RequestOptions] options
313
+ # Request-specific options
314
+ #
315
+ # @yield [result, err] Result & error if block supplied
316
+ # @yieldparam result [Google::Apis::DataflowV1b3::TemplateVersion] parsed result object
317
+ # @yieldparam err [StandardError] error object if request failed
318
+ #
319
+ # @return [Google::Apis::DataflowV1b3::TemplateVersion]
320
+ #
321
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
322
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
323
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
324
+ def create_template_version(parent, create_template_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
325
+ command = make_simple_command(:post, 'v1b3/{+parent}/templateVersions', options)
326
+ command.request_representation = Google::Apis::DataflowV1b3::CreateTemplateVersionRequest::Representation
327
+ command.request_object = create_template_version_request_object
328
+ command.response_representation = Google::Apis::DataflowV1b3::TemplateVersion::Representation
329
+ command.response_class = Google::Apis::DataflowV1b3::TemplateVersion
330
+ command.params['parent'] = parent unless parent.nil?
331
+ command.query['fields'] = fields unless fields.nil?
332
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
333
+ execute_or_queue_command(command, &block)
334
+ end
335
+
336
+ # List the jobs of a project across all regions.
337
+ # @param [String] project_id
338
+ # The project which owns the jobs.
339
+ # @param [String] filter
340
+ # The kind of filter to use.
341
+ # @param [String] location
342
+ # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
343
+ # regional-endpoints) that contains this job.
344
+ # @param [Fixnum] page_size
345
+ # If there are many jobs, limit response to at most this many. The actual number
346
+ # of jobs returned will be the lesser of max_responses and an unspecified server-
347
+ # defined limit.
348
+ # @param [String] page_token
349
+ # Set this to the 'next_page_token' field of a previous response to request
350
+ # additional results in a long list.
351
+ # @param [String] view
352
+ # Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.
353
+ # @param [String] fields
354
+ # Selector specifying which fields to include in a partial response.
355
+ # @param [String] quota_user
356
+ # Available to use for quota purposes for server-side applications. Can be any
357
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
358
+ # @param [Google::Apis::RequestOptions] options
359
+ # Request-specific options
360
+ #
361
+ # @yield [result, err] Result & error if block supplied
362
+ # @yieldparam result [Google::Apis::DataflowV1b3::ListJobsResponse] parsed result object
363
+ # @yieldparam err [StandardError] error object if request failed
364
+ #
365
+ # @return [Google::Apis::DataflowV1b3::ListJobsResponse]
366
+ #
367
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
368
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
369
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
370
+ def aggregated_project_job(project_id, filter: nil, location: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
371
+ command = make_simple_command(:get, 'v1b3/projects/{projectId}/jobs:aggregated', options)
372
+ command.response_representation = Google::Apis::DataflowV1b3::ListJobsResponse::Representation
373
+ command.response_class = Google::Apis::DataflowV1b3::ListJobsResponse
374
+ command.params['projectId'] = project_id unless project_id.nil?
375
+ command.query['filter'] = filter unless filter.nil?
376
+ command.query['location'] = location unless location.nil?
377
+ command.query['pageSize'] = page_size unless page_size.nil?
378
+ command.query['pageToken'] = page_token unless page_token.nil?
379
+ command.query['view'] = view unless view.nil?
380
+ command.query['fields'] = fields unless fields.nil?
381
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
382
+ execute_or_queue_command(command, &block)
383
+ end
384
+
385
+ # Creates a Cloud Dataflow job. To create a job, we recommend using `projects.
386
+ # locations.jobs.create` with a [regional endpoint] (https://cloud.google.com/
387
+ # dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.create` is
388
+ # not recommended, as your job will always start in `us-central1`.
389
+ # @param [String] project_id
390
+ # The ID of the Cloud Platform project that the job belongs to.
391
+ # @param [Google::Apis::DataflowV1b3::Job] job_object
392
+ # @param [String] location
393
+ # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
394
+ # regional-endpoints) that contains this job.
395
+ # @param [String] replace_job_id
396
+ # Deprecated. This field is now in the Job message.
397
+ # @param [String] view
398
+ # The level of information requested in response.
399
+ # @param [String] fields
400
+ # Selector specifying which fields to include in a partial response.
401
+ # @param [String] quota_user
402
+ # Available to use for quota purposes for server-side applications. Can be any
403
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
404
+ # @param [Google::Apis::RequestOptions] options
405
+ # Request-specific options
406
+ #
407
+ # @yield [result, err] Result & error if block supplied
408
+ # @yieldparam result [Google::Apis::DataflowV1b3::Job] parsed result object
409
+ # @yieldparam err [StandardError] error object if request failed
410
+ #
411
+ # @return [Google::Apis::DataflowV1b3::Job]
412
+ #
413
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
414
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
415
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
416
+ def create_project_job(project_id, job_object = nil, location: nil, replace_job_id: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
417
+ command = make_simple_command(:post, 'v1b3/projects/{projectId}/jobs', options)
418
+ command.request_representation = Google::Apis::DataflowV1b3::Job::Representation
419
+ command.request_object = job_object
420
+ command.response_representation = Google::Apis::DataflowV1b3::Job::Representation
421
+ command.response_class = Google::Apis::DataflowV1b3::Job
422
+ command.params['projectId'] = project_id unless project_id.nil?
423
+ command.query['location'] = location unless location.nil?
424
+ command.query['replaceJobId'] = replace_job_id unless replace_job_id.nil?
425
+ command.query['view'] = view unless view.nil?
426
+ command.query['fields'] = fields unless fields.nil?
427
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
428
+ execute_or_queue_command(command, &block)
429
+ end
430
+
431
+ # Gets the state of the specified Cloud Dataflow job. To get the state of a job,
432
+ # we recommend using `projects.locations.jobs.get` with a [regional endpoint] (
433
+ # https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `
434
+ # projects.jobs.get` is not recommended, as you can only get the state of jobs
435
+ # that are running in `us-central1`.
436
+ # @param [String] project_id
437
+ # The ID of the Cloud Platform project that the job belongs to.
438
+ # @param [String] job_id
439
+ # The job ID.
440
+ # @param [String] location
441
+ # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
442
+ # regional-endpoints) that contains this job.
443
+ # @param [String] view
444
+ # The level of information requested in response.
445
+ # @param [String] fields
446
+ # Selector specifying which fields to include in a partial response.
447
+ # @param [String] quota_user
448
+ # Available to use for quota purposes for server-side applications. Can be any
449
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
450
+ # @param [Google::Apis::RequestOptions] options
451
+ # Request-specific options
452
+ #
453
+ # @yield [result, err] Result & error if block supplied
454
+ # @yieldparam result [Google::Apis::DataflowV1b3::Job] parsed result object
455
+ # @yieldparam err [StandardError] error object if request failed
456
+ #
457
+ # @return [Google::Apis::DataflowV1b3::Job]
458
+ #
459
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
460
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
461
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
462
+ def get_project_job(project_id, job_id, location: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
463
+ command = make_simple_command(:get, 'v1b3/projects/{projectId}/jobs/{jobId}', options)
464
+ command.response_representation = Google::Apis::DataflowV1b3::Job::Representation
465
+ command.response_class = Google::Apis::DataflowV1b3::Job
466
+ command.params['projectId'] = project_id unless project_id.nil?
467
+ command.params['jobId'] = job_id unless job_id.nil?
468
+ command.query['location'] = location unless location.nil?
469
+ command.query['view'] = view unless view.nil?
470
+ command.query['fields'] = fields unless fields.nil?
471
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
472
+ execute_or_queue_command(command, &block)
473
+ end
474
+
475
+ # Request the job status. To request the status of a job, we recommend using `
476
+ # projects.locations.jobs.getMetrics` with a [regional endpoint] (https://cloud.
477
+ # google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.
478
+ # getMetrics` is not recommended, as you can only request the status of jobs
479
+ # that are running in `us-central1`.
480
+ # @param [String] project_id
481
+ # A project id.
482
+ # @param [String] job_id
483
+ # The job to get metrics for.
484
+ # @param [String] location
485
+ # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
486
+ # regional-endpoints) that contains the job specified by job_id.
487
+ # @param [String] start_time
488
+ # Return only metric data that has changed since this time. Default is to return
489
+ # all information about all metrics for the job.
490
+ # @param [String] fields
491
+ # Selector specifying which fields to include in a partial response.
492
+ # @param [String] quota_user
493
+ # Available to use for quota purposes for server-side applications. Can be any
494
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
495
+ # @param [Google::Apis::RequestOptions] options
496
+ # Request-specific options
497
+ #
498
+ # @yield [result, err] Result & error if block supplied
499
+ # @yieldparam result [Google::Apis::DataflowV1b3::JobMetrics] parsed result object
500
+ # @yieldparam err [StandardError] error object if request failed
501
+ #
502
+ # @return [Google::Apis::DataflowV1b3::JobMetrics]
503
+ #
504
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
505
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
506
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
507
+ def get_project_job_metrics(project_id, job_id, location: nil, start_time: nil, fields: nil, quota_user: nil, options: nil, &block)
508
+ command = make_simple_command(:get, 'v1b3/projects/{projectId}/jobs/{jobId}/metrics', options)
509
+ command.response_representation = Google::Apis::DataflowV1b3::JobMetrics::Representation
510
+ command.response_class = Google::Apis::DataflowV1b3::JobMetrics
511
+ command.params['projectId'] = project_id unless project_id.nil?
512
+ command.params['jobId'] = job_id unless job_id.nil?
513
+ command.query['location'] = location unless location.nil?
514
+ command.query['startTime'] = start_time unless start_time.nil?
515
+ command.query['fields'] = fields unless fields.nil?
516
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
517
+ execute_or_queue_command(command, &block)
518
+ end
519
+
520
+ # List the jobs of a project. To list the jobs of a project in a region, we
521
+ # recommend using `projects.locations.jobs.list` with a [regional endpoint] (
522
+ # https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list
523
+ # the all jobs across all regions, use `projects.jobs.aggregated`. Using `
524
+ # projects.jobs.list` is not recommended, as you can only get the list of jobs
525
+ # that are running in `us-central1`.
526
+ # @param [String] project_id
527
+ # The project which owns the jobs.
528
+ # @param [String] filter
529
+ # The kind of filter to use.
530
+ # @param [String] location
531
+ # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
532
+ # regional-endpoints) that contains this job.
533
+ # @param [Fixnum] page_size
534
+ # If there are many jobs, limit response to at most this many. The actual number
535
+ # of jobs returned will be the lesser of max_responses and an unspecified server-
536
+ # defined limit.
537
+ # @param [String] page_token
538
+ # Set this to the 'next_page_token' field of a previous response to request
539
+ # additional results in a long list.
540
+ # @param [String] view
541
+ # Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.
542
+ # @param [String] fields
543
+ # Selector specifying which fields to include in a partial response.
544
+ # @param [String] quota_user
545
+ # Available to use for quota purposes for server-side applications. Can be any
546
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
547
+ # @param [Google::Apis::RequestOptions] options
548
+ # Request-specific options
549
+ #
550
+ # @yield [result, err] Result & error if block supplied
551
+ # @yieldparam result [Google::Apis::DataflowV1b3::ListJobsResponse] parsed result object
552
+ # @yieldparam err [StandardError] error object if request failed
553
+ #
554
+ # @return [Google::Apis::DataflowV1b3::ListJobsResponse]
555
+ #
556
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
557
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
558
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
559
+ def list_project_jobs(project_id, filter: nil, location: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
560
+ command = make_simple_command(:get, 'v1b3/projects/{projectId}/jobs', options)
561
+ command.response_representation = Google::Apis::DataflowV1b3::ListJobsResponse::Representation
562
+ command.response_class = Google::Apis::DataflowV1b3::ListJobsResponse
563
+ command.params['projectId'] = project_id unless project_id.nil?
564
+ command.query['filter'] = filter unless filter.nil?
565
+ command.query['location'] = location unless location.nil?
566
+ command.query['pageSize'] = page_size unless page_size.nil?
567
+ command.query['pageToken'] = page_token unless page_token.nil?
568
+ command.query['view'] = view unless view.nil?
569
+ command.query['fields'] = fields unless fields.nil?
570
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
571
+ execute_or_queue_command(command, &block)
572
+ end
573
+
574
+ # Snapshot the state of a streaming job.
575
+ # @param [String] project_id
576
+ # The project which owns the job to be snapshotted.
577
+ # @param [String] job_id
578
+ # The job to be snapshotted.
579
+ # @param [Google::Apis::DataflowV1b3::SnapshotJobRequest] snapshot_job_request_object
580
+ # @param [String] fields
581
+ # Selector specifying which fields to include in a partial response.
582
+ # @param [String] quota_user
583
+ # Available to use for quota purposes for server-side applications. Can be any
584
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
585
+ # @param [Google::Apis::RequestOptions] options
586
+ # Request-specific options
587
+ #
588
+ # @yield [result, err] Result & error if block supplied
589
+ # @yieldparam result [Google::Apis::DataflowV1b3::Snapshot] parsed result object
590
+ # @yieldparam err [StandardError] error object if request failed
591
+ #
592
+ # @return [Google::Apis::DataflowV1b3::Snapshot]
593
+ #
594
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
595
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
596
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
597
+ def snapshot_project_job(project_id, job_id, snapshot_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
598
+ command = make_simple_command(:post, 'v1b3/projects/{projectId}/jobs/{jobId}:snapshot', options)
599
+ command.request_representation = Google::Apis::DataflowV1b3::SnapshotJobRequest::Representation
600
+ command.request_object = snapshot_job_request_object
601
+ command.response_representation = Google::Apis::DataflowV1b3::Snapshot::Representation
602
+ command.response_class = Google::Apis::DataflowV1b3::Snapshot
603
+ command.params['projectId'] = project_id unless project_id.nil?
604
+ command.params['jobId'] = job_id unless job_id.nil?
605
+ command.query['fields'] = fields unless fields.nil?
606
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
607
+ execute_or_queue_command(command, &block)
608
+ end
609
+
610
+ # Updates the state of an existing Cloud Dataflow job. To update the state of an
611
+ # existing job, we recommend using `projects.locations.jobs.update` with a [
612
+ # regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-
613
+ # endpoints). Using `projects.jobs.update` is not recommended, as you can only
614
+ # update the state of jobs that are running in `us-central1`.
615
+ # @param [String] project_id
616
+ # The ID of the Cloud Platform project that the job belongs to.
617
+ # @param [String] job_id
618
+ # The job ID.
619
+ # @param [Google::Apis::DataflowV1b3::Job] job_object
620
+ # @param [String] location
621
+ # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
622
+ # regional-endpoints) that contains this job.
623
+ # @param [String] fields
624
+ # Selector specifying which fields to include in a partial response.
625
+ # @param [String] quota_user
626
+ # Available to use for quota purposes for server-side applications. Can be any
627
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
628
+ # @param [Google::Apis::RequestOptions] options
629
+ # Request-specific options
630
+ #
631
+ # @yield [result, err] Result & error if block supplied
632
+ # @yieldparam result [Google::Apis::DataflowV1b3::Job] parsed result object
633
+ # @yieldparam err [StandardError] error object if request failed
634
+ #
635
+ # @return [Google::Apis::DataflowV1b3::Job]
636
+ #
637
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
638
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
639
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
640
+ def update_project_job(project_id, job_id, job_object = nil, location: nil, fields: nil, quota_user: nil, options: nil, &block)
641
+ command = make_simple_command(:put, 'v1b3/projects/{projectId}/jobs/{jobId}', options)
642
+ command.request_representation = Google::Apis::DataflowV1b3::Job::Representation
643
+ command.request_object = job_object
644
+ command.response_representation = Google::Apis::DataflowV1b3::Job::Representation
645
+ command.response_class = Google::Apis::DataflowV1b3::Job
646
+ command.params['projectId'] = project_id unless project_id.nil?
647
+ command.params['jobId'] = job_id unless job_id.nil?
648
+ command.query['location'] = location unless location.nil?
649
+ command.query['fields'] = fields unless fields.nil?
650
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
651
+ execute_or_queue_command(command, &block)
652
+ end
653
+
654
+ # Get encoded debug configuration for component. Not cacheable.
655
+ # @param [String] project_id
656
+ # The project id.
657
+ # @param [String] job_id
658
+ # The job id.
659
+ # @param [Google::Apis::DataflowV1b3::GetDebugConfigRequest] get_debug_config_request_object
660
+ # @param [String] fields
661
+ # Selector specifying which fields to include in a partial response.
662
+ # @param [String] quota_user
663
+ # Available to use for quota purposes for server-side applications. Can be any
664
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
665
+ # @param [Google::Apis::RequestOptions] options
666
+ # Request-specific options
667
+ #
668
+ # @yield [result, err] Result & error if block supplied
669
+ # @yieldparam result [Google::Apis::DataflowV1b3::GetDebugConfigResponse] parsed result object
670
+ # @yieldparam err [StandardError] error object if request failed
671
+ #
672
+ # @return [Google::Apis::DataflowV1b3::GetDebugConfigResponse]
673
+ #
674
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
675
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
676
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
677
+ def get_project_job_debug_config(project_id, job_id, get_debug_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
678
+ command = make_simple_command(:post, 'v1b3/projects/{projectId}/jobs/{jobId}/debug/getConfig', options)
679
+ command.request_representation = Google::Apis::DataflowV1b3::GetDebugConfigRequest::Representation
680
+ command.request_object = get_debug_config_request_object
681
+ command.response_representation = Google::Apis::DataflowV1b3::GetDebugConfigResponse::Representation
682
+ command.response_class = Google::Apis::DataflowV1b3::GetDebugConfigResponse
683
+ command.params['projectId'] = project_id unless project_id.nil?
684
+ command.params['jobId'] = job_id unless job_id.nil?
685
+ command.query['fields'] = fields unless fields.nil?
686
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
687
+ execute_or_queue_command(command, &block)
688
+ end
689
+
690
+ # Send encoded debug capture data for component.
691
+ # @param [String] project_id
692
+ # The project id.
693
+ # @param [String] job_id
694
+ # The job id.
695
+ # @param [Google::Apis::DataflowV1b3::SendDebugCaptureRequest] send_debug_capture_request_object
696
+ # @param [String] fields
697
+ # Selector specifying which fields to include in a partial response.
698
+ # @param [String] quota_user
699
+ # Available to use for quota purposes for server-side applications. Can be any
700
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
701
+ # @param [Google::Apis::RequestOptions] options
702
+ # Request-specific options
703
+ #
704
+ # @yield [result, err] Result & error if block supplied
705
+ # @yieldparam result [Google::Apis::DataflowV1b3::SendDebugCaptureResponse] parsed result object
706
+ # @yieldparam err [StandardError] error object if request failed
707
+ #
708
+ # @return [Google::Apis::DataflowV1b3::SendDebugCaptureResponse]
709
+ #
710
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
711
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
712
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
713
+ def send_project_job_debug_capture(project_id, job_id, send_debug_capture_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
714
+ command = make_simple_command(:post, 'v1b3/projects/{projectId}/jobs/{jobId}/debug/sendCapture', options)
715
+ command.request_representation = Google::Apis::DataflowV1b3::SendDebugCaptureRequest::Representation
716
+ command.request_object = send_debug_capture_request_object
717
+ command.response_representation = Google::Apis::DataflowV1b3::SendDebugCaptureResponse::Representation
718
+ command.response_class = Google::Apis::DataflowV1b3::SendDebugCaptureResponse
719
+ command.params['projectId'] = project_id unless project_id.nil?
720
+ command.params['jobId'] = job_id unless job_id.nil?
721
+ command.query['fields'] = fields unless fields.nil?
722
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
723
+ execute_or_queue_command(command, &block)
724
+ end
725
+
726
+ # Request the job status. To request the status of a job, we recommend using `
727
+ # projects.locations.jobs.messages.list` with a [regional endpoint] (https://
728
+ # cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.
729
+ # jobs.messages.list` is not recommended, as you can only request the status of
730
+ # jobs that are running in `us-central1`.
731
+ # @param [String] project_id
732
+ # A project id.
733
+ # @param [String] job_id
734
+ # The job to get messages about.
735
+ # @param [String] end_time
736
+ # Return only messages with timestamps < end_time. The default is now (i.e.
737
+ # return up to the latest messages available).
738
+ # @param [String] location
739
+ # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
740
+ # regional-endpoints) that contains the job specified by job_id.
741
+ # @param [String] minimum_importance
742
+ # Filter to only get messages with importance >= level
743
+ # @param [Fixnum] page_size
744
+ # If specified, determines the maximum number of messages to return. If
745
+ # unspecified, the service may choose an appropriate default, or may return an
746
+ # arbitrarily large number of results.
747
+ # @param [String] page_token
748
+ # If supplied, this should be the value of next_page_token returned by an
749
+ # earlier call. This will cause the next page of results to be returned.
750
+ # @param [String] start_time
751
+ # If specified, return only messages with timestamps >= start_time. The default
752
+ # is the job creation time (i.e. beginning of messages).
753
+ # @param [String] fields
754
+ # Selector specifying which fields to include in a partial response.
755
+ # @param [String] quota_user
756
+ # Available to use for quota purposes for server-side applications. Can be any
757
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
758
+ # @param [Google::Apis::RequestOptions] options
759
+ # Request-specific options
760
+ #
761
+ # @yield [result, err] Result & error if block supplied
762
+ # @yieldparam result [Google::Apis::DataflowV1b3::ListJobMessagesResponse] parsed result object
763
+ # @yieldparam err [StandardError] error object if request failed
764
+ #
765
+ # @return [Google::Apis::DataflowV1b3::ListJobMessagesResponse]
766
+ #
767
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
768
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
769
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
770
+ def list_project_job_messages(project_id, job_id, end_time: nil, location: nil, minimum_importance: nil, page_size: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, options: nil, &block)
771
+ command = make_simple_command(:get, 'v1b3/projects/{projectId}/jobs/{jobId}/messages', options)
772
+ command.response_representation = Google::Apis::DataflowV1b3::ListJobMessagesResponse::Representation
773
+ command.response_class = Google::Apis::DataflowV1b3::ListJobMessagesResponse
774
+ command.params['projectId'] = project_id unless project_id.nil?
775
+ command.params['jobId'] = job_id unless job_id.nil?
776
+ command.query['endTime'] = end_time unless end_time.nil?
777
+ command.query['location'] = location unless location.nil?
778
+ command.query['minimumImportance'] = minimum_importance unless minimum_importance.nil?
779
+ command.query['pageSize'] = page_size unless page_size.nil?
780
+ command.query['pageToken'] = page_token unless page_token.nil?
781
+ command.query['startTime'] = start_time unless start_time.nil?
782
+ command.query['fields'] = fields unless fields.nil?
783
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
784
+ execute_or_queue_command(command, &block)
785
+ end
786
+
787
+ # Leases a dataflow WorkItem to run.
788
+ # @param [String] project_id
789
+ # Identifies the project this worker belongs to.
790
+ # @param [String] job_id
791
+ # Identifies the workflow job this worker belongs to.
792
+ # @param [Google::Apis::DataflowV1b3::LeaseWorkItemRequest] lease_work_item_request_object
793
+ # @param [String] fields
794
+ # Selector specifying which fields to include in a partial response.
795
+ # @param [String] quota_user
796
+ # Available to use for quota purposes for server-side applications. Can be any
797
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
798
+ # @param [Google::Apis::RequestOptions] options
799
+ # Request-specific options
800
+ #
801
+ # @yield [result, err] Result & error if block supplied
802
+ # @yieldparam result [Google::Apis::DataflowV1b3::LeaseWorkItemResponse] parsed result object
803
+ # @yieldparam err [StandardError] error object if request failed
804
+ #
805
+ # @return [Google::Apis::DataflowV1b3::LeaseWorkItemResponse]
806
+ #
807
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
808
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
809
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
810
+ def lease_project_work_item(project_id, job_id, lease_work_item_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
811
+ command = make_simple_command(:post, 'v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease', options)
812
+ command.request_representation = Google::Apis::DataflowV1b3::LeaseWorkItemRequest::Representation
813
+ command.request_object = lease_work_item_request_object
814
+ command.response_representation = Google::Apis::DataflowV1b3::LeaseWorkItemResponse::Representation
815
+ command.response_class = Google::Apis::DataflowV1b3::LeaseWorkItemResponse
816
+ command.params['projectId'] = project_id unless project_id.nil?
817
+ command.params['jobId'] = job_id unless job_id.nil?
818
+ command.query['fields'] = fields unless fields.nil?
819
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
820
+ execute_or_queue_command(command, &block)
821
+ end
822
+
823
+ # Reports the status of dataflow WorkItems leased by a worker.
824
+ # @param [String] project_id
825
+ # The project which owns the WorkItem's job.
826
+ # @param [String] job_id
827
+ # The job which the WorkItem is part of.
828
+ # @param [Google::Apis::DataflowV1b3::ReportWorkItemStatusRequest] report_work_item_status_request_object
829
+ # @param [String] fields
830
+ # Selector specifying which fields to include in a partial response.
831
+ # @param [String] quota_user
832
+ # Available to use for quota purposes for server-side applications. Can be any
833
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
834
+ # @param [Google::Apis::RequestOptions] options
835
+ # Request-specific options
836
+ #
837
+ # @yield [result, err] Result & error if block supplied
838
+ # @yieldparam result [Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse] parsed result object
839
+ # @yieldparam err [StandardError] error object if request failed
840
+ #
841
+ # @return [Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse]
842
+ #
843
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
844
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
845
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
846
+ def report_project_job_work_item_status(project_id, job_id, report_work_item_status_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
847
+ command = make_simple_command(:post, 'v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatus', options)
848
+ command.request_representation = Google::Apis::DataflowV1b3::ReportWorkItemStatusRequest::Representation
849
+ command.request_object = report_work_item_status_request_object
850
+ command.response_representation = Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse::Representation
851
+ command.response_class = Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse
852
+ command.params['projectId'] = project_id unless project_id.nil?
853
+ command.params['jobId'] = job_id unless job_id.nil?
854
+ command.query['fields'] = fields unless fields.nil?
855
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
856
+ execute_or_queue_command(command, &block)
857
+ end
858
+
859
+ # Send a worker_message to the service.
860
+ # @param [String] project_id
861
+ # The project to send the WorkerMessages to.
862
+ # @param [String] location
863
+ # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
864
+ # regional-endpoints) that contains the job.
865
+ # @param [Google::Apis::DataflowV1b3::SendWorkerMessagesRequest] send_worker_messages_request_object
866
+ # @param [String] fields
867
+ # Selector specifying which fields to include in a partial response.
868
+ # @param [String] quota_user
869
+ # Available to use for quota purposes for server-side applications. Can be any
870
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
871
+ # @param [Google::Apis::RequestOptions] options
872
+ # Request-specific options
873
+ #
874
+ # @yield [result, err] Result & error if block supplied
875
+ # @yieldparam result [Google::Apis::DataflowV1b3::SendWorkerMessagesResponse] parsed result object
876
+ # @yieldparam err [StandardError] error object if request failed
877
+ #
878
+ # @return [Google::Apis::DataflowV1b3::SendWorkerMessagesResponse]
879
+ #
880
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
881
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
882
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
883
+ def worker_project_location_messages(project_id, location, send_worker_messages_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
884
+ command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/WorkerMessages', options)
885
+ command.request_representation = Google::Apis::DataflowV1b3::SendWorkerMessagesRequest::Representation
886
+ command.request_object = send_worker_messages_request_object
887
+ command.response_representation = Google::Apis::DataflowV1b3::SendWorkerMessagesResponse::Representation
888
+ command.response_class = Google::Apis::DataflowV1b3::SendWorkerMessagesResponse
889
+ command.params['projectId'] = project_id unless project_id.nil?
890
+ command.params['location'] = location unless location.nil?
891
+ command.query['fields'] = fields unless fields.nil?
892
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
893
+ execute_or_queue_command(command, &block)
894
+ end
895
+
896
+ # Launch a job with a FlexTemplate.
897
+ # @param [String] project_id
898
+ # Required. The ID of the Cloud Platform project that the job belongs to.
899
+ # @param [String] location
900
+ # Required. The [regional endpoint] (https://cloud.google.com/dataflow/docs/
901
+ # concepts/regional-endpoints) to which to direct the request. E.g., us-central1,
902
+ # us-west1.
903
+ # @param [Google::Apis::DataflowV1b3::LaunchFlexTemplateRequest] launch_flex_template_request_object
904
+ # @param [String] fields
905
+ # Selector specifying which fields to include in a partial response.
906
+ # @param [String] quota_user
907
+ # Available to use for quota purposes for server-side applications. Can be any
908
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
909
+ # @param [Google::Apis::RequestOptions] options
910
+ # Request-specific options
911
+ #
912
+ # @yield [result, err] Result & error if block supplied
913
+ # @yieldparam result [Google::Apis::DataflowV1b3::LaunchFlexTemplateResponse] parsed result object
914
+ # @yieldparam err [StandardError] error object if request failed
915
+ #
916
+ # @return [Google::Apis::DataflowV1b3::LaunchFlexTemplateResponse]
917
+ #
918
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
919
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
920
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
921
+ def launch_flex_template(project_id, location, launch_flex_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
922
+ command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/flexTemplates:launch', options)
923
+ command.request_representation = Google::Apis::DataflowV1b3::LaunchFlexTemplateRequest::Representation
924
+ command.request_object = launch_flex_template_request_object
925
+ command.response_representation = Google::Apis::DataflowV1b3::LaunchFlexTemplateResponse::Representation
926
+ command.response_class = Google::Apis::DataflowV1b3::LaunchFlexTemplateResponse
927
+ command.params['projectId'] = project_id unless project_id.nil?
928
+ command.params['location'] = location unless location.nil?
929
+ command.query['fields'] = fields unless fields.nil?
930
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
931
+ execute_or_queue_command(command, &block)
932
+ end
933
+
934
+ # Creates a Cloud Dataflow job. To create a job, we recommend using `projects.
935
+ # locations.jobs.create` with a [regional endpoint] (https://cloud.google.com/
936
+ # dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.create` is
937
+ # not recommended, as your job will always start in `us-central1`.
938
+ # @param [String] project_id
939
+ # The ID of the Cloud Platform project that the job belongs to.
940
+ # @param [String] location
941
+ # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
942
+ # regional-endpoints) that contains this job.
943
+ # @param [Google::Apis::DataflowV1b3::Job] job_object
944
+ # @param [String] replace_job_id
945
+ # Deprecated. This field is now in the Job message.
946
+ # @param [String] view
947
+ # The level of information requested in response.
948
+ # @param [String] fields
949
+ # Selector specifying which fields to include in a partial response.
950
+ # @param [String] quota_user
951
+ # Available to use for quota purposes for server-side applications. Can be any
952
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
953
+ # @param [Google::Apis::RequestOptions] options
954
+ # Request-specific options
955
+ #
956
+ # @yield [result, err] Result & error if block supplied
957
+ # @yieldparam result [Google::Apis::DataflowV1b3::Job] parsed result object
958
+ # @yieldparam err [StandardError] error object if request failed
959
+ #
960
+ # @return [Google::Apis::DataflowV1b3::Job]
961
+ #
962
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
963
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
964
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
965
+ def create_project_location_job(project_id, location, job_object = nil, replace_job_id: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
966
+ command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/jobs', options)
967
+ command.request_representation = Google::Apis::DataflowV1b3::Job::Representation
968
+ command.request_object = job_object
969
+ command.response_representation = Google::Apis::DataflowV1b3::Job::Representation
970
+ command.response_class = Google::Apis::DataflowV1b3::Job
971
+ command.params['projectId'] = project_id unless project_id.nil?
972
+ command.params['location'] = location unless location.nil?
973
+ command.query['replaceJobId'] = replace_job_id unless replace_job_id.nil?
974
+ command.query['view'] = view unless view.nil?
975
+ command.query['fields'] = fields unless fields.nil?
976
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
977
+ execute_or_queue_command(command, &block)
978
+ end
979
+
980
+ # Gets the state of the specified Cloud Dataflow job. To get the state of a job,
981
+ # we recommend using `projects.locations.jobs.get` with a [regional endpoint] (
982
+ # https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `
983
+ # projects.jobs.get` is not recommended, as you can only get the state of jobs
984
+ # that are running in `us-central1`.
985
+ # @param [String] project_id
986
+ # The ID of the Cloud Platform project that the job belongs to.
987
+ # @param [String] location
988
+ # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
989
+ # regional-endpoints) that contains this job.
990
+ # @param [String] job_id
991
+ # The job ID.
992
+ # @param [String] view
993
+ # The level of information requested in response.
994
+ # @param [String] fields
995
+ # Selector specifying which fields to include in a partial response.
996
+ # @param [String] quota_user
997
+ # Available to use for quota purposes for server-side applications. Can be any
998
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
999
+ # @param [Google::Apis::RequestOptions] options
1000
+ # Request-specific options
1001
+ #
1002
+ # @yield [result, err] Result & error if block supplied
1003
+ # @yieldparam result [Google::Apis::DataflowV1b3::Job] parsed result object
1004
+ # @yieldparam err [StandardError] error object if request failed
1005
+ #
1006
+ # @return [Google::Apis::DataflowV1b3::Job]
1007
+ #
1008
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1009
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1010
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1011
+ def get_project_location_job(project_id, location, job_id, view: nil, fields: nil, quota_user: nil, options: nil, &block)
1012
+ command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}', options)
1013
+ command.response_representation = Google::Apis::DataflowV1b3::Job::Representation
1014
+ command.response_class = Google::Apis::DataflowV1b3::Job
1015
+ command.params['projectId'] = project_id unless project_id.nil?
1016
+ command.params['location'] = location unless location.nil?
1017
+ command.params['jobId'] = job_id unless job_id.nil?
1018
+ command.query['view'] = view unless view.nil?
1019
+ command.query['fields'] = fields unless fields.nil?
1020
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1021
+ execute_or_queue_command(command, &block)
1022
+ end
1023
+
1024
+ # Request detailed information about the execution status of the job.
1025
+ # EXPERIMENTAL. This API is subject to change or removal without notice.
1026
+ # @param [String] project_id
1027
+ # A project id.
1028
+ # @param [String] location
1029
+ # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
1030
+ # regional-endpoints) that contains the job specified by job_id.
1031
+ # @param [String] job_id
1032
+ # The job to get execution details for.
1033
+ # @param [Fixnum] page_size
1034
+ # If specified, determines the maximum number of stages to return. If
1035
+ # unspecified, the service may choose an appropriate default, or may return an
1036
+ # arbitrarily large number of results.
1037
+ # @param [String] page_token
1038
+ # If supplied, this should be the value of next_page_token returned by an
1039
+ # earlier call. This will cause the next page of results to be returned.
1040
+ # @param [String] fields
1041
+ # Selector specifying which fields to include in a partial response.
1042
+ # @param [String] quota_user
1043
+ # Available to use for quota purposes for server-side applications. Can be any
1044
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1045
+ # @param [Google::Apis::RequestOptions] options
1046
+ # Request-specific options
1047
+ #
1048
+ # @yield [result, err] Result & error if block supplied
1049
+ # @yieldparam result [Google::Apis::DataflowV1b3::JobExecutionDetails] parsed result object
1050
+ # @yieldparam err [StandardError] error object if request failed
1051
+ #
1052
+ # @return [Google::Apis::DataflowV1b3::JobExecutionDetails]
1053
+ #
1054
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1055
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1056
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1057
+ def get_project_location_job_execution_details(project_id, location, job_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1058
+ command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/executionDetails', options)
1059
+ command.response_representation = Google::Apis::DataflowV1b3::JobExecutionDetails::Representation
1060
+ command.response_class = Google::Apis::DataflowV1b3::JobExecutionDetails
1061
+ command.params['projectId'] = project_id unless project_id.nil?
1062
+ command.params['location'] = location unless location.nil?
1063
+ command.params['jobId'] = job_id unless job_id.nil?
1064
+ command.query['pageSize'] = page_size unless page_size.nil?
1065
+ command.query['pageToken'] = page_token unless page_token.nil?
1066
+ command.query['fields'] = fields unless fields.nil?
1067
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1068
+ execute_or_queue_command(command, &block)
1069
+ end
1070
+
1071
+ # Request the job status. To request the status of a job, we recommend using `
1072
+ # projects.locations.jobs.getMetrics` with a [regional endpoint] (https://cloud.
1073
+ # google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.
1074
+ # getMetrics` is not recommended, as you can only request the status of jobs
1075
+ # that are running in `us-central1`.
1076
+ # @param [String] project_id
1077
+ # A project id.
1078
+ # @param [String] location
1079
+ # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
1080
+ # regional-endpoints) that contains the job specified by job_id.
1081
+ # @param [String] job_id
1082
+ # The job to get metrics for.
1083
+ # @param [String] start_time
1084
+ # Return only metric data that has changed since this time. Default is to return
1085
+ # all information about all metrics for the job.
1086
+ # @param [String] fields
1087
+ # Selector specifying which fields to include in a partial response.
1088
+ # @param [String] quota_user
1089
+ # Available to use for quota purposes for server-side applications. Can be any
1090
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1091
+ # @param [Google::Apis::RequestOptions] options
1092
+ # Request-specific options
1093
+ #
1094
+ # @yield [result, err] Result & error if block supplied
1095
+ # @yieldparam result [Google::Apis::DataflowV1b3::JobMetrics] parsed result object
1096
+ # @yieldparam err [StandardError] error object if request failed
1097
+ #
1098
+ # @return [Google::Apis::DataflowV1b3::JobMetrics]
1099
+ #
1100
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1101
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1102
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1103
+ def get_project_location_job_metrics(project_id, location, job_id, start_time: nil, fields: nil, quota_user: nil, options: nil, &block)
1104
+ command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics', options)
1105
+ command.response_representation = Google::Apis::DataflowV1b3::JobMetrics::Representation
1106
+ command.response_class = Google::Apis::DataflowV1b3::JobMetrics
1107
+ command.params['projectId'] = project_id unless project_id.nil?
1108
+ command.params['location'] = location unless location.nil?
1109
+ command.params['jobId'] = job_id unless job_id.nil?
1110
+ command.query['startTime'] = start_time unless start_time.nil?
1111
+ command.query['fields'] = fields unless fields.nil?
1112
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1113
+ execute_or_queue_command(command, &block)
1114
+ end
1115
+
1116
+ # List the jobs of a project. To list the jobs of a project in a region, we
1117
+ # recommend using `projects.locations.jobs.list` with a [regional endpoint] (
1118
+ # https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list
1119
+ # the all jobs across all regions, use `projects.jobs.aggregated`. Using `
1120
+ # projects.jobs.list` is not recommended, as you can only get the list of jobs
1121
+ # that are running in `us-central1`.
1122
+ # @param [String] project_id
1123
+ # The project which owns the jobs.
1124
+ # @param [String] location
1125
+ # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
1126
+ # regional-endpoints) that contains this job.
1127
+ # @param [String] filter
1128
+ # The kind of filter to use.
1129
+ # @param [Fixnum] page_size
1130
+ # If there are many jobs, limit response to at most this many. The actual number
1131
+ # of jobs returned will be the lesser of max_responses and an unspecified server-
1132
+ # defined limit.
1133
+ # @param [String] page_token
1134
+ # Set this to the 'next_page_token' field of a previous response to request
1135
+ # additional results in a long list.
1136
+ # @param [String] view
1137
+ # Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.
1138
+ # @param [String] fields
1139
+ # Selector specifying which fields to include in a partial response.
1140
+ # @param [String] quota_user
1141
+ # Available to use for quota purposes for server-side applications. Can be any
1142
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1143
+ # @param [Google::Apis::RequestOptions] options
1144
+ # Request-specific options
1145
+ #
1146
+ # @yield [result, err] Result & error if block supplied
1147
+ # @yieldparam result [Google::Apis::DataflowV1b3::ListJobsResponse] parsed result object
1148
+ # @yieldparam err [StandardError] error object if request failed
1149
+ #
1150
+ # @return [Google::Apis::DataflowV1b3::ListJobsResponse]
1151
+ #
1152
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1153
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1154
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1155
+ def list_project_location_jobs(project_id, location, filter: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
1156
+ command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/jobs', options)
1157
+ command.response_representation = Google::Apis::DataflowV1b3::ListJobsResponse::Representation
1158
+ command.response_class = Google::Apis::DataflowV1b3::ListJobsResponse
1159
+ command.params['projectId'] = project_id unless project_id.nil?
1160
+ command.params['location'] = location unless location.nil?
1161
+ command.query['filter'] = filter unless filter.nil?
1162
+ command.query['pageSize'] = page_size unless page_size.nil?
1163
+ command.query['pageToken'] = page_token unless page_token.nil?
1164
+ command.query['view'] = view unless view.nil?
1165
+ command.query['fields'] = fields unless fields.nil?
1166
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1167
+ execute_or_queue_command(command, &block)
1168
+ end
1169
+
1170
+ # Snapshot the state of a streaming job.
1171
+ # @param [String] project_id
1172
+ # The project which owns the job to be snapshotted.
1173
+ # @param [String] location
1174
+ # The location that contains this job.
1175
+ # @param [String] job_id
1176
+ # The job to be snapshotted.
1177
+ # @param [Google::Apis::DataflowV1b3::SnapshotJobRequest] snapshot_job_request_object
1178
+ # @param [String] fields
1179
+ # Selector specifying which fields to include in a partial response.
1180
+ # @param [String] quota_user
1181
+ # Available to use for quota purposes for server-side applications. Can be any
1182
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1183
+ # @param [Google::Apis::RequestOptions] options
1184
+ # Request-specific options
1185
+ #
1186
+ # @yield [result, err] Result & error if block supplied
1187
+ # @yieldparam result [Google::Apis::DataflowV1b3::Snapshot] parsed result object
1188
+ # @yieldparam err [StandardError] error object if request failed
1189
+ #
1190
+ # @return [Google::Apis::DataflowV1b3::Snapshot]
1191
+ #
1192
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1193
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1194
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1195
+ def snapshot_project_location_job(project_id, location, job_id, snapshot_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1196
+ command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}:snapshot', options)
1197
+ command.request_representation = Google::Apis::DataflowV1b3::SnapshotJobRequest::Representation
1198
+ command.request_object = snapshot_job_request_object
1199
+ command.response_representation = Google::Apis::DataflowV1b3::Snapshot::Representation
1200
+ command.response_class = Google::Apis::DataflowV1b3::Snapshot
1201
+ command.params['projectId'] = project_id unless project_id.nil?
1202
+ command.params['location'] = location unless location.nil?
1203
+ command.params['jobId'] = job_id unless job_id.nil?
1204
+ command.query['fields'] = fields unless fields.nil?
1205
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1206
+ execute_or_queue_command(command, &block)
1207
+ end
1208
+
1209
+ # Updates the state of an existing Cloud Dataflow job. To update the state of an
1210
+ # existing job, we recommend using `projects.locations.jobs.update` with a [
1211
+ # regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-
1212
+ # endpoints). Using `projects.jobs.update` is not recommended, as you can only
1213
+ # update the state of jobs that are running in `us-central1`.
1214
+ # @param [String] project_id
1215
+ # The ID of the Cloud Platform project that the job belongs to.
1216
+ # @param [String] location
1217
+ # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
1218
+ # regional-endpoints) that contains this job.
1219
+ # @param [String] job_id
1220
+ # The job ID.
1221
+ # @param [Google::Apis::DataflowV1b3::Job] job_object
1222
+ # @param [String] fields
1223
+ # Selector specifying which fields to include in a partial response.
1224
+ # @param [String] quota_user
1225
+ # Available to use for quota purposes for server-side applications. Can be any
1226
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1227
+ # @param [Google::Apis::RequestOptions] options
1228
+ # Request-specific options
1229
+ #
1230
+ # @yield [result, err] Result & error if block supplied
1231
+ # @yieldparam result [Google::Apis::DataflowV1b3::Job] parsed result object
1232
+ # @yieldparam err [StandardError] error object if request failed
1233
+ #
1234
+ # @return [Google::Apis::DataflowV1b3::Job]
1235
+ #
1236
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1237
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1238
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1239
+ def update_project_location_job(project_id, location, job_id, job_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1240
+ command = make_simple_command(:put, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}', options)
1241
+ command.request_representation = Google::Apis::DataflowV1b3::Job::Representation
1242
+ command.request_object = job_object
1243
+ command.response_representation = Google::Apis::DataflowV1b3::Job::Representation
1244
+ command.response_class = Google::Apis::DataflowV1b3::Job
1245
+ command.params['projectId'] = project_id unless project_id.nil?
1246
+ command.params['location'] = location unless location.nil?
1247
+ command.params['jobId'] = job_id unless job_id.nil?
1248
+ command.query['fields'] = fields unless fields.nil?
1249
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1250
+ execute_or_queue_command(command, &block)
1251
+ end
1252
+
1253
+ # Get encoded debug configuration for component. Not cacheable.
1254
+ # @param [String] project_id
1255
+ # The project id.
1256
+ # @param [String] location
1257
+ # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
1258
+ # regional-endpoints) that contains the job specified by job_id.
1259
+ # @param [String] job_id
1260
+ # The job id.
1261
+ # @param [Google::Apis::DataflowV1b3::GetDebugConfigRequest] get_debug_config_request_object
1262
+ # @param [String] fields
1263
+ # Selector specifying which fields to include in a partial response.
1264
+ # @param [String] quota_user
1265
+ # Available to use for quota purposes for server-side applications. Can be any
1266
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1267
+ # @param [Google::Apis::RequestOptions] options
1268
+ # Request-specific options
1269
+ #
1270
+ # @yield [result, err] Result & error if block supplied
1271
+ # @yieldparam result [Google::Apis::DataflowV1b3::GetDebugConfigResponse] parsed result object
1272
+ # @yieldparam err [StandardError] error object if request failed
1273
+ #
1274
+ # @return [Google::Apis::DataflowV1b3::GetDebugConfigResponse]
1275
+ #
1276
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1277
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1278
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1279
+ def get_project_location_job_debug_config(project_id, location, job_id, get_debug_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1280
+ command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/getConfig', options)
1281
+ command.request_representation = Google::Apis::DataflowV1b3::GetDebugConfigRequest::Representation
1282
+ command.request_object = get_debug_config_request_object
1283
+ command.response_representation = Google::Apis::DataflowV1b3::GetDebugConfigResponse::Representation
1284
+ command.response_class = Google::Apis::DataflowV1b3::GetDebugConfigResponse
1285
+ command.params['projectId'] = project_id unless project_id.nil?
1286
+ command.params['location'] = location unless location.nil?
1287
+ command.params['jobId'] = job_id unless job_id.nil?
1288
+ command.query['fields'] = fields unless fields.nil?
1289
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1290
+ execute_or_queue_command(command, &block)
1291
+ end
1292
+
1293
+ # Send encoded debug capture data for component.
1294
+ # @param [String] project_id
1295
+ # The project id.
1296
+ # @param [String] location
1297
+ # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
1298
+ # regional-endpoints) that contains the job specified by job_id.
1299
+ # @param [String] job_id
1300
+ # The job id.
1301
+ # @param [Google::Apis::DataflowV1b3::SendDebugCaptureRequest] send_debug_capture_request_object
1302
+ # @param [String] fields
1303
+ # Selector specifying which fields to include in a partial response.
1304
+ # @param [String] quota_user
1305
+ # Available to use for quota purposes for server-side applications. Can be any
1306
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1307
+ # @param [Google::Apis::RequestOptions] options
1308
+ # Request-specific options
1309
+ #
1310
+ # @yield [result, err] Result & error if block supplied
1311
+ # @yieldparam result [Google::Apis::DataflowV1b3::SendDebugCaptureResponse] parsed result object
1312
+ # @yieldparam err [StandardError] error object if request failed
1313
+ #
1314
+ # @return [Google::Apis::DataflowV1b3::SendDebugCaptureResponse]
1315
+ #
1316
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1317
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1318
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1319
+ def send_project_location_job_debug_capture(project_id, location, job_id, send_debug_capture_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1320
+ command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/sendCapture', options)
1321
+ command.request_representation = Google::Apis::DataflowV1b3::SendDebugCaptureRequest::Representation
1322
+ command.request_object = send_debug_capture_request_object
1323
+ command.response_representation = Google::Apis::DataflowV1b3::SendDebugCaptureResponse::Representation
1324
+ command.response_class = Google::Apis::DataflowV1b3::SendDebugCaptureResponse
1325
+ command.params['projectId'] = project_id unless project_id.nil?
1326
+ command.params['location'] = location unless location.nil?
1327
+ command.params['jobId'] = job_id unless job_id.nil?
1328
+ command.query['fields'] = fields unless fields.nil?
1329
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1330
+ execute_or_queue_command(command, &block)
1331
+ end
1332
+
1333
+ # Request the job status. To request the status of a job, we recommend using `
1334
+ # projects.locations.jobs.messages.list` with a [regional endpoint] (https://
1335
+ # cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.
1336
+ # jobs.messages.list` is not recommended, as you can only request the status of
1337
+ # jobs that are running in `us-central1`.
1338
+ # @param [String] project_id
1339
+ # A project id.
1340
+ # @param [String] location
1341
+ # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
1342
+ # regional-endpoints) that contains the job specified by job_id.
1343
+ # @param [String] job_id
1344
+ # The job to get messages about.
1345
+ # @param [String] end_time
1346
+ # Return only messages with timestamps < end_time. The default is now (i.e.
1347
+ # return up to the latest messages available).
1348
+ # @param [String] minimum_importance
1349
+ # Filter to only get messages with importance >= level
1350
+ # @param [Fixnum] page_size
1351
+ # If specified, determines the maximum number of messages to return. If
1352
+ # unspecified, the service may choose an appropriate default, or may return an
1353
+ # arbitrarily large number of results.
1354
+ # @param [String] page_token
1355
+ # If supplied, this should be the value of next_page_token returned by an
1356
+ # earlier call. This will cause the next page of results to be returned.
1357
+ # @param [String] start_time
1358
+ # If specified, return only messages with timestamps >= start_time. The default
1359
+ # is the job creation time (i.e. beginning of messages).
1360
+ # @param [String] fields
1361
+ # Selector specifying which fields to include in a partial response.
1362
+ # @param [String] quota_user
1363
+ # Available to use for quota purposes for server-side applications. Can be any
1364
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1365
+ # @param [Google::Apis::RequestOptions] options
1366
+ # Request-specific options
1367
+ #
1368
+ # @yield [result, err] Result & error if block supplied
1369
+ # @yieldparam result [Google::Apis::DataflowV1b3::ListJobMessagesResponse] parsed result object
1370
+ # @yieldparam err [StandardError] error object if request failed
1371
+ #
1372
+ # @return [Google::Apis::DataflowV1b3::ListJobMessagesResponse]
1373
+ #
1374
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1375
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1376
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1377
+ def list_project_location_job_messages(project_id, location, job_id, end_time: nil, minimum_importance: nil, page_size: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, options: nil, &block)
1378
+ command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages', options)
1379
+ command.response_representation = Google::Apis::DataflowV1b3::ListJobMessagesResponse::Representation
1380
+ command.response_class = Google::Apis::DataflowV1b3::ListJobMessagesResponse
1381
+ command.params['projectId'] = project_id unless project_id.nil?
1382
+ command.params['location'] = location unless location.nil?
1383
+ command.params['jobId'] = job_id unless job_id.nil?
1384
+ command.query['endTime'] = end_time unless end_time.nil?
1385
+ command.query['minimumImportance'] = minimum_importance unless minimum_importance.nil?
1386
+ command.query['pageSize'] = page_size unless page_size.nil?
1387
+ command.query['pageToken'] = page_token unless page_token.nil?
1388
+ command.query['startTime'] = start_time unless start_time.nil?
1389
+ command.query['fields'] = fields unless fields.nil?
1390
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1391
+ execute_or_queue_command(command, &block)
1392
+ end
1393
+
1394
+ # Lists snapshots.
1395
+ # @param [String] project_id
1396
+ # The project ID to list snapshots for.
1397
+ # @param [String] location
1398
+ # The location to list snapshots in.
1399
+ # @param [String] job_id
1400
+ # If specified, list snapshots created from this job.
1401
+ # @param [String] fields
1402
+ # Selector specifying which fields to include in a partial response.
1403
+ # @param [String] quota_user
1404
+ # Available to use for quota purposes for server-side applications. Can be any
1405
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1406
+ # @param [Google::Apis::RequestOptions] options
1407
+ # Request-specific options
1408
+ #
1409
+ # @yield [result, err] Result & error if block supplied
1410
+ # @yieldparam result [Google::Apis::DataflowV1b3::ListSnapshotsResponse] parsed result object
1411
+ # @yieldparam err [StandardError] error object if request failed
1412
+ #
1413
+ # @return [Google::Apis::DataflowV1b3::ListSnapshotsResponse]
1414
+ #
1415
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1416
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1417
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1418
+ def list_project_location_job_snapshots(project_id, location, job_id, fields: nil, quota_user: nil, options: nil, &block)
1419
+ command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/snapshots', options)
1420
+ command.response_representation = Google::Apis::DataflowV1b3::ListSnapshotsResponse::Representation
1421
+ command.response_class = Google::Apis::DataflowV1b3::ListSnapshotsResponse
1422
+ command.params['projectId'] = project_id unless project_id.nil?
1423
+ command.params['location'] = location unless location.nil?
1424
+ command.params['jobId'] = job_id unless job_id.nil?
1425
+ command.query['fields'] = fields unless fields.nil?
1426
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1427
+ execute_or_queue_command(command, &block)
1428
+ end
1429
+
1430
+ # Request detailed information about the execution status of a stage of the job.
1431
+ # EXPERIMENTAL. This API is subject to change or removal without notice.
1432
+ # @param [String] project_id
1433
+ # A project id.
1434
+ # @param [String] location
1435
+ # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
1436
+ # regional-endpoints) that contains the job specified by job_id.
1437
+ # @param [String] job_id
1438
+ # The job to get execution details for.
1439
+ # @param [String] stage_id
1440
+ # The stage for which to fetch information.
1441
+ # @param [String] end_time
1442
+ # Upper time bound of work items to include, by start time.
1443
+ # @param [Fixnum] page_size
1444
+ # If specified, determines the maximum number of work items to return. If
1445
+ # unspecified, the service may choose an appropriate default, or may return an
1446
+ # arbitrarily large number of results.
1447
+ # @param [String] page_token
1448
+ # If supplied, this should be the value of next_page_token returned by an
1449
+ # earlier call. This will cause the next page of results to be returned.
1450
+ # @param [String] start_time
1451
+ # Lower time bound of work items to include, by start time.
1452
+ # @param [String] fields
1453
+ # Selector specifying which fields to include in a partial response.
1454
+ # @param [String] quota_user
1455
+ # Available to use for quota purposes for server-side applications. Can be any
1456
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1457
+ # @param [Google::Apis::RequestOptions] options
1458
+ # Request-specific options
1459
+ #
1460
+ # @yield [result, err] Result & error if block supplied
1461
+ # @yieldparam result [Google::Apis::DataflowV1b3::StageExecutionDetails] parsed result object
1462
+ # @yieldparam err [StandardError] error object if request failed
1463
+ #
1464
+ # @return [Google::Apis::DataflowV1b3::StageExecutionDetails]
1465
+ #
1466
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1467
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1468
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1469
+ def get_project_location_job_stage_execution_details(project_id, location, job_id, stage_id, end_time: nil, page_size: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, options: nil, &block)
1470
+ command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/stages/{stageId}/executionDetails', options)
1471
+ command.response_representation = Google::Apis::DataflowV1b3::StageExecutionDetails::Representation
1472
+ command.response_class = Google::Apis::DataflowV1b3::StageExecutionDetails
1473
+ command.params['projectId'] = project_id unless project_id.nil?
1474
+ command.params['location'] = location unless location.nil?
1475
+ command.params['jobId'] = job_id unless job_id.nil?
1476
+ command.params['stageId'] = stage_id unless stage_id.nil?
1477
+ command.query['endTime'] = end_time unless end_time.nil?
1478
+ command.query['pageSize'] = page_size unless page_size.nil?
1479
+ command.query['pageToken'] = page_token unless page_token.nil?
1480
+ command.query['startTime'] = start_time unless start_time.nil?
1481
+ command.query['fields'] = fields unless fields.nil?
1482
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1483
+ execute_or_queue_command(command, &block)
1484
+ end
1485
+
1486
+ # Leases a dataflow WorkItem to run.
1487
+ # @param [String] project_id
1488
+ # Identifies the project this worker belongs to.
1489
+ # @param [String] location
1490
+ # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
1491
+ # regional-endpoints) that contains the WorkItem's job.
1492
+ # @param [String] job_id
1493
+ # Identifies the workflow job this worker belongs to.
1494
+ # @param [Google::Apis::DataflowV1b3::LeaseWorkItemRequest] lease_work_item_request_object
1495
+ # @param [String] fields
1496
+ # Selector specifying which fields to include in a partial response.
1497
+ # @param [String] quota_user
1498
+ # Available to use for quota purposes for server-side applications. Can be any
1499
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1500
+ # @param [Google::Apis::RequestOptions] options
1501
+ # Request-specific options
1502
+ #
1503
+ # @yield [result, err] Result & error if block supplied
1504
+ # @yieldparam result [Google::Apis::DataflowV1b3::LeaseWorkItemResponse] parsed result object
1505
+ # @yieldparam err [StandardError] error object if request failed
1506
+ #
1507
+ # @return [Google::Apis::DataflowV1b3::LeaseWorkItemResponse]
1508
+ #
1509
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1510
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1511
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1512
+ def lease_project_location_work_item(project_id, location, job_id, lease_work_item_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1513
+ command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:lease', options)
1514
+ command.request_representation = Google::Apis::DataflowV1b3::LeaseWorkItemRequest::Representation
1515
+ command.request_object = lease_work_item_request_object
1516
+ command.response_representation = Google::Apis::DataflowV1b3::LeaseWorkItemResponse::Representation
1517
+ command.response_class = Google::Apis::DataflowV1b3::LeaseWorkItemResponse
1518
+ command.params['projectId'] = project_id unless project_id.nil?
1519
+ command.params['location'] = location unless location.nil?
1520
+ command.params['jobId'] = job_id unless job_id.nil?
1521
+ command.query['fields'] = fields unless fields.nil?
1522
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1523
+ execute_or_queue_command(command, &block)
1524
+ end
1525
+
1526
+ # Reports the status of dataflow WorkItems leased by a worker.
1527
+ # @param [String] project_id
1528
+ # The project which owns the WorkItem's job.
1529
+ # @param [String] location
1530
+ # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
1531
+ # regional-endpoints) that contains the WorkItem's job.
1532
+ # @param [String] job_id
1533
+ # The job which the WorkItem is part of.
1534
+ # @param [Google::Apis::DataflowV1b3::ReportWorkItemStatusRequest] report_work_item_status_request_object
1535
+ # @param [String] fields
1536
+ # Selector specifying which fields to include in a partial response.
1537
+ # @param [String] quota_user
1538
+ # Available to use for quota purposes for server-side applications. Can be any
1539
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1540
+ # @param [Google::Apis::RequestOptions] options
1541
+ # Request-specific options
1542
+ #
1543
+ # @yield [result, err] Result & error if block supplied
1544
+ # @yieldparam result [Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse] parsed result object
1545
+ # @yieldparam err [StandardError] error object if request failed
1546
+ #
1547
+ # @return [Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse]
1548
+ #
1549
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1550
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1551
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1552
+ def report_project_location_job_work_item_status(project_id, location, job_id, report_work_item_status_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1553
+ command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:reportStatus', options)
1554
+ command.request_representation = Google::Apis::DataflowV1b3::ReportWorkItemStatusRequest::Representation
1555
+ command.request_object = report_work_item_status_request_object
1556
+ command.response_representation = Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse::Representation
1557
+ command.response_class = Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse
1558
+ command.params['projectId'] = project_id unless project_id.nil?
1559
+ command.params['location'] = location unless location.nil?
1560
+ command.params['jobId'] = job_id unless job_id.nil?
1561
+ command.query['fields'] = fields unless fields.nil?
1562
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1563
+ execute_or_queue_command(command, &block)
1564
+ end
1565
+
1566
+ # Deletes a snapshot.
1567
+ # @param [String] project_id
1568
+ # The ID of the Cloud Platform project that the snapshot belongs to.
1569
+ # @param [String] location
1570
+ # The location that contains this snapshot.
1571
+ # @param [String] snapshot_id
1572
+ # The ID of the snapshot.
1573
+ # @param [String] fields
1574
+ # Selector specifying which fields to include in a partial response.
1575
+ # @param [String] quota_user
1576
+ # Available to use for quota purposes for server-side applications. Can be any
1577
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1578
+ # @param [Google::Apis::RequestOptions] options
1579
+ # Request-specific options
1580
+ #
1581
+ # @yield [result, err] Result & error if block supplied
1582
+ # @yieldparam result [Google::Apis::DataflowV1b3::DeleteSnapshotResponse] parsed result object
1583
+ # @yieldparam err [StandardError] error object if request failed
1584
+ #
1585
+ # @return [Google::Apis::DataflowV1b3::DeleteSnapshotResponse]
1586
+ #
1587
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1588
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1589
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1590
+ def delete_project_location_snapshot(project_id, location, snapshot_id, fields: nil, quota_user: nil, options: nil, &block)
1591
+ command = make_simple_command(:delete, 'v1b3/projects/{projectId}/locations/{location}/snapshots/{snapshotId}', options)
1592
+ command.response_representation = Google::Apis::DataflowV1b3::DeleteSnapshotResponse::Representation
1593
+ command.response_class = Google::Apis::DataflowV1b3::DeleteSnapshotResponse
1594
+ command.params['projectId'] = project_id unless project_id.nil?
1595
+ command.params['location'] = location unless location.nil?
1596
+ command.params['snapshotId'] = snapshot_id unless snapshot_id.nil?
1597
+ command.query['fields'] = fields unless fields.nil?
1598
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1599
+ execute_or_queue_command(command, &block)
1600
+ end
1601
+
1602
+ # Gets information about a snapshot.
1603
+ # @param [String] project_id
1604
+ # The ID of the Cloud Platform project that the snapshot belongs to.
1605
+ # @param [String] location
1606
+ # The location that contains this snapshot.
1607
+ # @param [String] snapshot_id
1608
+ # The ID of the snapshot.
1609
+ # @param [String] fields
1610
+ # Selector specifying which fields to include in a partial response.
1611
+ # @param [String] quota_user
1612
+ # Available to use for quota purposes for server-side applications. Can be any
1613
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1614
+ # @param [Google::Apis::RequestOptions] options
1615
+ # Request-specific options
1616
+ #
1617
+ # @yield [result, err] Result & error if block supplied
1618
+ # @yieldparam result [Google::Apis::DataflowV1b3::Snapshot] parsed result object
1619
+ # @yieldparam err [StandardError] error object if request failed
1620
+ #
1621
+ # @return [Google::Apis::DataflowV1b3::Snapshot]
1622
+ #
1623
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1624
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1625
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1626
+ def get_project_location_snapshot(project_id, location, snapshot_id, fields: nil, quota_user: nil, options: nil, &block)
1627
+ command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/snapshots/{snapshotId}', options)
1628
+ command.response_representation = Google::Apis::DataflowV1b3::Snapshot::Representation
1629
+ command.response_class = Google::Apis::DataflowV1b3::Snapshot
1630
+ command.params['projectId'] = project_id unless project_id.nil?
1631
+ command.params['location'] = location unless location.nil?
1632
+ command.params['snapshotId'] = snapshot_id unless snapshot_id.nil?
1633
+ command.query['fields'] = fields unless fields.nil?
1634
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1635
+ execute_or_queue_command(command, &block)
1636
+ end
1637
+
1638
+ # Lists snapshots.
1639
+ # @param [String] project_id
1640
+ # The project ID to list snapshots for.
1641
+ # @param [String] location
1642
+ # The location to list snapshots in.
1643
+ # @param [String] job_id
1644
+ # If specified, list snapshots created from this job.
1645
+ # @param [String] fields
1646
+ # Selector specifying which fields to include in a partial response.
1647
+ # @param [String] quota_user
1648
+ # Available to use for quota purposes for server-side applications. Can be any
1649
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1650
+ # @param [Google::Apis::RequestOptions] options
1651
+ # Request-specific options
1652
+ #
1653
+ # @yield [result, err] Result & error if block supplied
1654
+ # @yieldparam result [Google::Apis::DataflowV1b3::ListSnapshotsResponse] parsed result object
1655
+ # @yieldparam err [StandardError] error object if request failed
1656
+ #
1657
+ # @return [Google::Apis::DataflowV1b3::ListSnapshotsResponse]
1658
+ #
1659
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1660
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1661
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1662
+ def list_project_location_snapshots(project_id, location, job_id: nil, fields: nil, quota_user: nil, options: nil, &block)
1663
+ command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/snapshots', options)
1664
+ command.response_representation = Google::Apis::DataflowV1b3::ListSnapshotsResponse::Representation
1665
+ command.response_class = Google::Apis::DataflowV1b3::ListSnapshotsResponse
1666
+ command.params['projectId'] = project_id unless project_id.nil?
1667
+ command.params['location'] = location unless location.nil?
1668
+ command.query['jobId'] = job_id unless job_id.nil?
1669
+ command.query['fields'] = fields unless fields.nil?
1670
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1671
+ execute_or_queue_command(command, &block)
1672
+ end
1673
+
1674
+ # Validates a GoogleSQL query for Cloud Dataflow syntax. Will always confirm the
1675
+ # given query parses correctly, and if able to look up schema information from
1676
+ # DataCatalog, will validate that the query analyzes properly as well.
1677
+ # @param [String] project_id
1678
+ # Required. The ID of the Cloud Platform project that the job belongs to.
1679
+ # @param [String] location
1680
+ # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
1681
+ # regional-endpoints) to which to direct the request.
1682
+ # @param [String] query
1683
+ # The sql query to validate.
1684
+ # @param [String] fields
1685
+ # Selector specifying which fields to include in a partial response.
1686
+ # @param [String] quota_user
1687
+ # Available to use for quota purposes for server-side applications. Can be any
1688
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1689
+ # @param [Google::Apis::RequestOptions] options
1690
+ # Request-specific options
1691
+ #
1692
+ # @yield [result, err] Result & error if block supplied
1693
+ # @yieldparam result [Google::Apis::DataflowV1b3::ValidateResponse] parsed result object
1694
+ # @yieldparam err [StandardError] error object if request failed
1695
+ #
1696
+ # @return [Google::Apis::DataflowV1b3::ValidateResponse]
1697
+ #
1698
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1699
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1700
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1701
+ def validate_project_location_sql(project_id, location, query: nil, fields: nil, quota_user: nil, options: nil, &block)
1702
+ command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/sql:validate', options)
1703
+ command.response_representation = Google::Apis::DataflowV1b3::ValidateResponse::Representation
1704
+ command.response_class = Google::Apis::DataflowV1b3::ValidateResponse
1705
+ command.params['projectId'] = project_id unless project_id.nil?
1706
+ command.params['location'] = location unless location.nil?
1707
+ command.query['query'] = query unless query.nil?
1708
+ command.query['fields'] = fields unless fields.nil?
1709
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1710
+ execute_or_queue_command(command, &block)
1711
+ end
1712
+
1713
+ # Creates a Cloud Dataflow job from a template.
1714
+ # @param [String] project_id
1715
+ # Required. The ID of the Cloud Platform project that the job belongs to.
1716
+ # @param [String] location
1717
+ # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
1718
+ # regional-endpoints) to which to direct the request.
1719
+ # @param [Google::Apis::DataflowV1b3::CreateJobFromTemplateRequest] create_job_from_template_request_object
1720
+ # @param [String] fields
1721
+ # Selector specifying which fields to include in a partial response.
1722
+ # @param [String] quota_user
1723
+ # Available to use for quota purposes for server-side applications. Can be any
1724
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1725
+ # @param [Google::Apis::RequestOptions] options
1726
+ # Request-specific options
1727
+ #
1728
+ # @yield [result, err] Result & error if block supplied
1729
+ # @yieldparam result [Google::Apis::DataflowV1b3::Job] parsed result object
1730
+ # @yieldparam err [StandardError] error object if request failed
1731
+ #
1732
+ # @return [Google::Apis::DataflowV1b3::Job]
1733
+ #
1734
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1735
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1736
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1737
+ def create_job_from_template_with_location(project_id, location, create_job_from_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1738
+ command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/templates', options)
1739
+ command.request_representation = Google::Apis::DataflowV1b3::CreateJobFromTemplateRequest::Representation
1740
+ command.request_object = create_job_from_template_request_object
1741
+ command.response_representation = Google::Apis::DataflowV1b3::Job::Representation
1742
+ command.response_class = Google::Apis::DataflowV1b3::Job
1743
+ command.params['projectId'] = project_id unless project_id.nil?
1744
+ command.params['location'] = location unless location.nil?
1745
+ command.query['fields'] = fields unless fields.nil?
1746
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1747
+ execute_or_queue_command(command, &block)
1748
+ end
1749
+
1750
+ # Get the template associated with a template.
1751
+ # @param [String] project_id
1752
+ # Required. The ID of the Cloud Platform project that the job belongs to.
1753
+ # @param [String] location
1754
+ # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
1755
+ # regional-endpoints) to which to direct the request.
1756
+ # @param [String] gcs_path
1757
+ # Required. A Cloud Storage path to the template from which to create the job.
1758
+ # Must be valid Cloud Storage URL, beginning with 'gs://'.
1759
+ # @param [String] view
1760
+ # The view to retrieve. Defaults to METADATA_ONLY.
1761
+ # @param [String] fields
1762
+ # Selector specifying which fields to include in a partial response.
1763
+ # @param [String] quota_user
1764
+ # Available to use for quota purposes for server-side applications. Can be any
1765
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1766
+ # @param [Google::Apis::RequestOptions] options
1767
+ # Request-specific options
1768
+ #
1769
+ # @yield [result, err] Result & error if block supplied
1770
+ # @yieldparam result [Google::Apis::DataflowV1b3::GetTemplateResponse] parsed result object
1771
+ # @yieldparam err [StandardError] error object if request failed
1772
+ #
1773
+ # @return [Google::Apis::DataflowV1b3::GetTemplateResponse]
1774
+ #
1775
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1776
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1777
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1778
+ def get_project_location_template(project_id, location, gcs_path: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
1779
+ command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/templates:get', options)
1780
+ command.response_representation = Google::Apis::DataflowV1b3::GetTemplateResponse::Representation
1781
+ command.response_class = Google::Apis::DataflowV1b3::GetTemplateResponse
1782
+ command.params['projectId'] = project_id unless project_id.nil?
1783
+ command.params['location'] = location unless location.nil?
1784
+ command.query['gcsPath'] = gcs_path unless gcs_path.nil?
1785
+ command.query['view'] = view unless view.nil?
1786
+ command.query['fields'] = fields unless fields.nil?
1787
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1788
+ execute_or_queue_command(command, &block)
1789
+ end
1790
+
1791
+ # Launch a template.
1792
+ # @param [String] project_id
1793
+ # Required. The ID of the Cloud Platform project that the job belongs to.
1794
+ # @param [String] location
1795
+ # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
1796
+ # regional-endpoints) to which to direct the request.
1797
+ # @param [Google::Apis::DataflowV1b3::LaunchTemplateParameters] launch_template_parameters_object
1798
+ # @param [String] dynamic_template_gcs_path
1799
+ # Path to dynamic template spec file on GCS. The file must be a Json serialized
1800
+ # DynamicTemplateFieSpec object.
1801
+ # @param [String] dynamic_template_staging_location
1802
+ # Cloud Storage path for staging dependencies. Must be a valid Cloud Storage URL,
1803
+ # beginning with `gs://`.
1804
+ # @param [String] gcs_path
1805
+ # A Cloud Storage path to the template from which to create the job. Must be
1806
+ # valid Cloud Storage URL, beginning with 'gs://'.
1807
+ # @param [Boolean] validate_only
1808
+ # If true, the request is validated but not actually executed. Defaults to false.
1809
+ # @param [String] fields
1810
+ # Selector specifying which fields to include in a partial response.
1811
+ # @param [String] quota_user
1812
+ # Available to use for quota purposes for server-side applications. Can be any
1813
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1814
+ # @param [Google::Apis::RequestOptions] options
1815
+ # Request-specific options
1816
+ #
1817
+ # @yield [result, err] Result & error if block supplied
1818
+ # @yieldparam result [Google::Apis::DataflowV1b3::LaunchTemplateResponse] parsed result object
1819
+ # @yieldparam err [StandardError] error object if request failed
1820
+ #
1821
+ # @return [Google::Apis::DataflowV1b3::LaunchTemplateResponse]
1822
+ #
1823
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1824
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1825
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1826
+ def launch_project_location_template(project_id, location, launch_template_parameters_object = nil, dynamic_template_gcs_path: nil, dynamic_template_staging_location: nil, gcs_path: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
1827
+ command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/templates:launch', options)
1828
+ command.request_representation = Google::Apis::DataflowV1b3::LaunchTemplateParameters::Representation
1829
+ command.request_object = launch_template_parameters_object
1830
+ command.response_representation = Google::Apis::DataflowV1b3::LaunchTemplateResponse::Representation
1831
+ command.response_class = Google::Apis::DataflowV1b3::LaunchTemplateResponse
1832
+ command.params['projectId'] = project_id unless project_id.nil?
1833
+ command.params['location'] = location unless location.nil?
1834
+ command.query['dynamicTemplate.gcsPath'] = dynamic_template_gcs_path unless dynamic_template_gcs_path.nil?
1835
+ command.query['dynamicTemplate.stagingLocation'] = dynamic_template_staging_location unless dynamic_template_staging_location.nil?
1836
+ command.query['gcsPath'] = gcs_path unless gcs_path.nil?
1837
+ command.query['validateOnly'] = validate_only unless validate_only.nil?
1838
+ command.query['fields'] = fields unless fields.nil?
1839
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1840
+ execute_or_queue_command(command, &block)
1841
+ end
1842
+
1843
+ # Gets information about a snapshot.
1844
+ # @param [String] project_id
1845
+ # The ID of the Cloud Platform project that the snapshot belongs to.
1846
+ # @param [String] snapshot_id
1847
+ # The ID of the snapshot.
1848
+ # @param [String] location
1849
+ # The location that contains this snapshot.
1850
+ # @param [String] fields
1851
+ # Selector specifying which fields to include in a partial response.
1852
+ # @param [String] quota_user
1853
+ # Available to use for quota purposes for server-side applications. Can be any
1854
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1855
+ # @param [Google::Apis::RequestOptions] options
1856
+ # Request-specific options
1857
+ #
1858
+ # @yield [result, err] Result & error if block supplied
1859
+ # @yieldparam result [Google::Apis::DataflowV1b3::Snapshot] parsed result object
1860
+ # @yieldparam err [StandardError] error object if request failed
1861
+ #
1862
+ # @return [Google::Apis::DataflowV1b3::Snapshot]
1863
+ #
1864
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1865
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1866
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1867
+ def get_project_snapshot(project_id, snapshot_id, location: nil, fields: nil, quota_user: nil, options: nil, &block)
1868
+ command = make_simple_command(:get, 'v1b3/projects/{projectId}/snapshots/{snapshotId}', options)
1869
+ command.response_representation = Google::Apis::DataflowV1b3::Snapshot::Representation
1870
+ command.response_class = Google::Apis::DataflowV1b3::Snapshot
1871
+ command.params['projectId'] = project_id unless project_id.nil?
1872
+ command.params['snapshotId'] = snapshot_id unless snapshot_id.nil?
1873
+ command.query['location'] = location unless location.nil?
1874
+ command.query['fields'] = fields unless fields.nil?
1875
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1876
+ execute_or_queue_command(command, &block)
1877
+ end
1878
+
1879
+ # Lists snapshots.
1880
+ # @param [String] project_id
1881
+ # The project ID to list snapshots for.
1882
+ # @param [String] job_id
1883
+ # If specified, list snapshots created from this job.
1884
+ # @param [String] location
1885
+ # The location to list snapshots in.
1886
+ # @param [String] fields
1887
+ # Selector specifying which fields to include in a partial response.
1888
+ # @param [String] quota_user
1889
+ # Available to use for quota purposes for server-side applications. Can be any
1890
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1891
+ # @param [Google::Apis::RequestOptions] options
1892
+ # Request-specific options
1893
+ #
1894
+ # @yield [result, err] Result & error if block supplied
1895
+ # @yieldparam result [Google::Apis::DataflowV1b3::ListSnapshotsResponse] parsed result object
1896
+ # @yieldparam err [StandardError] error object if request failed
1897
+ #
1898
+ # @return [Google::Apis::DataflowV1b3::ListSnapshotsResponse]
1899
+ #
1900
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1901
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1902
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1903
+ def list_project_snapshots(project_id, job_id: nil, location: nil, fields: nil, quota_user: nil, options: nil, &block)
1904
+ command = make_simple_command(:get, 'v1b3/projects/{projectId}/snapshots', options)
1905
+ command.response_representation = Google::Apis::DataflowV1b3::ListSnapshotsResponse::Representation
1906
+ command.response_class = Google::Apis::DataflowV1b3::ListSnapshotsResponse
1907
+ command.params['projectId'] = project_id unless project_id.nil?
1908
+ command.query['jobId'] = job_id unless job_id.nil?
1909
+ command.query['location'] = location unless location.nil?
1910
+ command.query['fields'] = fields unless fields.nil?
1911
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1912
+ execute_or_queue_command(command, &block)
1913
+ end
1914
+
1915
+ # List TemplateVersions using project_id and an optional display_name field.
1916
+ # List all the TemplateVersions in the Template if display set. List all the
1917
+ # TemplateVersions in the Project if display_name not set.
1918
+ # @param [String] parent
1919
+ # parent includes project_id, and display_name is optional. List by project_id(
1920
+ # pid1) and display_name(tid1). Format: projects/`pid1`/catalogTemplates/`tid1`
1921
+ # List by project_id(pid1). Format: projects/`pid1`
1922
+ # @param [Fixnum] page_size
1923
+ # The maximum number of TemplateVersions to return per page.
1924
+ # @param [String] page_token
1925
+ # The page token, received from a previous ListTemplateVersions call. Provide
1926
+ # this to retrieve the subsequent page.
1927
+ # @param [String] fields
1928
+ # Selector specifying which fields to include in a partial response.
1929
+ # @param [String] quota_user
1930
+ # Available to use for quota purposes for server-side applications. Can be any
1931
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1932
+ # @param [Google::Apis::RequestOptions] options
1933
+ # Request-specific options
1934
+ #
1935
+ # @yield [result, err] Result & error if block supplied
1936
+ # @yieldparam result [Google::Apis::DataflowV1b3::ListTemplateVersionsResponse] parsed result object
1937
+ # @yieldparam err [StandardError] error object if request failed
1938
+ #
1939
+ # @return [Google::Apis::DataflowV1b3::ListTemplateVersionsResponse]
1940
+ #
1941
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1942
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1943
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1944
+ def list_project_template_versions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1945
+ command = make_simple_command(:get, 'v1b3/{+parent}/templateVersions', options)
1946
+ command.response_representation = Google::Apis::DataflowV1b3::ListTemplateVersionsResponse::Representation
1947
+ command.response_class = Google::Apis::DataflowV1b3::ListTemplateVersionsResponse
1948
+ command.params['parent'] = parent unless parent.nil?
1949
+ command.query['pageSize'] = page_size unless page_size.nil?
1950
+ command.query['pageToken'] = page_token unless page_token.nil?
1951
+ command.query['fields'] = fields unless fields.nil?
1952
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1953
+ execute_or_queue_command(command, &block)
1954
+ end
1955
+
1956
+ # Creates a Cloud Dataflow job from a template.
1957
+ # @param [String] project_id
1958
+ # Required. The ID of the Cloud Platform project that the job belongs to.
1959
+ # @param [Google::Apis::DataflowV1b3::CreateJobFromTemplateRequest] create_job_from_template_request_object
1960
+ # @param [String] fields
1961
+ # Selector specifying which fields to include in a partial response.
1962
+ # @param [String] quota_user
1963
+ # Available to use for quota purposes for server-side applications. Can be any
1964
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1965
+ # @param [Google::Apis::RequestOptions] options
1966
+ # Request-specific options
1967
+ #
1968
+ # @yield [result, err] Result & error if block supplied
1969
+ # @yieldparam result [Google::Apis::DataflowV1b3::Job] parsed result object
1970
+ # @yieldparam err [StandardError] error object if request failed
1971
+ #
1972
+ # @return [Google::Apis::DataflowV1b3::Job]
1973
+ #
1974
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1975
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1976
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1977
+ def create_job_from_template(project_id, create_job_from_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1978
+ command = make_simple_command(:post, 'v1b3/projects/{projectId}/templates', options)
1979
+ command.request_representation = Google::Apis::DataflowV1b3::CreateJobFromTemplateRequest::Representation
1980
+ command.request_object = create_job_from_template_request_object
1981
+ command.response_representation = Google::Apis::DataflowV1b3::Job::Representation
1982
+ command.response_class = Google::Apis::DataflowV1b3::Job
1983
+ command.params['projectId'] = project_id unless project_id.nil?
1984
+ command.query['fields'] = fields unless fields.nil?
1985
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1986
+ execute_or_queue_command(command, &block)
1987
+ end
1988
+
1989
+ # Get the template associated with a template.
1990
+ # @param [String] project_id
1991
+ # Required. The ID of the Cloud Platform project that the job belongs to.
1992
+ # @param [String] gcs_path
1993
+ # Required. A Cloud Storage path to the template from which to create the job.
1994
+ # Must be valid Cloud Storage URL, beginning with 'gs://'.
1995
+ # @param [String] location
1996
+ # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
1997
+ # regional-endpoints) to which to direct the request.
1998
+ # @param [String] view
1999
+ # The view to retrieve. Defaults to METADATA_ONLY.
2000
+ # @param [String] fields
2001
+ # Selector specifying which fields to include in a partial response.
2002
+ # @param [String] quota_user
2003
+ # Available to use for quota purposes for server-side applications. Can be any
2004
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2005
+ # @param [Google::Apis::RequestOptions] options
2006
+ # Request-specific options
2007
+ #
2008
+ # @yield [result, err] Result & error if block supplied
2009
+ # @yieldparam result [Google::Apis::DataflowV1b3::GetTemplateResponse] parsed result object
2010
+ # @yieldparam err [StandardError] error object if request failed
2011
+ #
2012
+ # @return [Google::Apis::DataflowV1b3::GetTemplateResponse]
2013
+ #
2014
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2015
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2016
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2017
+ def get_project_template(project_id, gcs_path: nil, location: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
2018
+ command = make_simple_command(:get, 'v1b3/projects/{projectId}/templates:get', options)
2019
+ command.response_representation = Google::Apis::DataflowV1b3::GetTemplateResponse::Representation
2020
+ command.response_class = Google::Apis::DataflowV1b3::GetTemplateResponse
2021
+ command.params['projectId'] = project_id unless project_id.nil?
2022
+ command.query['gcsPath'] = gcs_path unless gcs_path.nil?
2023
+ command.query['location'] = location unless location.nil?
2024
+ command.query['view'] = view unless view.nil?
2025
+ command.query['fields'] = fields unless fields.nil?
2026
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2027
+ execute_or_queue_command(command, &block)
2028
+ end
2029
+
2030
+ # Launch a template.
2031
+ # @param [String] project_id
2032
+ # Required. The ID of the Cloud Platform project that the job belongs to.
2033
+ # @param [Google::Apis::DataflowV1b3::LaunchTemplateParameters] launch_template_parameters_object
2034
+ # @param [String] dynamic_template_gcs_path
2035
+ # Path to dynamic template spec file on GCS. The file must be a Json serialized
2036
+ # DynamicTemplateFieSpec object.
2037
+ # @param [String] dynamic_template_staging_location
2038
+ # Cloud Storage path for staging dependencies. Must be a valid Cloud Storage URL,
2039
+ # beginning with `gs://`.
2040
+ # @param [String] gcs_path
2041
+ # A Cloud Storage path to the template from which to create the job. Must be
2042
+ # valid Cloud Storage URL, beginning with 'gs://'.
2043
+ # @param [String] location
2044
+ # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
2045
+ # regional-endpoints) to which to direct the request.
2046
+ # @param [Boolean] validate_only
2047
+ # If true, the request is validated but not actually executed. Defaults to false.
2048
+ # @param [String] fields
2049
+ # Selector specifying which fields to include in a partial response.
2050
+ # @param [String] quota_user
2051
+ # Available to use for quota purposes for server-side applications. Can be any
2052
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2053
+ # @param [Google::Apis::RequestOptions] options
2054
+ # Request-specific options
2055
+ #
2056
+ # @yield [result, err] Result & error if block supplied
2057
+ # @yieldparam result [Google::Apis::DataflowV1b3::LaunchTemplateResponse] parsed result object
2058
+ # @yieldparam err [StandardError] error object if request failed
2059
+ #
2060
+ # @return [Google::Apis::DataflowV1b3::LaunchTemplateResponse]
2061
+ #
2062
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2063
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2064
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2065
+ def launch_project_template(project_id, launch_template_parameters_object = nil, dynamic_template_gcs_path: nil, dynamic_template_staging_location: nil, gcs_path: nil, location: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
2066
+ command = make_simple_command(:post, 'v1b3/projects/{projectId}/templates:launch', options)
2067
+ command.request_representation = Google::Apis::DataflowV1b3::LaunchTemplateParameters::Representation
2068
+ command.request_object = launch_template_parameters_object
2069
+ command.response_representation = Google::Apis::DataflowV1b3::LaunchTemplateResponse::Representation
2070
+ command.response_class = Google::Apis::DataflowV1b3::LaunchTemplateResponse
2071
+ command.params['projectId'] = project_id unless project_id.nil?
2072
+ command.query['dynamicTemplate.gcsPath'] = dynamic_template_gcs_path unless dynamic_template_gcs_path.nil?
2073
+ command.query['dynamicTemplate.stagingLocation'] = dynamic_template_staging_location unless dynamic_template_staging_location.nil?
2074
+ command.query['gcsPath'] = gcs_path unless gcs_path.nil?
2075
+ command.query['location'] = location unless location.nil?
2076
+ command.query['validateOnly'] = validate_only unless validate_only.nil?
2077
+ command.query['fields'] = fields unless fields.nil?
2078
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2079
+ execute_or_queue_command(command, &block)
2080
+ end
2081
+
2082
+ protected
2083
+
2084
+ def apply_command_defaults(command)
2085
+ command.query['key'] = key unless key.nil?
2086
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2087
+ end
2088
+ end
2089
+ end
2090
+ end
2091
+ end