Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(203)

Side by Side Diff: discovery/googleapis_beta/dataflow__v1b3.json

Issue 2649893002: Api-roll 44: 2017-01-23 (Closed)
Patch Set: Created 3 years, 11 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
1 { 1 {
2 "auth": { 2 "auth": {
3 "oauth2": { 3 "oauth2": {
4 "scopes": { 4 "scopes": {
5 "https://www.googleapis.com/auth/cloud-platform": { 5 "https://www.googleapis.com/auth/cloud-platform": {
6 "description": "View and manage your data across Google Clou d Platform services" 6 "description": "View and manage your data across Google Clou d Platform services"
7 }, 7 },
8 "https://www.googleapis.com/auth/userinfo.email": { 8 "https://www.googleapis.com/auth/userinfo.email": {
9 "description": "View your email address" 9 "description": "View your email address"
10 } 10 }
11 } 11 }
12 } 12 }
13 }, 13 },
14 "basePath": "", 14 "basePath": "",
15 "baseUrl": "https://dataflow.googleapis.com/", 15 "baseUrl": "https://dataflow.googleapis.com/",
16 "batchPath": "batch", 16 "batchPath": "batch",
17 "description": "Develops and executes data processing patterns like ETL, bat ch computation, and continuous computation.", 17 "description": "Manages Google Cloud Dataflow projects on Google Cloud Platf orm.",
18 "discoveryVersion": "v1", 18 "discoveryVersion": "v1",
19 "documentationLink": "https://cloud.google.com/dataflow", 19 "documentationLink": "https://cloud.google.com/dataflow",
20 "etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/2ldmPeHEvQ6NGgRE1Cb3tnvrYr8\"", 20 "etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/8IKdD_GkxmHITZPPBvAy8YZADEQ\"",
21 "icons": { 21 "icons": {
22 "x16": "http://www.google.com/images/icons/product/search-16.gif", 22 "x16": "http://www.google.com/images/icons/product/search-16.gif",
23 "x32": "http://www.google.com/images/icons/product/search-32.gif" 23 "x32": "http://www.google.com/images/icons/product/search-32.gif"
24 }, 24 },
25 "id": "dataflow:v1b3", 25 "id": "dataflow:v1b3",
26 "kind": "discovery#restDescription", 26 "kind": "discovery#restDescription",
27 "name": "dataflow", 27 "name": "dataflow",
28 "ownerDomain": "google.com", 28 "ownerDomain": "google.com",
29 "ownerName": "Google", 29 "ownerName": "Google",
30 "parameters": { 30 "parameters": {
(...skipping 104 matching lines...) Expand 10 before | Expand all | Expand 10 after
135 "scopes": [ 135 "scopes": [
136 "https://www.googleapis.com/auth/cloud-platform", 136 "https://www.googleapis.com/auth/cloud-platform",
137 "https://www.googleapis.com/auth/userinfo.email" 137 "https://www.googleapis.com/auth/userinfo.email"
138 ] 138 ]
139 } 139 }
140 }, 140 },
141 "resources": { 141 "resources": {
142 "jobs": { 142 "jobs": {
143 "methods": { 143 "methods": {
144 "create": { 144 "create": {
145 "description": "Creates a dataflow job.", 145 "description": "Creates a Cloud Dataflow job.",
146 "httpMethod": "POST", 146 "httpMethod": "POST",
147 "id": "dataflow.projects.jobs.create", 147 "id": "dataflow.projects.jobs.create",
148 "parameterOrder": [ 148 "parameterOrder": [
149 "projectId" 149 "projectId"
150 ], 150 ],
151 "parameters": { 151 "parameters": {
152 "projectId": { 152 "projectId": {
153 "description": "The project which owns the j ob.", 153 "description": "The ID of the Cloud Platform project that the job belongs to.",
154 "location": "path", 154 "location": "path",
155 "required": true, 155 "required": true,
156 "type": "string" 156 "type": "string"
157 }, 157 },
158 "view": { 158 "view": {
159 "description": "Level of information request ed in response.", 159 "description": "The level of information req uested in response.",
160 "enum": [ 160 "enum": [
161 "JOB_VIEW_UNKNOWN", 161 "JOB_VIEW_UNKNOWN",
162 "JOB_VIEW_SUMMARY", 162 "JOB_VIEW_SUMMARY",
163 "JOB_VIEW_ALL" 163 "JOB_VIEW_ALL"
164 ], 164 ],
165 "location": "query", 165 "location": "query",
166 "type": "string" 166 "type": "string"
167 }, 167 },
168 "replaceJobId": { 168 "replaceJobId": {
169 "description": "DEPRECATED. This field is no w on the Job message.", 169 "description": "Deprecated. This field is no w in the Job message.",
170 "location": "query", 170 "location": "query",
171 "type": "string" 171 "type": "string"
172 }, 172 },
173 "location": { 173 "location": {
174 "description": "The location which contains this job.", 174 "description": "The location that contains t his job.",
175 "location": "query", 175 "location": "query",
176 "type": "string" 176 "type": "string"
177 } 177 }
178 }, 178 },
179 "path": "v1b3/projects/{projectId}/jobs", 179 "path": "v1b3/projects/{projectId}/jobs",
180 "request": { 180 "request": {
181 "$ref": "Job" 181 "$ref": "Job"
182 }, 182 },
183 "response": { 183 "response": {
184 "$ref": "Job" 184 "$ref": "Job"
185 }, 185 },
186 "scopes": [ 186 "scopes": [
187 "https://www.googleapis.com/auth/cloud-platform" , 187 "https://www.googleapis.com/auth/cloud-platform" ,
188 "https://www.googleapis.com/auth/userinfo.email" 188 "https://www.googleapis.com/auth/userinfo.email"
189 ] 189 ]
190 }, 190 },
191 "get": { 191 "get": {
192 "description": "Gets the state of the specified data flow job.", 192 "description": "Gets the state of the specified Clou d Dataflow job.",
193 "httpMethod": "GET", 193 "httpMethod": "GET",
194 "id": "dataflow.projects.jobs.get", 194 "id": "dataflow.projects.jobs.get",
195 "parameterOrder": [ 195 "parameterOrder": [
196 "projectId", 196 "projectId",
197 "jobId" 197 "jobId"
198 ], 198 ],
199 "parameters": { 199 "parameters": {
200 "projectId": { 200 "projectId": {
201 "description": "The project which owns the j ob.", 201 "description": "The ID of the Cloud Platform project that the job belongs to.",
202 "location": "path", 202 "location": "path",
203 "required": true, 203 "required": true,
204 "type": "string" 204 "type": "string"
205 }, 205 },
206 "jobId": { 206 "jobId": {
207 "description": "Identifies a single job.", 207 "description": "The job ID.",
208 "location": "path", 208 "location": "path",
209 "required": true, 209 "required": true,
210 "type": "string" 210 "type": "string"
211 }, 211 },
212 "view": { 212 "view": {
213 "description": "Level of information request ed in response.", 213 "description": "The level of information req uested in response.",
214 "enum": [ 214 "enum": [
215 "JOB_VIEW_UNKNOWN", 215 "JOB_VIEW_UNKNOWN",
216 "JOB_VIEW_SUMMARY", 216 "JOB_VIEW_SUMMARY",
217 "JOB_VIEW_ALL" 217 "JOB_VIEW_ALL"
218 ], 218 ],
219 "location": "query", 219 "location": "query",
220 "type": "string" 220 "type": "string"
221 }, 221 },
222 "location": { 222 "location": {
223 "description": "The location which contains this job.", 223 "description": "The location that contains t his job.",
224 "location": "query", 224 "location": "query",
225 "type": "string" 225 "type": "string"
226 } 226 }
227 }, 227 },
228 "path": "v1b3/projects/{projectId}/jobs/{jobId}", 228 "path": "v1b3/projects/{projectId}/jobs/{jobId}",
229 "response": { 229 "response": {
230 "$ref": "Job" 230 "$ref": "Job"
231 }, 231 },
232 "scopes": [ 232 "scopes": [
233 "https://www.googleapis.com/auth/cloud-platform" , 233 "https://www.googleapis.com/auth/cloud-platform" ,
234 "https://www.googleapis.com/auth/userinfo.email" 234 "https://www.googleapis.com/auth/userinfo.email"
235 ] 235 ]
236 }, 236 },
237 "update": { 237 "update": {
238 "description": "Updates the state of an existing dat aflow job.", 238 "description": "Updates the state of an existing Clo ud Dataflow job.",
239 "httpMethod": "PUT", 239 "httpMethod": "PUT",
240 "id": "dataflow.projects.jobs.update", 240 "id": "dataflow.projects.jobs.update",
241 "parameterOrder": [ 241 "parameterOrder": [
242 "projectId", 242 "projectId",
243 "jobId" 243 "jobId"
244 ], 244 ],
245 "parameters": { 245 "parameters": {
246 "projectId": { 246 "projectId": {
247 "description": "The project which owns the j ob.", 247 "description": "The ID of the Cloud Platform project that the job belongs to.",
248 "location": "path", 248 "location": "path",
249 "required": true, 249 "required": true,
250 "type": "string" 250 "type": "string"
251 }, 251 },
252 "jobId": { 252 "jobId": {
253 "description": "Identifies a single job.", 253 "description": "The job ID.",
254 "location": "path", 254 "location": "path",
255 "required": true, 255 "required": true,
256 "type": "string" 256 "type": "string"
257 }, 257 },
258 "location": { 258 "location": {
259 "description": "The location which contains this job.", 259 "description": "The location that contains t his job.",
260 "location": "query", 260 "location": "query",
261 "type": "string" 261 "type": "string"
262 } 262 }
263 }, 263 },
264 "path": "v1b3/projects/{projectId}/jobs/{jobId}", 264 "path": "v1b3/projects/{projectId}/jobs/{jobId}",
265 "request": { 265 "request": {
266 "$ref": "Job" 266 "$ref": "Job"
267 }, 267 },
268 "response": { 268 "response": {
269 "$ref": "Job" 269 "$ref": "Job"
270 }, 270 },
271 "scopes": [ 271 "scopes": [
272 "https://www.googleapis.com/auth/cloud-platform" , 272 "https://www.googleapis.com/auth/cloud-platform" ,
273 "https://www.googleapis.com/auth/userinfo.email" 273 "https://www.googleapis.com/auth/userinfo.email"
274 ] 274 ]
275 }, 275 },
276 "list": { 276 "list": {
277 "description": "List the jobs of a project", 277 "description": "List the jobs of a project.",
278 "httpMethod": "GET", 278 "httpMethod": "GET",
279 "id": "dataflow.projects.jobs.list", 279 "id": "dataflow.projects.jobs.list",
280 "parameterOrder": [ 280 "parameterOrder": [
281 "projectId" 281 "projectId"
282 ], 282 ],
283 "parameters": { 283 "parameters": {
284 "projectId": { 284 "projectId": {
285 "description": "The project which owns the j obs.", 285 "description": "The project which owns the j obs.",
286 "location": "path", 286 "location": "path",
287 "required": true, 287 "required": true,
288 "type": "string" 288 "type": "string"
289 }, 289 },
290 "filter": { 290 "filter": {
291 "description": "The kind of filter to use.", 291 "description": "The kind of filter to use.",
292 "enum": [ 292 "enum": [
293 "UNKNOWN", 293 "UNKNOWN",
294 "ALL", 294 "ALL",
295 "TERMINATED", 295 "TERMINATED",
296 "ACTIVE" 296 "ACTIVE"
297 ], 297 ],
298 "location": "query", 298 "location": "query",
299 "type": "string" 299 "type": "string"
300 }, 300 },
301 "view": { 301 "view": {
302 "description": "Level of information request ed in response. Default is SUMMARY.", 302 "description": "Level of information request ed in response. Default is `JOB_VIEW_SUMMARY`.",
303 "enum": [ 303 "enum": [
304 "JOB_VIEW_UNKNOWN", 304 "JOB_VIEW_UNKNOWN",
305 "JOB_VIEW_SUMMARY", 305 "JOB_VIEW_SUMMARY",
306 "JOB_VIEW_ALL" 306 "JOB_VIEW_ALL"
307 ], 307 ],
308 "location": "query", 308 "location": "query",
309 "type": "string" 309 "type": "string"
310 }, 310 },
311 "pageSize": { 311 "pageSize": {
312 "description": "If there are many jobs, limi t response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit.", 312 "description": "If there are many jobs, limi t response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit.",
313 "format": "int32", 313 "format": "int32",
314 "location": "query", 314 "location": "query",
315 "type": "integer" 315 "type": "integer"
316 }, 316 },
317 "pageToken": { 317 "pageToken": {
318 "description": "Set this to the 'next_page_t oken' field of a previous response to request additional results in a long list. ", 318 "description": "Set this to the 'next_page_t oken' field of a previous response to request additional results in a long list. ",
319 "location": "query", 319 "location": "query",
320 "type": "string" 320 "type": "string"
321 }, 321 },
322 "location": { 322 "location": {
323 "description": "The location which contains this job.", 323 "description": "The location that contains t his job.",
324 "location": "query", 324 "location": "query",
325 "type": "string" 325 "type": "string"
326 } 326 }
327 }, 327 },
328 "path": "v1b3/projects/{projectId}/jobs", 328 "path": "v1b3/projects/{projectId}/jobs",
329 "response": { 329 "response": {
330 "$ref": "ListJobsResponse" 330 "$ref": "ListJobsResponse"
331 }, 331 },
332 "scopes": [ 332 "scopes": [
333 "https://www.googleapis.com/auth/cloud-platform" , 333 "https://www.googleapis.com/auth/cloud-platform" ,
(...skipping 261 matching lines...) Expand 10 before | Expand all | Expand 10 after
595 } 595 }
596 } 596 }
597 } 597 }
598 } 598 }
599 }, 599 },
600 "locations": { 600 "locations": {
601 "resources": { 601 "resources": {
602 "jobs": { 602 "jobs": {
603 "methods": { 603 "methods": {
604 "create": { 604 "create": {
605 "description": "Creates a dataflow job.", 605 "description": "Creates a Cloud Dataflow job .",
606 "httpMethod": "POST", 606 "httpMethod": "POST",
607 "id": "dataflow.projects.locations.jobs.crea te", 607 "id": "dataflow.projects.locations.jobs.crea te",
608 "parameterOrder": [ 608 "parameterOrder": [
609 "projectId", 609 "projectId",
610 "location" 610 "location"
611 ], 611 ],
612 "parameters": { 612 "parameters": {
613 "projectId": { 613 "projectId": {
614 "description": "The project which ow ns the job.", 614 "description": "The ID of the Cloud Platform project that the job belongs to.",
615 "location": "path", 615 "location": "path",
616 "required": true, 616 "required": true,
617 "type": "string" 617 "type": "string"
618 }, 618 },
619 "location": { 619 "location": {
620 "description": "The location which c ontains this job.", 620 "description": "The location that co ntains this job.",
621 "location": "path", 621 "location": "path",
622 "required": true, 622 "required": true,
623 "type": "string" 623 "type": "string"
624 }, 624 },
625 "view": { 625 "view": {
626 "description": "Level of information requested in response.", 626 "description": "The level of informa tion requested in response.",
627 "enum": [ 627 "enum": [
628 "JOB_VIEW_UNKNOWN", 628 "JOB_VIEW_UNKNOWN",
629 "JOB_VIEW_SUMMARY", 629 "JOB_VIEW_SUMMARY",
630 "JOB_VIEW_ALL" 630 "JOB_VIEW_ALL"
631 ], 631 ],
632 "location": "query", 632 "location": "query",
633 "type": "string" 633 "type": "string"
634 }, 634 },
635 "replaceJobId": { 635 "replaceJobId": {
636 "description": "DEPRECATED. This fie ld is now on the Job message.", 636 "description": "Deprecated. This fie ld is now in the Job message.",
637 "location": "query", 637 "location": "query",
638 "type": "string" 638 "type": "string"
639 } 639 }
640 }, 640 },
641 "path": "v1b3/projects/{projectId}/locations /{location}/jobs", 641 "path": "v1b3/projects/{projectId}/locations /{location}/jobs",
642 "request": { 642 "request": {
643 "$ref": "Job" 643 "$ref": "Job"
644 }, 644 },
645 "response": { 645 "response": {
646 "$ref": "Job" 646 "$ref": "Job"
647 }, 647 },
648 "scopes": [ 648 "scopes": [
649 "https://www.googleapis.com/auth/cloud-p latform", 649 "https://www.googleapis.com/auth/cloud-p latform",
650 "https://www.googleapis.com/auth/userinf o.email" 650 "https://www.googleapis.com/auth/userinf o.email"
651 ] 651 ]
652 }, 652 },
653 "get": { 653 "get": {
654 "description": "Gets the state of the specif ied dataflow job.", 654 "description": "Gets the state of the specif ied Cloud Dataflow job.",
655 "httpMethod": "GET", 655 "httpMethod": "GET",
656 "id": "dataflow.projects.locations.jobs.get" , 656 "id": "dataflow.projects.locations.jobs.get" ,
657 "parameterOrder": [ 657 "parameterOrder": [
658 "projectId", 658 "projectId",
659 "location", 659 "location",
660 "jobId" 660 "jobId"
661 ], 661 ],
662 "parameters": { 662 "parameters": {
663 "projectId": { 663 "projectId": {
664 "description": "The project which ow ns the job.", 664 "description": "The ID of the Cloud Platform project that the job belongs to.",
665 "location": "path", 665 "location": "path",
666 "required": true, 666 "required": true,
667 "type": "string" 667 "type": "string"
668 }, 668 },
669 "location": { 669 "location": {
670 "description": "The location which c ontains this job.", 670 "description": "The location that co ntains this job.",
671 "location": "path", 671 "location": "path",
672 "required": true, 672 "required": true,
673 "type": "string" 673 "type": "string"
674 }, 674 },
675 "jobId": { 675 "jobId": {
676 "description": "Identifies a single job.", 676 "description": "The job ID.",
677 "location": "path", 677 "location": "path",
678 "required": true, 678 "required": true,
679 "type": "string" 679 "type": "string"
680 }, 680 },
681 "view": { 681 "view": {
682 "description": "Level of information requested in response.", 682 "description": "The level of informa tion requested in response.",
683 "enum": [ 683 "enum": [
684 "JOB_VIEW_UNKNOWN", 684 "JOB_VIEW_UNKNOWN",
685 "JOB_VIEW_SUMMARY", 685 "JOB_VIEW_SUMMARY",
686 "JOB_VIEW_ALL" 686 "JOB_VIEW_ALL"
687 ], 687 ],
688 "location": "query", 688 "location": "query",
689 "type": "string" 689 "type": "string"
690 } 690 }
691 }, 691 },
692 "path": "v1b3/projects/{projectId}/locations /{location}/jobs/{jobId}", 692 "path": "v1b3/projects/{projectId}/locations /{location}/jobs/{jobId}",
693 "response": { 693 "response": {
694 "$ref": "Job" 694 "$ref": "Job"
695 }, 695 },
696 "scopes": [ 696 "scopes": [
697 "https://www.googleapis.com/auth/cloud-p latform", 697 "https://www.googleapis.com/auth/cloud-p latform",
698 "https://www.googleapis.com/auth/userinf o.email" 698 "https://www.googleapis.com/auth/userinf o.email"
699 ] 699 ]
700 }, 700 },
701 "update": { 701 "update": {
702 "description": "Updates the state of an exis ting dataflow job.", 702 "description": "Updates the state of an exis ting Cloud Dataflow job.",
703 "httpMethod": "PUT", 703 "httpMethod": "PUT",
704 "id": "dataflow.projects.locations.jobs.upda te", 704 "id": "dataflow.projects.locations.jobs.upda te",
705 "parameterOrder": [ 705 "parameterOrder": [
706 "projectId", 706 "projectId",
707 "location", 707 "location",
708 "jobId" 708 "jobId"
709 ], 709 ],
710 "parameters": { 710 "parameters": {
711 "projectId": { 711 "projectId": {
712 "description": "The project which ow ns the job.", 712 "description": "The ID of the Cloud Platform project that the job belongs to.",
713 "location": "path", 713 "location": "path",
714 "required": true, 714 "required": true,
715 "type": "string" 715 "type": "string"
716 }, 716 },
717 "location": { 717 "location": {
718 "description": "The location which c ontains this job.", 718 "description": "The location that co ntains this job.",
719 "location": "path", 719 "location": "path",
720 "required": true, 720 "required": true,
721 "type": "string" 721 "type": "string"
722 }, 722 },
723 "jobId": { 723 "jobId": {
724 "description": "Identifies a single job.", 724 "description": "The job ID.",
725 "location": "path", 725 "location": "path",
726 "required": true, 726 "required": true,
727 "type": "string" 727 "type": "string"
728 } 728 }
729 }, 729 },
730 "path": "v1b3/projects/{projectId}/locations /{location}/jobs/{jobId}", 730 "path": "v1b3/projects/{projectId}/locations /{location}/jobs/{jobId}",
731 "request": { 731 "request": {
732 "$ref": "Job" 732 "$ref": "Job"
733 }, 733 },
734 "response": { 734 "response": {
735 "$ref": "Job" 735 "$ref": "Job"
736 }, 736 },
737 "scopes": [ 737 "scopes": [
738 "https://www.googleapis.com/auth/cloud-p latform", 738 "https://www.googleapis.com/auth/cloud-p latform",
739 "https://www.googleapis.com/auth/userinf o.email" 739 "https://www.googleapis.com/auth/userinf o.email"
740 ] 740 ]
741 }, 741 },
742 "list": { 742 "list": {
743 "description": "List the jobs of a project", 743 "description": "List the jobs of a project." ,
744 "httpMethod": "GET", 744 "httpMethod": "GET",
745 "id": "dataflow.projects.locations.jobs.list ", 745 "id": "dataflow.projects.locations.jobs.list ",
746 "parameterOrder": [ 746 "parameterOrder": [
747 "projectId", 747 "projectId",
748 "location" 748 "location"
749 ], 749 ],
750 "parameters": { 750 "parameters": {
751 "projectId": { 751 "projectId": {
752 "description": "The project which ow ns the jobs.", 752 "description": "The project which ow ns the jobs.",
753 "location": "path", 753 "location": "path",
754 "required": true, 754 "required": true,
755 "type": "string" 755 "type": "string"
756 }, 756 },
757 "location": { 757 "location": {
758 "description": "The location which c ontains this job.", 758 "description": "The location that co ntains this job.",
759 "location": "path", 759 "location": "path",
760 "required": true, 760 "required": true,
761 "type": "string" 761 "type": "string"
762 }, 762 },
763 "filter": { 763 "filter": {
764 "description": "The kind of filter t o use.", 764 "description": "The kind of filter t o use.",
765 "enum": [ 765 "enum": [
766 "UNKNOWN", 766 "UNKNOWN",
767 "ALL", 767 "ALL",
768 "TERMINATED", 768 "TERMINATED",
769 "ACTIVE" 769 "ACTIVE"
770 ], 770 ],
771 "location": "query", 771 "location": "query",
772 "type": "string" 772 "type": "string"
773 }, 773 },
774 "view": { 774 "view": {
775 "description": "Level of information requested in response. Default is SUMMARY.", 775 "description": "Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.",
776 "enum": [ 776 "enum": [
777 "JOB_VIEW_UNKNOWN", 777 "JOB_VIEW_UNKNOWN",
778 "JOB_VIEW_SUMMARY", 778 "JOB_VIEW_SUMMARY",
779 "JOB_VIEW_ALL" 779 "JOB_VIEW_ALL"
780 ], 780 ],
781 "location": "query", 781 "location": "query",
782 "type": "string" 782 "type": "string"
783 }, 783 },
784 "pageSize": { 784 "pageSize": {
785 "description": "If there are many jo bs, limit response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit.", 785 "description": "If there are many jo bs, limit response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit.",
(...skipping 223 matching lines...) Expand 10 before | Expand all | Expand 10 after
1009 } 1009 }
1010 } 1010 }
1011 } 1011 }
1012 } 1012 }
1013 } 1013 }
1014 } 1014 }
1015 }, 1015 },
1016 "templates": { 1016 "templates": {
1017 "methods": { 1017 "methods": {
1018 "create": { 1018 "create": {
1019 "description": "Creates a dataflow job from a templa te.", 1019 "description": "Creates a Cloud Dataflow job from a template.",
1020 "httpMethod": "POST", 1020 "httpMethod": "POST",
1021 "id": "dataflow.projects.templates.create", 1021 "id": "dataflow.projects.templates.create",
1022 "parameterOrder": [ 1022 "parameterOrder": [
1023 "projectId" 1023 "projectId"
1024 ], 1024 ],
1025 "parameters": { 1025 "parameters": {
1026 "projectId": { 1026 "projectId": {
1027 "description": "The project which owns the j ob.", 1027 "description": "Required. The ID of the Clou d Platform project that the job belongs to.",
1028 "location": "path", 1028 "location": "path",
1029 "required": true, 1029 "required": true,
1030 "type": "string" 1030 "type": "string"
1031 } 1031 }
1032 }, 1032 },
1033 "path": "v1b3/projects/{projectId}/templates", 1033 "path": "v1b3/projects/{projectId}/templates",
1034 "request": { 1034 "request": {
1035 "$ref": "CreateJobFromTemplateRequest" 1035 "$ref": "CreateJobFromTemplateRequest"
1036 }, 1036 },
1037 "response": { 1037 "response": {
(...skipping 56 matching lines...) Expand 10 before | Expand all | Expand 10 after
1094 } 1094 }
1095 }, 1095 },
1096 "type": "object" 1096 "type": "object"
1097 }, 1097 },
1098 "SendDebugCaptureResponse": { 1098 "SendDebugCaptureResponse": {
1099 "description": "Response to a send capture request. nothing", 1099 "description": "Response to a send capture request. nothing",
1100 "id": "SendDebugCaptureResponse", 1100 "id": "SendDebugCaptureResponse",
1101 "type": "object" 1101 "type": "object"
1102 }, 1102 },
1103 "Job": { 1103 "Job": {
1104 "description": "Defines a job to be run by the Dataflow service.", 1104 "description": "Defines a job to be run by the Cloud Dataflow servic e.",
1105 "id": "Job", 1105 "id": "Job",
1106 "properties": { 1106 "properties": {
1107 "id": { 1107 "id": {
1108 "description": "The unique ID of this job. This field is set by the Dataflow service when the Job is created, and is immutable for the life of the Job.", 1108 "description": "The unique ID of this job. This field is set by the Cloud Dataflow service when the Job is created, and is immutable for the life of the job.",
1109 "type": "string" 1109 "type": "string"
1110 }, 1110 },
1111 "projectId": { 1111 "projectId": {
1112 "description": "The project which owns the job.", 1112 "description": "The ID of the Cloud Platform project that th e job belongs to.",
1113 "type": "string" 1113 "type": "string"
1114 }, 1114 },
1115 "name": { 1115 "name": {
1116 "description": "The user-specified Dataflow job name. Only o ne Job with a given name may exist in a project at any given time. If a caller a ttempts to create a Job with the same name as an already-existing Job, the attem pt will return the existing Job. The name must match the regular expression [a-z ]([-a-z0-9]{0,38}[a-z0-9])?", 1116 "description": "The user-specified Cloud Dataflow job name. Only one Job with a given name may exist in a project at any given time. If a ca ller attempts to create a Job with the same name as an already-existing Job, the attempt returns the existing Job. The name must match the regular expression `[ a-z]([-a-z0-9]{0,38}[a-z0-9])?`",
1117 "type": "string" 1117 "type": "string"
1118 }, 1118 },
1119 "type": { 1119 "type": {
1120 "description": "The type of dataflow job.", 1120 "description": "The type of Cloud Dataflow job.",
1121 "enum": [ 1121 "enum": [
1122 "JOB_TYPE_UNKNOWN", 1122 "JOB_TYPE_UNKNOWN",
1123 "JOB_TYPE_BATCH", 1123 "JOB_TYPE_BATCH",
1124 "JOB_TYPE_STREAMING" 1124 "JOB_TYPE_STREAMING"
1125 ], 1125 ],
1126 "type": "string" 1126 "type": "string"
1127 }, 1127 },
1128 "environment": { 1128 "environment": {
1129 "$ref": "Environment", 1129 "$ref": "Environment",
1130 "description": "Environment for the job." 1130 "description": "The environment for the job."
1131 }, 1131 },
1132 "steps": { 1132 "steps": {
1133 "description": "The top-level steps that constitute the enti re job.", 1133 "description": "The top-level steps that constitute the enti re job.",
1134 "items": { 1134 "items": {
1135 "$ref": "Step" 1135 "$ref": "Step"
1136 }, 1136 },
1137 "type": "array" 1137 "type": "array"
1138 }, 1138 },
1139 "currentState": { 1139 "currentState": {
1140 "description": "The current state of the job. Jobs are creat ed in the JOB_STATE_STOPPED state unless otherwise specified. A job in the JOB_S TATE_RUNNING state may asynchronously enter a terminal state. Once a job has rea ched a terminal state, no further state updates may be made. This field may be m utated by the Dataflow service; callers cannot mutate it.", 1140 "description": "The current state of the job. Jobs are creat ed in the `JOB_STATE_STOPPED` state unless otherwise specified. A job in the `JO B_STATE_RUNNING` state may asynchronously enter a terminal state. After a job ha s reached a terminal state, no further state updates may be made. This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.",
1141 "enum": [ 1141 "enum": [
1142 "JOB_STATE_UNKNOWN", 1142 "JOB_STATE_UNKNOWN",
1143 "JOB_STATE_STOPPED", 1143 "JOB_STATE_STOPPED",
1144 "JOB_STATE_RUNNING", 1144 "JOB_STATE_RUNNING",
1145 "JOB_STATE_DONE", 1145 "JOB_STATE_DONE",
1146 "JOB_STATE_FAILED", 1146 "JOB_STATE_FAILED",
1147 "JOB_STATE_CANCELLED", 1147 "JOB_STATE_CANCELLED",
1148 "JOB_STATE_UPDATED", 1148 "JOB_STATE_UPDATED",
1149 "JOB_STATE_DRAINING", 1149 "JOB_STATE_DRAINING",
1150 "JOB_STATE_DRAINED" 1150 "JOB_STATE_DRAINED"
1151 ], 1151 ],
1152 "type": "string" 1152 "type": "string"
1153 }, 1153 },
1154 "currentStateTime": { 1154 "currentStateTime": {
1155 "description": "The timestamp associated with the current st ate.", 1155 "description": "The timestamp associated with the current st ate.",
1156 "type": "string" 1156 "type": "string"
1157 }, 1157 },
1158 "requestedState": { 1158 "requestedState": {
1159 "description": "The job's requested state. UpdateJob may be used to switch between the JOB_STATE_STOPPED and JOB_STATE_RUNNING states, by se tting requested_state. UpdateJob may also be used to directly set a job's reques ted state to JOB_STATE_CANCELLED or JOB_STATE_DONE, irrevocably terminating the job if it has not already reached a terminal state.", 1159 "description": "The job's requested state. `UpdateJob` may b e used to switch between the `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may also be used to directly set a job' s requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably term inating the job if it has not already reached a terminal state.",
1160 "enum": [ 1160 "enum": [
1161 "JOB_STATE_UNKNOWN", 1161 "JOB_STATE_UNKNOWN",
1162 "JOB_STATE_STOPPED", 1162 "JOB_STATE_STOPPED",
1163 "JOB_STATE_RUNNING", 1163 "JOB_STATE_RUNNING",
1164 "JOB_STATE_DONE", 1164 "JOB_STATE_DONE",
1165 "JOB_STATE_FAILED", 1165 "JOB_STATE_FAILED",
1166 "JOB_STATE_CANCELLED", 1166 "JOB_STATE_CANCELLED",
1167 "JOB_STATE_UPDATED", 1167 "JOB_STATE_UPDATED",
1168 "JOB_STATE_DRAINING", 1168 "JOB_STATE_DRAINING",
1169 "JOB_STATE_DRAINED" 1169 "JOB_STATE_DRAINED"
1170 ], 1170 ],
1171 "type": "string" 1171 "type": "string"
1172 }, 1172 },
1173 "executionInfo": { 1173 "executionInfo": {
1174 "$ref": "JobExecutionInfo", 1174 "$ref": "JobExecutionInfo",
1175 "description": "Information about how the Dataflow service w ill actually run the job." 1175 "description": "Information about how the Cloud Dataflow ser vice will run the job."
1176 }, 1176 },
1177 "createTime": { 1177 "createTime": {
1178 "description": "Timestamp when job was initially created. Im mutable, set by the Dataflow service.", 1178 "description": "The timestamp when the job was initially cre ated. Immutable and set by the Cloud Dataflow service.",
1179 "type": "string" 1179 "type": "string"
1180 }, 1180 },
1181 "replaceJobId": { 1181 "replaceJobId": {
1182 "description": "If this job is an update of an existing job, this field will be the ID of the job it replaced. When sending a CreateJobReque st, you can update a job by specifying it here. The job named here will be stopp ed, and its intermediate state transferred to this job.", 1182 "description": "If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobReque st`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job.",
1183 "type": "string" 1183 "type": "string"
1184 }, 1184 },
1185 "transformNameMapping": { 1185 "transformNameMapping": {
1186 "additionalProperties": { 1186 "additionalProperties": {
1187 "type": "string" 1187 "type": "string"
1188 }, 1188 },
1189 "description": "Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.", 1189 "description": "The map of transform name prefixes of the jo b to be replaced to the corresponding name prefixes of the new job.",
1190 "type": "object" 1190 "type": "object"
1191 }, 1191 },
1192 "clientRequestId": { 1192 "clientRequestId": {
1193 "description": "Client's unique identifier of the job, re-us ed by SDK across retried attempts. If this field is set, the service will ensure its uniqueness. That is, the request to create a job will fail if the service h as knowledge of a previously submitted job with the same client's id and job nam e. The caller may, for example, use this field to ensure idempotence of job crea tion across retried attempts to create a job. By default, the field is empty and , in that case, the service ignores it.", 1193 "description": "The client's unique identifier of the job, r e-used across retried attempts. If this field is set, the service will ensure it s uniqueness. The request to create a job will fail if the service has knowledge of a previously submitted job with the same client's ID and job name. The calle r may use this field to ensure idempotence of job creation across retried attemp ts to create a job. By default, the field is empty and, in that case, the servic e ignores it.",
1194 "type": "string" 1194 "type": "string"
1195 }, 1195 },
1196 "replacedByJobId": { 1196 "replacedByJobId": {
1197 "description": "If another job is an update of this job (and thus, this job is in JOB_STATE_UPDATED), this field will contain the ID of that job.", 1197 "description": "If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that j ob.",
1198 "type": "string" 1198 "type": "string"
1199 }, 1199 },
1200 "tempFiles": { 1200 "tempFiles": {
1201 "description": "A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on j ob completion. No duplicates are allowed. No file patterns are supported. The su pported files are: Google Cloud Storage: storage.googleapis.com/{bucket}/{object } bucket.storage.googleapis.com/{object}", 1201 "description": "A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on j ob completion. No duplicates are allowed. No file patterns are supported. The su pported files are: Google Cloud Storage: storage.googleapis.com/{bucket}/{object } bucket.storage.googleapis.com/{object}",
1202 "items": { 1202 "items": {
1203 "type": "string" 1203 "type": "string"
1204 }, 1204 },
1205 "type": "array" 1205 "type": "array"
1206 }, 1206 },
1207 "labels": { 1207 "labels": {
1208 "additionalProperties": { 1208 "additionalProperties": {
1209 "type": "string" 1209 "type": "string"
1210 }, 1210 },
1211 "description": "User-defined labels for this job. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 str ings that comply with the following restrictions: * Keys must conform to regexp: \\p{Ll}\\p{Lo}{0,62} * Values must conform to regexp: [\\p{Ll}\\p{Lo}\\p{N}_-]{ 0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size.", 1211 "description": "User-defined labels for this job. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 str ings that comply with the following restrictions: * Keys must conform to regexp: \\p{Ll}\\p{Lo}{0,62} * Values must conform to regexp: [\\p{Ll}\\p{Lo}\\p{N}_-]{ 0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size.",
1212 "type": "object" 1212 "type": "object"
1213 }, 1213 },
1214 "location": { 1214 "location": {
1215 "description": "The location which contains this job.", 1215 "description": "The location that contains this job.",
1216 "type": "string" 1216 "type": "string"
1217 } 1217 }
1218 }, 1218 },
1219 "type": "object" 1219 "type": "object"
1220 }, 1220 },
1221 "Environment": { 1221 "Environment": {
1222 "description": "Describes the environment in which a Dataflow Job ru ns.", 1222 "description": "Describes the environment in which a Dataflow Job ru ns.",
1223 "id": "Environment", 1223 "id": "Environment",
1224 "properties": { 1224 "properties": {
1225 "tempStoragePrefix": { 1225 "tempStoragePrefix": {
1226 "description": "The prefix of the resources the system shoul d use for temporary storage. The system will append the suffix \"/temp-{JOBNAME} to this resource prefix, where {JOBNAME} is the value of the job_name field. Th e resulting bucket and object prefix is used as the prefix of the resources used to store temporary data needed during the job execution. NOTE: This will overri de the value in taskrunner_settings. The supported resource type is: Google Clou d Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.co m/{object}", 1226 "description": "The prefix of the resources the system shoul d use for temporary storage. The system will append the suffix \"/temp-{JOBNAME} to this resource prefix, where {JOBNAME} is the value of the job_name field. Th e resulting bucket and object prefix is used as the prefix of the resources used to store temporary data needed during the job execution. NOTE: This will overri de the value in taskrunner_settings. The supported resource type is: Google Clou d Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.co m/{object}",
1227 "type": "string" 1227 "type": "string"
1228 }, 1228 },
1229 "clusterManagerApiService": { 1229 "clusterManagerApiService": {
1230 "description": "The type of cluster manager API to use. If u nknown or unspecified, the service will attempt to choose a reasonable default. This should be in the form of the API service name, e.g. \"compute.googleapis.co m\".", 1230 "description": "The type of cluster manager API to use. If u nknown or unspecified, the service will attempt to choose a reasonable default. This should be in the form of the API service name, e.g. \"compute.googleapis.co m\".",
1231 "type": "string" 1231 "type": "string"
1232 }, 1232 },
1233 "experiments": { 1233 "experiments": {
1234 "description": "The list of experiments to enable.", 1234 "description": "The list of experiments to enable.",
1235 "items": { 1235 "items": {
1236 "type": "string" 1236 "type": "string"
1237 }, 1237 },
1238 "type": "array" 1238 "type": "array"
1239 }, 1239 },
1240 "workerPools": { 1240 "workerPools": {
1241 "description": "Worker pools. At least one \"harness\" worke r pool must be specified in order for the job to have workers.", 1241 "description": "The worker pools. At least one \"harness\" w orker pool must be specified in order for the job to have workers.",
1242 "items": { 1242 "items": {
1243 "$ref": "WorkerPool" 1243 "$ref": "WorkerPool"
1244 }, 1244 },
1245 "type": "array" 1245 "type": "array"
1246 }, 1246 },
1247 "userAgent": { 1247 "userAgent": {
1248 "additionalProperties": { 1248 "additionalProperties": {
1249 "description": "Properties of the object.", 1249 "description": "Properties of the object.",
1250 "type": "any" 1250 "type": "any"
1251 }, 1251 },
(...skipping 10 matching lines...) Expand all
1262 }, 1262 },
1263 "dataset": { 1263 "dataset": {
1264 "description": "The dataset for the current project where va rious workflow related tables are stored. The supported resource type is: Google BigQuery: bigquery.googleapis.com/{dataset}", 1264 "description": "The dataset for the current project where va rious workflow related tables are stored. The supported resource type is: Google BigQuery: bigquery.googleapis.com/{dataset}",
1265 "type": "string" 1265 "type": "string"
1266 }, 1266 },
1267 "sdkPipelineOptions": { 1267 "sdkPipelineOptions": {
1268 "additionalProperties": { 1268 "additionalProperties": {
1269 "description": "Properties of the object.", 1269 "description": "Properties of the object.",
1270 "type": "any" 1270 "type": "any"
1271 }, 1271 },
1272 "description": "The Dataflow SDK pipeline options specified by the user. These options are passed through the service and are used to recrea te the SDK pipeline options on the worker in a language agnostic and platform in dependent way.", 1272 "description": "The Cloud Dataflow SDK pipeline options spec ified by the user. These options are passed through the service and are used to recreate the SDK pipeline options on the worker in a language agnostic and platf orm independent way.",
1273 "type": "object" 1273 "type": "object"
1274 }, 1274 },
1275 "internalExperiments": { 1275 "internalExperiments": {
1276 "additionalProperties": { 1276 "additionalProperties": {
1277 "description": "Properties of the object. Contains field @type with type URL.", 1277 "description": "Properties of the object. Contains field @type with type URL.",
1278 "type": "any" 1278 "type": "any"
1279 }, 1279 },
1280 "description": "Experimental settings.", 1280 "description": "Experimental settings.",
1281 "type": "object" 1281 "type": "object"
1282 }, 1282 },
1283 "serviceAccountEmail": { 1283 "serviceAccountEmail": {
1284 "description": "Identity to run virtual machines as. Default s to the default account.", 1284 "description": "Identity to run virtual machines as. Default s to the default account.",
1285 "type": "string" 1285 "type": "string"
1286 } 1286 }
1287 }, 1287 },
1288 "type": "object" 1288 "type": "object"
1289 }, 1289 },
1290 "WorkerPool": { 1290 "WorkerPool": {
1291 "description": "Describes one particular pool of Dataflow workers to be instantiated by the Dataflow service in order to perform the computations re quired by a job. Note that a workflow job may use multiple pools, in order to ma tch the various computational requirements of the various stages of the job.", 1291 "description": "Describes one particular pool of Cloud Dataflow work ers to be instantiated by the Cloud Dataflow service in order to perform the com putations required by a job. Note that a workflow job may use multiple pools, in order to match the various computational requirements of the various stages of the job.",
1292 "id": "WorkerPool", 1292 "id": "WorkerPool",
1293 "properties": { 1293 "properties": {
1294 "kind": { 1294 "kind": {
1295 "description": "The kind of the worker pool; currently only 'harness' and 'shuffle' are supported.", 1295 "description": "The kind of the worker pool; currently only `harness` and `shuffle` are supported.",
1296 "type": "string" 1296 "type": "string"
1297 }, 1297 },
1298 "numWorkers": { 1298 "numWorkers": {
1299 "description": "Number of Google Compute Engine workers in t his pool needed to execute the job. If zero or unspecified, the service will att empt to choose a reasonable default.", 1299 "description": "Number of Google Compute Engine workers in t his pool needed to execute the job. If zero or unspecified, the service will att empt to choose a reasonable default.",
1300 "format": "int32", 1300 "format": "int32",
1301 "type": "integer" 1301 "type": "integer"
1302 }, 1302 },
1303 "packages": { 1303 "packages": {
1304 "description": "Packages to be installed on workers.", 1304 "description": "Packages to be installed on workers.",
1305 "items": { 1305 "items": {
1306 "$ref": "Package" 1306 "$ref": "Package"
1307 }, 1307 },
1308 "type": "array" 1308 "type": "array"
1309 }, 1309 },
1310 "defaultPackageSet": { 1310 "defaultPackageSet": {
1311 "description": "The default package set to install. This all ows the service to select a default set of packages which are useful to worker h arnesses written in a particular language.", 1311 "description": "The default package set to install. This all ows the service to select a default set of packages which are useful to worker h arnesses written in a particular language.",
1312 "enum": [ 1312 "enum": [
1313 "DEFAULT_PACKAGE_SET_UNKNOWN", 1313 "DEFAULT_PACKAGE_SET_UNKNOWN",
1314 "DEFAULT_PACKAGE_SET_NONE", 1314 "DEFAULT_PACKAGE_SET_NONE",
1315 "DEFAULT_PACKAGE_SET_JAVA", 1315 "DEFAULT_PACKAGE_SET_JAVA",
1316 "DEFAULT_PACKAGE_SET_PYTHON" 1316 "DEFAULT_PACKAGE_SET_PYTHON"
1317 ], 1317 ],
1318 "type": "string" 1318 "type": "string"
1319 }, 1319 },
1320 "machineType": { 1320 "machineType": {
1321 "description": "Machine type (e.g. \"n1-standard-1\"). If em pty or unspecified, the service will attempt to choose a reasonable default.", 1321 "description": "Machine type (e.g. \"n1-standard-1\"). If em pty or unspecified, the service will attempt to choose a reasonable default.",
1322 "type": "string" 1322 "type": "string"
1323 }, 1323 },
1324 "teardownPolicy": { 1324 "teardownPolicy": {
1325 "description": "Sets the policy for determining when to turn down worker pool. Allowed values are: TEARDOWN_ALWAYS, TEARDOWN_ON_SUCCESS, and TEARDOWN_NEVER. TEARDOWN_ALWAYS means workers are always torn down regardless of whether the job succeeds. TEARDOWN_ON_SUCCESS means workers are torn down if th e job succeeds. TEARDOWN_NEVER means the workers are never torn down. If the wor kers are not torn down by the service, they will continue to run and use Google Compute Engine VM resources in the user's project until they are explicitly term inated by the user. Because of this, Google recommends using the TEARDOWN_ALWAYS policy except for small, manually supervised test jobs. If unknown or unspecifi ed, the service will attempt to choose a reasonable default.", 1325 "description": "Sets the policy for determining when to turn down worker pool. Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and `TEARDOWN_NEVER`. `TEARDOWN_ALWAYS` means workers are always torn down regar dless of whether the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn down . If the workers are not torn down by the service, they will continue to run and use Google Compute Engine VM resources in the user's project until they are exp licitly terminated by the user. Because of this, Google recommends using the `TE ARDOWN_ALWAYS` policy except for small, manually supervised test jobs. If unknow n or unspecified, the service will attempt to choose a reasonable default.",
1326 "enum": [ 1326 "enum": [
1327 "TEARDOWN_POLICY_UNKNOWN", 1327 "TEARDOWN_POLICY_UNKNOWN",
1328 "TEARDOWN_ALWAYS", 1328 "TEARDOWN_ALWAYS",
1329 "TEARDOWN_ON_SUCCESS", 1329 "TEARDOWN_ON_SUCCESS",
1330 "TEARDOWN_NEVER" 1330 "TEARDOWN_NEVER"
1331 ], 1331 ],
1332 "type": "string" 1332 "type": "string"
1333 }, 1333 },
1334 "diskSizeGb": { 1334 "diskSizeGb": {
1335 "description": "Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.", 1335 "description": "Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.",
(...skipping 48 matching lines...) Expand 10 before | Expand all | Expand 10 after
1384 }, 1384 },
1385 "network": { 1385 "network": {
1386 "description": "Network to which VMs will be assigned. If em pty or unspecified, the service will use the network \"default\".", 1386 "description": "Network to which VMs will be assigned. If em pty or unspecified, the service will use the network \"default\".",
1387 "type": "string" 1387 "type": "string"
1388 }, 1388 },
1389 "subnetwork": { 1389 "subnetwork": {
1390 "description": "Subnetwork to which VMs will be assigned, if desired. Expected to be of the form \"regions/REGION/subnetworks/SUBNETWORK\"." , 1390 "description": "Subnetwork to which VMs will be assigned, if desired. Expected to be of the form \"regions/REGION/subnetworks/SUBNETWORK\"." ,
1391 "type": "string" 1391 "type": "string"
1392 }, 1392 },
1393 "workerHarnessContainerImage": { 1393 "workerHarnessContainerImage": {
1394 "description": "Docker container image that executes Dataflo w worker harness, residing in Google Container Registry. Required.", 1394 "description": "Required. Docker container image that execut es the Cloud Dataflow worker harness, residing in Google Container Registry.",
1395 "type": "string" 1395 "type": "string"
1396 }, 1396 },
1397 "numThreadsPerWorker": { 1397 "numThreadsPerWorker": {
1398 "description": "The number of threads per worker harness. If empty or unspecified, the service will choose a number of threads (according to the number of cores on the selected machine type for batch, or 1 by convention for streaming).", 1398 "description": "The number of threads per worker harness. If empty or unspecified, the service will choose a number of threads (according to the number of cores on the selected machine type for batch, or 1 by convention for streaming).",
1399 "format": "int32", 1399 "format": "int32",
1400 "type": "integer" 1400 "type": "integer"
1401 }, 1401 },
1402 "ipConfiguration": { 1402 "ipConfiguration": {
1403 "description": "Configuration for VM IPs.", 1403 "description": "Configuration for VM IPs.",
1404 "enum": [ 1404 "enum": [
1405 "WORKER_IP_UNSPECIFIED", 1405 "WORKER_IP_UNSPECIFIED",
1406 "WORKER_IP_PUBLIC", 1406 "WORKER_IP_PUBLIC",
1407 "WORKER_IP_PRIVATE" 1407 "WORKER_IP_PRIVATE"
1408 ], 1408 ],
1409 "type": "string" 1409 "type": "string"
1410 } 1410 }
1411 }, 1411 },
1412 "type": "object" 1412 "type": "object"
1413 }, 1413 },
1414 "Package": { 1414 "Package": {
1415 "description": "Packages that need to be installed in order for a wo rker to run the steps of the Dataflow job which will be assigned to its worker p ool. This is the mechanism by which the SDK causes code to be loaded onto the wo rkers. For example, the Dataflow Java SDK might use this to install jars contain ing the user's code and all of the various dependencies (libraries, data files, etc) required in order for that code to run.", 1415 "description": "The packages that must be installed in order for a w orker to run the steps of the Cloud Dataflow job that will be assigned to its wo rker pool. This is the mechanism by which the Cloud Dataflow SDK causes code to be loaded onto the workers. For example, the Cloud Dataflow Java SDK might use t his to install jars containing the user's code and all of the various dependenci es (libraries, data files, etc.) required in order for that code to run.",
1416 "id": "Package", 1416 "id": "Package",
1417 "properties": { 1417 "properties": {
1418 "name": { 1418 "name": {
1419 "description": "The name of the package.", 1419 "description": "The name of the package.",
1420 "type": "string" 1420 "type": "string"
1421 }, 1421 },
1422 "location": { 1422 "location": {
1423 "description": "The resource to read the package from. The s upported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket} bucket.storage.googleapis.com/", 1423 "description": "The resource to read the package from. The s upported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket} bucket.storage.googleapis.com/",
1424 "type": "string" 1424 "type": "string"
1425 } 1425 }
1426 }, 1426 },
1427 "type": "object" 1427 "type": "object"
1428 }, 1428 },
1429 "TaskRunnerSettings": { 1429 "TaskRunnerSettings": {
1430 "description": "Taskrunner configuration settings.", 1430 "description": "Taskrunner configuration settings.",
1431 "id": "TaskRunnerSettings", 1431 "id": "TaskRunnerSettings",
1432 "properties": { 1432 "properties": {
1433 "taskUser": { 1433 "taskUser": {
1434 "description": "The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. \"root\".", 1434 "description": "The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. \"root\".",
1435 "type": "string" 1435 "type": "string"
1436 }, 1436 },
1437 "taskGroup": { 1437 "taskGroup": {
1438 "description": "The UNIX group ID on the worker VM to use fo r tasks launched by taskrunner; e.g. \"wheel\".", 1438 "description": "The UNIX group ID on the worker VM to use fo r tasks launched by taskrunner; e.g. \"wheel\".",
1439 "type": "string" 1439 "type": "string"
1440 }, 1440 },
1441 "oauthScopes": { 1441 "oauthScopes": {
1442 "description": "OAuth2 scopes to be requested by the taskrun ner in order to access the dataflow API.", 1442 "description": "The OAuth2 scopes to be requested by the tas krunner in order to access the Cloud Dataflow API.",
1443 "items": { 1443 "items": {
1444 "type": "string" 1444 "type": "string"
1445 }, 1445 },
1446 "type": "array" 1446 "type": "array"
1447 }, 1447 },
1448 "baseUrl": { 1448 "baseUrl": {
1449 "description": "The base URL for the taskrunner to use when accessing Google Cloud APIs. When workers access Google Cloud APIs, they logical ly do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defin ed by RFC 1808, \"Relative Uniform Resource Locators\". If not specified, the de fault value is \"http://www.googleapis.com/\"", 1449 "description": "The base URL for the taskrunner to use when accessing Google Cloud APIs. When workers access Google Cloud APIs, they logical ly do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defin ed by RFC 1808, \"Relative Uniform Resource Locators\". If not specified, the de fault value is \"http://www.googleapis.com/\"",
1450 "type": "string" 1450 "type": "string"
1451 }, 1451 },
1452 "dataflowApiVersion": { 1452 "dataflowApiVersion": {
1453 "description": "API version of endpoint, e.g. \"v1b3\"", 1453 "description": "The API version of endpoint, e.g. \"v1b3\"",
1454 "type": "string" 1454 "type": "string"
1455 }, 1455 },
1456 "parallelWorkerSettings": { 1456 "parallelWorkerSettings": {
1457 "$ref": "WorkerSettings", 1457 "$ref": "WorkerSettings",
1458 "description": "Settings to pass to the parallel worker harn ess." 1458 "description": "The settings to pass to the parallel worker harness."
1459 }, 1459 },
1460 "baseTaskDir": { 1460 "baseTaskDir": {
1461 "description": "Location on the worker for task-specific sub directories.", 1461 "description": "The location on the worker for task-specific subdirectories.",
1462 "type": "string" 1462 "type": "string"
1463 }, 1463 },
1464 "continueOnException": { 1464 "continueOnException": {
1465 "description": "Do we continue taskrunner if an exception is hit?", 1465 "description": "Whether to continue taskrunner if an excepti on is hit.",
1466 "type": "boolean" 1466 "type": "boolean"
1467 }, 1467 },
1468 "logToSerialconsole": { 1468 "logToSerialconsole": {
1469 "description": "Send taskrunner log into to Google Compute E ngine VM serial console?", 1469 "description": "Whether to send taskrunner log info to Googl e Compute Engine VM serial console.",
1470 "type": "boolean" 1470 "type": "boolean"
1471 }, 1471 },
1472 "alsologtostderr": { 1472 "alsologtostderr": {
1473 "description": "Also send taskrunner log info to stderr?", 1473 "description": "Whether to also send taskrunner log info to stderr.",
1474 "type": "boolean" 1474 "type": "boolean"
1475 }, 1475 },
1476 "logUploadLocation": { 1476 "logUploadLocation": {
1477 "description": "Indicates where to put logs. If this is not specified, the logs will not be uploaded. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleap is.com/{object}", 1477 "description": "Indicates where to put logs. If this is not specified, the logs will not be uploaded. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleap is.com/{object}",
1478 "type": "string" 1478 "type": "string"
1479 }, 1479 },
1480 "logDir": { 1480 "logDir": {
1481 "description": "Directory on the VM to store logs.", 1481 "description": "The directory on the VM to store logs.",
1482 "type": "string" 1482 "type": "string"
1483 }, 1483 },
1484 "tempStoragePrefix": { 1484 "tempStoragePrefix": {
1485 "description": "The prefix of the resources the taskrunner s hould use for temporary storage. The supported resource type is: Google Cloud St orage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{o bject}", 1485 "description": "The prefix of the resources the taskrunner s hould use for temporary storage. The supported resource type is: Google Cloud St orage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{o bject}",
1486 "type": "string" 1486 "type": "string"
1487 }, 1487 },
1488 "harnessCommand": { 1488 "harnessCommand": {
1489 "description": "Command to launch the worker harness.", 1489 "description": "The command to launch the worker harness.",
1490 "type": "string" 1490 "type": "string"
1491 }, 1491 },
1492 "workflowFileName": { 1492 "workflowFileName": {
1493 "description": "Store the workflow in this file.", 1493 "description": "The file to store the workflow in.",
1494 "type": "string" 1494 "type": "string"
1495 }, 1495 },
1496 "commandlinesFileName": { 1496 "commandlinesFileName": {
1497 "description": "Store preprocessing commands in this file.", 1497 "description": "The file to store preprocessing commands in. ",
1498 "type": "string" 1498 "type": "string"
1499 }, 1499 },
1500 "vmId": { 1500 "vmId": {
1501 "description": "ID string of VM.", 1501 "description": "The ID string of the VM.",
1502 "type": "string" 1502 "type": "string"
1503 }, 1503 },
1504 "languageHint": { 1504 "languageHint": {
1505 "description": "Suggested backend language.", 1505 "description": "The suggested backend language.",
1506 "type": "string" 1506 "type": "string"
1507 }, 1507 },
1508 "streamingWorkerMainClass": { 1508 "streamingWorkerMainClass": {
1509 "description": "Streaming worker main class name.", 1509 "description": "The streaming worker main class name.",
1510 "type": "string" 1510 "type": "string"
1511 } 1511 }
1512 }, 1512 },
1513 "type": "object" 1513 "type": "object"
1514 }, 1514 },
1515 "WorkerSettings": { 1515 "WorkerSettings": {
1516 "description": "Provides data to pass through to the worker harness. ", 1516 "description": "Provides data to pass through to the worker harness. ",
1517 "id": "WorkerSettings", 1517 "id": "WorkerSettings",
1518 "properties": { 1518 "properties": {
1519 "baseUrl": { 1519 "baseUrl": {
1520 "description": "The base URL for accessing Google Cloud APIs . When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, \"Relative Uniform Resource Locators\". If not specified, the default value is \"http://www .googleapis.com/\"", 1520 "description": "The base URL for accessing Google Cloud APIs . When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, \"Relative Uniform Resource Locators\". If not specified, the default value is \"http://www .googleapis.com/\"",
1521 "type": "string" 1521 "type": "string"
1522 }, 1522 },
1523 "reportingEnabled": { 1523 "reportingEnabled": {
1524 "description": "Send work progress updates to service.", 1524 "description": "Whether to send work progress updates to the service.",
1525 "type": "boolean" 1525 "type": "boolean"
1526 }, 1526 },
1527 "servicePath": { 1527 "servicePath": {
1528 "description": "The Dataflow service path relative to the ro ot URL, for example, \"dataflow/v1b3/projects\".", 1528 "description": "The Cloud Dataflow service path relative to the root URL, for example, \"dataflow/v1b3/projects\".",
1529 "type": "string" 1529 "type": "string"
1530 }, 1530 },
1531 "shuffleServicePath": { 1531 "shuffleServicePath": {
1532 "description": "The Shuffle service path relative to the roo t URL, for example, \"shuffle/v1beta1\".", 1532 "description": "The Shuffle service path relative to the roo t URL, for example, \"shuffle/v1beta1\".",
1533 "type": "string" 1533 "type": "string"
1534 }, 1534 },
1535 "workerId": { 1535 "workerId": {
1536 "description": "ID of the worker running this pipeline.", 1536 "description": "The ID of the worker running this pipeline." ,
1537 "type": "string" 1537 "type": "string"
1538 }, 1538 },
1539 "tempStoragePrefix": { 1539 "tempStoragePrefix": {
1540 "description": "The prefix of the resources the system shoul d use for temporary storage. The supported resource type is: Google Cloud Storag e: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{objec t}", 1540 "description": "The prefix of the resources the system shoul d use for temporary storage. The supported resource type is: Google Cloud Storag e: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{objec t}",
1541 "type": "string" 1541 "type": "string"
1542 } 1542 }
1543 }, 1543 },
1544 "type": "object" 1544 "type": "object"
1545 }, 1545 },
1546 "Disk": { 1546 "Disk": {
1547 "description": "Describes the data disk used by a workflow job.", 1547 "description": "Describes the data disk used by a workflow job.",
1548 "id": "Disk", 1548 "id": "Disk",
1549 "properties": { 1549 "properties": {
1550 "sizeGb": { 1550 "sizeGb": {
1551 "description": "Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default.", 1551 "description": "Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default.",
1552 "format": "int32", 1552 "format": "int32",
1553 "type": "integer" 1553 "type": "integer"
1554 }, 1554 },
1555 "diskType": { 1555 "diskType": {
1556 "description": "Disk storage type, as defined by Google Comp ute Engine. This must be a disk type appropriate to the project and zone in whic h the workers will run. If unknown or unspecified, the service will attempt to c hoose a reasonable default. For example, the standard persistent disk type is a resource name typically ending in \"pd-standard\". If SSD persistent disks are a vailable, the resource name typically ends with \"pd-ssd\". The actual valid val ues are defined the Google Compute Engine API, not by the Dataflow API; consult the Google Compute Engine documentation for more information about determining t he set of available disk types for a particular project and zone. Google Compute Engine Disk types are local to a particular project in a particular zone, and s o the resource name will typically look something like this: compute.googleapis. com/projects/\n/zones//diskTypes/pd-standard", 1556 "description": "Disk storage type, as defined by Google Comp ute Engine. This must be a disk type appropriate to the project and zone in whic h the workers will run. If unknown or unspecified, the service will attempt to c hoose a reasonable default. For example, the standard persistent disk type is a resource name typically ending in \"pd-standard\". If SSD persistent disks are a vailable, the resource name typically ends with \"pd-ssd\". The actual valid val ues are defined the Google Compute Engine API, not by the Cloud Dataflow API; co nsult the Google Compute Engine documentation for more information about determi ning the set of available disk types for a particular project and zone. Google C ompute Engine Disk types are local to a particular project in a particular zone, and so the resource name will typically look something like this: compute.googl eapis.com/projects/project-id/zones/zone/diskTypes/pd-standard",
1557 "type": "string" 1557 "type": "string"
1558 }, 1558 },
1559 "mountPoint": { 1559 "mountPoint": {
1560 "description": "Directory in a VM where disk is mounted.", 1560 "description": "Directory in a VM where disk is mounted.",
1561 "type": "string" 1561 "type": "string"
1562 } 1562 }
1563 }, 1563 },
1564 "type": "object" 1564 "type": "object"
1565 }, 1565 },
1566 "AutoscalingSettings": { 1566 "AutoscalingSettings": {
(...skipping 11 matching lines...) Expand all
1578 }, 1578 },
1579 "maxNumWorkers": { 1579 "maxNumWorkers": {
1580 "description": "The maximum number of workers to cap scaling at.", 1580 "description": "The maximum number of workers to cap scaling at.",
1581 "format": "int32", 1581 "format": "int32",
1582 "type": "integer" 1582 "type": "integer"
1583 } 1583 }
1584 }, 1584 },
1585 "type": "object" 1585 "type": "object"
1586 }, 1586 },
1587 "Step": { 1587 "Step": {
1588 "description": "Defines a particular step within a Dataflow job. A j ob consists of multiple steps, each of which performs some specific operation as part of the overall job. Data is typically passed from one step to another as p art of the job. Here's an example of a sequence of steps which together implemen t a Map-Reduce job: * Read a collection of data from some source, parsing the co llection's elements. * Validate the elements. * Apply a user-defined function to map each element to some value and extract an element-specific key value. * Gro up elements with the same key into a single element with that key, transforming a multiply-keyed collection into a uniquely-keyed collection. * Write the elemen ts out to some data sink. (Note that the Dataflow service may be used to run man y different types of jobs, not just Map-Reduce).", 1588 "description": "Defines a particular step within a Cloud Dataflow jo b. A job consists of multiple steps, each of which performs some specific operat ion as part of the overall job. Data is typically passed from one step to anothe r as part of the job. Here's an example of a sequence of steps which together im plement a Map-Reduce job: * Read a collection of data from some source, parsing the collection's elements. * Validate the elements. * Apply a user-defined funct ion to map each element to some value and extract an element-specific key value. * Group elements with the same key into a single element with that key, transfo rming a multiply-keyed collection into a uniquely-keyed collection. * Write the elements out to some data sink. Note that the Cloud Dataflow service may be used to run many different types of jobs, not just Map-Reduce.",
1589 "id": "Step", 1589 "id": "Step",
1590 "properties": { 1590 "properties": {
1591 "kind": { 1591 "kind": {
1592 "description": "The kind of step in the dataflow Job.", 1592 "description": "The kind of step in the Cloud Dataflow job." ,
1593 "type": "string" 1593 "type": "string"
1594 }, 1594 },
1595 "name": { 1595 "name": {
1596 "description": "Name identifying the step. This must be uniq ue for each step with respect to all other steps in the dataflow Job.", 1596 "description": "The name that identifies the step. This must be unique for each step with respect to all other steps in the Cloud Dataflow j ob.",
1597 "type": "string" 1597 "type": "string"
1598 }, 1598 },
1599 "properties": { 1599 "properties": {
1600 "additionalProperties": { 1600 "additionalProperties": {
1601 "description": "Properties of the object.", 1601 "description": "Properties of the object.",
1602 "type": "any" 1602 "type": "any"
1603 }, 1603 },
1604 "description": "Named properties associated with the step. E ach kind of predefined step has its own required set of properties.", 1604 "description": "Named properties associated with the step. E ach kind of predefined step has its own required set of properties.",
1605 "type": "object" 1605 "type": "object"
1606 } 1606 }
1607 }, 1607 },
1608 "type": "object" 1608 "type": "object"
1609 }, 1609 },
1610 "JobExecutionInfo": { 1610 "JobExecutionInfo": {
1611 "description": "Additional information about how a Dataflow job will be executed which isnt contained in the submitted job.", 1611 "description": "Additional information about how a Cloud Dataflow jo b will be executed that isn't contained in the submitted job.",
1612 "id": "JobExecutionInfo", 1612 "id": "JobExecutionInfo",
1613 "properties": { 1613 "properties": {
1614 "stages": { 1614 "stages": {
1615 "additionalProperties": { 1615 "additionalProperties": {
1616 "$ref": "JobExecutionStageInfo" 1616 "$ref": "JobExecutionStageInfo"
1617 }, 1617 },
1618 "description": "A mapping from each stage to the information about that stage.", 1618 "description": "A mapping from each stage to the information about that stage.",
1619 "type": "object" 1619 "type": "object"
1620 } 1620 }
1621 }, 1621 },
1622 "type": "object" 1622 "type": "object"
1623 }, 1623 },
1624 "JobExecutionStageInfo": { 1624 "JobExecutionStageInfo": {
1625 "description": "Contains information about how a particular google.d ataflow.v1beta3.Step will be executed.", 1625 "description": "Contains information about how a particular google.d ataflow.v1beta3.Step will be executed.",
1626 "id": "JobExecutionStageInfo", 1626 "id": "JobExecutionStageInfo",
1627 "properties": { 1627 "properties": {
1628 "stepName": { 1628 "stepName": {
1629 "description": "The steps associated with the execution stag e. Note that stages may have several steps, and that a given step might be run b y more than one stage.", 1629 "description": "The steps associated with the execution stag e. Note that stages may have several steps, and that a given step might be run b y more than one stage.",
1630 "items": { 1630 "items": {
1631 "type": "string" 1631 "type": "string"
1632 }, 1632 },
1633 "type": "array" 1633 "type": "array"
1634 } 1634 }
1635 }, 1635 },
1636 "type": "object" 1636 "type": "object"
1637 }, 1637 },
1638 "ListJobsResponse": { 1638 "ListJobsResponse": {
1639 "description": "Response to a request to list Dataflow jobs. This ma y be a partial response, depending on the page size in the ListJobsRequest.", 1639 "description": "Response to a request to list Cloud Dataflow jobs. T his may be a partial response, depending on the page size in the ListJobsRequest .",
1640 "id": "ListJobsResponse", 1640 "id": "ListJobsResponse",
1641 "properties": { 1641 "properties": {
1642 "jobs": { 1642 "jobs": {
1643 "description": "A subset of the requested job information.", 1643 "description": "A subset of the requested job information.",
1644 "items": { 1644 "items": {
1645 "$ref": "Job" 1645 "$ref": "Job"
1646 }, 1646 },
1647 "type": "array" 1647 "type": "array"
1648 }, 1648 },
1649 "nextPageToken": { 1649 "nextPageToken": {
1650 "description": "Set if there may be more results than fit in this response.", 1650 "description": "Set if there may be more results than fit in this response.",
1651 "type": "string" 1651 "type": "string"
1652 }, 1652 },
1653 "failedLocation": { 1653 "failedLocation": {
1654 "description": "Zero or more messages describing locations t hat failed to respond.", 1654 "description": "Zero or more messages describing locations t hat failed to respond.",
1655 "items": { 1655 "items": {
1656 "$ref": "FailedLocation" 1656 "$ref": "FailedLocation"
1657 }, 1657 },
1658 "type": "array" 1658 "type": "array"
1659 } 1659 }
1660 }, 1660 },
1661 "type": "object" 1661 "type": "object"
1662 }, 1662 },
1663 "FailedLocation": { 1663 "FailedLocation": {
1664 "description": "FailedLocation indicates which location failed to re spond to a request for data.", 1664 "description": "Indicates which location failed to respond to a requ est for data.",
1665 "id": "FailedLocation", 1665 "id": "FailedLocation",
1666 "properties": { 1666 "properties": {
1667 "name": { 1667 "name": {
1668 "description": "The name of the failed location.", 1668 "description": "The name of the failed location.",
1669 "type": "string" 1669 "type": "string"
1670 } 1670 }
1671 }, 1671 },
1672 "type": "object" 1672 "type": "object"
1673 }, 1673 },
1674 "ListJobMessagesResponse": { 1674 "ListJobMessagesResponse": {
(...skipping 122 matching lines...) Expand 10 before | Expand all | Expand 10 after
1797 "additionalProperties": { 1797 "additionalProperties": {
1798 "type": "string" 1798 "type": "string"
1799 }, 1799 },
1800 "description": "Zero or more labeled fields which identify t he part of the job this metric is associated with, such as the name of a step or collection. For example, built-in counters associated with steps will have cont ext['step'] = . Counters associated with PCollections in the SDK will have conte xt['pcollection'] =\n.", 1800 "description": "Zero or more labeled fields which identify t he part of the job this metric is associated with, such as the name of a step or collection. For example, built-in counters associated with steps will have cont ext['step'] = . Counters associated with PCollections in the SDK will have conte xt['pcollection'] =\n.",
1801 "type": "object" 1801 "type": "object"
1802 } 1802 }
1803 }, 1803 },
1804 "type": "object" 1804 "type": "object"
1805 }, 1805 },
1806 "CreateJobFromTemplateRequest": { 1806 "CreateJobFromTemplateRequest": {
1807 "description": "Request to create a Dataflow job.", 1807 "description": "A request to create a Cloud Dataflow job from a temp late.",
1808 "id": "CreateJobFromTemplateRequest", 1808 "id": "CreateJobFromTemplateRequest",
1809 "properties": { 1809 "properties": {
1810 "jobName": { 1810 "jobName": {
1811 "description": "The job name to use for the created job..", 1811 "description": "Required. The job name to use for the create d job.",
1812 "type": "string" 1812 "type": "string"
1813 }, 1813 },
1814 "gcsPath": { 1814 "gcsPath": {
1815 "description": "A path to the serialized JSON representation of the job.", 1815 "description": "Required. A Cloud Storage path to the templa te from which to create the job. Must be a valid Cloud Storage URL, beginning wi th `gs://`.",
1816 "type": "string" 1816 "type": "string"
1817 }, 1817 },
1818 "parameters": { 1818 "parameters": {
1819 "additionalProperties": { 1819 "additionalProperties": {
1820 "type": "string" 1820 "type": "string"
1821 }, 1821 },
1822 "description": "Dynamic parameterization of the job's runtim e environment.", 1822 "description": "The runtime parameters to pass to the job.",
1823 "type": "object" 1823 "type": "object"
1824 }, 1824 },
1825 "environment": { 1825 "environment": {
1826 "$ref": "RuntimeEnvironment", 1826 "$ref": "RuntimeEnvironment",
1827 "description": "Runtime environment for the job." 1827 "description": "The runtime environment for the job."
1828 } 1828 }
1829 }, 1829 },
1830 "type": "object" 1830 "type": "object"
1831 }, 1831 },
1832 "RuntimeEnvironment": { 1832 "RuntimeEnvironment": {
1833 "description": "Environment values to set at runtime.", 1833 "description": "The environment values to set at runtime.",
1834 "id": "RuntimeEnvironment", 1834 "id": "RuntimeEnvironment",
1835 "properties": { 1835 "properties": {
1836 "maxWorkers": { 1836 "maxWorkers": {
1837 "description": "The maximum number of workers to start for t he job.", 1837 "description": "The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000 .",
1838 "format": "int32", 1838 "format": "int32",
1839 "type": "integer" 1839 "type": "integer"
1840 }, 1840 },
1841 "zone": { 1841 "zone": {
1842 "description": "The zone to start the workers in.", 1842 "description": "The Compute Engine [availability zone](https ://cloud.google.com/compute/docs/regions-zones/regions-zones) for launching work er instances to run your pipeline.",
1843 "type": "string" 1843 "type": "string"
1844 }, 1844 },
1845 "serviceAccountEmail": { 1845 "serviceAccountEmail": {
1846 "description": "The service account to run the job as.", 1846 "description": "The email address of the service account to run the job as.",
1847 "type": "string" 1847 "type": "string"
1848 },
1849 "tempLocation": {
1850 "description": "The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.",
1851 "type": "string"
1852 },
1853 "bypassTempDirValidation": {
1854 "description": "Whether to bypass the safety checks for the job's temporary directory. Use with caution.",
1855 "type": "boolean"
1848 } 1856 }
1849 }, 1857 },
1850 "type": "object" 1858 "type": "object"
1851 }, 1859 },
1852 "ReportWorkItemStatusRequest": { 1860 "ReportWorkItemStatusRequest": {
1853 "description": "Request to report the status of WorkItems.", 1861 "description": "Request to report the status of WorkItems.",
1854 "id": "ReportWorkItemStatusRequest", 1862 "id": "ReportWorkItemStatusRequest",
1855 "properties": { 1863 "properties": {
1856 "workerId": { 1864 "workerId": {
1857 "description": "The ID of the worker reporting the WorkItem status. If this does not match the ID of the worker which the Dataflow service b elieves currently has the lease on the WorkItem, the report will be dropped (wit h an error response).", 1865 "description": "The ID of the worker reporting the WorkItem status. If this does not match the ID of the worker which the Dataflow service b elieves currently has the lease on the WorkItem, the report will be dropped (wit h an error response).",
(...skipping 160 matching lines...) Expand 10 before | Expand all | Expand 10 after
2018 "description": "List of integers, for Set." 2026 "description": "List of integers, for Set."
2019 }, 2027 },
2020 "floatingPointList": { 2028 "floatingPointList": {
2021 "$ref": "FloatingPointList", 2029 "$ref": "FloatingPointList",
2022 "description": "List of floating point numbers, for Set." 2030 "description": "List of floating point numbers, for Set."
2023 }, 2031 },
2024 "stringList": { 2032 "stringList": {
2025 "$ref": "StringList", 2033 "$ref": "StringList",
2026 "description": "List of strings, for Set." 2034 "description": "List of strings, for Set."
2027 }, 2035 },
2036 "distribution": {
2037 "$ref": "DistributionUpdate",
2038 "description": "Distribution data"
2039 },
2028 "internal": { 2040 "internal": {
2029 "description": "Value for internally-defined counters used b y the Dataflow service.", 2041 "description": "Value for internally-defined counters used b y the Dataflow service.",
2030 "type": "any" 2042 "type": "any"
2031 } 2043 }
2032 }, 2044 },
2033 "type": "object" 2045 "type": "object"
2034 }, 2046 },
2035 "NameAndKind": { 2047 "NameAndKind": {
2036 "description": "Basic metadata about a counter.", 2048 "description": "Basic metadata about a counter.",
2037 "id": "NameAndKind", 2049 "id": "NameAndKind",
2038 "properties": { 2050 "properties": {
2039 "name": { 2051 "name": {
2040 "description": "Name of the counter.", 2052 "description": "Name of the counter.",
2041 "type": "string" 2053 "type": "string"
2042 }, 2054 },
2043 "kind": { 2055 "kind": {
2044 "description": "Counter aggregation kind.", 2056 "description": "Counter aggregation kind.",
2045 "enum": [ 2057 "enum": [
2046 "INVALID", 2058 "INVALID",
2047 "SUM", 2059 "SUM",
2048 "MAX", 2060 "MAX",
2049 "MIN", 2061 "MIN",
2050 "MEAN", 2062 "MEAN",
2051 "OR", 2063 "OR",
2052 "AND", 2064 "AND",
2053 "SET" 2065 "SET",
2066 "DISTRIBUTION"
2054 ], 2067 ],
2055 "type": "string" 2068 "type": "string"
2056 } 2069 }
2057 }, 2070 },
2058 "type": "object" 2071 "type": "object"
2059 }, 2072 },
2060 "CounterStructuredNameAndMetadata": { 2073 "CounterStructuredNameAndMetadata": {
2061 "description": "A single message which encapsulates structured name and metadata for a given counter.", 2074 "description": "A single message which encapsulates structured name and metadata for a given counter.",
2062 "id": "CounterStructuredNameAndMetadata", 2075 "id": "CounterStructuredNameAndMetadata",
2063 "properties": { 2076 "properties": {
(...skipping 63 matching lines...) Expand 10 before | Expand all | Expand 10 after
2127 "kind": { 2140 "kind": {
2128 "description": "Counter aggregation kind.", 2141 "description": "Counter aggregation kind.",
2129 "enum": [ 2142 "enum": [
2130 "INVALID", 2143 "INVALID",
2131 "SUM", 2144 "SUM",
2132 "MAX", 2145 "MAX",
2133 "MIN", 2146 "MIN",
2134 "MEAN", 2147 "MEAN",
2135 "OR", 2148 "OR",
2136 "AND", 2149 "AND",
2137 "SET" 2150 "SET",
2151 "DISTRIBUTION"
2138 ], 2152 ],
2139 "type": "string" 2153 "type": "string"
2140 }, 2154 },
2141 "description": { 2155 "description": {
2142 "description": "Human-readable description of the counter se mantics.", 2156 "description": "Human-readable description of the counter se mantics.",
2143 "type": "string" 2157 "type": "string"
2144 }, 2158 },
2145 "standardUnits": { 2159 "standardUnits": {
2146 "description": "System defined Units, see above enum.", 2160 "description": "System defined Units, see above enum.",
2147 "enum": [ 2161 "enum": [
(...skipping 99 matching lines...) Expand 10 before | Expand all | Expand 10 after
2247 "elements": { 2261 "elements": {
2248 "description": "Elements of the list.", 2262 "description": "Elements of the list.",
2249 "items": { 2263 "items": {
2250 "type": "string" 2264 "type": "string"
2251 }, 2265 },
2252 "type": "array" 2266 "type": "array"
2253 } 2267 }
2254 }, 2268 },
2255 "type": "object" 2269 "type": "object"
2256 }, 2270 },
2271 "DistributionUpdate": {
2272 "description": "A metric value representing a distribution.",
2273 "id": "DistributionUpdate",
2274 "properties": {
2275 "min": {
2276 "$ref": "SplitInt64",
2277 "description": "The minimum value present in the distributio n."
2278 },
2279 "max": {
2280 "$ref": "SplitInt64",
2281 "description": "The maximum value present in the distributio n."
2282 },
2283 "count": {
2284 "$ref": "SplitInt64",
2285 "description": "The count of the number of elements present in the distribution."
2286 },
2287 "sum": {
2288 "$ref": "SplitInt64",
2289 "description": "Use an int64 since we'd prefer the added pre cision. If overflow is a common problem we can detect it and use an additional i nt64 or a double."
2290 },
2291 "sumOfSquares": {
2292 "description": "Use a double since the sum of squares is lik ely to overflow int64.",
2293 "format": "double",
2294 "type": "number"
2295 }
2296 },
2297 "type": "object"
2298 },
2257 "ApproximateReportedProgress": { 2299 "ApproximateReportedProgress": {
2258 "description": "A progress measurement of a WorkItem by a worker.", 2300 "description": "A progress measurement of a WorkItem by a worker.",
2259 "id": "ApproximateReportedProgress", 2301 "id": "ApproximateReportedProgress",
2260 "properties": { 2302 "properties": {
2261 "position": { 2303 "position": {
2262 "$ref": "Position", 2304 "$ref": "Position",
2263 "description": "A Position within the work to represent a pr ogress." 2305 "description": "A Position within the work to represent a pr ogress."
2264 }, 2306 },
2265 "fractionConsumed": { 2307 "fractionConsumed": {
2266 "description": "Completion as fraction of the input consumed , from 0.0 (beginning, nothing consumed), to 1.0 (end of the input, entire input consumed).", 2308 "description": "Completion as fraction of the input consumed , from 0.0 (beginning, nothing consumed), to 1.0 (end of the input, entire input consumed).",
(...skipping 1360 matching lines...) Expand 10 before | Expand all | Expand 10 after
3627 "description": "The timestamp of the worker_message.", 3669 "description": "The timestamp of the worker_message.",
3628 "type": "string" 3670 "type": "string"
3629 }, 3671 },
3630 "workerHealthReport": { 3672 "workerHealthReport": {
3631 "$ref": "WorkerHealthReport", 3673 "$ref": "WorkerHealthReport",
3632 "description": "The health of a worker." 3674 "description": "The health of a worker."
3633 }, 3675 },
3634 "workerMessageCode": { 3676 "workerMessageCode": {
3635 "$ref": "WorkerMessageCode", 3677 "$ref": "WorkerMessageCode",
3636 "description": "A worker message code." 3678 "description": "A worker message code."
3679 },
3680 "workerMetrics": {
3681 "$ref": "ResourceUtilizationReport",
3682 "description": "Resource metrics reported by workers."
3637 } 3683 }
3638 }, 3684 },
3639 "type": "object" 3685 "type": "object"
3640 }, 3686 },
3641 "WorkerHealthReport": { 3687 "WorkerHealthReport": {
3642 "description": "WorkerHealthReport contains information about the he alth of a worker. The VM should be identified by the labels attached to the Work erMessage that this health ping belongs to.", 3688 "description": "WorkerHealthReport contains information about the he alth of a worker. The VM should be identified by the labels attached to the Work erMessage that this health ping belongs to.",
3643 "id": "WorkerHealthReport", 3689 "id": "WorkerHealthReport",
3644 "properties": { 3690 "properties": {
3645 "vmIsHealthy": { 3691 "vmIsHealthy": {
3646 "description": "Whether the VM is healthy.", 3692 "description": "Whether the VM is healthy.",
(...skipping 33 matching lines...) Expand 10 before | Expand all | Expand 10 after
3680 "additionalProperties": { 3726 "additionalProperties": {
3681 "description": "Properties of the object.", 3727 "description": "Properties of the object.",
3682 "type": "any" 3728 "type": "any"
3683 }, 3729 },
3684 "description": "Parameters contains specific information abo ut the code. This is a struct to allow parameters of different types. Examples: 1. For a \"HARNESS_STARTED\" message parameters might provide the name of the wo rker and additional data like timing information. 2. For a \"GCS_DOWNLOAD_ERROR\ " parameters might contain fields listing the GCS objects being downloaded and f ields containing errors. In general complex data structures should be avoided. I f a worker needs to send a specific and complicated data structure then please c onsider defining a new proto and adding it to the data oneof in WorkerMessageRes ponse. Conventions: Parameters should only be used for information that isn't ty pically passed as a label. hostname and other worker identifiers should almost a lways be passed as labels since they will be included on most messages.", 3730 "description": "Parameters contains specific information abo ut the code. This is a struct to allow parameters of different types. Examples: 1. For a \"HARNESS_STARTED\" message parameters might provide the name of the wo rker and additional data like timing information. 2. For a \"GCS_DOWNLOAD_ERROR\ " parameters might contain fields listing the GCS objects being downloaded and f ields containing errors. In general complex data structures should be avoided. I f a worker needs to send a specific and complicated data structure then please c onsider defining a new proto and adding it to the data oneof in WorkerMessageRes ponse. Conventions: Parameters should only be used for information that isn't ty pically passed as a label. hostname and other worker identifiers should almost a lways be passed as labels since they will be included on most messages.",
3685 "type": "object" 3731 "type": "object"
3686 } 3732 }
3687 }, 3733 },
3688 "type": "object" 3734 "type": "object"
3689 }, 3735 },
3736 "ResourceUtilizationReport": {
3737 "description": "Worker metrics exported from workers. This contains resource utilization metrics accumulated from a variety of sources. For more inf ormation, see go/df-resource-signals. Note that this proto closely follows the s tructure of its DFE siblings in its contents.",
3738 "id": "ResourceUtilizationReport",
3739 "properties": {
3740 "metrics": {
3741 "description": "Each Struct must parallel DFE worker metrics protos (eg., cpu_time metric will have nested values “timestamp_ms, total_ms, r ate”).",
3742 "items": {
3743 "additionalProperties": {
3744 "description": "Properties of the object.",
3745 "type": "any"
3746 },
3747 "type": "object"
3748 },
3749 "type": "array"
3750 }
3751 },
3752 "type": "object"
3753 },
3690 "SendWorkerMessagesResponse": { 3754 "SendWorkerMessagesResponse": {
3691 "description": "The response to the worker messages.", 3755 "description": "The response to the worker messages.",
3692 "id": "SendWorkerMessagesResponse", 3756 "id": "SendWorkerMessagesResponse",
3693 "properties": { 3757 "properties": {
3694 "workerMessageResponses": { 3758 "workerMessageResponses": {
3695 "description": "The servers response to the worker messages. ", 3759 "description": "The servers response to the worker messages. ",
3696 "items": { 3760 "items": {
3697 "$ref": "WorkerMessageResponse" 3761 "$ref": "WorkerMessageResponse"
3698 }, 3762 },
3699 "type": "array" 3763 "type": "array"
3700 } 3764 }
3701 }, 3765 },
3702 "type": "object" 3766 "type": "object"
3703 }, 3767 },
3704 "WorkerMessageResponse": { 3768 "WorkerMessageResponse": {
3705 "description": "A worker_message response allows the server to pass information to the sender.", 3769 "description": "A worker_message response allows the server to pass information to the sender.",
3706 "id": "WorkerMessageResponse", 3770 "id": "WorkerMessageResponse",
3707 "properties": { 3771 "properties": {
3708 "workerHealthReportResponse": { 3772 "workerHealthReportResponse": {
3709 "$ref": "WorkerHealthReportResponse", 3773 "$ref": "WorkerHealthReportResponse",
3710 "description": "The service's response to a worker's health report." 3774 "description": "The service's response to a worker's health report."
3775 },
3776 "workerMetricsResponse": {
3777 "$ref": "ResourceUtilizationReportResponse",
3778 "description": "Service's response to reporting worker metri cs (currently empty)."
3711 } 3779 }
3712 }, 3780 },
3713 "type": "object" 3781 "type": "object"
3714 }, 3782 },
3715 "WorkerHealthReportResponse": { 3783 "WorkerHealthReportResponse": {
3716 "description": "WorkerHealthReportResponse contains information retu rned to the worker in response to a health ping.", 3784 "description": "WorkerHealthReportResponse contains information retu rned to the worker in response to a health ping.",
3717 "id": "WorkerHealthReportResponse", 3785 "id": "WorkerHealthReportResponse",
3718 "properties": { 3786 "properties": {
3719 "reportInterval": { 3787 "reportInterval": {
3720 "description": "A positive value indicates the worker should change its reporting interval to the specified value. The default value of zero means no change in report rate is requested by the server.", 3788 "description": "A positive value indicates the worker should change its reporting interval to the specified value. The default value of zero means no change in report rate is requested by the server.",
3721 "type": "string" 3789 "type": "string"
3722 } 3790 }
3723 }, 3791 },
3724 "type": "object" 3792 "type": "object"
3793 },
3794 "ResourceUtilizationReportResponse": {
3795 "description": "Service-side response to WorkerMessage reporting res ource utilization.",
3796 "id": "ResourceUtilizationReportResponse",
3797 "type": "object"
3725 } 3798 }
3726 }, 3799 },
3727 "servicePath": "", 3800 "servicePath": "",
3728 "title": "Google Dataflow API", 3801 "title": "Google Dataflow API",
3729 "version": "v1b3" 3802 "version": "v1b3"
3730 } 3803 }
OLDNEW
« no previous file with comments | « discovery/googleapis_beta/cloudresourcemanager__v1beta1.json ('k') | discovery/googleapis_beta/datastore__v1beta3.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698