Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4f877e562986034f25ea4246ad1256eabd339526 / . / docs / dyn / dataflow_v1b3.projects.jobs.html
blob: 59e4c1eef2879b4044045e71bd405684835b6765 [file] [log] [blame]
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="dataflow_v1b3.html">Google Dataflow API</a> . <a href="dataflow_v1b3.projects.html">projects</a> . <a href="dataflow_v1b3.projects.jobs.html">jobs</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="dataflow_v1b3.projects.jobs.messages.html">messages()</a></code>
79</p>
80<p class="firstline">Returns the messages Resource.</p>
81
82<p class="toc_element">
83 <code><a href="dataflow_v1b3.projects.jobs.workItems.html">workItems()</a></code>
84</p>
85<p class="firstline">Returns the workItems Resource.</p>
86
87<p class="toc_element">
88 <code><a href="#create">create(projectId, body, replaceJobId=None, view=None)</a></code></p>
89<p class="firstline">Creates a dataflow job.</p>
90<p class="toc_element">
91 <code><a href="#get">get(projectId, jobId, view=None)</a></code></p>
92<p class="firstline">Gets the state of the specified dataflow job.</p>
93<p class="toc_element">
94 <code><a href="#getMetrics">getMetrics(projectId, jobId, startTime=None)</a></code></p>
95<p class="firstline">Request the job status.</p>
96<p class="toc_element">
97 <code><a href="#list">list(projectId, pageToken=None, pageSize=None, view=None)</a></code></p>
98<p class="firstline">List the jobs of a project</p>
99<p class="toc_element">
100 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
101<p class="firstline">Retrieves the next page of results.</p>
102<p class="toc_element">
103 <code><a href="#patch">patch(projectId, jobId, body)</a></code></p>
104<p class="firstline">Updates the state of an existing dataflow job. This method supports patch semantics.</p>
105<p class="toc_element">
106 <code><a href="#update">update(projectId, jobId, body)</a></code></p>
107<p class="firstline">Updates the state of an existing dataflow job.</p>
108<h3>Method Details</h3>
109<div class="method">
110 <code class="details" id="create">create(projectId, body, replaceJobId=None, view=None)</code>
111 <pre>Creates a dataflow job.
112
113Args:
114 projectId: string, A parameter (required)
115 body: object, The request body. (required)
116 The object takes the form of:
117
118{
119 "clientRequestId": "A String",
120 "requestedState": "A String",
121 "name": "A String",
122 "projectId": "A String",
123 "transformNameMapping": {
124 "a_key": "A String",
125 },
126 "id": "A String",
127 "environment": {
128 "version": {
129 "a_key": "",
130 },
131 "workerPools": [
132 {
133 "diskSourceImage": "A String",
134 "teardownPolicy": "A String",
135 "kind": "A String",
136 "packages": [
137 {
138 "location": "A String",
139 "name": "A String",
140 },
141 ],
142 "machineType": "A String",
143 "network": "A String",
144 "zone": "A String",
145 "onHostMaintenance": "A String",
146 "diskType": "A String",
147 "taskrunnerSettings": {
148 "workflowFileName": "A String",
149 "logUploadLocation": "A String",
150 "commandlinesFileName": "A String",
151 "alsologtostderr": True or False,
152 "vmId": "A String",
153 "baseTaskDir": "A String",
154 "continueOnException": True or False,
155 "baseUrl": "A String",
156 "parallelWorkerSettings": {
157 "reportingEnabled": True or False,
158 "shuffleServicePath": "A String",
159 "workerId": "A String",
160 "baseUrl": "A String",
161 "servicePath": "A String",
162 "tempStoragePrefix": "A String",
163 },
164 "oauthScopes": [
165 "A String",
166 ],
167 "taskGroup": "A String",
168 "languageHint": "A String",
169 "logToSerialconsole": True or False,
170 "streamingWorkerMainClass": "A String",
171 "logDir": "A String",
172 "dataflowApiVersion": "A String",
173 "taskUser": "A String",
174 "harnessCommand": "A String",
175 "tempStoragePrefix": "A String",
176 },
177 "diskSizeGb": 42,
178 "poolArgs": {
179 "a_key": "",
180 },
181 "numWorkers": 42,
182 "defaultPackageSet": "A String",
183 "metadata": {
184 "a_key": "A String",
185 },
186 "autoscalingSettings": {
187 "maxNumWorkers": 42,
188 "algorithm": "A String",
189 },
190 "dataDisks": [
191 {
192 "mountPoint": "A String",
193 "sizeGb": 42,
194 "diskType": "A String",
195 },
196 ],
197 },
198 ],
199 "dataset": "A String",
200 "experiments": [
201 "A String",
202 ],
203 "sdkPipelineOptions": {
204 "a_key": "",
205 },
206 "userAgent": {
207 "a_key": "",
208 },
209 "clusterManagerApiService": "A String",
210 "tempStoragePrefix": "A String",
211 },
212 "replaceJobId": "A String",
213 "steps": [
214 {
215 "kind": "A String",
216 "name": "A String",
217 "properties": {
218 "a_key": "",
219 },
220 },
221 ],
222 "currentStateTime": "A String",
223 "type": "A String",
224 "createTime": "A String",
225 "currentState": "A String",
226 "executionInfo": {
227 "stages": {
228 "a_key": {
229 "stepName": [
230 "A String",
231 ],
232 },
233 },
234 },
235}
236
237 replaceJobId: string, A parameter
238 view: string, A parameter
239 Allowed values
240 JOB_VIEW_ALL -
241 JOB_VIEW_SUMMARY -
242 JOB_VIEW_UNKNOWN -
243
244Returns:
245 An object of the form:
246
247 {
248 "clientRequestId": "A String",
249 "requestedState": "A String",
250 "name": "A String",
251 "projectId": "A String",
252 "transformNameMapping": {
253 "a_key": "A String",
254 },
255 "id": "A String",
256 "environment": {
257 "version": {
258 "a_key": "",
259 },
260 "workerPools": [
261 {
262 "diskSourceImage": "A String",
263 "teardownPolicy": "A String",
264 "kind": "A String",
265 "packages": [
266 {
267 "location": "A String",
268 "name": "A String",
269 },
270 ],
271 "machineType": "A String",
272 "network": "A String",
273 "zone": "A String",
274 "onHostMaintenance": "A String",
275 "diskType": "A String",
276 "taskrunnerSettings": {
277 "workflowFileName": "A String",
278 "logUploadLocation": "A String",
279 "commandlinesFileName": "A String",
280 "alsologtostderr": True or False,
281 "vmId": "A String",
282 "baseTaskDir": "A String",
283 "continueOnException": True or False,
284 "baseUrl": "A String",
285 "parallelWorkerSettings": {
286 "reportingEnabled": True or False,
287 "shuffleServicePath": "A String",
288 "workerId": "A String",
289 "baseUrl": "A String",
290 "servicePath": "A String",
291 "tempStoragePrefix": "A String",
292 },
293 "oauthScopes": [
294 "A String",
295 ],
296 "taskGroup": "A String",
297 "languageHint": "A String",
298 "logToSerialconsole": True or False,
299 "streamingWorkerMainClass": "A String",
300 "logDir": "A String",
301 "dataflowApiVersion": "A String",
302 "taskUser": "A String",
303 "harnessCommand": "A String",
304 "tempStoragePrefix": "A String",
305 },
306 "diskSizeGb": 42,
307 "poolArgs": {
308 "a_key": "",
309 },
310 "numWorkers": 42,
311 "defaultPackageSet": "A String",
312 "metadata": {
313 "a_key": "A String",
314 },
315 "autoscalingSettings": {
316 "maxNumWorkers": 42,
317 "algorithm": "A String",
318 },
319 "dataDisks": [
320 {
321 "mountPoint": "A String",
322 "sizeGb": 42,
323 "diskType": "A String",
324 },
325 ],
326 },
327 ],
328 "dataset": "A String",
329 "experiments": [
330 "A String",
331 ],
332 "sdkPipelineOptions": {
333 "a_key": "",
334 },
335 "userAgent": {
336 "a_key": "",
337 },
338 "clusterManagerApiService": "A String",
339 "tempStoragePrefix": "A String",
340 },
341 "replaceJobId": "A String",
342 "steps": [
343 {
344 "kind": "A String",
345 "name": "A String",
346 "properties": {
347 "a_key": "",
348 },
349 },
350 ],
351 "currentStateTime": "A String",
352 "type": "A String",
353 "createTime": "A String",
354 "currentState": "A String",
355 "executionInfo": {
356 "stages": {
357 "a_key": {
358 "stepName": [
359 "A String",
360 ],
361 },
362 },
363 },
364 }</pre>
365</div>
366
367<div class="method">
368 <code class="details" id="get">get(projectId, jobId, view=None)</code>
369 <pre>Gets the state of the specified dataflow job.
370
371Args:
372 projectId: string, A parameter (required)
373 jobId: string, A parameter (required)
374 view: string, A parameter
375 Allowed values
376 JOB_VIEW_ALL -
377 JOB_VIEW_SUMMARY -
378 JOB_VIEW_UNKNOWN -
379
380Returns:
381 An object of the form:
382
383 {
384 "clientRequestId": "A String",
385 "requestedState": "A String",
386 "name": "A String",
387 "projectId": "A String",
388 "transformNameMapping": {
389 "a_key": "A String",
390 },
391 "id": "A String",
392 "environment": {
393 "version": {
394 "a_key": "",
395 },
396 "workerPools": [
397 {
398 "diskSourceImage": "A String",
399 "teardownPolicy": "A String",
400 "kind": "A String",
401 "packages": [
402 {
403 "location": "A String",
404 "name": "A String",
405 },
406 ],
407 "machineType": "A String",
408 "network": "A String",
409 "zone": "A String",
410 "onHostMaintenance": "A String",
411 "diskType": "A String",
412 "taskrunnerSettings": {
413 "workflowFileName": "A String",
414 "logUploadLocation": "A String",
415 "commandlinesFileName": "A String",
416 "alsologtostderr": True or False,
417 "vmId": "A String",
418 "baseTaskDir": "A String",
419 "continueOnException": True or False,
420 "baseUrl": "A String",
421 "parallelWorkerSettings": {
422 "reportingEnabled": True or False,
423 "shuffleServicePath": "A String",
424 "workerId": "A String",
425 "baseUrl": "A String",
426 "servicePath": "A String",
427 "tempStoragePrefix": "A String",
428 },
429 "oauthScopes": [
430 "A String",
431 ],
432 "taskGroup": "A String",
433 "languageHint": "A String",
434 "logToSerialconsole": True or False,
435 "streamingWorkerMainClass": "A String",
436 "logDir": "A String",
437 "dataflowApiVersion": "A String",
438 "taskUser": "A String",
439 "harnessCommand": "A String",
440 "tempStoragePrefix": "A String",
441 },
442 "diskSizeGb": 42,
443 "poolArgs": {
444 "a_key": "",
445 },
446 "numWorkers": 42,
447 "defaultPackageSet": "A String",
448 "metadata": {
449 "a_key": "A String",
450 },
451 "autoscalingSettings": {
452 "maxNumWorkers": 42,
453 "algorithm": "A String",
454 },
455 "dataDisks": [
456 {
457 "mountPoint": "A String",
458 "sizeGb": 42,
459 "diskType": "A String",
460 },
461 ],
462 },
463 ],
464 "dataset": "A String",
465 "experiments": [
466 "A String",
467 ],
468 "sdkPipelineOptions": {
469 "a_key": "",
470 },
471 "userAgent": {
472 "a_key": "",
473 },
474 "clusterManagerApiService": "A String",
475 "tempStoragePrefix": "A String",
476 },
477 "replaceJobId": "A String",
478 "steps": [
479 {
480 "kind": "A String",
481 "name": "A String",
482 "properties": {
483 "a_key": "",
484 },
485 },
486 ],
487 "currentStateTime": "A String",
488 "type": "A String",
489 "createTime": "A String",
490 "currentState": "A String",
491 "executionInfo": {
492 "stages": {
493 "a_key": {
494 "stepName": [
495 "A String",
496 ],
497 },
498 },
499 },
500 }</pre>
501</div>
502
503<div class="method">
504 <code class="details" id="getMetrics">getMetrics(projectId, jobId, startTime=None)</code>
505 <pre>Request the job status.
506
507Args:
508 projectId: string, A parameter (required)
509 jobId: string, A parameter (required)
510 startTime: string, A parameter
511
512Returns:
513 An object of the form:
514
515 {
516 "metrics": [
517 {
518 "meanCount": "",
519 "kind": "A String",
520 "set": "",
521 "name": {
522 "origin": "A String",
523 "name": "A String",
524 "context": {
525 "a_key": "A String",
526 },
527 },
528 "meanSum": "",
529 "cumulative": True or False,
530 "updateTime": "A String",
531 "scalar": "",
532 "internal": "",
533 },
534 ],
535 "metricTime": "A String",
536 }</pre>
537</div>
538
539<div class="method">
540 <code class="details" id="list">list(projectId, pageToken=None, pageSize=None, view=None)</code>
541 <pre>List the jobs of a project
542
543Args:
544 projectId: string, A parameter (required)
545 pageToken: string, A parameter
546 pageSize: integer, A parameter
547 view: string, A parameter
548 Allowed values
549 JOB_VIEW_ALL -
550 JOB_VIEW_SUMMARY -
551 JOB_VIEW_UNKNOWN -
552
553Returns:
554 An object of the form:
555
556 {
557 "nextPageToken": "A String",
558 "jobs": [
559 {
560 "clientRequestId": "A String",
561 "requestedState": "A String",
562 "name": "A String",
563 "projectId": "A String",
564 "transformNameMapping": {
565 "a_key": "A String",
566 },
567 "id": "A String",
568 "environment": {
569 "version": {
570 "a_key": "",
571 },
572 "workerPools": [
573 {
574 "diskSourceImage": "A String",
575 "teardownPolicy": "A String",
576 "kind": "A String",
577 "packages": [
578 {
579 "location": "A String",
580 "name": "A String",
581 },
582 ],
583 "machineType": "A String",
584 "network": "A String",
585 "zone": "A String",
586 "onHostMaintenance": "A String",
587 "diskType": "A String",
588 "taskrunnerSettings": {
589 "workflowFileName": "A String",
590 "logUploadLocation": "A String",
591 "commandlinesFileName": "A String",
592 "alsologtostderr": True or False,
593 "vmId": "A String",
594 "baseTaskDir": "A String",
595 "continueOnException": True or False,
596 "baseUrl": "A String",
597 "parallelWorkerSettings": {
598 "reportingEnabled": True or False,
599 "shuffleServicePath": "A String",
600 "workerId": "A String",
601 "baseUrl": "A String",
602 "servicePath": "A String",
603 "tempStoragePrefix": "A String",
604 },
605 "oauthScopes": [
606 "A String",
607 ],
608 "taskGroup": "A String",
609 "languageHint": "A String",
610 "logToSerialconsole": True or False,
611 "streamingWorkerMainClass": "A String",
612 "logDir": "A String",
613 "dataflowApiVersion": "A String",
614 "taskUser": "A String",
615 "harnessCommand": "A String",
616 "tempStoragePrefix": "A String",
617 },
618 "diskSizeGb": 42,
619 "poolArgs": {
620 "a_key": "",
621 },
622 "numWorkers": 42,
623 "defaultPackageSet": "A String",
624 "metadata": {
625 "a_key": "A String",
626 },
627 "autoscalingSettings": {
628 "maxNumWorkers": 42,
629 "algorithm": "A String",
630 },
631 "dataDisks": [
632 {
633 "mountPoint": "A String",
634 "sizeGb": 42,
635 "diskType": "A String",
636 },
637 ],
638 },
639 ],
640 "dataset": "A String",
641 "experiments": [
642 "A String",
643 ],
644 "sdkPipelineOptions": {
645 "a_key": "",
646 },
647 "userAgent": {
648 "a_key": "",
649 },
650 "clusterManagerApiService": "A String",
651 "tempStoragePrefix": "A String",
652 },
653 "replaceJobId": "A String",
654 "steps": [
655 {
656 "kind": "A String",
657 "name": "A String",
658 "properties": {
659 "a_key": "",
660 },
661 },
662 ],
663 "currentStateTime": "A String",
664 "type": "A String",
665 "createTime": "A String",
666 "currentState": "A String",
667 "executionInfo": {
668 "stages": {
669 "a_key": {
670 "stepName": [
671 "A String",
672 ],
673 },
674 },
675 },
676 },
677 ],
678 }</pre>
679</div>
680
681<div class="method">
682 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
683 <pre>Retrieves the next page of results.
684
685Args:
686 previous_request: The request for the previous page. (required)
687 previous_response: The response from the request for the previous page. (required)
688
689Returns:
690 A request object that you can call 'execute()' on to request the next
691 page. Returns None if there are no more items in the collection.
692 </pre>
693</div>
694
695<div class="method">
696 <code class="details" id="patch">patch(projectId, jobId, body)</code>
697 <pre>Updates the state of an existing dataflow job. This method supports patch semantics.
698
699Args:
700 projectId: string, A parameter (required)
701 jobId: string, A parameter (required)
702 body: object, The request body. (required)
703 The object takes the form of:
704
705{
706 "clientRequestId": "A String",
707 "requestedState": "A String",
708 "name": "A String",
709 "projectId": "A String",
710 "transformNameMapping": {
711 "a_key": "A String",
712 },
713 "id": "A String",
714 "environment": {
715 "version": {
716 "a_key": "",
717 },
718 "workerPools": [
719 {
720 "diskSourceImage": "A String",
721 "teardownPolicy": "A String",
722 "kind": "A String",
723 "packages": [
724 {
725 "location": "A String",
726 "name": "A String",
727 },
728 ],
729 "machineType": "A String",
730 "network": "A String",
731 "zone": "A String",
732 "onHostMaintenance": "A String",
733 "diskType": "A String",
734 "taskrunnerSettings": {
735 "workflowFileName": "A String",
736 "logUploadLocation": "A String",
737 "commandlinesFileName": "A String",
738 "alsologtostderr": True or False,
739 "vmId": "A String",
740 "baseTaskDir": "A String",
741 "continueOnException": True or False,
742 "baseUrl": "A String",
743 "parallelWorkerSettings": {
744 "reportingEnabled": True or False,
745 "shuffleServicePath": "A String",
746 "workerId": "A String",
747 "baseUrl": "A String",
748 "servicePath": "A String",
749 "tempStoragePrefix": "A String",
750 },
751 "oauthScopes": [
752 "A String",
753 ],
754 "taskGroup": "A String",
755 "languageHint": "A String",
756 "logToSerialconsole": True or False,
757 "streamingWorkerMainClass": "A String",
758 "logDir": "A String",
759 "dataflowApiVersion": "A String",
760 "taskUser": "A String",
761 "harnessCommand": "A String",
762 "tempStoragePrefix": "A String",
763 },
764 "diskSizeGb": 42,
765 "poolArgs": {
766 "a_key": "",
767 },
768 "numWorkers": 42,
769 "defaultPackageSet": "A String",
770 "metadata": {
771 "a_key": "A String",
772 },
773 "autoscalingSettings": {
774 "maxNumWorkers": 42,
775 "algorithm": "A String",
776 },
777 "dataDisks": [
778 {
779 "mountPoint": "A String",
780 "sizeGb": 42,
781 "diskType": "A String",
782 },
783 ],
784 },
785 ],
786 "dataset": "A String",
787 "experiments": [
788 "A String",
789 ],
790 "sdkPipelineOptions": {
791 "a_key": "",
792 },
793 "userAgent": {
794 "a_key": "",
795 },
796 "clusterManagerApiService": "A String",
797 "tempStoragePrefix": "A String",
798 },
799 "replaceJobId": "A String",
800 "steps": [
801 {
802 "kind": "A String",
803 "name": "A String",
804 "properties": {
805 "a_key": "",
806 },
807 },
808 ],
809 "currentStateTime": "A String",
810 "type": "A String",
811 "createTime": "A String",
812 "currentState": "A String",
813 "executionInfo": {
814 "stages": {
815 "a_key": {
816 "stepName": [
817 "A String",
818 ],
819 },
820 },
821 },
822}
823
824
825Returns:
826 An object of the form:
827
828 {
829 "clientRequestId": "A String",
830 "requestedState": "A String",
831 "name": "A String",
832 "projectId": "A String",
833 "transformNameMapping": {
834 "a_key": "A String",
835 },
836 "id": "A String",
837 "environment": {
838 "version": {
839 "a_key": "",
840 },
841 "workerPools": [
842 {
843 "diskSourceImage": "A String",
844 "teardownPolicy": "A String",
845 "kind": "A String",
846 "packages": [
847 {
848 "location": "A String",
849 "name": "A String",
850 },
851 ],
852 "machineType": "A String",
853 "network": "A String",
854 "zone": "A String",
855 "onHostMaintenance": "A String",
856 "diskType": "A String",
857 "taskrunnerSettings": {
858 "workflowFileName": "A String",
859 "logUploadLocation": "A String",
860 "commandlinesFileName": "A String",
861 "alsologtostderr": True or False,
862 "vmId": "A String",
863 "baseTaskDir": "A String",
864 "continueOnException": True or False,
865 "baseUrl": "A String",
866 "parallelWorkerSettings": {
867 "reportingEnabled": True or False,
868 "shuffleServicePath": "A String",
869 "workerId": "A String",
870 "baseUrl": "A String",
871 "servicePath": "A String",
872 "tempStoragePrefix": "A String",
873 },
874 "oauthScopes": [
875 "A String",
876 ],
877 "taskGroup": "A String",
878 "languageHint": "A String",
879 "logToSerialconsole": True or False,
880 "streamingWorkerMainClass": "A String",
881 "logDir": "A String",
882 "dataflowApiVersion": "A String",
883 "taskUser": "A String",
884 "harnessCommand": "A String",
885 "tempStoragePrefix": "A String",
886 },
887 "diskSizeGb": 42,
888 "poolArgs": {
889 "a_key": "",
890 },
891 "numWorkers": 42,
892 "defaultPackageSet": "A String",
893 "metadata": {
894 "a_key": "A String",
895 },
896 "autoscalingSettings": {
897 "maxNumWorkers": 42,
898 "algorithm": "A String",
899 },
900 "dataDisks": [
901 {
902 "mountPoint": "A String",
903 "sizeGb": 42,
904 "diskType": "A String",
905 },
906 ],
907 },
908 ],
909 "dataset": "A String",
910 "experiments": [
911 "A String",
912 ],
913 "sdkPipelineOptions": {
914 "a_key": "",
915 },
916 "userAgent": {
917 "a_key": "",
918 },
919 "clusterManagerApiService": "A String",
920 "tempStoragePrefix": "A String",
921 },
922 "replaceJobId": "A String",
923 "steps": [
924 {
925 "kind": "A String",
926 "name": "A String",
927 "properties": {
928 "a_key": "",
929 },
930 },
931 ],
932 "currentStateTime": "A String",
933 "type": "A String",
934 "createTime": "A String",
935 "currentState": "A String",
936 "executionInfo": {
937 "stages": {
938 "a_key": {
939 "stepName": [
940 "A String",
941 ],
942 },
943 },
944 },
945 }</pre>
946</div>
947
948<div class="method">
949 <code class="details" id="update">update(projectId, jobId, body)</code>
950 <pre>Updates the state of an existing dataflow job.
951
952Args:
953 projectId: string, A parameter (required)
954 jobId: string, A parameter (required)
955 body: object, The request body. (required)
956 The object takes the form of:
957
958{
959 "clientRequestId": "A String",
960 "requestedState": "A String",
961 "name": "A String",
962 "projectId": "A String",
963 "transformNameMapping": {
964 "a_key": "A String",
965 },
966 "id": "A String",
967 "environment": {
968 "version": {
969 "a_key": "",
970 },
971 "workerPools": [
972 {
973 "diskSourceImage": "A String",
974 "teardownPolicy": "A String",
975 "kind": "A String",
976 "packages": [
977 {
978 "location": "A String",
979 "name": "A String",
980 },
981 ],
982 "machineType": "A String",
983 "network": "A String",
984 "zone": "A String",
985 "onHostMaintenance": "A String",
986 "diskType": "A String",
987 "taskrunnerSettings": {
988 "workflowFileName": "A String",
989 "logUploadLocation": "A String",
990 "commandlinesFileName": "A String",
991 "alsologtostderr": True or False,
992 "vmId": "A String",
993 "baseTaskDir": "A String",
994 "continueOnException": True or False,
995 "baseUrl": "A String",
996 "parallelWorkerSettings": {
997 "reportingEnabled": True or False,
998 "shuffleServicePath": "A String",
999 "workerId": "A String",
1000 "baseUrl": "A String",
1001 "servicePath": "A String",
1002 "tempStoragePrefix": "A String",
1003 },
1004 "oauthScopes": [
1005 "A String",
1006 ],
1007 "taskGroup": "A String",
1008 "languageHint": "A String",
1009 "logToSerialconsole": True or False,
1010 "streamingWorkerMainClass": "A String",
1011 "logDir": "A String",
1012 "dataflowApiVersion": "A String",
1013 "taskUser": "A String",
1014 "harnessCommand": "A String",
1015 "tempStoragePrefix": "A String",
1016 },
1017 "diskSizeGb": 42,
1018 "poolArgs": {
1019 "a_key": "",
1020 },
1021 "numWorkers": 42,
1022 "defaultPackageSet": "A String",
1023 "metadata": {
1024 "a_key": "A String",
1025 },
1026 "autoscalingSettings": {
1027 "maxNumWorkers": 42,
1028 "algorithm": "A String",
1029 },
1030 "dataDisks": [
1031 {
1032 "mountPoint": "A String",
1033 "sizeGb": 42,
1034 "diskType": "A String",
1035 },
1036 ],
1037 },
1038 ],
1039 "dataset": "A String",
1040 "experiments": [
1041 "A String",
1042 ],
1043 "sdkPipelineOptions": {
1044 "a_key": "",
1045 },
1046 "userAgent": {
1047 "a_key": "",
1048 },
1049 "clusterManagerApiService": "A String",
1050 "tempStoragePrefix": "A String",
1051 },
1052 "replaceJobId": "A String",
1053 "steps": [
1054 {
1055 "kind": "A String",
1056 "name": "A String",
1057 "properties": {
1058 "a_key": "",
1059 },
1060 },
1061 ],
1062 "currentStateTime": "A String",
1063 "type": "A String",
1064 "createTime": "A String",
1065 "currentState": "A String",
1066 "executionInfo": {
1067 "stages": {
1068 "a_key": {
1069 "stepName": [
1070 "A String",
1071 ],
1072 },
1073 },
1074 },
1075}
1076
1077
1078Returns:
1079 An object of the form:
1080
1081 {
1082 "clientRequestId": "A String",
1083 "requestedState": "A String",
1084 "name": "A String",
1085 "projectId": "A String",
1086 "transformNameMapping": {
1087 "a_key": "A String",
1088 },
1089 "id": "A String",
1090 "environment": {
1091 "version": {
1092 "a_key": "",
1093 },
1094 "workerPools": [
1095 {
1096 "diskSourceImage": "A String",
1097 "teardownPolicy": "A String",
1098 "kind": "A String",
1099 "packages": [
1100 {
1101 "location": "A String",
1102 "name": "A String",
1103 },
1104 ],
1105 "machineType": "A String",
1106 "network": "A String",
1107 "zone": "A String",
1108 "onHostMaintenance": "A String",
1109 "diskType": "A String",
1110 "taskrunnerSettings": {
1111 "workflowFileName": "A String",
1112 "logUploadLocation": "A String",
1113 "commandlinesFileName": "A String",
1114 "alsologtostderr": True or False,
1115 "vmId": "A String",
1116 "baseTaskDir": "A String",
1117 "continueOnException": True or False,
1118 "baseUrl": "A String",
1119 "parallelWorkerSettings": {
1120 "reportingEnabled": True or False,
1121 "shuffleServicePath": "A String",
1122 "workerId": "A String",
1123 "baseUrl": "A String",
1124 "servicePath": "A String",
1125 "tempStoragePrefix": "A String",
1126 },
1127 "oauthScopes": [
1128 "A String",
1129 ],
1130 "taskGroup": "A String",
1131 "languageHint": "A String",
1132 "logToSerialconsole": True or False,
1133 "streamingWorkerMainClass": "A String",
1134 "logDir": "A String",
1135 "dataflowApiVersion": "A String",
1136 "taskUser": "A String",
1137 "harnessCommand": "A String",
1138 "tempStoragePrefix": "A String",
1139 },
1140 "diskSizeGb": 42,
1141 "poolArgs": {
1142 "a_key": "",
1143 },
1144 "numWorkers": 42,
1145 "defaultPackageSet": "A String",
1146 "metadata": {
1147 "a_key": "A String",
1148 },
1149 "autoscalingSettings": {
1150 "maxNumWorkers": 42,
1151 "algorithm": "A String",
1152 },
1153 "dataDisks": [
1154 {
1155 "mountPoint": "A String",
1156 "sizeGb": 42,
1157 "diskType": "A String",
1158 },
1159 ],
1160 },
1161 ],
1162 "dataset": "A String",
1163 "experiments": [
1164 "A String",
1165 ],
1166 "sdkPipelineOptions": {
1167 "a_key": "",
1168 },
1169 "userAgent": {
1170 "a_key": "",
1171 },
1172 "clusterManagerApiService": "A String",
1173 "tempStoragePrefix": "A String",
1174 },
1175 "replaceJobId": "A String",
1176 "steps": [
1177 {
1178 "kind": "A String",
1179 "name": "A String",
1180 "properties": {
1181 "a_key": "",
1182 },
1183 },
1184 ],
1185 "currentStateTime": "A String",
1186 "type": "A String",
1187 "createTime": "A String",
1188 "currentState": "A String",
1189 "executionInfo": {
1190 "stages": {
1191 "a_key": {
1192 "stepName": [
1193 "A String",
1194 ],
1195 },
1196 },
1197 },
1198 }</pre>
1199</div>
1200
1201</body></html>