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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 2734843002: Api-roll 46: 2017-03-06 (Closed)
Patch Set: Created 3 years, 9 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
« no previous file with comments | « discovery/googleapis_beta/cloudresourcemanager__v1beta1.json ('k') | discovery/googleapis_beta/dataproc__v1beta1.json » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
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": "Manages Google Cloud Dataflow projects on Google Cloud Platf orm.", 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 "icons": { 20 "icons": {
21 "x16": "http://www.google.com/images/icons/product/search-16.gif", 21 "x16": "http://www.google.com/images/icons/product/search-16.gif",
22 "x32": "http://www.google.com/images/icons/product/search-32.gif" 22 "x32": "http://www.google.com/images/icons/product/search-32.gif"
23 }, 23 },
24 "id": "dataflow:v1b3", 24 "id": "dataflow:v1b3",
25 "kind": "discovery#restDescription", 25 "kind": "discovery#restDescription",
26 "name": "dataflow", 26 "name": "dataflow",
27 "ownerDomain": "google.com", 27 "ownerDomain": "google.com",
28 "ownerName": "Google", 28 "ownerName": "Google",
29 "parameters": { 29 "parameters": {
30 "quotaUser": {
31 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.",
32 "location": "query",
33 "type": "string"
34 },
35 "pp": {
36 "default": "true",
37 "description": "Pretty-print response.",
38 "location": "query",
39 "type": "boolean"
40 },
41 "bearer_token": {
42 "description": "OAuth bearer token.",
43 "location": "query",
44 "type": "string"
45 },
46 "oauth_token": {
47 "description": "OAuth 2.0 token for the current user.",
48 "location": "query",
49 "type": "string"
50 },
51 "upload_protocol": {
52 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
53 "location": "query",
54 "type": "string"
55 },
56 "prettyPrint": { 30 "prettyPrint": {
57 "default": "true", 31 "default": "true",
58 "description": "Returns response with indentations and line breaks." , 32 "description": "Returns response with indentations and line breaks." ,
59 "location": "query", 33 "location": "query",
60 "type": "boolean" 34 "type": "boolean"
61 }, 35 },
36 "fields": {
37 "description": "Selector specifying which fields to include in a par tial response.",
38 "location": "query",
39 "type": "string"
40 },
62 "uploadType": { 41 "uploadType": {
63 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").", 42 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
64 "location": "query", 43 "location": "query",
65 "type": "string" 44 "type": "string"
66 }, 45 },
67 "fields": {
68 "description": "Selector specifying which fields to include in a par tial response.",
69 "location": "query",
70 "type": "string"
71 },
72 "callback": {
73 "description": "JSONP",
74 "location": "query",
75 "type": "string"
76 },
77 "$.xgafv": { 46 "$.xgafv": {
78 "description": "V1 error format.", 47 "description": "V1 error format.",
79 "enum": [ 48 "enum": [
80 "1", 49 "1",
81 "2" 50 "2"
82 ], 51 ],
83 "enumDescriptions": [ 52 "enumDescriptions": [
84 "v1 error format", 53 "v1 error format",
85 "v2 error format" 54 "v2 error format"
86 ], 55 ],
87 "location": "query", 56 "location": "query",
88 "type": "string" 57 "type": "string"
89 }, 58 },
59 "callback": {
60 "description": "JSONP",
61 "location": "query",
62 "type": "string"
63 },
90 "alt": { 64 "alt": {
91 "default": "json", 65 "default": "json",
92 "description": "Data format for response.", 66 "description": "Data format for response.",
93 "enum": [ 67 "enum": [
94 "json", 68 "json",
95 "media", 69 "media",
96 "proto" 70 "proto"
97 ], 71 ],
98 "enumDescriptions": [ 72 "enumDescriptions": [
99 "Responses with Content-Type of application/json", 73 "Responses with Content-Type of application/json",
100 "Media download with context-dependent Content-Type", 74 "Media download with context-dependent Content-Type",
101 "Responses with Content-Type of application/x-protobuf" 75 "Responses with Content-Type of application/x-protobuf"
102 ], 76 ],
103 "location": "query", 77 "location": "query",
104 "type": "string" 78 "type": "string"
105 }, 79 },
80 "access_token": {
81 "description": "OAuth access token.",
82 "location": "query",
83 "type": "string"
84 },
106 "key": { 85 "key": {
107 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.", 86 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.",
108 "location": "query", 87 "location": "query",
109 "type": "string" 88 "type": "string"
110 }, 89 },
111 "access_token": { 90 "quotaUser": {
112 "description": "OAuth access token.", 91 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.",
92 "location": "query",
93 "type": "string"
94 },
95 "pp": {
96 "default": "true",
97 "description": "Pretty-print response.",
98 "location": "query",
99 "type": "boolean"
100 },
101 "oauth_token": {
102 "description": "OAuth 2.0 token for the current user.",
103 "location": "query",
104 "type": "string"
105 },
106 "bearer_token": {
107 "description": "OAuth bearer token.",
108 "location": "query",
109 "type": "string"
110 },
111 "upload_protocol": {
112 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
113 "location": "query", 113 "location": "query",
114 "type": "string" 114 "type": "string"
115 } 115 }
116 }, 116 },
117 "protocol": "rest", 117 "protocol": "rest",
118 "resources": { 118 "resources": {
119 "projects": { 119 "projects": {
120 "methods": { 120 "methods": {
121 "workerMessages": { 121 "workerMessages": {
122 "description": "Send a worker_message to the service.", 122 "description": "Send a worker_message to the service.",
(...skipping 21 matching lines...) Expand all
144 "https://www.googleapis.com/auth/cloud-platform", 144 "https://www.googleapis.com/auth/cloud-platform",
145 "https://www.googleapis.com/auth/userinfo.email" 145 "https://www.googleapis.com/auth/userinfo.email"
146 ] 146 ]
147 } 147 }
148 }, 148 },
149 "resources": { 149 "resources": {
150 "locations": { 150 "locations": {
151 "resources": { 151 "resources": {
152 "jobs": { 152 "jobs": {
153 "methods": { 153 "methods": {
154 "getMetrics": {
155 "description": "Request the job status.",
156 "httpMethod": "GET",
157 "id": "dataflow.projects.locations.jobs.getM etrics",
158 "parameterOrder": [
159 "projectId",
160 "location",
161 "jobId"
162 ],
163 "parameters": {
164 "location": {
165 "description": "The location which c ontains the job specified by job_id.",
166 "location": "path",
167 "required": true,
168 "type": "string"
169 },
170 "startTime": {
171 "description": "Return only metric d ata that has changed since this time.\nDefault is to return all information abou t all metrics for the job.",
172 "format": "google-datetime",
173 "location": "query",
174 "type": "string"
175 },
176 "projectId": {
177 "description": "A project id.",
178 "location": "path",
179 "required": true,
180 "type": "string"
181 },
182 "jobId": {
183 "description": "The job to get messa ges for.",
184 "location": "path",
185 "required": true,
186 "type": "string"
187 }
188 },
189 "path": "v1b3/projects/{projectId}/locations /{location}/jobs/{jobId}/metrics",
190 "response": {
191 "$ref": "JobMetrics"
192 },
193 "scopes": [
194 "https://www.googleapis.com/auth/cloud-p latform",
195 "https://www.googleapis.com/auth/userinf o.email"
196 ]
197 },
198 "get": { 154 "get": {
199 "description": "Gets the state of the specif ied Cloud Dataflow job.", 155 "description": "Gets the state of the specif ied Cloud Dataflow job.",
200 "httpMethod": "GET", 156 "httpMethod": "GET",
201 "id": "dataflow.projects.locations.jobs.get" , 157 "id": "dataflow.projects.locations.jobs.get" ,
202 "parameterOrder": [ 158 "parameterOrder": [
203 "projectId", 159 "projectId",
204 "location", 160 "location",
205 "jobId" 161 "jobId"
206 ], 162 ],
207 "parameters": { 163 "parameters": {
(...skipping 13 matching lines...) Expand all
221 "description": "The job ID.", 177 "description": "The job ID.",
222 "location": "path", 178 "location": "path",
223 "required": true, 179 "required": true,
224 "type": "string" 180 "type": "string"
225 }, 181 },
226 "view": { 182 "view": {
227 "description": "The level of informa tion requested in response.", 183 "description": "The level of informa tion requested in response.",
228 "enum": [ 184 "enum": [
229 "JOB_VIEW_UNKNOWN", 185 "JOB_VIEW_UNKNOWN",
230 "JOB_VIEW_SUMMARY", 186 "JOB_VIEW_SUMMARY",
231 "JOB_VIEW_ALL" 187 "JOB_VIEW_ALL",
188 "JOB_VIEW_DESCRIPTION"
232 ], 189 ],
233 "location": "query", 190 "location": "query",
234 "type": "string" 191 "type": "string"
235 } 192 }
236 }, 193 },
237 "path": "v1b3/projects/{projectId}/locations /{location}/jobs/{jobId}", 194 "path": "v1b3/projects/{projectId}/locations /{location}/jobs/{jobId}",
238 "response": { 195 "response": {
239 "$ref": "Job" 196 "$ref": "Job"
240 }, 197 },
241 "scopes": [ 198 "scopes": [
(...skipping 42 matching lines...) Expand 10 before | Expand all | Expand 10 after
284 "description": "If there are many jo bs, limit response to at most this many.\nThe actual number of jobs returned wil l be the lesser of max_responses\nand an unspecified server-defined limit.", 241 "description": "If there are many jo bs, limit response to at most this many.\nThe actual number of jobs returned wil l be the lesser of max_responses\nand an unspecified server-defined limit.",
285 "format": "int32", 242 "format": "int32",
286 "location": "query", 243 "location": "query",
287 "type": "integer" 244 "type": "integer"
288 }, 245 },
289 "view": { 246 "view": {
290 "description": "Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.", 247 "description": "Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.",
291 "enum": [ 248 "enum": [
292 "JOB_VIEW_UNKNOWN", 249 "JOB_VIEW_UNKNOWN",
293 "JOB_VIEW_SUMMARY", 250 "JOB_VIEW_SUMMARY",
294 "JOB_VIEW_ALL" 251 "JOB_VIEW_ALL",
252 "JOB_VIEW_DESCRIPTION"
295 ], 253 ],
296 "location": "query", 254 "location": "query",
297 "type": "string" 255 "type": "string"
298 } 256 }
299 }, 257 },
300 "path": "v1b3/projects/{projectId}/locations /{location}/jobs", 258 "path": "v1b3/projects/{projectId}/locations /{location}/jobs",
301 "response": { 259 "response": {
302 "$ref": "ListJobsResponse" 260 "$ref": "ListJobsResponse"
303 }, 261 },
304 "scopes": [ 262 "scopes": [
(...skipping 44 matching lines...) Expand 10 before | Expand all | Expand 10 after
349 }, 307 },
350 "create": { 308 "create": {
351 "description": "Creates a Cloud Dataflow job .", 309 "description": "Creates a Cloud Dataflow job .",
352 "httpMethod": "POST", 310 "httpMethod": "POST",
353 "id": "dataflow.projects.locations.jobs.crea te", 311 "id": "dataflow.projects.locations.jobs.crea te",
354 "parameterOrder": [ 312 "parameterOrder": [
355 "projectId", 313 "projectId",
356 "location" 314 "location"
357 ], 315 ],
358 "parameters": { 316 "parameters": {
317 "replaceJobId": {
318 "description": "Deprecated. This fie ld is now in the Job message.",
319 "location": "query",
320 "type": "string"
321 },
359 "projectId": { 322 "projectId": {
360 "description": "The ID of the Cloud Platform project that the job belongs to.", 323 "description": "The ID of the Cloud Platform project that the job belongs to.",
361 "location": "path", 324 "location": "path",
362 "required": true, 325 "required": true,
363 "type": "string" 326 "type": "string"
364 }, 327 },
365 "view": { 328 "view": {
366 "description": "The level of informa tion requested in response.", 329 "description": "The level of informa tion requested in response.",
367 "enum": [ 330 "enum": [
368 "JOB_VIEW_UNKNOWN", 331 "JOB_VIEW_UNKNOWN",
369 "JOB_VIEW_SUMMARY", 332 "JOB_VIEW_SUMMARY",
370 "JOB_VIEW_ALL" 333 "JOB_VIEW_ALL",
334 "JOB_VIEW_DESCRIPTION"
371 ], 335 ],
372 "location": "query", 336 "location": "query",
373 "type": "string" 337 "type": "string"
374 }, 338 },
375 "location": { 339 "location": {
376 "description": "The location that co ntains this job.", 340 "description": "The location that co ntains this job.",
377 "location": "path", 341 "location": "path",
378 "required": true, 342 "required": true,
379 "type": "string" 343 "type": "string"
380 },
381 "replaceJobId": {
382 "description": "Deprecated. This fie ld is now in the Job message.",
383 "location": "query",
384 "type": "string"
385 } 344 }
386 }, 345 },
387 "path": "v1b3/projects/{projectId}/locations /{location}/jobs", 346 "path": "v1b3/projects/{projectId}/locations /{location}/jobs",
388 "request": { 347 "request": {
389 "$ref": "Job" 348 "$ref": "Job"
390 }, 349 },
391 "response": { 350 "response": {
392 "$ref": "Job" 351 "$ref": "Job"
393 }, 352 },
394 "scopes": [ 353 "scopes": [
395 "https://www.googleapis.com/auth/cloud-p latform", 354 "https://www.googleapis.com/auth/cloud-p latform",
396 "https://www.googleapis.com/auth/userinf o.email" 355 "https://www.googleapis.com/auth/userinf o.email"
397 ] 356 ]
357 },
358 "getMetrics": {
359 "description": "Request the job status.",
360 "httpMethod": "GET",
361 "id": "dataflow.projects.locations.jobs.getM etrics",
362 "parameterOrder": [
363 "projectId",
364 "location",
365 "jobId"
366 ],
367 "parameters": {
368 "projectId": {
369 "description": "A project id.",
370 "location": "path",
371 "required": true,
372 "type": "string"
373 },
374 "jobId": {
375 "description": "The job to get messa ges for.",
376 "location": "path",
377 "required": true,
378 "type": "string"
379 },
380 "location": {
381 "description": "The location which c ontains the job specified by job_id.",
382 "location": "path",
383 "required": true,
384 "type": "string"
385 },
386 "startTime": {
387 "description": "Return only metric d ata that has changed since this time.\nDefault is to return all information abou t all metrics for the job.",
388 "format": "google-datetime",
389 "location": "query",
390 "type": "string"
391 }
392 },
393 "path": "v1b3/projects/{projectId}/locations /{location}/jobs/{jobId}/metrics",
394 "response": {
395 "$ref": "JobMetrics"
396 },
397 "scopes": [
398 "https://www.googleapis.com/auth/cloud-p latform",
399 "https://www.googleapis.com/auth/userinf o.email"
400 ]
398 } 401 }
399 }, 402 },
400 "resources": { 403 "resources": {
404 "messages": {
405 "methods": {
406 "list": {
407 "description": "Request the job stat us.",
408 "httpMethod": "GET",
409 "id": "dataflow.projects.locations.j obs.messages.list",
410 "parameterOrder": [
411 "projectId",
412 "location",
413 "jobId"
414 ],
415 "parameters": {
416 "projectId": {
417 "description": "A project id .",
418 "location": "path",
419 "required": true,
420 "type": "string"
421 },
422 "jobId": {
423 "description": "The job to g et messages about.",
424 "location": "path",
425 "required": true,
426 "type": "string"
427 },
428 "location": {
429 "description": "The location which contains the job specified by job_id.",
430 "location": "path",
431 "required": true,
432 "type": "string"
433 },
434 "endTime": {
435 "description": "Return only messages with timestamps < end_time. The default is now\n(i.e. return up to the latest messages available).",
436 "format": "google-datetime",
437 "location": "query",
438 "type": "string"
439 },
440 "pageToken": {
441 "description": "If supplied, this should be the value of next_page_token returned\nby an earlier call. This will cause the next page of results to\nbe returned.",
442 "location": "query",
443 "type": "string"
444 },
445 "startTime": {
446 "description": "If specified , return only messages with timestamps >= start_time.\nThe default is the job cr eation time (i.e. beginning of messages).",
447 "format": "google-datetime",
448 "location": "query",
449 "type": "string"
450 },
451 "pageSize": {
452 "description": "If specified , determines the maximum number of messages to\nreturn. If unspecified, the ser vice may choose an appropriate\ndefault, or may return an arbitrarily large numb er of results.",
453 "format": "int32",
454 "location": "query",
455 "type": "integer"
456 },
457 "minimumImportance": {
458 "description": "Filter to on ly get messages with importance >= level",
459 "enum": [
460 "JOB_MESSAGE_IMPORTANCE_ UNKNOWN",
461 "JOB_MESSAGE_DEBUG",
462 "JOB_MESSAGE_DETAILED",
463 "JOB_MESSAGE_BASIC",
464 "JOB_MESSAGE_WARNING",
465 "JOB_MESSAGE_ERROR"
466 ],
467 "location": "query",
468 "type": "string"
469 }
470 },
471 "path": "v1b3/projects/{projectId}/l ocations/{location}/jobs/{jobId}/messages",
472 "response": {
473 "$ref": "ListJobMessagesResponse "
474 },
475 "scopes": [
476 "https://www.googleapis.com/auth /cloud-platform",
477 "https://www.googleapis.com/auth /userinfo.email"
478 ]
479 }
480 }
481 },
401 "workItems": { 482 "workItems": {
402 "methods": { 483 "methods": {
403 "lease": { 484 "lease": {
404 "description": "Leases a dataflow Wo rkItem to run.", 485 "description": "Leases a dataflow Wo rkItem to run.",
405 "httpMethod": "POST", 486 "httpMethod": "POST",
406 "id": "dataflow.projects.locations.j obs.workItems.lease", 487 "id": "dataflow.projects.locations.j obs.workItems.lease",
407 "parameterOrder": [ 488 "parameterOrder": [
408 "projectId", 489 "projectId",
409 "location", 490 "location",
410 "jobId"
411 ],
412 "parameters": {
413 "location": {
414 "description": "The location which contains the WorkItem's job.",
415 "location": "path",
416 "required": true,
417 "type": "string"
418 },
419 "projectId": {
420 "description": "Identifies t he project this worker belongs to.",
421 "location": "path",
422 "required": true,
423 "type": "string"
424 },
425 "jobId": {
426 "description": "Identifies t he workflow job this worker belongs to.",
427 "location": "path",
428 "required": true,
429 "type": "string"
430 }
431 },
432 "path": "v1b3/projects/{projectId}/l ocations/{location}/jobs/{jobId}/workItems:lease",
433 "request": {
434 "$ref": "LeaseWorkItemRequest"
435 },
436 "response": {
437 "$ref": "LeaseWorkItemResponse"
438 },
439 "scopes": [
440 "https://www.googleapis.com/auth /cloud-platform",
441 "https://www.googleapis.com/auth /userinfo.email"
442 ]
443 },
444 "reportStatus": {
445 "description": "Reports the status o f dataflow WorkItems leased by a worker.",
446 "httpMethod": "POST",
447 "id": "dataflow.projects.locations.j obs.workItems.reportStatus",
448 "parameterOrder": [
449 "projectId",
450 "location",
451 "jobId" 491 "jobId"
452 ], 492 ],
453 "parameters": { 493 "parameters": {
454 "projectId": { 494 "projectId": {
455 "description": "The project which owns the WorkItem's job.", 495 "description": "Identifies t he project this worker belongs to.",
456 "location": "path", 496 "location": "path",
457 "required": true, 497 "required": true,
458 "type": "string" 498 "type": "string"
459 }, 499 },
460 "jobId": { 500 "jobId": {
461 "description": "The job whic h the WorkItem is part of.", 501 "description": "Identifies t he workflow job this worker belongs to.",
462 "location": "path", 502 "location": "path",
463 "required": true, 503 "required": true,
464 "type": "string" 504 "type": "string"
465 }, 505 },
466 "location": { 506 "location": {
467 "description": "The location which contains the WorkItem's job.", 507 "description": "The location which contains the WorkItem's job.",
468 "location": "path", 508 "location": "path",
469 "required": true, 509 "required": true,
470 "type": "string" 510 "type": "string"
471 } 511 }
472 }, 512 },
513 "path": "v1b3/projects/{projectId}/l ocations/{location}/jobs/{jobId}/workItems:lease",
514 "request": {
515 "$ref": "LeaseWorkItemRequest"
516 },
517 "response": {
518 "$ref": "LeaseWorkItemResponse"
519 },
520 "scopes": [
521 "https://www.googleapis.com/auth /cloud-platform",
522 "https://www.googleapis.com/auth /userinfo.email"
523 ]
524 },
525 "reportStatus": {
526 "description": "Reports the status o f dataflow WorkItems leased by a worker.",
527 "httpMethod": "POST",
528 "id": "dataflow.projects.locations.j obs.workItems.reportStatus",
529 "parameterOrder": [
530 "projectId",
531 "location",
532 "jobId"
533 ],
534 "parameters": {
535 "location": {
536 "description": "The location which contains the WorkItem's job.",
537 "location": "path",
538 "required": true,
539 "type": "string"
540 },
541 "projectId": {
542 "description": "The project which owns the WorkItem's job.",
543 "location": "path",
544 "required": true,
545 "type": "string"
546 },
547 "jobId": {
548 "description": "The job whic h the WorkItem is part of.",
549 "location": "path",
550 "required": true,
551 "type": "string"
552 }
553 },
473 "path": "v1b3/projects/{projectId}/l ocations/{location}/jobs/{jobId}/workItems:reportStatus", 554 "path": "v1b3/projects/{projectId}/l ocations/{location}/jobs/{jobId}/workItems:reportStatus",
474 "request": { 555 "request": {
475 "$ref": "ReportWorkItemStatusReq uest" 556 "$ref": "ReportWorkItemStatusReq uest"
476 }, 557 },
477 "response": { 558 "response": {
478 "$ref": "ReportWorkItemStatusRes ponse" 559 "$ref": "ReportWorkItemStatusRes ponse"
479 }, 560 },
480 "scopes": [ 561 "scopes": [
481 "https://www.googleapis.com/auth /cloud-platform", 562 "https://www.googleapis.com/auth /cloud-platform",
482 "https://www.googleapis.com/auth /userinfo.email"
483 ]
484 }
485 }
486 },
487 "messages": {
488 "methods": {
489 "list": {
490 "description": "Request the job stat us.",
491 "httpMethod": "GET",
492 "id": "dataflow.projects.locations.j obs.messages.list",
493 "parameterOrder": [
494 "projectId",
495 "location",
496 "jobId"
497 ],
498 "parameters": {
499 "jobId": {
500 "description": "The job to g et messages about.",
501 "location": "path",
502 "required": true,
503 "type": "string"
504 },
505 "projectId": {
506 "description": "A project id .",
507 "location": "path",
508 "required": true,
509 "type": "string"
510 },
511 "endTime": {
512 "description": "Return only messages with timestamps < end_time. The default is now\n(i.e. return up to the latest messages available).",
513 "format": "google-datetime",
514 "location": "query",
515 "type": "string"
516 },
517 "location": {
518 "description": "The location which contains the job specified by job_id.",
519 "location": "path",
520 "required": true,
521 "type": "string"
522 },
523 "startTime": {
524 "description": "If specified , return only messages with timestamps >= start_time.\nThe default is the job cr eation time (i.e. beginning of messages).",
525 "format": "google-datetime",
526 "location": "query",
527 "type": "string"
528 },
529 "pageToken": {
530 "description": "If supplied, this should be the value of next_page_token returned\nby an earlier call. This will cause the next page of results to\nbe returned.",
531 "location": "query",
532 "type": "string"
533 },
534 "pageSize": {
535 "description": "If specified , determines the maximum number of messages to\nreturn. If unspecified, the ser vice may choose an appropriate\ndefault, or may return an arbitrarily large numb er of results.",
536 "format": "int32",
537 "location": "query",
538 "type": "integer"
539 },
540 "minimumImportance": {
541 "description": "Filter to on ly get messages with importance >= level",
542 "enum": [
543 "JOB_MESSAGE_IMPORTANCE_ UNKNOWN",
544 "JOB_MESSAGE_DEBUG",
545 "JOB_MESSAGE_DETAILED",
546 "JOB_MESSAGE_BASIC",
547 "JOB_MESSAGE_WARNING",
548 "JOB_MESSAGE_ERROR"
549 ],
550 "location": "query",
551 "type": "string"
552 }
553 },
554 "path": "v1b3/projects/{projectId}/l ocations/{location}/jobs/{jobId}/messages",
555 "response": {
556 "$ref": "ListJobMessagesResponse "
557 },
558 "scopes": [
559 "https://www.googleapis.com/auth /cloud-platform",
560 "https://www.googleapis.com/auth /userinfo.email" 563 "https://www.googleapis.com/auth /userinfo.email"
561 ] 564 ]
562 } 565 }
563 } 566 }
564 } 567 }
565 } 568 }
566 } 569 }
567 } 570 }
568 }, 571 },
569 "templates": { 572 "templates": {
570 "methods": { 573 "methods": {
574 "get": {
575 "description": "Get the template associated with a t emplate.",
576 "httpMethod": "GET",
577 "id": "dataflow.projects.templates.get",
578 "parameterOrder": [
579 "projectId"
580 ],
581 "parameters": {
582 "projectId": {
583 "description": "Required. The ID of the Clou d Platform project that the job belongs to.",
584 "location": "path",
585 "required": true,
586 "type": "string"
587 },
588 "view": {
589 "description": "The view to retrieve. Defaul ts to METADATA_ONLY.",
590 "enum": [
591 "METADATA_ONLY"
592 ],
593 "location": "query",
594 "type": "string"
595 },
596 "gcsPath": {
597 "description": "Required. A Cloud Storage pa th to the template from which to\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`.",
598 "location": "query",
599 "type": "string"
600 }
601 },
602 "path": "v1b3/projects/{projectId}/templates:get",
603 "response": {
604 "$ref": "GetTemplateResponse"
605 },
606 "scopes": [
607 "https://www.googleapis.com/auth/cloud-platform" ,
608 "https://www.googleapis.com/auth/userinfo.email"
609 ]
610 },
571 "create": { 611 "create": {
572 "description": "Creates a Cloud Dataflow job from a template.", 612 "description": "Creates a Cloud Dataflow job from a template.",
573 "httpMethod": "POST", 613 "httpMethod": "POST",
574 "id": "dataflow.projects.templates.create", 614 "id": "dataflow.projects.templates.create",
575 "parameterOrder": [ 615 "parameterOrder": [
576 "projectId" 616 "projectId"
577 ], 617 ],
578 "parameters": { 618 "parameters": {
579 "projectId": { 619 "projectId": {
580 "description": "Required. The ID of the Clou d Platform project that the job belongs to.", 620 "description": "Required. The ID of the Clou d Platform project that the job belongs to.",
581 "location": "path", 621 "location": "path",
582 "required": true, 622 "required": true,
583 "type": "string" 623 "type": "string"
584 } 624 }
585 }, 625 },
586 "path": "v1b3/projects/{projectId}/templates", 626 "path": "v1b3/projects/{projectId}/templates",
587 "request": { 627 "request": {
588 "$ref": "CreateJobFromTemplateRequest" 628 "$ref": "CreateJobFromTemplateRequest"
589 }, 629 },
590 "response": { 630 "response": {
591 "$ref": "Job" 631 "$ref": "Job"
592 }, 632 },
593 "scopes": [ 633 "scopes": [
594 "https://www.googleapis.com/auth/cloud-platform" , 634 "https://www.googleapis.com/auth/cloud-platform" ,
595 "https://www.googleapis.com/auth/userinfo.email" 635 "https://www.googleapis.com/auth/userinfo.email"
596 ] 636 ]
637 },
638 "launch": {
639 "description": "Launch a template.",
640 "httpMethod": "POST",
641 "id": "dataflow.projects.templates.launch",
642 "parameterOrder": [
643 "projectId"
644 ],
645 "parameters": {
646 "dryRun": {
647 "description": "Whether or not the job shoul d actually be executed after\nvalidating parameters. Defaults to false. Validati on errors do\nnot cause the HTTP request to fail if true.",
648 "location": "query",
649 "type": "boolean"
650 },
651 "projectId": {
652 "description": "Required. The ID of the Clou d Platform project that the job belongs to.",
653 "location": "path",
654 "required": true,
655 "type": "string"
656 },
657 "gcsPath": {
658 "description": "Required. A Cloud Storage pa th to the template from which to create\nthe job.\nMust be valid Cloud Storage U RL, beginning with 'gs://'.",
659 "location": "query",
660 "type": "string"
661 }
662 },
663 "path": "v1b3/projects/{projectId}/templates:launch" ,
664 "request": {
665 "$ref": "LaunchTemplateParameters"
666 },
667 "response": {
668 "$ref": "LaunchTemplateResponse"
669 },
670 "scopes": [
671 "https://www.googleapis.com/auth/cloud-platform" ,
672 "https://www.googleapis.com/auth/userinfo.email"
673 ]
597 } 674 }
598 } 675 }
599 }, 676 },
600 "jobs": { 677 "jobs": {
601 "methods": { 678 "methods": {
602 "getMetrics": { 679 "getMetrics": {
603 "description": "Request the job status.", 680 "description": "Request the job status.",
604 "httpMethod": "GET", 681 "httpMethod": "GET",
605 "id": "dataflow.projects.jobs.getMetrics", 682 "id": "dataflow.projects.jobs.getMetrics",
606 "parameterOrder": [ 683 "parameterOrder": [
607 "projectId", 684 "projectId",
608 "jobId" 685 "jobId"
609 ], 686 ],
610 "parameters": { 687 "parameters": {
688 "location": {
689 "description": "The location which contains the job specified by job_id.",
690 "location": "query",
691 "type": "string"
692 },
693 "startTime": {
694 "description": "Return only metric data that has changed since this time.\nDefault is to return all information about all me trics for the job.",
695 "format": "google-datetime",
696 "location": "query",
697 "type": "string"
698 },
611 "projectId": { 699 "projectId": {
612 "description": "A project id.", 700 "description": "A project id.",
613 "location": "path", 701 "location": "path",
614 "required": true, 702 "required": true,
615 "type": "string" 703 "type": "string"
616 }, 704 },
617 "jobId": { 705 "jobId": {
618 "description": "The job to get messages for. ", 706 "description": "The job to get messages for. ",
619 "location": "path", 707 "location": "path",
620 "required": true, 708 "required": true,
621 "type": "string" 709 "type": "string"
622 },
623 "location": {
624 "description": "The location which contains the job specified by job_id.",
625 "location": "query",
626 "type": "string"
627 },
628 "startTime": {
629 "description": "Return only metric data that has changed since this time.\nDefault is to return all information about all me trics for the job.",
630 "format": "google-datetime",
631 "location": "query",
632 "type": "string"
633 } 710 }
634 }, 711 },
635 "path": "v1b3/projects/{projectId}/jobs/{jobId}/metr ics", 712 "path": "v1b3/projects/{projectId}/jobs/{jobId}/metr ics",
636 "response": { 713 "response": {
637 "$ref": "JobMetrics" 714 "$ref": "JobMetrics"
638 }, 715 },
639 "scopes": [ 716 "scopes": [
640 "https://www.googleapis.com/auth/cloud-platform" , 717 "https://www.googleapis.com/auth/cloud-platform" ,
641 "https://www.googleapis.com/auth/userinfo.email" 718 "https://www.googleapis.com/auth/userinfo.email"
642 ] 719 ]
643 }, 720 },
644 "get": { 721 "get": {
645 "description": "Gets the state of the specified Clou d Dataflow job.", 722 "description": "Gets the state of the specified Clou d Dataflow job.",
646 "httpMethod": "GET", 723 "httpMethod": "GET",
647 "id": "dataflow.projects.jobs.get", 724 "id": "dataflow.projects.jobs.get",
648 "parameterOrder": [ 725 "parameterOrder": [
649 "projectId", 726 "projectId",
650 "jobId" 727 "jobId"
651 ], 728 ],
652 "parameters": { 729 "parameters": {
730 "location": {
731 "description": "The location that contains t his job.",
732 "location": "query",
733 "type": "string"
734 },
653 "projectId": { 735 "projectId": {
654 "description": "The ID of the Cloud Platform project that the job belongs to.", 736 "description": "The ID of the Cloud Platform project that the job belongs to.",
655 "location": "path", 737 "location": "path",
656 "required": true, 738 "required": true,
657 "type": "string" 739 "type": "string"
658 }, 740 },
659 "jobId": { 741 "jobId": {
660 "description": "The job ID.", 742 "description": "The job ID.",
661 "location": "path", 743 "location": "path",
662 "required": true, 744 "required": true,
663 "type": "string" 745 "type": "string"
664 }, 746 },
665 "view": { 747 "view": {
666 "description": "The level of information req uested in response.", 748 "description": "The level of information req uested in response.",
667 "enum": [ 749 "enum": [
668 "JOB_VIEW_UNKNOWN", 750 "JOB_VIEW_UNKNOWN",
669 "JOB_VIEW_SUMMARY", 751 "JOB_VIEW_SUMMARY",
670 "JOB_VIEW_ALL" 752 "JOB_VIEW_ALL",
753 "JOB_VIEW_DESCRIPTION"
671 ], 754 ],
672 "location": "query", 755 "location": "query",
673 "type": "string" 756 "type": "string"
674 },
675 "location": {
676 "description": "The location that contains t his job.",
677 "location": "query",
678 "type": "string"
679 } 757 }
680 }, 758 },
681 "path": "v1b3/projects/{projectId}/jobs/{jobId}", 759 "path": "v1b3/projects/{projectId}/jobs/{jobId}",
682 "response": { 760 "response": {
683 "$ref": "Job" 761 "$ref": "Job"
684 }, 762 },
685 "scopes": [ 763 "scopes": [
686 "https://www.googleapis.com/auth/cloud-platform" , 764 "https://www.googleapis.com/auth/cloud-platform" ,
687 "https://www.googleapis.com/auth/userinfo.email" 765 "https://www.googleapis.com/auth/userinfo.email"
688 ] 766 ]
689 }, 767 },
690 "list": { 768 "list": {
691 "description": "List the jobs of a project.", 769 "description": "List the jobs of a project.",
692 "httpMethod": "GET", 770 "httpMethod": "GET",
693 "id": "dataflow.projects.jobs.list", 771 "id": "dataflow.projects.jobs.list",
694 "parameterOrder": [ 772 "parameterOrder": [
695 "projectId" 773 "projectId"
696 ], 774 ],
697 "parameters": { 775 "parameters": {
698 "projectId": {
699 "description": "The project which owns the j obs.",
700 "location": "path",
701 "required": true,
702 "type": "string"
703 },
704 "filter": { 776 "filter": {
705 "description": "The kind of filter to use.", 777 "description": "The kind of filter to use.",
706 "enum": [ 778 "enum": [
707 "UNKNOWN", 779 "UNKNOWN",
708 "ALL", 780 "ALL",
709 "TERMINATED", 781 "TERMINATED",
710 "ACTIVE" 782 "ACTIVE"
711 ], 783 ],
712 "location": "query", 784 "location": "query",
713 "type": "string" 785 "type": "string"
(...skipping 12 matching lines...) Expand all
726 "description": "If there are many jobs, limi t response to at most this many.\nThe actual number of jobs returned will be the lesser of max_responses\nand an unspecified server-defined limit.", 798 "description": "If there are many jobs, limi t response to at most this many.\nThe actual number of jobs returned will be the lesser of max_responses\nand an unspecified server-defined limit.",
727 "format": "int32", 799 "format": "int32",
728 "location": "query", 800 "location": "query",
729 "type": "integer" 801 "type": "integer"
730 }, 802 },
731 "view": { 803 "view": {
732 "description": "Level of information request ed in response. Default is `JOB_VIEW_SUMMARY`.", 804 "description": "Level of information request ed in response. Default is `JOB_VIEW_SUMMARY`.",
733 "enum": [ 805 "enum": [
734 "JOB_VIEW_UNKNOWN", 806 "JOB_VIEW_UNKNOWN",
735 "JOB_VIEW_SUMMARY", 807 "JOB_VIEW_SUMMARY",
736 "JOB_VIEW_ALL" 808 "JOB_VIEW_ALL",
809 "JOB_VIEW_DESCRIPTION"
737 ], 810 ],
738 "location": "query", 811 "location": "query",
739 "type": "string" 812 "type": "string"
813 },
814 "projectId": {
815 "description": "The project which owns the j obs.",
816 "location": "path",
817 "required": true,
818 "type": "string"
740 } 819 }
741 }, 820 },
742 "path": "v1b3/projects/{projectId}/jobs", 821 "path": "v1b3/projects/{projectId}/jobs",
743 "response": { 822 "response": {
744 "$ref": "ListJobsResponse" 823 "$ref": "ListJobsResponse"
745 }, 824 },
746 "scopes": [ 825 "scopes": [
747 "https://www.googleapis.com/auth/cloud-platform" , 826 "https://www.googleapis.com/auth/cloud-platform" ,
748 "https://www.googleapis.com/auth/userinfo.email" 827 "https://www.googleapis.com/auth/userinfo.email"
749 ] 828 ]
750 }, 829 },
751 "update": { 830 "update": {
752 "description": "Updates the state of an existing Clo ud Dataflow job.", 831 "description": "Updates the state of an existing Clo ud Dataflow job.",
753 "httpMethod": "PUT", 832 "httpMethod": "PUT",
754 "id": "dataflow.projects.jobs.update", 833 "id": "dataflow.projects.jobs.update",
755 "parameterOrder": [ 834 "parameterOrder": [
756 "projectId", 835 "projectId",
757 "jobId" 836 "jobId"
758 ], 837 ],
759 "parameters": { 838 "parameters": {
760 "location": {
761 "description": "The location that contains t his job.",
762 "location": "query",
763 "type": "string"
764 },
765 "projectId": { 839 "projectId": {
766 "description": "The ID of the Cloud Platform project that the job belongs to.", 840 "description": "The ID of the Cloud Platform project that the job belongs to.",
767 "location": "path", 841 "location": "path",
768 "required": true, 842 "required": true,
769 "type": "string" 843 "type": "string"
770 }, 844 },
771 "jobId": { 845 "jobId": {
772 "description": "The job ID.", 846 "description": "The job ID.",
773 "location": "path", 847 "location": "path",
774 "required": true, 848 "required": true,
775 "type": "string" 849 "type": "string"
850 },
851 "location": {
852 "description": "The location that contains t his job.",
853 "location": "query",
854 "type": "string"
776 } 855 }
777 }, 856 },
778 "path": "v1b3/projects/{projectId}/jobs/{jobId}", 857 "path": "v1b3/projects/{projectId}/jobs/{jobId}",
779 "request": { 858 "request": {
780 "$ref": "Job" 859 "$ref": "Job"
781 }, 860 },
782 "response": { 861 "response": {
783 "$ref": "Job" 862 "$ref": "Job"
784 }, 863 },
785 "scopes": [ 864 "scopes": [
(...skipping 23 matching lines...) Expand all
809 "description": "The ID of the Cloud Platform project that the job belongs to.", 888 "description": "The ID of the Cloud Platform project that the job belongs to.",
810 "location": "path", 889 "location": "path",
811 "required": true, 890 "required": true,
812 "type": "string" 891 "type": "string"
813 }, 892 },
814 "view": { 893 "view": {
815 "description": "The level of information req uested in response.", 894 "description": "The level of information req uested in response.",
816 "enum": [ 895 "enum": [
817 "JOB_VIEW_UNKNOWN", 896 "JOB_VIEW_UNKNOWN",
818 "JOB_VIEW_SUMMARY", 897 "JOB_VIEW_SUMMARY",
819 "JOB_VIEW_ALL" 898 "JOB_VIEW_ALL",
899 "JOB_VIEW_DESCRIPTION"
820 ], 900 ],
821 "location": "query", 901 "location": "query",
822 "type": "string" 902 "type": "string"
823 } 903 }
824 }, 904 },
825 "path": "v1b3/projects/{projectId}/jobs", 905 "path": "v1b3/projects/{projectId}/jobs",
826 "request": { 906 "request": {
827 "$ref": "Job" 907 "$ref": "Job"
828 }, 908 },
829 "response": { 909 "response": {
830 "$ref": "Job" 910 "$ref": "Job"
831 }, 911 },
832 "scopes": [ 912 "scopes": [
833 "https://www.googleapis.com/auth/cloud-platform" , 913 "https://www.googleapis.com/auth/cloud-platform" ,
834 "https://www.googleapis.com/auth/userinfo.email" 914 "https://www.googleapis.com/auth/userinfo.email"
835 ] 915 ]
836 } 916 }
837 }, 917 },
838 "resources": { 918 "resources": {
919 "messages": {
920 "methods": {
921 "list": {
922 "description": "Request the job status.",
923 "httpMethod": "GET",
924 "id": "dataflow.projects.jobs.messages.list" ,
925 "parameterOrder": [
926 "projectId",
927 "jobId"
928 ],
929 "parameters": {
930 "startTime": {
931 "description": "If specified, return only messages with timestamps >= start_time.\nThe default is the job creation t ime (i.e. beginning of messages).",
932 "format": "google-datetime",
933 "location": "query",
934 "type": "string"
935 },
936 "pageToken": {
937 "description": "If supplied, this sh ould be the value of next_page_token returned\nby an earlier call. This will cau se the next page of results to\nbe returned.",
938 "location": "query",
939 "type": "string"
940 },
941 "pageSize": {
942 "description": "If specified, determ ines the maximum number of messages to\nreturn. If unspecified, the service may choose an appropriate\ndefault, or may return an arbitrarily large number of re sults.",
943 "format": "int32",
944 "location": "query",
945 "type": "integer"
946 },
947 "minimumImportance": {
948 "description": "Filter to only get m essages with importance >= level",
949 "enum": [
950 "JOB_MESSAGE_IMPORTANCE_UNKNOWN" ,
951 "JOB_MESSAGE_DEBUG",
952 "JOB_MESSAGE_DETAILED",
953 "JOB_MESSAGE_BASIC",
954 "JOB_MESSAGE_WARNING",
955 "JOB_MESSAGE_ERROR"
956 ],
957 "location": "query",
958 "type": "string"
959 },
960 "jobId": {
961 "description": "The job to get messa ges about.",
962 "location": "path",
963 "required": true,
964 "type": "string"
965 },
966 "projectId": {
967 "description": "A project id.",
968 "location": "path",
969 "required": true,
970 "type": "string"
971 },
972 "location": {
973 "description": "The location which c ontains the job specified by job_id.",
974 "location": "query",
975 "type": "string"
976 },
977 "endTime": {
978 "description": "Return only messages with timestamps < end_time. The default is now\n(i.e. return up to the latest m essages available).",
979 "format": "google-datetime",
980 "location": "query",
981 "type": "string"
982 }
983 },
984 "path": "v1b3/projects/{projectId}/jobs/{job Id}/messages",
985 "response": {
986 "$ref": "ListJobMessagesResponse"
987 },
988 "scopes": [
989 "https://www.googleapis.com/auth/cloud-p latform",
990 "https://www.googleapis.com/auth/userinf o.email"
991 ]
992 }
993 }
994 },
839 "debug": { 995 "debug": {
840 "methods": { 996 "methods": {
841 "getConfig": { 997 "getConfig": {
842 "description": "Get encoded debug configurat ion for component. Not cacheable.", 998 "description": "Get encoded debug configurat ion for component. Not cacheable.",
843 "httpMethod": "POST", 999 "httpMethod": "POST",
844 "id": "dataflow.projects.jobs.debug.getConfi g", 1000 "id": "dataflow.projects.jobs.debug.getConfi g",
845 "parameterOrder": [ 1001 "parameterOrder": [
846 "projectId", 1002 "projectId",
847 "jobId" 1003 "jobId"
848 ], 1004 ],
(...skipping 54 matching lines...) Expand 10 before | Expand all | Expand 10 after
903 }, 1059 },
904 "scopes": [ 1060 "scopes": [
905 "https://www.googleapis.com/auth/cloud-p latform", 1061 "https://www.googleapis.com/auth/cloud-p latform",
906 "https://www.googleapis.com/auth/userinf o.email" 1062 "https://www.googleapis.com/auth/userinf o.email"
907 ] 1063 ]
908 } 1064 }
909 } 1065 }
910 }, 1066 },
911 "workItems": { 1067 "workItems": {
912 "methods": { 1068 "methods": {
913 "reportStatus": {
914 "description": "Reports the status of datafl ow WorkItems leased by a worker.",
915 "httpMethod": "POST",
916 "id": "dataflow.projects.jobs.workItems.repo rtStatus",
917 "parameterOrder": [
918 "projectId",
919 "jobId"
920 ],
921 "parameters": {
922 "projectId": {
923 "description": "The project which ow ns the WorkItem's job.",
924 "location": "path",
925 "required": true,
926 "type": "string"
927 },
928 "jobId": {
929 "description": "The job which the Wo rkItem is part of.",
930 "location": "path",
931 "required": true,
932 "type": "string"
933 }
934 },
935 "path": "v1b3/projects/{projectId}/jobs/{job Id}/workItems:reportStatus",
936 "request": {
937 "$ref": "ReportWorkItemStatusRequest"
938 },
939 "response": {
940 "$ref": "ReportWorkItemStatusResponse"
941 },
942 "scopes": [
943 "https://www.googleapis.com/auth/cloud-p latform",
944 "https://www.googleapis.com/auth/userinf o.email"
945 ]
946 },
947 "lease": { 1069 "lease": {
948 "description": "Leases a dataflow WorkItem t o run.", 1070 "description": "Leases a dataflow WorkItem t o run.",
949 "httpMethod": "POST", 1071 "httpMethod": "POST",
950 "id": "dataflow.projects.jobs.workItems.leas e", 1072 "id": "dataflow.projects.jobs.workItems.leas e",
951 "parameterOrder": [ 1073 "parameterOrder": [
952 "projectId", 1074 "projectId",
953 "jobId" 1075 "jobId"
954 ], 1076 ],
955 "parameters": { 1077 "parameters": {
956 "projectId": { 1078 "projectId": {
(...skipping 13 matching lines...) Expand all
970 "request": { 1092 "request": {
971 "$ref": "LeaseWorkItemRequest" 1093 "$ref": "LeaseWorkItemRequest"
972 }, 1094 },
973 "response": { 1095 "response": {
974 "$ref": "LeaseWorkItemResponse" 1096 "$ref": "LeaseWorkItemResponse"
975 }, 1097 },
976 "scopes": [ 1098 "scopes": [
977 "https://www.googleapis.com/auth/cloud-p latform", 1099 "https://www.googleapis.com/auth/cloud-p latform",
978 "https://www.googleapis.com/auth/userinf o.email" 1100 "https://www.googleapis.com/auth/userinf o.email"
979 ] 1101 ]
980 } 1102 },
981 } 1103 "reportStatus": {
982 }, 1104 "description": "Reports the status of datafl ow WorkItems leased by a worker.",
983 "messages": { 1105 "httpMethod": "POST",
984 "methods": { 1106 "id": "dataflow.projects.jobs.workItems.repo rtStatus",
985 "list": {
986 "description": "Request the job status.",
987 "httpMethod": "GET",
988 "id": "dataflow.projects.jobs.messages.list" ,
989 "parameterOrder": [ 1107 "parameterOrder": [
990 "projectId", 1108 "projectId",
991 "jobId" 1109 "jobId"
992 ], 1110 ],
993 "parameters": { 1111 "parameters": {
994 "minimumImportance": { 1112 "projectId": {
995 "description": "Filter to only get m essages with importance >= level", 1113 "description": "The project which ow ns the WorkItem's job.",
996 "enum": [
997 "JOB_MESSAGE_IMPORTANCE_UNKNOWN" ,
998 "JOB_MESSAGE_DEBUG",
999 "JOB_MESSAGE_DETAILED",
1000 "JOB_MESSAGE_BASIC",
1001 "JOB_MESSAGE_WARNING",
1002 "JOB_MESSAGE_ERROR"
1003 ],
1004 "location": "query",
1005 "type": "string"
1006 },
1007 "jobId": {
1008 "description": "The job to get messa ges about.",
1009 "location": "path", 1114 "location": "path",
1010 "required": true, 1115 "required": true,
1011 "type": "string" 1116 "type": "string"
1012 }, 1117 },
1013 "projectId": { 1118 "jobId": {
1014 "description": "A project id.", 1119 "description": "The job which the Wo rkItem is part of.",
1015 "location": "path", 1120 "location": "path",
1016 "required": true, 1121 "required": true,
1017 "type": "string" 1122 "type": "string"
1018 },
1019 "location": {
1020 "description": "The location which c ontains the job specified by job_id.",
1021 "location": "query",
1022 "type": "string"
1023 },
1024 "endTime": {
1025 "description": "Return only messages with timestamps < end_time. The default is now\n(i.e. return up to the latest m essages available).",
1026 "format": "google-datetime",
1027 "location": "query",
1028 "type": "string"
1029 },
1030 "startTime": {
1031 "description": "If specified, return only messages with timestamps >= start_time.\nThe default is the job creation t ime (i.e. beginning of messages).",
1032 "format": "google-datetime",
1033 "location": "query",
1034 "type": "string"
1035 },
1036 "pageToken": {
1037 "description": "If supplied, this sh ould be the value of next_page_token returned\nby an earlier call. This will cau se the next page of results to\nbe returned.",
1038 "location": "query",
1039 "type": "string"
1040 },
1041 "pageSize": {
1042 "description": "If specified, determ ines the maximum number of messages to\nreturn. If unspecified, the service may choose an appropriate\ndefault, or may return an arbitrarily large number of re sults.",
1043 "format": "int32",
1044 "location": "query",
1045 "type": "integer"
1046 } 1123 }
1047 }, 1124 },
1048 "path": "v1b3/projects/{projectId}/jobs/{job Id}/messages", 1125 "path": "v1b3/projects/{projectId}/jobs/{job Id}/workItems:reportStatus",
1126 "request": {
1127 "$ref": "ReportWorkItemStatusRequest"
1128 },
1049 "response": { 1129 "response": {
1050 "$ref": "ListJobMessagesResponse" 1130 "$ref": "ReportWorkItemStatusResponse"
1051 }, 1131 },
1052 "scopes": [ 1132 "scopes": [
1053 "https://www.googleapis.com/auth/cloud-p latform", 1133 "https://www.googleapis.com/auth/cloud-p latform",
1054 "https://www.googleapis.com/auth/userinf o.email" 1134 "https://www.googleapis.com/auth/userinf o.email"
1055 ] 1135 ]
1056 } 1136 }
1057 } 1137 }
1058 } 1138 }
1059 } 1139 }
1060 } 1140 }
1061 } 1141 }
1062 } 1142 }
1063 }, 1143 },
1064 "revision": "20170210", 1144 "revision": "20170303",
1065 "rootUrl": "https://dataflow.googleapis.com/", 1145 "rootUrl": "https://dataflow.googleapis.com/",
1066 "schemas": { 1146 "schemas": {
1067 "WorkItemStatus": {
1068 "description": "Conveys a worker's progress through the work describ ed by a WorkItem.",
1069 "id": "WorkItemStatus",
1070 "properties": {
1071 "counterUpdates": {
1072 "description": "Worker output counters for this WorkItem.",
1073 "items": {
1074 "$ref": "CounterUpdate"
1075 },
1076 "type": "array"
1077 },
1078 "workItemId": {
1079 "description": "Identifies the WorkItem.",
1080 "type": "string"
1081 },
1082 "metricUpdates": {
1083 "description": "DEPRECATED in favor of counter_updates.",
1084 "items": {
1085 "$ref": "MetricUpdate"
1086 },
1087 "type": "array"
1088 },
1089 "errors": {
1090 "description": "Specifies errors which occurred during proce ssing. If errors are\nprovided, and completed = true, then the WorkItem is cons idered\nto have failed.",
1091 "items": {
1092 "$ref": "Status"
1093 },
1094 "type": "array"
1095 },
1096 "dynamicSourceSplit": {
1097 "$ref": "DynamicSourceSplit",
1098 "description": "See documentation of stop_position."
1099 },
1100 "sourceOperationResponse": {
1101 "$ref": "SourceOperationResponse",
1102 "description": "If the work item represented a SourceOperati onRequest, and the work\nis completed, contains the result of the operation."
1103 },
1104 "progress": {
1105 "$ref": "ApproximateProgress",
1106 "description": "DEPRECATED in favor of reported_progress."
1107 },
1108 "requestedLeaseDuration": {
1109 "description": "Amount of time the worker requests for its l ease.",
1110 "format": "google-duration",
1111 "type": "string"
1112 },
1113 "reportIndex": {
1114 "description": "The report index. When a WorkItem is leased , the lease will\ncontain an initial report index. When a WorkItem's status is\ nreported to the system, the report should be sent with\nthat report index, and the response will contain the index the\nworker should use for the next report. Reports received with\nunexpected index values will be rejected by the service. \n\nIn order to preserve idempotency, the worker should not alter the\ncontents of a report, even if the worker must submit the same\nreport multiple times befo re getting back a response. The worker\nshould not submit a subsequent report u ntil the response for the\nprevious report had been received from the service.",
1115 "format": "int64",
1116 "type": "string"
1117 },
1118 "stopPosition": {
1119 "$ref": "Position",
1120 "description": "A worker may split an active map task in two parts, \"primary\" and\n\"residual\", continuing to process the primary part an d returning the\nresidual part into the pool of available work.\nThis event is c alled a \"dynamic split\" and is critical to the dynamic\nwork rebalancing featu re. The two obtained sub-tasks are called\n\"parts\" of the split.\nThe parts, i f concatenated, must represent the same input as would\nbe read by the current t ask if the split did not happen.\nThe exact way in which the original task is de composed into the two\nparts is specified either as a position demarcating them\ n(stop_position), or explicitly as two DerivedSources, if this\ntask consumes a user-defined source type (dynamic_source_split).\n\nThe \"current\" task is adju sted as a result of the split: after a task\nwith range [A, B) sends a stop_posi tion update at C, its range is\nconsidered to be [A, C), e.g.:\n* Progress shoul d be interpreted relative to the new range, e.g.\n \"75% completed\" means \"75 % of [A, C) completed\"\n* The worker should interpret proposed_stop_position re lative to the\n new range, e.g. \"split at 68%\" should be interpreted as\n \" split at 68% of [A, C)\".\n* If the worker chooses to split again using stop_pos ition, only\n stop_positions in [A, C) will be accepted.\n* Etc.\ndynamic_sourc e_split has similar semantics: e.g., if a task with\nsource S splits using dynam ic_source_split into {P, R}\n(where P and R must be together equivalent to S), t hen subsequent\nprogress and proposed_stop_position should be interpreted relati ve\nto P, and in a potential subsequent dynamic_source_split into {P', R'},\nP' and R' must be together equivalent to P, etc."
1121 },
1122 "completed": {
1123 "description": "True if the WorkItem was completed (successf ully or unsuccessfully).",
1124 "type": "boolean"
1125 },
1126 "reportedProgress": {
1127 "$ref": "ApproximateReportedProgress",
1128 "description": "The worker's progress through this WorkItem. "
1129 },
1130 "sourceFork": {
1131 "$ref": "SourceFork",
1132 "description": "DEPRECATED in favor of dynamic_source_split. "
1133 }
1134 },
1135 "type": "object"
1136 },
1137 "WorkItemServiceState": {
1138 "description": "The Dataflow service's idea of the current state of a WorkItem\nbeing processed by a worker.",
1139 "id": "WorkItemServiceState",
1140 "properties": {
1141 "leaseExpireTime": {
1142 "description": "Time at which the current lease will expire. ",
1143 "format": "google-datetime",
1144 "type": "string"
1145 },
1146 "metricShortId": {
1147 "description": "The short ids that workers should use in sub sequent metric updates.\nWorkers should strive to use short ids whenever possibl e, but it is ok\nto request the short_id again if a worker lost track of it\n(e. g. if the worker is recovering from a crash).\nNOTE: it is possible that the res ponse may have short ids for a subset\nof the metrics.",
1148 "items": {
1149 "$ref": "MetricShortId"
1150 },
1151 "type": "array"
1152 },
1153 "nextReportIndex": {
1154 "description": "The index value to use for the next report s ent by the worker.\nNote: If the report call fails for whatever reason, the work er should\nreuse this index for subsequent report attempts.",
1155 "format": "int64",
1156 "type": "string"
1157 },
1158 "suggestedStopPoint": {
1159 "$ref": "ApproximateProgress",
1160 "description": "DEPRECATED in favor of split_request."
1161 },
1162 "splitRequest": {
1163 "$ref": "ApproximateSplitRequest",
1164 "description": "The progress point in the WorkItem where the Dataflow service\nsuggests that the worker truncate the task."
1165 },
1166 "reportStatusInterval": {
1167 "description": "New recommended reporting interval.",
1168 "format": "google-duration",
1169 "type": "string"
1170 },
1171 "suggestedStopPosition": {
1172 "$ref": "Position",
1173 "description": "Obsolete, always empty."
1174 },
1175 "harnessData": {
1176 "additionalProperties": {
1177 "description": "Properties of the object.",
1178 "type": "any"
1179 },
1180 "description": "Other data returned by the service, specific to the particular\nworker harness.",
1181 "type": "object"
1182 }
1183 },
1184 "type": "object"
1185 },
1186 "MetricStructuredName": {
1187 "description": "Identifies a metric, by describing the source which generated the\nmetric.",
1188 "id": "MetricStructuredName",
1189 "properties": {
1190 "origin": {
1191 "description": "Origin (namespace) of metric name. May be bl ank for user-define metrics;\nwill be \"dataflow\" for metrics defined by the Da taflow service or SDK.",
1192 "type": "string"
1193 },
1194 "name": {
1195 "description": "Worker-defined metric name.",
1196 "type": "string"
1197 },
1198 "context": {
1199 "additionalProperties": {
1200 "type": "string"
1201 },
1202 "description": "Zero or more labeled fields which identify t he part of the job this\nmetric is associated with, such as the name of a step o r collection.\n\nFor example, built-in counters associated with steps will have\ ncontext['step'] = <step-name>. Counters associated with PCollections\nin the SD K will have context['pcollection'] = <pcollection-name>.",
1203 "type": "object"
1204 }
1205 },
1206 "type": "object"
1207 },
1208 "SeqMapTaskOutputInfo": { 1147 "SeqMapTaskOutputInfo": {
1209 "description": "Information about an output of a SeqMapTask.", 1148 "description": "Information about an output of a SeqMapTask.",
1210 "id": "SeqMapTaskOutputInfo", 1149 "id": "SeqMapTaskOutputInfo",
1211 "properties": { 1150 "properties": {
1151 "sink": {
1152 "$ref": "Sink",
1153 "description": "The sink to write the output value to."
1154 },
1212 "tag": { 1155 "tag": {
1213 "description": "The id of the TupleTag the user code will ta g the output value by.", 1156 "description": "The id of the TupleTag the user code will ta g the output value by.",
1214 "type": "string" 1157 "type": "string"
1215 },
1216 "sink": {
1217 "$ref": "Sink",
1218 "description": "The sink to write the output value to."
1219 } 1158 }
1220 }, 1159 },
1221 "type": "object" 1160 "type": "object"
1222 }, 1161 },
1223 "JobExecutionStageInfo": { 1162 "JobExecutionStageInfo": {
1224 "description": "Contains information about how a particular\ngoogle. dataflow.v1beta3.Step will be executed.", 1163 "description": "Contains information about how a particular\ngoogle. dataflow.v1beta3.Step will be executed.",
1225 "id": "JobExecutionStageInfo", 1164 "id": "JobExecutionStageInfo",
1226 "properties": { 1165 "properties": {
1227 "stepName": { 1166 "stepName": {
1228 "description": "The steps associated with the execution stag e.\nNote that stages may have several steps, and that a given step\nmight be run by more than one stage.", 1167 "description": "The steps associated with the execution stag e.\nNote that stages may have several steps, and that a given step\nmight be run by more than one stage.",
(...skipping 77 matching lines...) Expand 10 before | Expand all | Expand 10 after
1306 ], 1245 ],
1307 "type": "string" 1246 "type": "string"
1308 } 1247 }
1309 }, 1248 },
1310 "type": "object" 1249 "type": "object"
1311 }, 1250 },
1312 "SeqMapTask": { 1251 "SeqMapTask": {
1313 "description": "Describes a particular function to invoke.", 1252 "description": "Describes a particular function to invoke.",
1314 "id": "SeqMapTask", 1253 "id": "SeqMapTask",
1315 "properties": { 1254 "properties": {
1255 "inputs": {
1256 "description": "Information about each of the inputs.",
1257 "items": {
1258 "$ref": "SideInputInfo"
1259 },
1260 "type": "array"
1261 },
1262 "systemName": {
1263 "description": "System-defined name of the SeqDo operation.\ nUnique across the workflow.",
1264 "type": "string"
1265 },
1266 "stageName": {
1267 "description": "System-defined name of the stage containing the SeqDo operation.\nUnique across the workflow.",
1268 "type": "string"
1269 },
1316 "userFn": { 1270 "userFn": {
1317 "additionalProperties": { 1271 "additionalProperties": {
1318 "description": "Properties of the object.", 1272 "description": "Properties of the object.",
1319 "type": "any" 1273 "type": "any"
1320 }, 1274 },
1321 "description": "The user function to invoke.", 1275 "description": "The user function to invoke.",
1322 "type": "object" 1276 "type": "object"
1323 }, 1277 },
1324 "name": { 1278 "name": {
1325 "description": "The user-provided name of the SeqDo operatio n.", 1279 "description": "The user-provided name of the SeqDo operatio n.",
1326 "type": "string" 1280 "type": "string"
1327 }, 1281 },
1328 "outputInfos": { 1282 "outputInfos": {
1329 "description": "Information about each of the outputs.", 1283 "description": "Information about each of the outputs.",
1330 "items": { 1284 "items": {
1331 "$ref": "SeqMapTaskOutputInfo" 1285 "$ref": "SeqMapTaskOutputInfo"
1332 }, 1286 },
1333 "type": "array" 1287 "type": "array"
1334 },
1335 "inputs": {
1336 "description": "Information about each of the inputs.",
1337 "items": {
1338 "$ref": "SideInputInfo"
1339 },
1340 "type": "array"
1341 },
1342 "stageName": {
1343 "description": "System-defined name of the stage containing the SeqDo operation.\nUnique across the workflow.",
1344 "type": "string"
1345 },
1346 "systemName": {
1347 "description": "System-defined name of the SeqDo operation.\ nUnique across the workflow.",
1348 "type": "string"
1349 } 1288 }
1350 }, 1289 },
1351 "type": "object" 1290 "type": "object"
1352 }, 1291 },
1353 "WorkerMessageCode": { 1292 "WorkerMessageCode": {
1354 "description": "A message code is used to report status and error me ssages to the service.\nThe message codes are intended to be machine readable. T he service will\ntake care of translating these into user understandable message s if\nnecessary.\n\nExample use cases:\n 1. Worker processes reporting successf ul startup.\n 2. Worker processes reporting specific errors (e.g. package stagi ng\n failure).", 1293 "description": "A message code is used to report status and error me ssages to the service.\nThe message codes are intended to be machine readable. T he service will\ntake care of translating these into user understandable message s if\nnecessary.\n\nExample use cases:\n 1. Worker processes reporting successf ul startup.\n 2. Worker processes reporting specific errors (e.g. package stagi ng\n failure).",
1355 "id": "WorkerMessageCode", 1294 "id": "WorkerMessageCode",
1356 "properties": { 1295 "properties": {
1296 "code": {
1297 "description": "The code is a string intended for consumptio n by a machine that identifies\nthe type of message being sent.\nExamples:\n 1. \"HARNESS_STARTED\" might be used to indicate the worker harness has\n start ed.\n 2. \"GCS_DOWNLOAD_ERROR\" might be used to indicate an error downloading\n a GCS file as part of the boot process of one of the worker containers.\n\nT his is a string and not an enum to make it easy to add new codes without\nwaitin g for an API change.",
1298 "type": "string"
1299 },
1357 "parameters": { 1300 "parameters": {
1358 "additionalProperties": { 1301 "additionalProperties": {
1359 "description": "Properties of the object.", 1302 "description": "Properties of the object.",
1360 "type": "any" 1303 "type": "any"
1361 }, 1304 },
1362 "description": "Parameters contains specific information abo ut the code.\n\nThis is a struct to allow parameters of different types.\n\nExam ples:\n 1. For a \"HARNESS_STARTED\" message parameters might provide the name\n of the worker and additional data like timing information.\n 2. For a \"GCS_ DOWNLOAD_ERROR\" parameters might contain fields listing\n the GCS objects be ing downloaded and fields containing errors.\n\nIn general complex data structur es should be avoided. If a worker\nneeds to send a specific and complicated data structure then please\nconsider defining a new proto and adding it to the data oneof in\nWorkerMessageResponse.\n\nConventions:\n Parameters should only be use d for information that isn't typically passed\n as a label.\n hostname and other worker identifiers should almost always be passed\n as labels since they will b e included on most messages.", 1305 "description": "Parameters contains specific information abo ut the code.\n\nThis is a struct to allow parameters of different types.\n\nExam ples:\n 1. For a \"HARNESS_STARTED\" message parameters might provide the name\n of the worker and additional data like timing information.\n 2. For a \"GCS_ DOWNLOAD_ERROR\" parameters might contain fields listing\n the GCS objects be ing downloaded and fields containing errors.\n\nIn general complex data structur es should be avoided. If a worker\nneeds to send a specific and complicated data structure then please\nconsider defining a new proto and adding it to the data oneof in\nWorkerMessageResponse.\n\nConventions:\n Parameters should only be use d for information that isn't typically passed\n as a label.\n hostname and other worker identifiers should almost always be passed\n as labels since they will b e included on most messages.",
1363 "type": "object" 1306 "type": "object"
1364 },
1365 "code": {
1366 "description": "The code is a string intended for consumptio n by a machine that identifies\nthe type of message being sent.\nExamples:\n 1. \"HARNESS_STARTED\" might be used to indicate the worker harness has\n start ed.\n 2. \"GCS_DOWNLOAD_ERROR\" might be used to indicate an error downloading\n a GCS file as part of the boot process of one of the worker containers.\n\nT his is a string and not an enum to make it easy to add new codes without\nwaitin g for an API change.",
1367 "type": "string"
1368 } 1307 }
1369 }, 1308 },
1370 "type": "object" 1309 "type": "object"
1371 }, 1310 },
1372 "CustomSourceLocation": { 1311 "CustomSourceLocation": {
1373 "description": "Identifies the location of a custom souce.", 1312 "description": "Identifies the location of a custom souce.",
1374 "id": "CustomSourceLocation", 1313 "id": "CustomSourceLocation",
1375 "properties": { 1314 "properties": {
1376 "stateful": { 1315 "stateful": {
1377 "description": "Whether this source is stateful.", 1316 "description": "Whether this source is stateful.",
(...skipping 51 matching lines...) Expand 10 before | Expand all | Expand 10 after
1429 }, 1368 },
1430 "type": "array" 1369 "type": "array"
1431 } 1370 }
1432 }, 1371 },
1433 "type": "object" 1372 "type": "object"
1434 }, 1373 },
1435 "InstructionOutput": { 1374 "InstructionOutput": {
1436 "description": "An output of an instruction.", 1375 "description": "An output of an instruction.",
1437 "id": "InstructionOutput", 1376 "id": "InstructionOutput",
1438 "properties": { 1377 "properties": {
1439 "name": {
1440 "description": "The user-provided name of this output.",
1441 "type": "string"
1442 },
1443 "originalName": {
1444 "description": "System-defined name for this output in the o riginal workflow graph.\nOutputs that do not contribute to an original instructi on do not set this.",
1445 "type": "string"
1446 },
1447 "systemName": { 1378 "systemName": {
1448 "description": "System-defined name of this output.\nUnique across the workflow.", 1379 "description": "System-defined name of this output.\nUnique across the workflow.",
1449 "type": "string" 1380 "type": "string"
1450 }, 1381 },
1451 "onlyCountKeyBytes": { 1382 "onlyCountKeyBytes": {
1452 "description": "For system-generated byte and mean byte metr ics, certain instructions\nshould only report the key size.", 1383 "description": "For system-generated byte and mean byte metr ics, certain instructions\nshould only report the key size.",
1453 "type": "boolean" 1384 "type": "boolean"
1454 }, 1385 },
1455 "onlyCountValueBytes": { 1386 "onlyCountValueBytes": {
1456 "description": "For system-generated byte and mean byte metr ics, certain instructions\nshould only report the value size.", 1387 "description": "For system-generated byte and mean byte metr ics, certain instructions\nshould only report the value size.",
1457 "type": "boolean" 1388 "type": "boolean"
1458 }, 1389 },
1459 "codec": { 1390 "codec": {
1460 "additionalProperties": { 1391 "additionalProperties": {
1461 "description": "Properties of the object.", 1392 "description": "Properties of the object.",
1462 "type": "any" 1393 "type": "any"
1463 }, 1394 },
1464 "description": "The codec to use to encode data being writte n via this output.", 1395 "description": "The codec to use to encode data being writte n via this output.",
1465 "type": "object" 1396 "type": "object"
1397 },
1398 "name": {
1399 "description": "The user-provided name of this output.",
1400 "type": "string"
1401 },
1402 "originalName": {
1403 "description": "System-defined name for this output in the o riginal workflow graph.\nOutputs that do not contribute to an original instructi on do not set this.",
1404 "type": "string"
1466 } 1405 }
1467 }, 1406 },
1468 "type": "object" 1407 "type": "object"
1469 }, 1408 },
1470 "CreateJobFromTemplateRequest": { 1409 "CreateJobFromTemplateRequest": {
1471 "description": "A request to create a Cloud Dataflow job from a temp late.", 1410 "description": "A request to create a Cloud Dataflow job from a temp late.",
1472 "id": "CreateJobFromTemplateRequest", 1411 "id": "CreateJobFromTemplateRequest",
1473 "properties": { 1412 "properties": {
1474 "gcsPath": { 1413 "gcsPath": {
1475 "description": "Required. A Cloud Storage path to the templa te from which to\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`.", 1414 "description": "Required. A Cloud Storage path to the templa te from which to\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`.",
(...skipping 29 matching lines...) Expand all
1505 "$ref": "SplitInt64", 1444 "$ref": "SplitInt64",
1506 "description": "The number of values being aggregated." 1445 "description": "The number of values being aggregated."
1507 } 1446 }
1508 }, 1447 },
1509 "type": "object" 1448 "type": "object"
1510 }, 1449 },
1511 "ListJobsResponse": { 1450 "ListJobsResponse": {
1512 "description": "Response to a request to list Cloud Dataflow jobs. This may be a partial\nresponse, depending on the page size in the ListJobsReque st.", 1451 "description": "Response to a request to list Cloud Dataflow jobs. This may be a partial\nresponse, depending on the page size in the ListJobsReque st.",
1513 "id": "ListJobsResponse", 1452 "id": "ListJobsResponse",
1514 "properties": { 1453 "properties": {
1454 "jobs": {
1455 "description": "A subset of the requested job information.",
1456 "items": {
1457 "$ref": "Job"
1458 },
1459 "type": "array"
1460 },
1515 "nextPageToken": { 1461 "nextPageToken": {
1516 "description": "Set if there may be more results than fit in this response.", 1462 "description": "Set if there may be more results than fit in this response.",
1517 "type": "string" 1463 "type": "string"
1518 }, 1464 },
1519 "failedLocation": { 1465 "failedLocation": {
1520 "description": "Zero or more messages describing locations t hat failed to respond.", 1466 "description": "Zero or more messages describing locations t hat failed to respond.",
1521 "items": { 1467 "items": {
1522 "$ref": "FailedLocation" 1468 "$ref": "FailedLocation"
1523 }, 1469 },
1524 "type": "array" 1470 "type": "array"
1525 },
1526 "jobs": {
1527 "description": "A subset of the requested job information.",
1528 "items": {
1529 "$ref": "Job"
1530 },
1531 "type": "array"
1532 } 1471 }
1533 }, 1472 },
1534 "type": "object" 1473 "type": "object"
1535 }, 1474 },
1536 "ComputationTopology": { 1475 "ComputationTopology": {
1537 "description": "All configuration data for a particular Computation. ", 1476 "description": "All configuration data for a particular Computation. ",
1538 "id": "ComputationTopology", 1477 "id": "ComputationTopology",
1539 "properties": { 1478 "properties": {
1479 "systemStageName": {
1480 "description": "The system stage name.",
1481 "type": "string"
1482 },
1483 "inputs": {
1484 "description": "The inputs to the computation.",
1485 "items": {
1486 "$ref": "StreamLocation"
1487 },
1488 "type": "array"
1489 },
1490 "computationId": {
1491 "description": "The ID of the computation.",
1492 "type": "string"
1493 },
1494 "keyRanges": {
1495 "description": "The key ranges processed by the computation. ",
1496 "items": {
1497 "$ref": "KeyRangeLocation"
1498 },
1499 "type": "array"
1500 },
1540 "userStageName": { 1501 "userStageName": {
1541 "description": "The user stage name.", 1502 "description": "The user stage name.",
1542 "type": "string" 1503 "type": "string"
1543 }, 1504 },
1544 "outputs": { 1505 "outputs": {
1545 "description": "The outputs from the computation.", 1506 "description": "The outputs from the computation.",
1546 "items": { 1507 "items": {
1547 "$ref": "StreamLocation" 1508 "$ref": "StreamLocation"
1548 }, 1509 },
1549 "type": "array" 1510 "type": "array"
1550 }, 1511 },
1551 "stateFamilies": { 1512 "stateFamilies": {
1552 "description": "The state family values.", 1513 "description": "The state family values.",
1553 "items": { 1514 "items": {
1554 "$ref": "StateFamilyConfig" 1515 "$ref": "StateFamilyConfig"
1555 }, 1516 },
1556 "type": "array" 1517 "type": "array"
1557 },
1558 "systemStageName": {
1559 "description": "The system stage name.",
1560 "type": "string"
1561 },
1562 "computationId": {
1563 "description": "The ID of the computation.",
1564 "type": "string"
1565 },
1566 "inputs": {
1567 "description": "The inputs to the computation.",
1568 "items": {
1569 "$ref": "StreamLocation"
1570 },
1571 "type": "array"
1572 },
1573 "keyRanges": {
1574 "description": "The key ranges processed by the computation. ",
1575 "items": {
1576 "$ref": "KeyRangeLocation"
1577 },
1578 "type": "array"
1579 } 1518 }
1580 }, 1519 },
1581 "type": "object" 1520 "type": "object"
1582 }, 1521 },
1583 "RuntimeEnvironment": { 1522 "RuntimeEnvironment": {
1584 "description": "The environment values to set at runtime.", 1523 "description": "The environment values to set at runtime.",
1585 "id": "RuntimeEnvironment", 1524 "id": "RuntimeEnvironment",
1586 "properties": { 1525 "properties": {
1526 "maxWorkers": {
1527 "description": "The maximum number of Google Compute Engine instances to be made\navailable to your pipeline during execution, from 1 to 100 0.",
1528 "format": "int32",
1529 "type": "integer"
1530 },
1531 "zone": {
1532 "description": "The Compute Engine [availability zone](https ://cloud.google.com/compute/docs/regions-zones/regions-zones)\nfor launching wor ker instances to run your pipeline.",
1533 "type": "string"
1534 },
1587 "serviceAccountEmail": { 1535 "serviceAccountEmail": {
1588 "description": "The email address of the service account to run the job as.", 1536 "description": "The email address of the service account to run the job as.",
1589 "type": "string" 1537 "type": "string"
1590 }, 1538 },
1591 "tempLocation": { 1539 "tempLocation": {
1592 "description": "The Cloud Storage path to use for temporary files.\nMust be a valid Cloud Storage URL, beginning with `gs://`.", 1540 "description": "The Cloud Storage path to use for temporary files.\nMust be a valid Cloud Storage URL, beginning with `gs://`.",
1593 "type": "string" 1541 "type": "string"
1594 }, 1542 },
1595 "bypassTempDirValidation": { 1543 "bypassTempDirValidation": {
1596 "description": "Whether to bypass the safety checks for the job's temporary directory.\nUse with caution.", 1544 "description": "Whether to bypass the safety checks for the job's temporary directory.\nUse with caution.",
1597 "type": "boolean" 1545 "type": "boolean"
1546 }
1547 },
1548 "type": "object"
1549 },
1550 "StreamingSideInputLocation": {
1551 "description": "Identifies the location of a streaming side input.",
1552 "id": "StreamingSideInputLocation",
1553 "properties": {
1554 "stateFamily": {
1555 "description": "Identifies the state family where this side input is stored.",
1556 "type": "string"
1598 }, 1557 },
1599 "maxWorkers": { 1558 "tag": {
1600 "description": "The maximum number of Google Compute Engine instances to be made\navailable to your pipeline during execution, from 1 to 100 0.", 1559 "description": "Identifies the particular side input within the streaming Dataflow job.",
1601 "format": "int32",
1602 "type": "integer"
1603 },
1604 "zone": {
1605 "description": "The Compute Engine [availability zone](https ://cloud.google.com/compute/docs/regions-zones/regions-zones)\nfor launching wor ker instances to run your pipeline.",
1606 "type": "string" 1560 "type": "string"
1607 } 1561 }
1608 }, 1562 },
1609 "type": "object" 1563 "type": "object"
1610 }, 1564 },
1611 "MountedDataDisk": { 1565 "MountedDataDisk": {
1612 "description": "Describes mounted data disk.", 1566 "description": "Describes mounted data disk.",
1613 "id": "MountedDataDisk", 1567 "id": "MountedDataDisk",
1614 "properties": { 1568 "properties": {
1615 "dataDisk": { 1569 "dataDisk": {
1616 "description": "The name of the data disk.\nThis name is loc al to the Google Cloud Platform project and uniquely\nidentifies the disk within that project, for example\n\"myproject-1014-104817-4c2-harness-0-disk-1\".", 1570 "description": "The name of the data disk.\nThis name is loc al to the Google Cloud Platform project and uniquely\nidentifies the disk within that project, for example\n\"myproject-1014-104817-4c2-harness-0-disk-1\".",
1617 "type": "string" 1571 "type": "string"
1618 } 1572 }
1619 }, 1573 },
1620 "type": "object" 1574 "type": "object"
1621 }, 1575 },
1622 "StreamingSideInputLocation": { 1576 "LaunchTemplateResponse": {
1623 "description": "Identifies the location of a streaming side input.", 1577 "description": "Response to the request to launch a template.",
1624 "id": "StreamingSideInputLocation", 1578 "id": "LaunchTemplateResponse",
1625 "properties": { 1579 "properties": {
1626 "stateFamily": { 1580 "status": {
1627 "description": "Identifies the state family where this side input is stored.", 1581 "$ref": "Status",
1582 "description": "The status of the launch template request. A ny problems with the request\nwill be indicated in the error_details."
1583 },
1584 "job": {
1585 "$ref": "Job",
1586 "description": "The job that was launched, if the request wa s not a dry run and\nthe job was successfully launched."
1587 }
1588 },
1589 "type": "object"
1590 },
1591 "DerivedSource": {
1592 "description": "Specification of one of the bundles produced as a re sult of splitting\na Source (e.g. when executing a SourceSplitRequest, or when\n splitting an active task using WorkItemStatus.dynamic_source_split),\nrelative t o the source being split.",
1593 "id": "DerivedSource",
1594 "properties": {
1595 "derivationMode": {
1596 "description": "What source to base the produced source on ( if any).",
1597 "enum": [
1598 "SOURCE_DERIVATION_MODE_UNKNOWN",
1599 "SOURCE_DERIVATION_MODE_INDEPENDENT",
1600 "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT",
1601 "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT"
1602 ],
1603 "enumDescriptions": [
1604 "The source derivation is unknown, or unspecified.",
1605 "Produce a completely independent Source with no base.",
1606 "Produce a Source based on the Source being split.",
1607 "Produce a Source based on the base of the Source being split."
1608 ],
1628 "type": "string" 1609 "type": "string"
1629 }, 1610 },
1630 "tag": { 1611 "source": {
1631 "description": "Identifies the particular side input within the streaming Dataflow job.", 1612 "$ref": "Source",
1632 "type": "string" 1613 "description": "Specification of the source."
1614 }
1615 },
1616 "type": "object"
1617 },
1618 "DynamicSourceSplit": {
1619 "description": "When a task splits using WorkItemStatus.dynamic_sour ce_split, this\nmessage describes the two parts of the split relative to the\nde scription of the current task's input.",
1620 "id": "DynamicSourceSplit",
1621 "properties": {
1622 "primary": {
1623 "$ref": "DerivedSource",
1624 "description": "Primary part (continued to be processed by w orker).\nSpecified relative to the previously-current source.\nBecomes current."
1625 },
1626 "residual": {
1627 "$ref": "DerivedSource",
1628 "description": "Residual part (returned to the pool of work) .\nSpecified relative to the previously-current source."
1633 } 1629 }
1634 }, 1630 },
1635 "type": "object" 1631 "type": "object"
1636 }, 1632 },
1637 "Job": { 1633 "Job": {
1638 "description": "Defines a job to be run by the Cloud Dataflow servic e.", 1634 "description": "Defines a job to be run by the Cloud Dataflow servic e.",
1639 "id": "Job", 1635 "id": "Job",
1640 "properties": { 1636 "properties": {
1641 "requestedState": {
1642 "description": "The job's requested state.\n\n`UpdateJob` ma y be used to switch between the `JOB_STATE_STOPPED` and\n`JOB_STATE_RUNNING` sta tes, by setting requested_state. `UpdateJob` may\nalso be used to directly set a job's requested state to\n`JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocab ly terminating the\njob if it has not already reached a terminal state.",
1643 "enum": [
1644 "JOB_STATE_UNKNOWN",
1645 "JOB_STATE_STOPPED",
1646 "JOB_STATE_RUNNING",
1647 "JOB_STATE_DONE",
1648 "JOB_STATE_FAILED",
1649 "JOB_STATE_CANCELLED",
1650 "JOB_STATE_UPDATED",
1651 "JOB_STATE_DRAINING",
1652 "JOB_STATE_DRAINED"
1653 ],
1654 "enumDescriptions": [
1655 "The job's run state isn't specified.",
1656 "`JOB_STATE_STOPPED` indicates that the job has not\nyet started to run.",
1657 "`JOB_STATE_RUNNING` indicates that the job is currently running.",
1658 "`JOB_STATE_DONE` indicates that the job has successfull y completed.\nThis is a terminal job state. This state may be set by the Cloud Dataflow\nservice, as a transition from `JOB_STATE_RUNNING`. It may also be set via a\nCloud Dataflow `UpdateJob` call, if the job has not yet reached a termina l\nstate.",
1659 "`JOB_STATE_FAILED` indicates that the job has failed. This is a\nterminal job state. This state may only be set by the Cloud Dataflow \nservice, and only as a transition from `JOB_STATE_RUNNING`.",
1660 "`JOB_STATE_CANCELLED` indicates that the job has been e xplicitly\ncancelled. This is a terminal job state. This state may only be\nset via a Cloud Dataflow `UpdateJob` call, and only if the job has not\nyet reached another terminal state.",
1661 "`JOB_STATE_UPDATED` indicates that the job was successf ully updated,\nmeaning that this job was stopped and another job was started, in heriting\nstate from this one. This is a terminal job state. This state may only be\nset by the Cloud Dataflow service, and only as a transition from\n`JOB_STAT E_RUNNING`.",
1662 "`JOB_STATE_DRAINING` indicates that the job is in the p rocess of draining.\nA draining job has stopped pulling from its input sources a nd is processing\nany data that remains in-flight. This state may be set via a C loud Dataflow\n`UpdateJob` call, but only as a transition from `JOB_STATE_RUNNIN G`. Jobs\nthat are draining may only transition to `JOB_STATE_DRAINED`,\n`JOB_ST ATE_CANCELLED`, or `JOB_STATE_FAILED`.",
1663 "`JOB_STATE_DRAINED` indicates that the job has been dra ined.\nA drained job terminated by stopping pulling from its input sources and\n processing any data that remained in-flight when draining was requested.\nThis s tate is a terminal state, may only be set by the Cloud Dataflow\nservice, and on ly as a transition from `JOB_STATE_DRAINING`."
1664 ],
1665 "type": "string"
1666 },
1667 "tempFiles": {
1668 "description": "A set of files the system should be aware of that are used\nfor temporary storage. These temporary files will be\nremoved on job completion.\nNo duplicates are allowed.\nNo file patterns are supported.\n\ nThe supported files are:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/ {bucket}/{object}\n bucket.storage.googleapis.com/{object}",
1669 "items": {
1670 "type": "string"
1671 },
1672 "type": "array"
1673 },
1674 "clientRequestId": {
1675 "description": "The client's unique identifier of the job, r e-used across retried attempts.\nIf this field is set, the service will ensure i ts uniqueness.\nThe request to create a job will fail if the service has knowled ge of a\npreviously submitted job with the same client's ID and job name.\nThe c aller may use this field to ensure idempotence of job\ncreation across retried a ttempts to create a job.\nBy default, the field is empty and, in that case, the service ignores it.",
1676 "type": "string"
1677 },
1678 "name": {
1679 "description": "The user-specified Cloud Dataflow job name.\ n\nOnly one Job with a given name may exist in a project at any\ngiven time. If a caller attempts to create a Job with the same\nname as an already-existing Job , the attempt returns the\nexisting Job.\n\nThe name must match the regular expr ession\n`[a-z]([-a-z0-9]{0,38}[a-z0-9])?`",
1680 "type": "string"
1681 },
1682 "steps": { 1637 "steps": {
1683 "description": "The top-level steps that constitute the enti re job.", 1638 "description": "The top-level steps that constitute the enti re job.",
1684 "items": { 1639 "items": {
1685 "$ref": "Step" 1640 "$ref": "Step"
1686 }, 1641 },
1687 "type": "array" 1642 "type": "array"
1688 }, 1643 },
1689 "replacedByJobId": { 1644 "replacedByJobId": {
1690 "description": "If another job is an update of this job (and thus, this job is in\n`JOB_STATE_UPDATED`), this field contains the ID of that job.", 1645 "description": "If another job is an update of this job (and thus, this job is in\n`JOB_STATE_UPDATED`), this field contains the ID of that job.",
1691 "type": "string" 1646 "type": "string"
1692 }, 1647 },
1693 "executionInfo": { 1648 "executionInfo": {
1694 "$ref": "JobExecutionInfo", 1649 "$ref": "JobExecutionInfo",
1695 "description": "Information about how the Cloud Dataflow ser vice will run the job." 1650 "description": "Deprecated."
1696 }, 1651 },
1697 "id": { 1652 "id": {
1698 "description": "The unique ID of this job.\n\nThis field is set by the Cloud Dataflow service when the Job is\ncreated, and is immutable for the life of the job.", 1653 "description": "The unique ID of this job.\n\nThis field is set by the Cloud Dataflow service when the Job is\ncreated, and is immutable for the life of the job.",
1699 "type": "string" 1654 "type": "string"
1700 }, 1655 },
1701 "currentState": { 1656 "currentState": {
1702 "description": "The current state of the job.\n\nJobs are cr eated in the `JOB_STATE_STOPPED` state unless otherwise\nspecified.\n\nA job in the `JOB_STATE_RUNNING` state may asynchronously enter a\nterminal state. After a job has reached a terminal state, no\nfurther state updates may be made.\n\nTh is field may be mutated by the Cloud Dataflow service;\ncallers cannot mutate it .", 1657 "description": "The current state of the job.\n\nJobs are cr eated in the `JOB_STATE_STOPPED` state unless otherwise\nspecified.\n\nA job in the `JOB_STATE_RUNNING` state may asynchronously enter a\nterminal state. After a job has reached a terminal state, no\nfurther state updates may be made.\n\nTh is field may be mutated by the Cloud Dataflow service;\ncallers cannot mutate it .",
1703 "enum": [ 1658 "enum": [
1704 "JOB_STATE_UNKNOWN", 1659 "JOB_STATE_UNKNOWN",
1705 "JOB_STATE_STOPPED", 1660 "JOB_STATE_STOPPED",
(...skipping 27 matching lines...) Expand all
1733 "format": "google-datetime", 1688 "format": "google-datetime",
1734 "type": "string" 1689 "type": "string"
1735 }, 1690 },
1736 "transformNameMapping": { 1691 "transformNameMapping": {
1737 "additionalProperties": { 1692 "additionalProperties": {
1738 "type": "string" 1693 "type": "string"
1739 }, 1694 },
1740 "description": "The map of transform name prefixes of the jo b to be replaced to the\ncorresponding name prefixes of the new job.", 1695 "description": "The map of transform name prefixes of the jo b to be replaced to the\ncorresponding name prefixes of the new job.",
1741 "type": "object" 1696 "type": "object"
1742 }, 1697 },
1743 "createTime": {
1744 "description": "The timestamp when the job was initially cre ated. Immutable and set by the\nCloud Dataflow service.",
1745 "format": "google-datetime",
1746 "type": "string"
1747 },
1748 "environment": {
1749 "$ref": "Environment",
1750 "description": "The environment for the job."
1751 },
1752 "labels": { 1698 "labels": {
1753 "additionalProperties": { 1699 "additionalProperties": {
1754 "type": "string" 1700 "type": "string"
1755 }, 1701 },
1756 "description": "User-defined labels for this job.\n\nThe lab els map can contain no more than 64 entries. Entries of the labels\nmap are UTF 8 strings that comply with the following restrictions:\n\n* Keys must conform to regexp: \\p{Ll}\\p{Lo}{0,62}\n* Values must conform to regexp: [\\p{Ll}\\p{Lo }\\p{N}_-]{0,63}\n* Both keys and values are additionally constrained to be <= 1 28 bytes in\nsize.", 1702 "description": "User-defined labels for this job.\n\nThe lab els map can contain no more than 64 entries. Entries of the labels\nmap are UTF 8 strings that comply with the following restrictions:\n\n* Keys must conform to regexp: \\p{Ll}\\p{Lo}{0,62}\n* Values must conform to regexp: [\\p{Ll}\\p{Lo }\\p{N}_-]{0,63}\n* Both keys and values are additionally constrained to be <= 1 28 bytes in\nsize.",
1757 "type": "object" 1703 "type": "object"
1758 }, 1704 },
1705 "environment": {
1706 "$ref": "Environment",
1707 "description": "The environment for the job."
1708 },
1709 "createTime": {
1710 "description": "The timestamp when the job was initially cre ated. Immutable and set by the\nCloud Dataflow service.",
1711 "format": "google-datetime",
1712 "type": "string"
1713 },
1759 "type": { 1714 "type": {
1760 "description": "The type of Cloud Dataflow job.", 1715 "description": "The type of Cloud Dataflow job.",
1761 "enum": [ 1716 "enum": [
1762 "JOB_TYPE_UNKNOWN", 1717 "JOB_TYPE_UNKNOWN",
1763 "JOB_TYPE_BATCH", 1718 "JOB_TYPE_BATCH",
1764 "JOB_TYPE_STREAMING" 1719 "JOB_TYPE_STREAMING"
1765 ], 1720 ],
1766 "enumDescriptions": [ 1721 "enumDescriptions": [
1767 "The type of the job is unspecified, or unknown.", 1722 "The type of the job is unspecified, or unknown.",
1768 "A batch job with a well-defined end point: data is read , data is\nprocessed, data is written, and the job is done.", 1723 "A batch job with a well-defined end point: data is read , data is\nprocessed, data is written, and the job is done.",
1769 "A continuously streaming job with no end: data is read, \nprocessed, and written continuously." 1724 "A continuously streaming job with no end: data is read, \nprocessed, and written continuously."
1770 ], 1725 ],
1771 "type": "string" 1726 "type": "string"
1772 }, 1727 },
1773 "projectId": { 1728 "projectId": {
1774 "description": "The ID of the Cloud Platform project that th e job belongs to.", 1729 "description": "The ID of the Cloud Platform project that th e job belongs to.",
1775 "type": "string" 1730 "type": "string"
1776 }, 1731 },
1732 "pipelineDescription": {
1733 "$ref": "PipelineDescription",
1734 "description": "Preliminary field: The format of this data m ay change at any time.\nA description of the user pipeline and stages through wh ich it is executed.\nCreated by Cloud Dataflow service. Only retrieved with\nJO B_VIEW_DESCRIPTION or JOB_VIEW_ALL."
1735 },
1777 "replaceJobId": { 1736 "replaceJobId": {
1778 "description": "If this job is an update of an existing job, this field is the job ID\nof the job it replaced.\n\nWhen sending a `CreateJobR equest`, you can update a job by specifying it\nhere. The job named here is stop ped, and its intermediate state is\ntransferred to this job.", 1737 "description": "If this job is an update of an existing job, this field is the job ID\nof the job it replaced.\n\nWhen sending a `CreateJobR equest`, you can update a job by specifying it\nhere. The job named here is stop ped, and its intermediate state is\ntransferred to this job.",
1779 "type": "string" 1738 "type": "string"
1780 }
1781 },
1782 "type": "object"
1783 },
1784 "DynamicSourceSplit": {
1785 "description": "When a task splits using WorkItemStatus.dynamic_sour ce_split, this\nmessage describes the two parts of the split relative to the\nde scription of the current task's input.",
1786 "id": "DynamicSourceSplit",
1787 "properties": {
1788 "residual": {
1789 "$ref": "DerivedSource",
1790 "description": "Residual part (returned to the pool of work) .\nSpecified relative to the previously-current source."
1791 }, 1739 },
1792 "primary": { 1740 "requestedState": {
1793 "$ref": "DerivedSource", 1741 "description": "The job's requested state.\n\n`UpdateJob` ma y be used to switch between the `JOB_STATE_STOPPED` and\n`JOB_STATE_RUNNING` sta tes, by setting requested_state. `UpdateJob` may\nalso be used to directly set a job's requested state to\n`JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocab ly terminating the\njob if it has not already reached a terminal state.",
1794 "description": "Primary part (continued to be processed by w orker).\nSpecified relative to the previously-current source.\nBecomes current."
1795 }
1796 },
1797 "type": "object"
1798 },
1799 "DerivedSource": {
1800 "description": "Specification of one of the bundles produced as a re sult of splitting\na Source (e.g. when executing a SourceSplitRequest, or when\n splitting an active task using WorkItemStatus.dynamic_source_split),\nrelative t o the source being split.",
1801 "id": "DerivedSource",
1802 "properties": {
1803 "source": {
1804 "$ref": "Source",
1805 "description": "Specification of the source."
1806 },
1807 "derivationMode": {
1808 "description": "What source to base the produced source on ( if any).",
1809 "enum": [ 1742 "enum": [
1810 "SOURCE_DERIVATION_MODE_UNKNOWN", 1743 "JOB_STATE_UNKNOWN",
1811 "SOURCE_DERIVATION_MODE_INDEPENDENT", 1744 "JOB_STATE_STOPPED",
1812 "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT", 1745 "JOB_STATE_RUNNING",
1813 "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT" 1746 "JOB_STATE_DONE",
1747 "JOB_STATE_FAILED",
1748 "JOB_STATE_CANCELLED",
1749 "JOB_STATE_UPDATED",
1750 "JOB_STATE_DRAINING",
1751 "JOB_STATE_DRAINED"
1814 ], 1752 ],
1815 "enumDescriptions": [ 1753 "enumDescriptions": [
1816 "The source derivation is unknown, or unspecified.", 1754 "The job's run state isn't specified.",
1817 "Produce a completely independent Source with no base.", 1755 "`JOB_STATE_STOPPED` indicates that the job has not\nyet started to run.",
1818 "Produce a Source based on the Source being split.", 1756 "`JOB_STATE_RUNNING` indicates that the job is currently running.",
1819 "Produce a Source based on the base of the Source being split." 1757 "`JOB_STATE_DONE` indicates that the job has successfull y completed.\nThis is a terminal job state. This state may be set by the Cloud Dataflow\nservice, as a transition from `JOB_STATE_RUNNING`. It may also be set via a\nCloud Dataflow `UpdateJob` call, if the job has not yet reached a termina l\nstate.",
1758 "`JOB_STATE_FAILED` indicates that the job has failed. This is a\nterminal job state. This state may only be set by the Cloud Dataflow \nservice, and only as a transition from `JOB_STATE_RUNNING`.",
1759 "`JOB_STATE_CANCELLED` indicates that the job has been e xplicitly\ncancelled. This is a terminal job state. This state may only be\nset via a Cloud Dataflow `UpdateJob` call, and only if the job has not\nyet reached another terminal state.",
1760 "`JOB_STATE_UPDATED` indicates that the job was successf ully updated,\nmeaning that this job was stopped and another job was started, in heriting\nstate from this one. This is a terminal job state. This state may only be\nset by the Cloud Dataflow service, and only as a transition from\n`JOB_STAT E_RUNNING`.",
1761 "`JOB_STATE_DRAINING` indicates that the job is in the p rocess of draining.\nA draining job has stopped pulling from its input sources a nd is processing\nany data that remains in-flight. This state may be set via a C loud Dataflow\n`UpdateJob` call, but only as a transition from `JOB_STATE_RUNNIN G`. Jobs\nthat are draining may only transition to `JOB_STATE_DRAINED`,\n`JOB_ST ATE_CANCELLED`, or `JOB_STATE_FAILED`.",
1762 "`JOB_STATE_DRAINED` indicates that the job has been dra ined.\nA drained job terminated by stopping pulling from its input sources and\n processing any data that remained in-flight when draining was requested.\nThis s tate is a terminal state, may only be set by the Cloud Dataflow\nservice, and on ly as a transition from `JOB_STATE_DRAINING`."
1820 ], 1763 ],
1821 "type": "string" 1764 "type": "string"
1765 },
1766 "tempFiles": {
1767 "description": "A set of files the system should be aware of that are used\nfor temporary storage. These temporary files will be\nremoved on job completion.\nNo duplicates are allowed.\nNo file patterns are supported.\n\ nThe supported files are:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/ {bucket}/{object}\n bucket.storage.googleapis.com/{object}",
1768 "items": {
1769 "type": "string"
1770 },
1771 "type": "array"
1772 },
1773 "clientRequestId": {
1774 "description": "The client's unique identifier of the job, r e-used across retried attempts.\nIf this field is set, the service will ensure i ts uniqueness.\nThe request to create a job will fail if the service has knowled ge of a\npreviously submitted job with the same client's ID and job name.\nThe c aller may use this field to ensure idempotence of job\ncreation across retried a ttempts to create a job.\nBy default, the field is empty and, in that case, the service ignores it.",
1775 "type": "string"
1776 },
1777 "name": {
1778 "description": "The user-specified Cloud Dataflow job name.\ n\nOnly one Job with a given name may exist in a project at any\ngiven time. If a caller attempts to create a Job with the same\nname as an already-existing Job , the attempt returns the\nexisting Job.\n\nThe name must match the regular expr ession\n`[a-z]([-a-z0-9]{0,38}[a-z0-9])?`",
1779 "type": "string"
1822 } 1780 }
1823 }, 1781 },
1824 "type": "object" 1782 "type": "object"
1825 }, 1783 },
1826 "SourceOperationResponse": { 1784 "SourceOperationResponse": {
1827 "description": "The result of a SourceOperationRequest, specified in \nReportWorkItemStatusRequest.source_operation when the work item\nis completed. ", 1785 "description": "The result of a SourceOperationRequest, specified in \nReportWorkItemStatusRequest.source_operation when the work item\nis completed. ",
1828 "id": "SourceOperationResponse", 1786 "id": "SourceOperationResponse",
1829 "properties": { 1787 "properties": {
1830 "split": { 1788 "split": {
1831 "$ref": "SourceSplitResponse", 1789 "$ref": "SourceSplitResponse",
1832 "description": "A response to a request to split a source." 1790 "description": "A response to a request to split a source."
1833 }, 1791 },
1834 "getMetadata": { 1792 "getMetadata": {
1835 "$ref": "SourceGetMetadataResponse", 1793 "$ref": "SourceGetMetadataResponse",
1836 "description": "A response to a request to get metadata abou t a source." 1794 "description": "A response to a request to get metadata abou t a source."
1837 } 1795 }
1838 }, 1796 },
1839 "type": "object" 1797 "type": "object"
1840 }, 1798 },
1841 "SendDebugCaptureResponse": {
1842 "description": "Response to a send capture request.\nnothing",
1843 "id": "SendDebugCaptureResponse",
1844 "properties": {},
1845 "type": "object"
1846 },
1847 "SideInputInfo": { 1799 "SideInputInfo": {
1848 "description": "Information about a side input of a DoFn or an input of a SeqDoFn.", 1800 "description": "Information about a side input of a DoFn or an input of a SeqDoFn.",
1849 "id": "SideInputInfo", 1801 "id": "SideInputInfo",
1850 "properties": { 1802 "properties": {
1851 "sources": { 1803 "sources": {
1852 "description": "The source(s) to read element(s) from to get the value of this side input.\nIf more than one source, then the elements are t aken from the\nsources, in the specified order if order matters.\nAt least one s ource is required.", 1804 "description": "The source(s) to read element(s) from to get the value of this side input.\nIf more than one source, then the elements are t aken from the\nsources, in the specified order if order matters.\nAt least one s ource is required.",
1853 "items": { 1805 "items": {
1854 "$ref": "Source" 1806 "$ref": "Source"
1855 }, 1807 },
1856 "type": "array" 1808 "type": "array"
1857 }, 1809 },
1858 "kind": { 1810 "kind": {
1859 "additionalProperties": { 1811 "additionalProperties": {
1860 "description": "Properties of the object.", 1812 "description": "Properties of the object.",
1861 "type": "any" 1813 "type": "any"
1862 }, 1814 },
1863 "description": "How to interpret the source element(s) as a side input value.", 1815 "description": "How to interpret the source element(s) as a side input value.",
1864 "type": "object" 1816 "type": "object"
1865 }, 1817 },
1866 "tag": { 1818 "tag": {
1867 "description": "The id of the tag the user code will access this side input by;\nthis should correspond to the tag of some MultiOutputInfo." , 1819 "description": "The id of the tag the user code will access this side input by;\nthis should correspond to the tag of some MultiOutputInfo." ,
1868 "type": "string" 1820 "type": "string"
1869 } 1821 }
1870 }, 1822 },
1871 "type": "object" 1823 "type": "object"
1872 }, 1824 },
1873 "ConcatPosition": { 1825 "SendDebugCaptureResponse": {
1874 "description": "A position that encapsulates an inner position and a n index for the inner\nposition. A ConcatPosition can be used by a reader of a s ource that\nencapsulates a set of other sources.", 1826 "description": "Response to a send capture request.\nnothing",
1875 "id": "ConcatPosition", 1827 "id": "SendDebugCaptureResponse",
1876 "properties": { 1828 "properties": {},
1877 "position": {
1878 "$ref": "Position",
1879 "description": "Position within the inner source."
1880 },
1881 "index": {
1882 "description": "Index of the inner source.",
1883 "format": "int32",
1884 "type": "integer"
1885 }
1886 },
1887 "type": "object" 1829 "type": "object"
1888 }, 1830 },
1889 "WriteInstruction": { 1831 "WriteInstruction": {
1890 "description": "An instruction that writes records.\nTakes one input , produces no outputs.", 1832 "description": "An instruction that writes records.\nTakes one input , produces no outputs.",
1891 "id": "WriteInstruction", 1833 "id": "WriteInstruction",
1892 "properties": { 1834 "properties": {
1893 "input": { 1835 "input": {
1894 "$ref": "InstructionInput", 1836 "$ref": "InstructionInput",
1895 "description": "The input." 1837 "description": "The input."
1896 }, 1838 },
1897 "sink": { 1839 "sink": {
1898 "$ref": "Sink", 1840 "$ref": "Sink",
1899 "description": "The sink to write to." 1841 "description": "The sink to write to."
1900 } 1842 }
1901 }, 1843 },
1902 "type": "object" 1844 "type": "object"
1903 }, 1845 },
1846 "ConcatPosition": {
1847 "description": "A position that encapsulates an inner position and a n index for the inner\nposition. A ConcatPosition can be used by a reader of a s ource that\nencapsulates a set of other sources.",
1848 "id": "ConcatPosition",
1849 "properties": {
1850 "position": {
1851 "$ref": "Position",
1852 "description": "Position within the inner source."
1853 },
1854 "index": {
1855 "description": "Index of the inner source.",
1856 "format": "int32",
1857 "type": "integer"
1858 }
1859 },
1860 "type": "object"
1861 },
1904 "CounterStructuredNameAndMetadata": { 1862 "CounterStructuredNameAndMetadata": {
1905 "description": "A single message which encapsulates structured name and metadata for a given\ncounter.", 1863 "description": "A single message which encapsulates structured name and metadata for a given\ncounter.",
1906 "id": "CounterStructuredNameAndMetadata", 1864 "id": "CounterStructuredNameAndMetadata",
1907 "properties": { 1865 "properties": {
1908 "name": { 1866 "name": {
1909 "$ref": "CounterStructuredName", 1867 "$ref": "CounterStructuredName",
1910 "description": "Structured name of the counter." 1868 "description": "Structured name of the counter."
1911 }, 1869 },
1912 "metadata": { 1870 "metadata": {
1913 "$ref": "CounterMetadata", 1871 "$ref": "CounterMetadata",
(...skipping 39 matching lines...) Expand 10 before | Expand all | Expand 10 after
1953 }, 1911 },
1954 "type": "array" 1912 "type": "array"
1955 }, 1913 },
1956 "computationId": { 1914 "computationId": {
1957 "description": "The ID of the computation.", 1915 "description": "The ID of the computation.",
1958 "type": "string" 1916 "type": "string"
1959 } 1917 }
1960 }, 1918 },
1961 "type": "object" 1919 "type": "object"
1962 }, 1920 },
1921 "ExecutionStageSummary": {
1922 "description": "Description of the composing transforms, names/ids, and input/outputs of a\nstage of execution. Some composing transforms and sourc es may have been\ngenerated by the Dataflow service during execution planning.",
1923 "id": "ExecutionStageSummary",
1924 "properties": {
1925 "outputSource": {
1926 "description": "Output sources for this stage.",
1927 "items": {
1928 "$ref": "StageSource"
1929 },
1930 "type": "array"
1931 },
1932 "name": {
1933 "description": "Dataflow service generated name for this sta ge.",
1934 "type": "string"
1935 },
1936 "inputSource": {
1937 "description": "Input sources for this stage.",
1938 "items": {
1939 "$ref": "StageSource"
1940 },
1941 "type": "array"
1942 },
1943 "id": {
1944 "description": "Dataflow service generated id for this stage .",
1945 "type": "string"
1946 },
1947 "componentTransform": {
1948 "description": "Transforms that comprise this execution stag e.",
1949 "items": {
1950 "$ref": "ComponentTransform"
1951 },
1952 "type": "array"
1953 },
1954 "componentSource": {
1955 "description": "Collections produced and consumed by compone nt transforms of this stage.",
1956 "items": {
1957 "$ref": "ComponentSource"
1958 },
1959 "type": "array"
1960 },
1961 "kind": {
1962 "description": "Type of tranform this stage is executing.",
1963 "enum": [
1964 "UNKNOWN_KIND",
1965 "PAR_DO_KIND",
1966 "GROUP_BY_KEY_KIND",
1967 "FLATTEN_KIND",
1968 "READ_KIND",
1969 "WRITE_KIND",
1970 "CONSTANT_KIND",
1971 "SINGLETON_KIND",
1972 "SHUFFLE_KIND"
1973 ],
1974 "enumDescriptions": [
1975 "Unrecognized transform type.",
1976 "ParDo transform.",
1977 "Group By Key transform.",
1978 "Flatten transform.",
1979 "Read transform.",
1980 "Write transform.",
1981 "Constructs from a constant value, such as with Create.o f.",
1982 "Creates a Singleton view of a collection.",
1983 "Opening or closing a shuffle session, often as part of a GroupByKey."
1984 ],
1985 "type": "string"
1986 }
1987 },
1988 "type": "object"
1989 },
1963 "SendWorkerMessagesRequest": { 1990 "SendWorkerMessagesRequest": {
1964 "description": "A request for sending worker messages to the service .", 1991 "description": "A request for sending worker messages to the service .",
1965 "id": "SendWorkerMessagesRequest", 1992 "id": "SendWorkerMessagesRequest",
1966 "properties": { 1993 "properties": {
1967 "workerMessages": { 1994 "workerMessages": {
1968 "description": "The WorkerMessages to send.", 1995 "description": "The WorkerMessages to send.",
1969 "items": { 1996 "items": {
1970 "$ref": "WorkerMessage" 1997 "$ref": "WorkerMessage"
1971 }, 1998 },
1972 "type": "array" 1999 "type": "array"
(...skipping 25 matching lines...) Expand all
1998 "$ref": "Source", 2025 "$ref": "Source",
1999 "description": "DEPRECATED" 2026 "description": "DEPRECATED"
2000 } 2027 }
2001 }, 2028 },
2002 "type": "object" 2029 "type": "object"
2003 }, 2030 },
2004 "CPUTime": { 2031 "CPUTime": {
2005 "description": "Modeled after information exposed by /proc/stat.", 2032 "description": "Modeled after information exposed by /proc/stat.",
2006 "id": "CPUTime", 2033 "id": "CPUTime",
2007 "properties": { 2034 "properties": {
2008 "totalMs": {
2009 "description": "Total active CPU time across all cores (ie., non-idle) in milliseconds\nsince start-up.",
2010 "format": "uint64",
2011 "type": "string"
2012 },
2013 "rate": { 2035 "rate": {
2014 "description": "Average CPU utilization rate (% non-idle cpu / second) since previous\nsample.", 2036 "description": "Average CPU utilization rate (% non-idle cpu / second) since previous\nsample.",
2015 "format": "double", 2037 "format": "double",
2016 "type": "number" 2038 "type": "number"
2017 }, 2039 },
2018 "timestamp": { 2040 "timestamp": {
2019 "description": "Timestamp of the measurement.", 2041 "description": "Timestamp of the measurement.",
2020 "format": "google-datetime", 2042 "format": "google-datetime",
2021 "type": "string" 2043 "type": "string"
2044 },
2045 "totalMs": {
2046 "description": "Total active CPU time across all cores (ie., non-idle) in milliseconds\nsince start-up.",
2047 "format": "uint64",
2048 "type": "string"
2022 } 2049 }
2023 }, 2050 },
2024 "type": "object" 2051 "type": "object"
2025 }, 2052 },
2026 "Environment": { 2053 "Environment": {
2027 "description": "Describes the environment in which a Dataflow Job ru ns.", 2054 "description": "Describes the environment in which a Dataflow Job ru ns.",
2028 "id": "Environment", 2055 "id": "Environment",
2029 "properties": { 2056 "properties": {
2057 "serviceAccountEmail": {
2058 "description": "Identity to run virtual machines as. Default s to the default account.",
2059 "type": "string"
2060 },
2061 "userAgent": {
2062 "additionalProperties": {
2063 "description": "Properties of the object.",
2064 "type": "any"
2065 },
2066 "description": "A description of the process that generated the request.",
2067 "type": "object"
2068 },
2069 "sdkPipelineOptions": {
2070 "additionalProperties": {
2071 "description": "Properties of the object.",
2072 "type": "any"
2073 },
2074 "description": "The Cloud Dataflow SDK pipeline options spec ified by the user. These\noptions are passed through the service and are used to recreate the\nSDK pipeline options on the worker in a language agnostic and pla tform\nindependent way.",
2075 "type": "object"
2076 },
2030 "clusterManagerApiService": { 2077 "clusterManagerApiService": {
2031 "description": "The type of cluster manager API to use. If unknown or\nunspecified, the service will attempt to choose a reasonable\ndefaul t. This should be in the form of the API service name,\ne.g. \"compute.googleap is.com\".", 2078 "description": "The type of cluster manager API to use. If unknown or\nunspecified, the service will attempt to choose a reasonable\ndefaul t. This should be in the form of the API service name,\ne.g. \"compute.googleap is.com\".",
2032 "type": "string" 2079 "type": "string"
2033 }, 2080 },
2034 "tempStoragePrefix": { 2081 "tempStoragePrefix": {
2035 "description": "The prefix of the resources the system shoul d use for temporary\nstorage. The system will append the suffix \"/temp-{JOBNAM E} to\nthis resource prefix, where {JOBNAME} is the value of the\njob_name field . The resulting bucket and object prefix is used\nas the prefix of the resource s used to store temporary data\nneeded during the job execution. NOTE: This wil l override the\nvalue in taskrunner_settings.\nThe supported resource type is:\n \nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket. storage.googleapis.com/{object}", 2082 "description": "The prefix of the resources the system shoul d use for temporary\nstorage. The system will append the suffix \"/temp-{JOBNAM E} to\nthis resource prefix, where {JOBNAME} is the value of the\njob_name field . The resulting bucket and object prefix is used\nas the prefix of the resource s used to store temporary data\nneeded during the job execution. NOTE: This wil l override the\nvalue in taskrunner_settings.\nThe supported resource type is:\n \nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket. storage.googleapis.com/{object}",
2036 "type": "string" 2083 "type": "string"
2037 }, 2084 },
2038 "workerPools": { 2085 "workerPools": {
2039 "description": "The worker pools. At least one \"harness\" w orker pool must be\nspecified in order for the job to have workers.", 2086 "description": "The worker pools. At least one \"harness\" w orker pool must be\nspecified in order for the job to have workers.",
2040 "items": { 2087 "items": {
2041 "$ref": "WorkerPool" 2088 "$ref": "WorkerPool"
2042 }, 2089 },
2043 "type": "array" 2090 "type": "array"
2044 }, 2091 },
2045 "dataset": { 2092 "dataset": {
2046 "description": "The dataset for the current project where va rious workflow\nrelated tables are stored.\n\nThe supported resource type is:\n\ nGoogle BigQuery:\n bigquery.googleapis.com/{dataset}", 2093 "description": "The dataset for the current project where va rious workflow\nrelated tables are stored.\n\nThe supported resource type is:\n\ nGoogle BigQuery:\n bigquery.googleapis.com/{dataset}",
2047 "type": "string" 2094 "type": "string"
2048 }, 2095 },
2049 "experiments": { 2096 "experiments": {
2050 "description": "The list of experiments to enable.", 2097 "description": "The list of experiments to enable.",
2051 "items": { 2098 "items": {
2052 "type": "string" 2099 "type": "string"
2053 }, 2100 },
2054 "type": "array" 2101 "type": "array"
2055 }, 2102 },
2056 "internalExperiments": {
2057 "additionalProperties": {
2058 "description": "Properties of the object. Contains field @type with type URL.",
2059 "type": "any"
2060 },
2061 "description": "Experimental settings.",
2062 "type": "object"
2063 },
2064 "version": { 2103 "version": {
2065 "additionalProperties": { 2104 "additionalProperties": {
2066 "description": "Properties of the object.", 2105 "description": "Properties of the object.",
2067 "type": "any" 2106 "type": "any"
2068 }, 2107 },
2069 "description": "A structure describing which components and their versions of the service\nare required in order to run the job.", 2108 "description": "A structure describing which components and their versions of the service\nare required in order to run the job.",
2070 "type": "object" 2109 "type": "object"
2071 }, 2110 },
2072 "serviceAccountEmail": { 2111 "internalExperiments": {
2073 "description": "Identity to run virtual machines as. Default s to the default account.",
2074 "type": "string"
2075 },
2076 "userAgent": {
2077 "additionalProperties": { 2112 "additionalProperties": {
2078 "description": "Properties of the object.", 2113 "description": "Properties of the object. Contains field @type with type URL.",
2079 "type": "any" 2114 "type": "any"
2080 }, 2115 },
2081 "description": "A description of the process that generated the request.", 2116 "description": "Experimental settings.",
2082 "type": "object"
2083 },
2084 "sdkPipelineOptions": {
2085 "additionalProperties": {
2086 "description": "Properties of the object.",
2087 "type": "any"
2088 },
2089 "description": "The Cloud Dataflow SDK pipeline options spec ified by the user. These\noptions are passed through the service and are used to recreate the\nSDK pipeline options on the worker in a language agnostic and pla tform\nindependent way.",
2090 "type": "object" 2117 "type": "object"
2091 } 2118 }
2092 }, 2119 },
2093 "type": "object" 2120 "type": "object"
2094 }, 2121 },
2095 "StreamingComputationTask": { 2122 "StreamingComputationTask": {
2096 "description": "A task which describes what action should be perform ed for the specified\nstreaming computation ranges.", 2123 "description": "A task which describes what action should be perform ed for the specified\nstreaming computation ranges.",
2097 "id": "StreamingComputationTask", 2124 "id": "StreamingComputationTask",
2098 "properties": { 2125 "properties": {
2099 "dataDisks": {
2100 "description": "Describes the set of data disks this task sh ould apply to.",
2101 "items": {
2102 "$ref": "MountedDataDisk"
2103 },
2104 "type": "array"
2105 },
2106 "taskType": { 2126 "taskType": {
2107 "description": "A type of streaming computation task.", 2127 "description": "A type of streaming computation task.",
2108 "enum": [ 2128 "enum": [
2109 "STREAMING_COMPUTATION_TASK_UNKNOWN", 2129 "STREAMING_COMPUTATION_TASK_UNKNOWN",
2110 "STREAMING_COMPUTATION_TASK_STOP", 2130 "STREAMING_COMPUTATION_TASK_STOP",
2111 "STREAMING_COMPUTATION_TASK_START" 2131 "STREAMING_COMPUTATION_TASK_START"
2112 ], 2132 ],
2113 "enumDescriptions": [ 2133 "enumDescriptions": [
2114 "The streaming computation task is unknown, or unspecifi ed.", 2134 "The streaming computation task is unknown, or unspecifi ed.",
2115 "Stop processing specified streaming computation range(s ).", 2135 "Stop processing specified streaming computation range(s ).",
2116 "Start processing specified streaming computation range( s)." 2136 "Start processing specified streaming computation range( s)."
2117 ], 2137 ],
2118 "type": "string" 2138 "type": "string"
2119 }, 2139 },
2120 "computationRanges": { 2140 "computationRanges": {
2121 "description": "Contains ranges of a streaming computation t his task should apply to.", 2141 "description": "Contains ranges of a streaming computation t his task should apply to.",
2122 "items": { 2142 "items": {
2123 "$ref": "StreamingComputationRanges" 2143 "$ref": "StreamingComputationRanges"
2124 }, 2144 },
2125 "type": "array" 2145 "type": "array"
2146 },
2147 "dataDisks": {
2148 "description": "Describes the set of data disks this task sh ould apply to.",
2149 "items": {
2150 "$ref": "MountedDataDisk"
2151 },
2152 "type": "array"
2126 } 2153 }
2127 }, 2154 },
2128 "type": "object" 2155 "type": "object"
2129 }, 2156 },
2130 "SendDebugCaptureRequest": { 2157 "SendDebugCaptureRequest": {
2131 "description": "Request to send encoded debug information.", 2158 "description": "Request to send encoded debug information.",
2132 "id": "SendDebugCaptureRequest", 2159 "id": "SendDebugCaptureRequest",
2133 "properties": { 2160 "properties": {
2161 "data": {
2162 "description": "The encoded debug information.",
2163 "type": "string"
2164 },
2134 "componentId": { 2165 "componentId": {
2135 "description": "The internal component id for which debug in formation is sent.", 2166 "description": "The internal component id for which debug in formation is sent.",
2136 "type": "string" 2167 "type": "string"
2137 }, 2168 },
2138 "workerId": { 2169 "workerId": {
2139 "description": "The worker id, i.e., VM hostname.", 2170 "description": "The worker id, i.e., VM hostname.",
2140 "type": "string" 2171 "type": "string"
2141 },
2142 "data": {
2143 "description": "The encoded debug information.",
2144 "type": "string"
2145 } 2172 }
2146 }, 2173 },
2147 "type": "object" 2174 "type": "object"
2148 }, 2175 },
2149 "GetDebugConfigResponse": { 2176 "GetDebugConfigResponse": {
2150 "description": "Response to a get debug configuration request.", 2177 "description": "Response to a get debug configuration request.",
2151 "id": "GetDebugConfigResponse", 2178 "id": "GetDebugConfigResponse",
2152 "properties": { 2179 "properties": {
2153 "config": { 2180 "config": {
2154 "description": "The encoded debug configuration for the requ ested component.", 2181 "description": "The encoded debug configuration for the requ ested component.",
2155 "type": "string" 2182 "type": "string"
2156 } 2183 }
2157 }, 2184 },
2158 "type": "object" 2185 "type": "object"
2159 }, 2186 },
2187 "ComponentTransform": {
2188 "description": "Description of a transform executed as part of an ex ecution stage.",
2189 "id": "ComponentTransform",
2190 "properties": {
2191 "name": {
2192 "description": "Dataflow service generated name for this sou rce.",
2193 "type": "string"
2194 },
2195 "userName": {
2196 "description": "Human-readable name for this transform; may be user or system generated.",
2197 "type": "string"
2198 },
2199 "originalTransform": {
2200 "description": "User name for the original user transform wi th which this transform is\nmost closely associated.",
2201 "type": "string"
2202 }
2203 },
2204 "type": "object"
2205 },
2160 "StreamingSetupTask": { 2206 "StreamingSetupTask": {
2161 "description": "A task which initializes part of a streaming Dataflo w job.", 2207 "description": "A task which initializes part of a streaming Dataflo w job.",
2162 "id": "StreamingSetupTask", 2208 "id": "StreamingSetupTask",
2163 "properties": { 2209 "properties": {
2210 "streamingComputationTopology": {
2211 "$ref": "TopologyConfig",
2212 "description": "The global topology of the streaming Dataflo w job."
2213 },
2164 "workerHarnessPort": { 2214 "workerHarnessPort": {
2165 "description": "The TCP port used by the worker to communica te with the Dataflow\nworker harness.", 2215 "description": "The TCP port used by the worker to communica te with the Dataflow\nworker harness.",
2166 "format": "int32", 2216 "format": "int32",
2167 "type": "integer" 2217 "type": "integer"
2168 }, 2218 },
2169 "drain": { 2219 "drain": {
2170 "description": "The user has requested drain.", 2220 "description": "The user has requested drain.",
2171 "type": "boolean" 2221 "type": "boolean"
2172 }, 2222 },
2173 "receiveWorkPort": { 2223 "receiveWorkPort": {
2174 "description": "The TCP port on which the worker should list en for messages from\nother streaming computation workers.", 2224 "description": "The TCP port on which the worker should list en for messages from\nother streaming computation workers.",
2175 "format": "int32", 2225 "format": "int32",
2176 "type": "integer" 2226 "type": "integer"
2177 },
2178 "streamingComputationTopology": {
2179 "$ref": "TopologyConfig",
2180 "description": "The global topology of the streaming Dataflo w job."
2181 } 2227 }
2182 }, 2228 },
2183 "type": "object" 2229 "type": "object"
2184 }, 2230 },
2185 "PubsubLocation": { 2231 "PubsubLocation": {
2186 "description": "Identifies a pubsub location to use for transferring data into or\nout of a streaming Dataflow job.", 2232 "description": "Identifies a pubsub location to use for transferring data into or\nout of a streaming Dataflow job.",
2187 "id": "PubsubLocation", 2233 "id": "PubsubLocation",
2188 "properties": { 2234 "properties": {
2189 "withAttributes": { 2235 "withAttributes": {
2190 "description": "If true, then the client has requested to ge t pubsub attributes.", 2236 "description": "If true, then the client has requested to ge t pubsub attributes.",
2191 "type": "boolean" 2237 "type": "boolean"
2192 }, 2238 },
2193 "idLabel": { 2239 "idLabel": {
2194 "description": "If set, contains a pubsub label from which t o extract record ids.\nIf left empty, record deduplication will be strictly best effort.", 2240 "description": "If set, contains a pubsub label from which t o extract record ids.\nIf left empty, record deduplication will be strictly best effort.",
2195 "type": "string" 2241 "type": "string"
2196 }, 2242 },
2243 "timestampLabel": {
2244 "description": "If set, contains a pubsub label from which t o extract record timestamps.\nIf left empty, record timestamps will be generated upon arrival.",
2245 "type": "string"
2246 },
2197 "topic": { 2247 "topic": {
2198 "description": "A pubsub topic, in the form of\n\"pubsub.goo gleapis.com/topics/<project-id>/<topic-name>\"", 2248 "description": "A pubsub topic, in the form of\n\"pubsub.goo gleapis.com/topics/<project-id>/<topic-name>\"",
2199 "type": "string" 2249 "type": "string"
2200 }, 2250 },
2201 "timestampLabel": {
2202 "description": "If set, contains a pubsub label from which t o extract record timestamps.\nIf left empty, record timestamps will be generated upon arrival.",
2203 "type": "string"
2204 },
2205 "subscription": { 2251 "subscription": {
2206 "description": "A pubsub subscription, in the form of\n\"pub sub.googleapis.com/subscriptions/<project-id>/<subscription-name>\"", 2252 "description": "A pubsub subscription, in the form of\n\"pub sub.googleapis.com/subscriptions/<project-id>/<subscription-name>\"",
2207 "type": "string" 2253 "type": "string"
2208 }, 2254 },
2209 "dropLateData": { 2255 "dropLateData": {
2210 "description": "Indicates whether the pipeline allows late-a rriving data.", 2256 "description": "Indicates whether the pipeline allows late-a rriving data.",
2211 "type": "boolean" 2257 "type": "boolean"
2212 }, 2258 },
2213 "trackingSubscription": { 2259 "trackingSubscription": {
2214 "description": "If set, specifies the pubsub subscription th at will be used for tracking\ncustom time timestamps for watermark estimation.", 2260 "description": "If set, specifies the pubsub subscription th at will be used for tracking\ncustom time timestamps for watermark estimation.",
2215 "type": "string" 2261 "type": "string"
2216 } 2262 }
2217 }, 2263 },
2218 "type": "object" 2264 "type": "object"
2219 }, 2265 },
2220 "WorkerHealthReport": { 2266 "WorkerHealthReport": {
2221 "description": "WorkerHealthReport contains information about the he alth of a worker.\n\nThe VM should be identified by the labels attached to the W orkerMessage that\nthis health ping belongs to.", 2267 "description": "WorkerHealthReport contains information about the he alth of a worker.\n\nThe VM should be identified by the labels attached to the W orkerMessage that\nthis health ping belongs to.",
2222 "id": "WorkerHealthReport", 2268 "id": "WorkerHealthReport",
2223 "properties": { 2269 "properties": {
2270 "vmIsHealthy": {
2271 "description": "Whether the VM is healthy.",
2272 "type": "boolean"
2273 },
2274 "reportInterval": {
2275 "description": "The interval at which the worker is sending health reports.\nThe default value of 0 should be interpreted as the field is no t being\nexplicitly set by the worker.",
2276 "format": "google-duration",
2277 "type": "string"
2278 },
2224 "pods": { 2279 "pods": {
2225 "description": "The pods running on the worker. See:\nhttp:/ /kubernetes.io/v1.1/docs/api-reference/v1/definitions.html#_v1_pod\n\nThis field is used by the worker to send the status of the indvidual\ncontainers running o n each worker.", 2280 "description": "The pods running on the worker. See:\nhttp:/ /kubernetes.io/v1.1/docs/api-reference/v1/definitions.html#_v1_pod\n\nThis field is used by the worker to send the status of the indvidual\ncontainers running o n each worker.",
2226 "items": { 2281 "items": {
2227 "additionalProperties": { 2282 "additionalProperties": {
2228 "description": "Properties of the object.", 2283 "description": "Properties of the object.",
2229 "type": "any" 2284 "type": "any"
2230 }, 2285 },
2231 "type": "object" 2286 "type": "object"
2232 }, 2287 },
2233 "type": "array" 2288 "type": "array"
2234 }, 2289 },
2235 "vmStartupTime": { 2290 "vmStartupTime": {
2236 "description": "The time the VM was booted.", 2291 "description": "The time the VM was booted.",
2237 "format": "google-datetime", 2292 "format": "google-datetime",
2238 "type": "string" 2293 "type": "string"
2239 },
2240 "vmIsHealthy": {
2241 "description": "Whether the VM is healthy.",
2242 "type": "boolean"
2243 },
2244 "reportInterval": {
2245 "description": "The interval at which the worker is sending health reports.\nThe default value of 0 should be interpreted as the field is no t being\nexplicitly set by the worker.",
2246 "format": "google-duration",
2247 "type": "string"
2248 } 2294 }
2249 }, 2295 },
2250 "type": "object" 2296 "type": "object"
2251 }, 2297 },
2252 "JobMessage": { 2298 "JobMessage": {
2253 "description": "A particular message pertaining to a Dataflow job.", 2299 "description": "A particular message pertaining to a Dataflow job.",
2254 "id": "JobMessage", 2300 "id": "JobMessage",
2255 "properties": { 2301 "properties": {
2256 "id": { 2302 "id": {
2257 "description": "Identifies the message. This is automatical ly generated by the\nservice; the caller should treat it as an opaque string.", 2303 "description": "Identifies the message. This is automatical ly generated by the\nservice; the caller should treat it as an opaque string.",
(...skipping 24 matching lines...) Expand all
2282 "type": "string" 2328 "type": "string"
2283 }, 2329 },
2284 "time": { 2330 "time": {
2285 "description": "The timestamp of the message.", 2331 "description": "The timestamp of the message.",
2286 "format": "google-datetime", 2332 "format": "google-datetime",
2287 "type": "string" 2333 "type": "string"
2288 } 2334 }
2289 }, 2335 },
2290 "type": "object" 2336 "type": "object"
2291 }, 2337 },
2338 "ParameterMetadata": {
2339 "description": "Metadata for a specific parameter.",
2340 "id": "ParameterMetadata",
2341 "properties": {
2342 "label": {
2343 "description": "Required. The label to display for the param eter.",
2344 "type": "string"
2345 },
2346 "helpText": {
2347 "description": "Required. The help text to display for the p arameter.",
2348 "type": "string"
2349 },
2350 "isOptional": {
2351 "description": "Optional. Whether the parameter is optional. Defaults to false.",
2352 "type": "boolean"
2353 },
2354 "name": {
2355 "description": "Required. The name of the parameter.",
2356 "type": "string"
2357 },
2358 "regexes": {
2359 "description": "Optional. Regexes that the parameter must ma tch.",
2360 "items": {
2361 "type": "string"
2362 },
2363 "type": "array"
2364 }
2365 },
2366 "type": "object"
2367 },
2292 "MultiOutputInfo": { 2368 "MultiOutputInfo": {
2293 "description": "Information about an output of a multi-output DoFn." , 2369 "description": "Information about an output of a multi-output DoFn." ,
2294 "id": "MultiOutputInfo", 2370 "id": "MultiOutputInfo",
2295 "properties": { 2371 "properties": {
2296 "tag": { 2372 "tag": {
2297 "description": "The id of the tag the user code will emit to this output by; this\nshould correspond to the tag of some SideInputInfo.", 2373 "description": "The id of the tag the user code will emit to this output by; this\nshould correspond to the tag of some SideInputInfo.",
2298 "type": "string" 2374 "type": "string"
2299 } 2375 }
2300 }, 2376 },
2301 "type": "object" 2377 "type": "object"
(...skipping 54 matching lines...) Expand 10 before | Expand all | Expand 10 after
2356 "description": "The shell command to run.", 2432 "description": "The shell command to run.",
2357 "type": "string" 2433 "type": "string"
2358 } 2434 }
2359 }, 2435 },
2360 "type": "object" 2436 "type": "object"
2361 }, 2437 },
2362 "TaskRunnerSettings": { 2438 "TaskRunnerSettings": {
2363 "description": "Taskrunner configuration settings.", 2439 "description": "Taskrunner configuration settings.",
2364 "id": "TaskRunnerSettings", 2440 "id": "TaskRunnerSettings",
2365 "properties": { 2441 "properties": {
2366 "baseUrl": {
2367 "description": "The base URL for the taskrunner to use when accessing Google Cloud APIs.\n\nWhen workers access Google Cloud APIs, they logi cally do so via\nrelative URLs. If this field is specified, it supplies the bas e\nURL to use for resolving these relative URLs. The normative\nalgorithm used is defined by RFC 1808, \"Relative Uniform Resource\nLocators\".\n\nIf not speci fied, the default value is \"http://www.googleapis.com/\"",
2368 "type": "string"
2369 },
2370 "logToSerialconsole": {
2371 "description": "Whether to send taskrunner log info to Googl e Compute Engine VM serial\nconsole.",
2372 "type": "boolean"
2373 },
2374 "continueOnException": {
2375 "description": "Whether to continue taskrunner if an excepti on is hit.",
2376 "type": "boolean"
2377 },
2378 "parallelWorkerSettings": {
2379 "$ref": "WorkerSettings",
2380 "description": "The settings to pass to the parallel worker harness."
2381 },
2382 "vmId": {
2383 "description": "The ID string of the VM.",
2384 "type": "string"
2385 },
2386 "taskUser": {
2387 "description": "The UNIX user ID on the worker VM to use for tasks launched by\ntaskrunner; e.g. \"root\".",
2388 "type": "string"
2389 },
2390 "alsologtostderr": {
2391 "description": "Whether to also send taskrunner log info to stderr.",
2392 "type": "boolean"
2393 },
2394 "taskGroup": { 2442 "taskGroup": {
2395 "description": "The UNIX group ID on the worker VM to use fo r tasks launched by\ntaskrunner; e.g. \"wheel\".", 2443 "description": "The UNIX group ID on the worker VM to use fo r tasks launched by\ntaskrunner; e.g. \"wheel\".",
2396 "type": "string" 2444 "type": "string"
2397 }, 2445 },
2398 "harnessCommand": { 2446 "harnessCommand": {
2399 "description": "The command to launch the worker harness.", 2447 "description": "The command to launch the worker harness.",
2400 "type": "string" 2448 "type": "string"
2401 }, 2449 },
2402 "logDir": { 2450 "logDir": {
2403 "description": "The directory on the VM to store logs.", 2451 "description": "The directory on the VM to store logs.",
2404 "type": "string" 2452 "type": "string"
2405 }, 2453 },
2406 "dataflowApiVersion": {
2407 "description": "The API version of endpoint, e.g. \"v1b3\"",
2408 "type": "string"
2409 },
2410 "oauthScopes": { 2454 "oauthScopes": {
2411 "description": "The OAuth2 scopes to be requested by the tas krunner in order to\naccess the Cloud Dataflow API.", 2455 "description": "The OAuth2 scopes to be requested by the tas krunner in order to\naccess the Cloud Dataflow API.",
2412 "items": { 2456 "items": {
2413 "type": "string" 2457 "type": "string"
2414 }, 2458 },
2415 "type": "array" 2459 "type": "array"
2416 }, 2460 },
2417 "streamingWorkerMainClass": { 2461 "dataflowApiVersion": {
2418 "description": "The streaming worker main class name.", 2462 "description": "The API version of endpoint, e.g. \"v1b3\"",
2419 "type": "string" 2463 "type": "string"
2420 }, 2464 },
2421 "logUploadLocation": { 2465 "logUploadLocation": {
2422 "description": "Indicates where to put logs. If this is not specified, the logs\nwill not be uploaded.\n\nThe supported resource type is:\n \nGoogle Cloud Storage:\n storage.googleapis.com/{bucket}/{object}\n bucket.st orage.googleapis.com/{object}", 2466 "description": "Indicates where to put logs. If this is not specified, the logs\nwill not be uploaded.\n\nThe supported resource type is:\n \nGoogle Cloud Storage:\n storage.googleapis.com/{bucket}/{object}\n bucket.st orage.googleapis.com/{object}",
2423 "type": "string" 2467 "type": "string"
2424 }, 2468 },
2469 "streamingWorkerMainClass": {
2470 "description": "The streaming worker main class name.",
2471 "type": "string"
2472 },
2425 "workflowFileName": { 2473 "workflowFileName": {
2426 "description": "The file to store the workflow in.", 2474 "description": "The file to store the workflow in.",
2427 "type": "string" 2475 "type": "string"
2428 }, 2476 },
2429 "commandlinesFileName": {
2430 "description": "The file to store preprocessing commands in. ",
2431 "type": "string"
2432 },
2433 "languageHint": {
2434 "description": "The suggested backend language.",
2435 "type": "string"
2436 },
2437 "tempStoragePrefix": { 2477 "tempStoragePrefix": {
2438 "description": "The prefix of the resources the taskrunner s hould use for\ntemporary storage.\n\nThe supported resource type is:\n\nGoogle C loud Storage:\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.goog leapis.com/{object}", 2478 "description": "The prefix of the resources the taskrunner s hould use for\ntemporary storage.\n\nThe supported resource type is:\n\nGoogle C loud Storage:\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.goog leapis.com/{object}",
2439 "type": "string" 2479 "type": "string"
2440 }, 2480 },
2441 "baseTaskDir": { 2481 "baseTaskDir": {
2442 "description": "The location on the worker for task-specific subdirectories.", 2482 "description": "The location on the worker for task-specific subdirectories.",
2443 "type": "string" 2483 "type": "string"
2484 },
2485 "languageHint": {
2486 "description": "The suggested backend language.",
2487 "type": "string"
2488 },
2489 "commandlinesFileName": {
2490 "description": "The file to store preprocessing commands in. ",
2491 "type": "string"
2492 },
2493 "baseUrl": {
2494 "description": "The base URL for the taskrunner to use when accessing Google Cloud APIs.\n\nWhen workers access Google Cloud APIs, they logi cally do so via\nrelative URLs. If this field is specified, it supplies the bas e\nURL to use for resolving these relative URLs. The normative\nalgorithm used is defined by RFC 1808, \"Relative Uniform Resource\nLocators\".\n\nIf not speci fied, the default value is \"http://www.googleapis.com/\"",
2495 "type": "string"
2496 },
2497 "logToSerialconsole": {
2498 "description": "Whether to send taskrunner log info to Googl e Compute Engine VM serial\nconsole.",
2499 "type": "boolean"
2500 },
2501 "continueOnException": {
2502 "description": "Whether to continue taskrunner if an excepti on is hit.",
2503 "type": "boolean"
2504 },
2505 "parallelWorkerSettings": {
2506 "$ref": "WorkerSettings",
2507 "description": "The settings to pass to the parallel worker harness."
2508 },
2509 "vmId": {
2510 "description": "The ID string of the VM.",
2511 "type": "string"
2512 },
2513 "taskUser": {
2514 "description": "The UNIX user ID on the worker VM to use for tasks launched by\ntaskrunner; e.g. \"root\".",
2515 "type": "string"
2516 },
2517 "alsologtostderr": {
2518 "description": "Whether to also send taskrunner log info to stderr.",
2519 "type": "boolean"
2444 } 2520 }
2445 }, 2521 },
2446 "type": "object" 2522 "type": "object"
2447 }, 2523 },
2448 "Position": { 2524 "Position": {
2449 "description": "Position defines a position within a collection of d ata. The value\ncan be either the end position, a key (used with ordered\ncolle ctions), a byte offset, or a record index.", 2525 "description": "Position defines a position within a collection of d ata. The value\ncan be either the end position, a key (used with ordered\ncolle ctions), a byte offset, or a record index.",
2450 "id": "Position", 2526 "id": "Position",
2451 "properties": { 2527 "properties": {
2528 "recordIndex": {
2529 "description": "Position is a record index.",
2530 "format": "int64",
2531 "type": "string"
2532 },
2452 "shufflePosition": { 2533 "shufflePosition": {
2453 "description": "CloudPosition is a base64 encoded BatchShuff lePosition (with FIXED\nsharding).", 2534 "description": "CloudPosition is a base64 encoded BatchShuff lePosition (with FIXED\nsharding).",
2454 "type": "string" 2535 "type": "string"
2455 }, 2536 },
2456 "concatPosition": { 2537 "concatPosition": {
2457 "$ref": "ConcatPosition", 2538 "$ref": "ConcatPosition",
2458 "description": "CloudPosition is a concat position." 2539 "description": "CloudPosition is a concat position."
2459 }, 2540 },
2460 "byteOffset": { 2541 "byteOffset": {
2461 "description": "Position is a byte offset.", 2542 "description": "Position is a byte offset.",
2462 "format": "int64", 2543 "format": "int64",
2463 "type": "string" 2544 "type": "string"
2464 }, 2545 },
2465 "end": { 2546 "end": {
2466 "description": "Position is past all other positions. Also u seful for the end\nposition of an unbounded range.", 2547 "description": "Position is past all other positions. Also u seful for the end\nposition of an unbounded range.",
2467 "type": "boolean" 2548 "type": "boolean"
2468 }, 2549 },
2469 "key": { 2550 "key": {
2470 "description": "Position is a string key, ordered lexicograp hically.", 2551 "description": "Position is a string key, ordered lexicograp hically.",
2471 "type": "string" 2552 "type": "string"
2472 },
2473 "recordIndex": {
2474 "description": "Position is a record index.",
2475 "format": "int64",
2476 "type": "string"
2477 } 2553 }
2478 }, 2554 },
2479 "type": "object" 2555 "type": "object"
2480 }, 2556 },
2481 "SplitInt64": { 2557 "SplitInt64": {
2482 "description": "A representation of an int64, n, that is immune to p recision loss when\nencoded in JSON.", 2558 "description": "A representation of an int64, n, that is immune to p recision loss when\nencoded in JSON.",
2483 "id": "SplitInt64", 2559 "id": "SplitInt64",
2484 "properties": { 2560 "properties": {
2485 "lowBits": { 2561 "lowBits": {
2486 "description": "The low order bits: n & 0xffffffff.", 2562 "description": "The low order bits: n & 0xffffffff.",
2487 "format": "uint32", 2563 "format": "uint32",
2488 "type": "integer" 2564 "type": "integer"
2489 }, 2565 },
2490 "highBits": { 2566 "highBits": {
2491 "description": "The high order bits, including the sign: n > > 32.", 2567 "description": "The high order bits, including the sign: n > > 32.",
2492 "format": "int32", 2568 "format": "int32",
2493 "type": "integer" 2569 "type": "integer"
2494 } 2570 }
2495 }, 2571 },
2496 "type": "object" 2572 "type": "object"
2497 }, 2573 },
2498 "Source": { 2574 "Source": {
2499 "description": "A source that records can be read and decoded from." , 2575 "description": "A source that records can be read and decoded from." ,
2500 "id": "Source", 2576 "id": "Source",
2501 "properties": { 2577 "properties": {
2578 "metadata": {
2579 "$ref": "SourceMetadata",
2580 "description": "Optionally, metadata for this source can be supplied right away,\navoiding a SourceGetMetadataOperation roundtrip\n(see Sour ceOperationRequest).\n\nThis field is meaningful only in the Source objects popu lated\nby the user (e.g. when filling in a DerivedSource).\nSource objects suppl ied by the framework to the user don't have\nthis field populated."
2581 },
2582 "baseSpecs": {
2583 "description": "While splitting, sources may specify the pro duced bundles\nas differences against another source, in order to save backend-s ide\nmemory and allow bigger jobs. For details, see SourceSplitRequest.\nTo supp ort this use case, the full set of parameters of the source\nis logically obtain ed by taking the latest explicitly specified value\nof each parameter in the ord er:\nbase_specs (later items win), spec (overrides anything in base_specs).",
2584 "items": {
2585 "additionalProperties": {
2586 "description": "Properties of the object.",
2587 "type": "any"
2588 },
2589 "type": "object"
2590 },
2591 "type": "array"
2592 },
2502 "codec": { 2593 "codec": {
2503 "additionalProperties": { 2594 "additionalProperties": {
2504 "description": "Properties of the object.", 2595 "description": "Properties of the object.",
2505 "type": "any" 2596 "type": "any"
2506 }, 2597 },
2507 "description": "The codec to use to decode data read from th e source.", 2598 "description": "The codec to use to decode data read from th e source.",
2508 "type": "object" 2599 "type": "object"
2509 }, 2600 },
2510 "doesNotNeedSplitting": { 2601 "doesNotNeedSplitting": {
2511 "description": "Setting this value to true hints to the fram ework that the source\ndoesn't need splitting, and using SourceSplitRequest on i t would\nyield SOURCE_SPLIT_OUTCOME_USE_CURRENT.\n\nE.g. a file splitter may set this to true when splitting a single file\ninto a set of byte ranges of appropr iate size, and set this\nto false when splitting a filepattern into individual f iles.\nHowever, for efficiency, a file splitter may decide to produce\nfile subr anges directly from the filepattern to avoid a splitting\nround-trip.\n\nSee Sou rceSplitRequest for an overview of the splitting process.\n\nThis field is meani ngful only in the Source objects populated\nby the user (e.g. when filling in a DerivedSource).\nSource objects supplied by the framework to the user don't have \nthis field populated.", 2602 "description": "Setting this value to true hints to the fram ework that the source\ndoesn't need splitting, and using SourceSplitRequest on i t would\nyield SOURCE_SPLIT_OUTCOME_USE_CURRENT.\n\nE.g. a file splitter may set this to true when splitting a single file\ninto a set of byte ranges of appropr iate size, and set this\nto false when splitting a filepattern into individual f iles.\nHowever, for efficiency, a file splitter may decide to produce\nfile subr anges directly from the filepattern to avoid a splitting\nround-trip.\n\nSee Sou rceSplitRequest for an overview of the splitting process.\n\nThis field is meani ngful only in the Source objects populated\nby the user (e.g. when filling in a DerivedSource).\nSource objects supplied by the framework to the user don't have \nthis field populated.",
2512 "type": "boolean" 2603 "type": "boolean"
2513 }, 2604 },
2514 "spec": { 2605 "spec": {
2515 "additionalProperties": { 2606 "additionalProperties": {
2516 "description": "Properties of the object.", 2607 "description": "Properties of the object.",
2517 "type": "any" 2608 "type": "any"
2518 }, 2609 },
2519 "description": "The source to read from, plus its parameters .", 2610 "description": "The source to read from, plus its parameters .",
2520 "type": "object" 2611 "type": "object"
2521 },
2522 "metadata": {
2523 "$ref": "SourceMetadata",
2524 "description": "Optionally, metadata for this source can be supplied right away,\navoiding a SourceGetMetadataOperation roundtrip\n(see Sour ceOperationRequest).\n\nThis field is meaningful only in the Source objects popu lated\nby the user (e.g. when filling in a DerivedSource).\nSource objects suppl ied by the framework to the user don't have\nthis field populated."
2525 },
2526 "baseSpecs": {
2527 "description": "While splitting, sources may specify the pro duced bundles\nas differences against another source, in order to save backend-s ide\nmemory and allow bigger jobs. For details, see SourceSplitRequest.\nTo supp ort this use case, the full set of parameters of the source\nis logically obtain ed by taking the latest explicitly specified value\nof each parameter in the ord er:\nbase_specs (later items win), spec (overrides anything in base_specs).",
2528 "items": {
2529 "additionalProperties": {
2530 "description": "Properties of the object.",
2531 "type": "any"
2532 },
2533 "type": "object"
2534 },
2535 "type": "array"
2536 } 2612 }
2537 }, 2613 },
2538 "type": "object" 2614 "type": "object"
2539 }, 2615 },
2540 "WorkerPool": { 2616 "WorkerPool": {
2541 "description": "Describes one particular pool of Cloud Dataflow work ers to be\ninstantiated by the Cloud Dataflow service in order to perform the\nc omputations required by a job. Note that a workflow job may use\nmultiple pools , in order to match the various computational\nrequirements of the various stage s of the job.", 2617 "description": "Describes one particular pool of Cloud Dataflow work ers to be\ninstantiated by the Cloud Dataflow service in order to perform the\nc omputations required by a job. Note that a workflow job may use\nmultiple pools , in order to match the various computational\nrequirements of the various stage s of the job.",
2542 "id": "WorkerPool", 2618 "id": "WorkerPool",
2543 "properties": { 2619 "properties": {
2620 "numThreadsPerWorker": {
2621 "description": "The number of threads per worker harness. If empty or unspecified, the\nservice will choose a number of threads (according t o the number of cores\non the selected machine type for batch, or 1 by conventio n for streaming).",
2622 "format": "int32",
2623 "type": "integer"
2624 },
2625 "zone": {
2626 "description": "Zone to run the worker pools in. If empty o r unspecified, the service\nwill attempt to choose a reasonable default.",
2627 "type": "string"
2628 },
2629 "numWorkers": {
2630 "description": "Number of Google Compute Engine workers in t his pool needed to\nexecute the job. If zero or unspecified, the service will\n attempt to choose a reasonable default.",
2631 "format": "int32",
2632 "type": "integer"
2633 },
2634 "diskSourceImage": {
2635 "description": "Fully qualified source image for disks.",
2636 "type": "string"
2637 },
2638 "packages": {
2639 "description": "Packages to be installed on workers.",
2640 "items": {
2641 "$ref": "Package"
2642 },
2643 "type": "array"
2644 },
2645 "teardownPolicy": {
2646 "description": "Sets the policy for determining when to turn down worker pool.\nAllowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and\n`TEARDOWN_NEVER`.\n`TEARDOWN_ALWAYS` means workers are always torn down re gardless of whether\nthe job succeeds. `TEARDOWN_ON_SUCCESS` means workers are t orn down\nif the job succeeds. `TEARDOWN_NEVER` means the workers are never torn \ndown.\n\nIf the workers are not torn down by the service, they will\ncontinue to run and use Google Compute Engine VM resources in the\nuser's project until t hey are explicitly terminated by the user.\nBecause of this, Google recommends u sing the `TEARDOWN_ALWAYS`\npolicy except for small, manually supervised test jo bs.\n\nIf unknown or unspecified, the service will attempt to choose a reasonabl e\ndefault.",
2647 "enum": [
2648 "TEARDOWN_POLICY_UNKNOWN",
2649 "TEARDOWN_ALWAYS",
2650 "TEARDOWN_ON_SUCCESS",
2651 "TEARDOWN_NEVER"
2652 ],
2653 "enumDescriptions": [
2654 "The teardown policy isn't specified, or is unknown.",
2655 "Always teardown the resource.",
2656 "Teardown the resource on success. This is useful for de bugging\nfailures.",
2657 "Never teardown the resource. This is useful for debuggi ng and\ndevelopment."
2658 ],
2659 "type": "string"
2660 },
2661 "onHostMaintenance": {
2662 "description": "The action to take on host maintenance, as d efined by the Google\nCompute Engine API.",
2663 "type": "string"
2664 },
2665 "poolArgs": {
2666 "additionalProperties": {
2667 "description": "Properties of the object. Contains field @type with type URL.",
2668 "type": "any"
2669 },
2670 "description": "Extra arguments for this worker pool.",
2671 "type": "object"
2672 },
2673 "diskSizeGb": {
2674 "description": "Size of root disk for VMs, in GB. If zero o r unspecified, the service will\nattempt to choose a reasonable default.",
2675 "format": "int32",
2676 "type": "integer"
2677 },
2544 "workerHarnessContainerImage": { 2678 "workerHarnessContainerImage": {
2545 "description": "Required. Docker container image that execut es the Cloud Dataflow worker\nharness, residing in Google Container Registry.", 2679 "description": "Required. Docker container image that execut es the Cloud Dataflow worker\nharness, residing in Google Container Registry.",
2546 "type": "string" 2680 "type": "string"
2547 }, 2681 },
2682 "machineType": {
2683 "description": "Machine type (e.g. \"n1-standard-1\"). If e mpty or unspecified, the\nservice will attempt to choose a reasonable default.",
2684 "type": "string"
2685 },
2548 "diskType": { 2686 "diskType": {
2549 "description": "Type of root disk for VMs. If empty or unsp ecified, the service will\nattempt to choose a reasonable default.", 2687 "description": "Type of root disk for VMs. If empty or unsp ecified, the service will\nattempt to choose a reasonable default.",
2550 "type": "string" 2688 "type": "string"
2551 }, 2689 },
2552 "machineType": {
2553 "description": "Machine type (e.g. \"n1-standard-1\"). If e mpty or unspecified, the\nservice will attempt to choose a reasonable default.",
2554 "type": "string"
2555 },
2556 "kind": { 2690 "kind": {
2557 "description": "The kind of the worker pool; currently only `harness` and `shuffle`\nare supported.", 2691 "description": "The kind of the worker pool; currently only `harness` and `shuffle`\nare supported.",
2558 "type": "string" 2692 "type": "string"
2559 }, 2693 },
2560 "dataDisks": { 2694 "dataDisks": {
2561 "description": "Data disks that are used by a VM in this wor kflow.", 2695 "description": "Data disks that are used by a VM in this wor kflow.",
2562 "items": { 2696 "items": {
2563 "$ref": "Disk" 2697 "$ref": "Disk"
2564 }, 2698 },
2565 "type": "array" 2699 "type": "array"
(...skipping 24 matching lines...) Expand all
2590 "$ref": "TaskRunnerSettings", 2724 "$ref": "TaskRunnerSettings",
2591 "description": "Settings passed through to Google Compute En gine workers when\nusing the standard Dataflow task runner. Users should ignore \nthis field." 2725 "description": "Settings passed through to Google Compute En gine workers when\nusing the standard Dataflow task runner. Users should ignore \nthis field."
2592 }, 2726 },
2593 "metadata": { 2727 "metadata": {
2594 "additionalProperties": { 2728 "additionalProperties": {
2595 "type": "string" 2729 "type": "string"
2596 }, 2730 },
2597 "description": "Metadata to set on the Google Compute Engine VMs.", 2731 "description": "Metadata to set on the Google Compute Engine VMs.",
2598 "type": "object" 2732 "type": "object"
2599 }, 2733 },
2600 "network": {
2601 "description": "Network to which VMs will be assigned. If e mpty or unspecified,\nthe service will use the network \"default\".",
2602 "type": "string"
2603 },
2604 "defaultPackageSet": { 2734 "defaultPackageSet": {
2605 "description": "The default package set to install. This al lows the service to\nselect a default set of packages which are useful to worker \nharnesses written in a particular language.", 2735 "description": "The default package set to install. This al lows the service to\nselect a default set of packages which are useful to worker \nharnesses written in a particular language.",
2606 "enum": [ 2736 "enum": [
2607 "DEFAULT_PACKAGE_SET_UNKNOWN", 2737 "DEFAULT_PACKAGE_SET_UNKNOWN",
2608 "DEFAULT_PACKAGE_SET_NONE", 2738 "DEFAULT_PACKAGE_SET_NONE",
2609 "DEFAULT_PACKAGE_SET_JAVA", 2739 "DEFAULT_PACKAGE_SET_JAVA",
2610 "DEFAULT_PACKAGE_SET_PYTHON" 2740 "DEFAULT_PACKAGE_SET_PYTHON"
2611 ], 2741 ],
2612 "enumDescriptions": [ 2742 "enumDescriptions": [
2613 "The default set of packages to stage is unknown, or uns pecified.", 2743 "The default set of packages to stage is unknown, or uns pecified.",
2614 "Indicates that no packages should be staged at the work er unless\nexplicitly specified by the job.", 2744 "Indicates that no packages should be staged at the work er unless\nexplicitly specified by the job.",
2615 "Stage packages typically useful to workers written in J ava.", 2745 "Stage packages typically useful to workers written in J ava.",
2616 "Stage pacakges typically useful to workers written in P ython." 2746 "Stage pacakges typically useful to workers written in P ython."
2617 ], 2747 ],
2618 "type": "string" 2748 "type": "string"
2619 }, 2749 },
2620 "numThreadsPerWorker": { 2750 "network": {
2621 "description": "The number of threads per worker harness. If empty or unspecified, the\nservice will choose a number of threads (according t o the number of cores\non the selected machine type for batch, or 1 by conventio n for streaming).", 2751 "description": "Network to which VMs will be assigned. If e mpty or unspecified,\nthe service will use the network \"default\".",
2622 "format": "int32",
2623 "type": "integer"
2624 },
2625 "numWorkers": {
2626 "description": "Number of Google Compute Engine workers in t his pool needed to\nexecute the job. If zero or unspecified, the service will\n attempt to choose a reasonable default.",
2627 "format": "int32",
2628 "type": "integer"
2629 },
2630 "zone": {
2631 "description": "Zone to run the worker pools in. If empty o r unspecified, the service\nwill attempt to choose a reasonable default.",
2632 "type": "string" 2752 "type": "string"
2633 },
2634 "diskSourceImage": {
2635 "description": "Fully qualified source image for disks.",
2636 "type": "string"
2637 },
2638 "packages": {
2639 "description": "Packages to be installed on workers.",
2640 "items": {
2641 "$ref": "Package"
2642 },
2643 "type": "array"
2644 },
2645 "teardownPolicy": {
2646 "description": "Sets the policy for determining when to turn down worker pool.\nAllowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and\n`TEARDOWN_NEVER`.\n`TEARDOWN_ALWAYS` means workers are always torn down re gardless of whether\nthe job succeeds. `TEARDOWN_ON_SUCCESS` means workers are t orn down\nif the job succeeds. `TEARDOWN_NEVER` means the workers are never torn \ndown.\n\nIf the workers are not torn down by the service, they will\ncontinue to run and use Google Compute Engine VM resources in the\nuser's project until t hey are explicitly terminated by the user.\nBecause of this, Google recommends u sing the `TEARDOWN_ALWAYS`\npolicy except for small, manually supervised test jo bs.\n\nIf unknown or unspecified, the service will attempt to choose a reasonabl e\ndefault.",
2647 "enum": [
2648 "TEARDOWN_POLICY_UNKNOWN",
2649 "TEARDOWN_ALWAYS",
2650 "TEARDOWN_ON_SUCCESS",
2651 "TEARDOWN_NEVER"
2652 ],
2653 "enumDescriptions": [
2654 "The teardown policy isn't specified, or is unknown.",
2655 "Always teardown the resource.",
2656 "Teardown the resource on success. This is useful for de bugging\nfailures.",
2657 "Never teardown the resource. This is useful for debuggi ng and\ndevelopment."
2658 ],
2659 "type": "string"
2660 },
2661 "onHostMaintenance": {
2662 "description": "The action to take on host maintenance, as d efined by the Google\nCompute Engine API.",
2663 "type": "string"
2664 },
2665 "poolArgs": {
2666 "additionalProperties": {
2667 "description": "Properties of the object. Contains field @type with type URL.",
2668 "type": "any"
2669 },
2670 "description": "Extra arguments for this worker pool.",
2671 "type": "object"
2672 },
2673 "diskSizeGb": {
2674 "description": "Size of root disk for VMs, in GB. If zero o r unspecified, the service will\nattempt to choose a reasonable default.",
2675 "format": "int32",
2676 "type": "integer"
2677 } 2753 }
2678 }, 2754 },
2679 "type": "object" 2755 "type": "object"
2680 }, 2756 },
2681 "SourceOperationRequest": { 2757 "SourceOperationRequest": {
2682 "description": "A work item that represents the different operations that can be\nperformed on a user-defined Source specification.", 2758 "description": "A work item that represents the different operations that can be\nperformed on a user-defined Source specification.",
2683 "id": "SourceOperationRequest", 2759 "id": "SourceOperationRequest",
2684 "properties": { 2760 "properties": {
2761 "getMetadata": {
2762 "$ref": "SourceGetMetadataRequest",
2763 "description": "Information about a request to get metadata about a source."
2764 },
2685 "split": { 2765 "split": {
2686 "$ref": "SourceSplitRequest", 2766 "$ref": "SourceSplitRequest",
2687 "description": "Information about a request to split a sourc e." 2767 "description": "Information about a request to split a sourc e."
2688 },
2689 "getMetadata": {
2690 "$ref": "SourceGetMetadataRequest",
2691 "description": "Information about a request to get metadata about a source."
2692 } 2768 }
2693 }, 2769 },
2694 "type": "object" 2770 "type": "object"
2695 }, 2771 },
2696 "WorkItem": { 2772 "WorkItem": {
2697 "description": "WorkItem represents basic information about a WorkIt em to be executed\nin the cloud.", 2773 "description": "WorkItem represents basic information about a WorkIt em to be executed\nin the cloud.",
2698 "id": "WorkItem", 2774 "id": "WorkItem",
2699 "properties": { 2775 "properties": {
2700 "initialReportIndex": { 2776 "shellTask": {
2701 "description": "The initial index to use when reporting the status of the WorkItem.", 2777 "$ref": "ShellTask",
2702 "format": "int64", 2778 "description": "Additional information for ShellTask WorkIte ms."
2703 "type": "string"
2704 }, 2779 },
2705 "streamingComputationTask": { 2780 "streamingComputationTask": {
2706 "$ref": "StreamingComputationTask", 2781 "$ref": "StreamingComputationTask",
2707 "description": "Additional information for StreamingComputat ionTask WorkItems." 2782 "description": "Additional information for StreamingComputat ionTask WorkItems."
2708 }, 2783 },
2709 "shellTask": {
2710 "$ref": "ShellTask",
2711 "description": "Additional information for ShellTask WorkIte ms."
2712 },
2713 "jobId": { 2784 "jobId": {
2714 "description": "Identifies the workflow job this WorkItem be longs to.", 2785 "description": "Identifies the workflow job this WorkItem be longs to.",
2715 "type": "string" 2786 "type": "string"
2716 }, 2787 },
2717 "id": { 2788 "id": {
2718 "description": "Identifies this WorkItem.", 2789 "description": "Identifies this WorkItem.",
2719 "format": "int64", 2790 "format": "int64",
2720 "type": "string" 2791 "type": "string"
2721 }, 2792 },
2722 "configuration": { 2793 "configuration": {
(...skipping 12 matching lines...) Expand all
2735 "description": "Any required packages that need to be fetche d in order to execute\nthis WorkItem.", 2806 "description": "Any required packages that need to be fetche d in order to execute\nthis WorkItem.",
2736 "items": { 2807 "items": {
2737 "$ref": "Package" 2808 "$ref": "Package"
2738 }, 2809 },
2739 "type": "array" 2810 "type": "array"
2740 }, 2811 },
2741 "projectId": { 2812 "projectId": {
2742 "description": "Identifies the cloud project this WorkItem b elongs to.", 2813 "description": "Identifies the cloud project this WorkItem b elongs to.",
2743 "type": "string" 2814 "type": "string"
2744 }, 2815 },
2745 "reportStatusInterval": {
2746 "description": "Recommended reporting interval.",
2747 "format": "google-duration",
2748 "type": "string"
2749 },
2750 "sourceOperationTask": { 2816 "sourceOperationTask": {
2751 "$ref": "SourceOperationRequest", 2817 "$ref": "SourceOperationRequest",
2752 "description": "Additional information for source operation WorkItems." 2818 "description": "Additional information for source operation WorkItems."
2753 }, 2819 },
2754 "streamingSetupTask": { 2820 "streamingSetupTask": {
2755 "$ref": "StreamingSetupTask", 2821 "$ref": "StreamingSetupTask",
2756 "description": "Additional information for StreamingSetupTas k WorkItems." 2822 "description": "Additional information for StreamingSetupTas k WorkItems."
2757 }, 2823 },
2824 "reportStatusInterval": {
2825 "description": "Recommended reporting interval.",
2826 "format": "google-duration",
2827 "type": "string"
2828 },
2758 "streamingConfigTask": { 2829 "streamingConfigTask": {
2759 "$ref": "StreamingConfigTask", 2830 "$ref": "StreamingConfigTask",
2760 "description": "Additional information for StreamingConfigTa sk WorkItems." 2831 "description": "Additional information for StreamingConfigTa sk WorkItems."
2761 }, 2832 },
2762 "leaseExpireTime": { 2833 "leaseExpireTime": {
2763 "description": "Time when the lease on this Work will expire .", 2834 "description": "Time when the lease on this Work will expire .",
2764 "format": "google-datetime", 2835 "format": "google-datetime",
2765 "type": "string" 2836 "type": "string"
2837 },
2838 "initialReportIndex": {
2839 "description": "The initial index to use when reporting the status of the WorkItem.",
2840 "format": "int64",
2841 "type": "string"
2766 } 2842 }
2767 }, 2843 },
2768 "type": "object" 2844 "type": "object"
2845 },
2846 "ReportedParallelism": {
2847 "description": "Represents the level of parallelism in a WorkItem's input,\nreported by the worker.",
2848 "id": "ReportedParallelism",
2849 "properties": {
2850 "value": {
2851 "description": "Specifies the level of parallelism in case i t is finite.",
2852 "format": "double",
2853 "type": "number"
2854 },
2855 "isInfinite": {
2856 "description": "Specifies whether the parallelism is infinit e. If true, \"value\" is\nignored.\nInfinite parallelism means the service will assume that the work item\ncan always be split into more non-empty work items by dynamic splitting.\nThis is a work-around for lack of support for infinity by t he current\nJSON-based Java RPC stack.",
2857 "type": "boolean"
2858 }
2859 },
2860 "type": "object"
2769 }, 2861 },
2770 "ResourceUtilizationReport": { 2862 "ResourceUtilizationReport": {
2771 "description": "Worker metrics exported from workers. This contains resource utilization\nmetrics accumulated from a variety of sources. For more in formation, see\ngo/df-resource-signals.", 2863 "description": "Worker metrics exported from workers. This contains resource utilization\nmetrics accumulated from a variety of sources. For more in formation, see\ngo/df-resource-signals.",
2772 "id": "ResourceUtilizationReport", 2864 "id": "ResourceUtilizationReport",
2773 "properties": { 2865 "properties": {
2774 "cpuTime": { 2866 "cpuTime": {
2775 "description": "CPU utilization samples.", 2867 "description": "CPU utilization samples.",
2776 "items": { 2868 "items": {
2777 "$ref": "CPUTime" 2869 "$ref": "CPUTime"
2778 }, 2870 },
2779 "type": "array" 2871 "type": "array"
2780 } 2872 }
2781 }, 2873 },
2782 "type": "object" 2874 "type": "object"
2783 }, 2875 },
2784 "ReportedParallelism": {
2785 "description": "Represents the level of parallelism in a WorkItem's input,\nreported by the worker.",
2786 "id": "ReportedParallelism",
2787 "properties": {
2788 "isInfinite": {
2789 "description": "Specifies whether the parallelism is infinit e. If true, \"value\" is\nignored.\nInfinite parallelism means the service will assume that the work item\ncan always be split into more non-empty work items by dynamic splitting.\nThis is a work-around for lack of support for infinity by t he current\nJSON-based Java RPC stack.",
2790 "type": "boolean"
2791 },
2792 "value": {
2793 "description": "Specifies the level of parallelism in case i t is finite.",
2794 "format": "double",
2795 "type": "number"
2796 }
2797 },
2798 "type": "object"
2799 },
2800 "TopologyConfig": { 2876 "TopologyConfig": {
2801 "description": "Global topology of the streaming Dataflow job, inclu ding all\ncomputations and their sharded locations.", 2877 "description": "Global topology of the streaming Dataflow job, inclu ding all\ncomputations and their sharded locations.",
2802 "id": "TopologyConfig", 2878 "id": "TopologyConfig",
2803 "properties": { 2879 "properties": {
2804 "forwardingKeyBits": {
2805 "description": "The size (in bits) of keys that will be assi gned to source messages.",
2806 "format": "int32",
2807 "type": "integer"
2808 },
2809 "userStageToComputationNameMap": {
2810 "additionalProperties": {
2811 "type": "string"
2812 },
2813 "description": "Maps user stage names to stable computation names.",
2814 "type": "object"
2815 },
2816 "computations": { 2880 "computations": {
2817 "description": "The computations associated with a streaming Dataflow job.", 2881 "description": "The computations associated with a streaming Dataflow job.",
2818 "items": { 2882 "items": {
2819 "$ref": "ComputationTopology" 2883 "$ref": "ComputationTopology"
2820 }, 2884 },
2821 "type": "array" 2885 "type": "array"
2822 }, 2886 },
2823 "dataDiskAssignments": { 2887 "dataDiskAssignments": {
2824 "description": "The disks assigned to a streaming Dataflow j ob.", 2888 "description": "The disks assigned to a streaming Dataflow j ob.",
2825 "items": { 2889 "items": {
2826 "$ref": "DataDiskAssignment" 2890 "$ref": "DataDiskAssignment"
2827 }, 2891 },
2828 "type": "array" 2892 "type": "array"
2829 }, 2893 },
2830 "persistentStateVersion": { 2894 "persistentStateVersion": {
2831 "description": "Version number for persistent state.", 2895 "description": "Version number for persistent state.",
2832 "format": "int32", 2896 "format": "int32",
2833 "type": "integer" 2897 "type": "integer"
2898 },
2899 "forwardingKeyBits": {
2900 "description": "The size (in bits) of keys that will be assi gned to source messages.",
2901 "format": "int32",
2902 "type": "integer"
2903 },
2904 "userStageToComputationNameMap": {
2905 "additionalProperties": {
2906 "type": "string"
2907 },
2908 "description": "Maps user stage names to stable computation names.",
2909 "type": "object"
2834 } 2910 }
2835 }, 2911 },
2836 "type": "object" 2912 "type": "object"
2837 }, 2913 },
2838 "SourceSplitOptions": { 2914 "SourceSplitOptions": {
2839 "description": "Hints for splitting a Source into bundles (parts for parallel\nprocessing) using SourceSplitRequest.", 2915 "description": "Hints for splitting a Source into bundles (parts for parallel\nprocessing) using SourceSplitRequest.",
2840 "id": "SourceSplitOptions", 2916 "id": "SourceSplitOptions",
2841 "properties": { 2917 "properties": {
2842 "desiredBundleSizeBytes": { 2918 "desiredBundleSizeBytes": {
2843 "description": "The source should be split into a set of bun dles where the estimated size\nof each is approximately this many bytes.", 2919 "description": "The source should be split into a set of bun dles where the estimated size\nof each is approximately this many bytes.",
(...skipping 16 matching lines...) Expand all
2860 "$ref": "Source", 2936 "$ref": "Source",
2861 "description": "The source to read from." 2937 "description": "The source to read from."
2862 } 2938 }
2863 }, 2939 },
2864 "type": "object" 2940 "type": "object"
2865 }, 2941 },
2866 "WorkerSettings": { 2942 "WorkerSettings": {
2867 "description": "Provides data to pass through to the worker harness. ", 2943 "description": "Provides data to pass through to the worker harness. ",
2868 "id": "WorkerSettings", 2944 "id": "WorkerSettings",
2869 "properties": { 2945 "properties": {
2946 "tempStoragePrefix": {
2947 "description": "The prefix of the resources the system shoul d use for temporary\nstorage.\n\nThe supported resource type is:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.google apis.com/{object}",
2948 "type": "string"
2949 },
2950 "baseUrl": {
2951 "description": "The base URL for accessing Google Cloud APIs .\n\nWhen workers access Google Cloud APIs, they logically do so via\nrelative U RLs. If this field is specified, it supplies the base\nURL to use for resolving these relative URLs. The normative\nalgorithm used is defined by RFC 1808, \"R elative Uniform Resource\nLocators\".\n\nIf not specified, the default value is \"http://www.googleapis.com/\"",
2952 "type": "string"
2953 },
2954 "reportingEnabled": {
2955 "description": "Whether to send work progress updates to the service.",
2956 "type": "boolean"
2957 },
2870 "servicePath": { 2958 "servicePath": {
2871 "description": "The Cloud Dataflow service path relative to the root URL, for example,\n\"dataflow/v1b3/projects\".", 2959 "description": "The Cloud Dataflow service path relative to the root URL, for example,\n\"dataflow/v1b3/projects\".",
2872 "type": "string" 2960 "type": "string"
2873 }, 2961 },
2874 "shuffleServicePath": { 2962 "shuffleServicePath": {
2875 "description": "The Shuffle service path relative to the roo t URL, for example,\n\"shuffle/v1beta1\".", 2963 "description": "The Shuffle service path relative to the roo t URL, for example,\n\"shuffle/v1beta1\".",
2876 "type": "string" 2964 "type": "string"
2877 }, 2965 },
2878 "workerId": { 2966 "workerId": {
2879 "description": "The ID of the worker running this pipeline." , 2967 "description": "The ID of the worker running this pipeline." ,
2880 "type": "string" 2968 "type": "string"
2881 },
2882 "tempStoragePrefix": {
2883 "description": "The prefix of the resources the system shoul d use for temporary\nstorage.\n\nThe supported resource type is:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.google apis.com/{object}",
2884 "type": "string"
2885 },
2886 "baseUrl": {
2887 "description": "The base URL for accessing Google Cloud APIs .\n\nWhen workers access Google Cloud APIs, they logically do so via\nrelative U RLs. If this field is specified, it supplies the base\nURL to use for resolving these relative URLs. The normative\nalgorithm used is defined by RFC 1808, \"R elative Uniform Resource\nLocators\".\n\nIf not specified, the default value is \"http://www.googleapis.com/\"",
2888 "type": "string"
2889 },
2890 "reportingEnabled": {
2891 "description": "Whether to send work progress updates to the service.",
2892 "type": "boolean"
2893 } 2969 }
2894 }, 2970 },
2895 "type": "object" 2971 "type": "object"
2972 },
2973 "StreamingStageLocation": {
2974 "description": "Identifies the location of a streaming computation s tage, for\nstage-to-stage communication.",
2975 "id": "StreamingStageLocation",
2976 "properties": {
2977 "streamId": {
2978 "description": "Identifies the particular stream within the streaming Dataflow\njob.",
2979 "type": "string"
2980 }
2981 },
2982 "type": "object"
2896 }, 2983 },
2897 "DataDiskAssignment": { 2984 "DataDiskAssignment": {
2898 "description": "Data disk assignment for a given VM instance.", 2985 "description": "Data disk assignment for a given VM instance.",
2899 "id": "DataDiskAssignment", 2986 "id": "DataDiskAssignment",
2900 "properties": { 2987 "properties": {
2901 "vmInstance": { 2988 "vmInstance": {
2902 "description": "VM instance name the data disks mounted to, for example\n\"myproject-1014-104817-4c2-harness-0\".", 2989 "description": "VM instance name the data disks mounted to, for example\n\"myproject-1014-104817-4c2-harness-0\".",
2903 "type": "string" 2990 "type": "string"
2904 }, 2991 },
2905 "dataDisks": { 2992 "dataDisks": {
2906 "description": "Mounted data disks. The order is important a data disk's 0-based index in\nthis list defines which persistent directory the disk is mounted to, for\nexample the list of { \"myproject-1014-104817-4c2-harne ss-0-disk-0\" },\n{ \"myproject-1014-104817-4c2-harness-0-disk-1\" }.", 2993 "description": "Mounted data disks. The order is important a data disk's 0-based index in\nthis list defines which persistent directory the disk is mounted to, for\nexample the list of { \"myproject-1014-104817-4c2-harne ss-0-disk-0\" },\n{ \"myproject-1014-104817-4c2-harness-0-disk-1\" }.",
2907 "items": { 2994 "items": {
2908 "type": "string" 2995 "type": "string"
2909 }, 2996 },
2910 "type": "array" 2997 "type": "array"
2911 } 2998 }
2912 }, 2999 },
2913 "type": "object" 3000 "type": "object"
2914 }, 3001 },
2915 "StreamingStageLocation": {
2916 "description": "Identifies the location of a streaming computation s tage, for\nstage-to-stage communication.",
2917 "id": "StreamingStageLocation",
2918 "properties": {
2919 "streamId": {
2920 "description": "Identifies the particular stream within the streaming Dataflow\njob.",
2921 "type": "string"
2922 }
2923 },
2924 "type": "object"
2925 },
2926 "ApproximateSplitRequest": { 3002 "ApproximateSplitRequest": {
2927 "description": "A suggestion by the service to the worker to dynamic ally split the WorkItem.", 3003 "description": "A suggestion by the service to the worker to dynamic ally split the WorkItem.",
2928 "id": "ApproximateSplitRequest", 3004 "id": "ApproximateSplitRequest",
2929 "properties": { 3005 "properties": {
3006 "position": {
3007 "$ref": "Position",
3008 "description": "A Position at which to split the work item."
3009 },
2930 "fractionConsumed": { 3010 "fractionConsumed": {
2931 "description": "A fraction at which to split the work item, from 0.0 (beginning of the\ninput) to 1.0 (end of the input).", 3011 "description": "A fraction at which to split the work item, from 0.0 (beginning of the\ninput) to 1.0 (end of the input).",
2932 "format": "double", 3012 "format": "double",
2933 "type": "number" 3013 "type": "number"
2934 },
2935 "position": {
2936 "$ref": "Position",
2937 "description": "A Position at which to split the work item."
2938 } 3014 }
2939 }, 3015 },
2940 "type": "object" 3016 "type": "object"
2941 }, 3017 },
2942 "Status": { 3018 "Status": {
2943 "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RP C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie ces of data: error code, error message,\nand error details. The error code shoul d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message tha t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa cing\nerror message is needed, put the localized message in the error details or \nlocalize it in the client. The optional error details may contain arbitrary\ni nformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` which can be used for common error conditions.\n\n# Lan guage mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` mes sage is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some except ions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\ n\nThe error model and the `Status` message can be used in a variety of\nenviron ments, either with or without APIs, to provide a\nconsistent developer experienc e across different environments.\n\nExample uses of this error model include:\n\ n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operati ons. If a client uses batch request and batch response, the\n `Status` messag e should be used directly inside batch response, one for\n each error sub-res ponse.\n\n- Asynchronous operations. If an API call embeds asynchronous operatio n\n results in its response, the status of those operations should be\n re presented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any s tripping needed for security/privacy reasons.", 3019 "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RP C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie ces of data: error code, error message,\nand error details. The error code shoul d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message tha t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa cing\nerror message is needed, put the localized message in the error details or \nlocalize it in the client. The optional error details may contain arbitrary\ni nformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` which can be used for common error conditions.\n\n# Lan guage mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` mes sage is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some except ions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\ n\nThe error model and the `Status` message can be used in a variety of\nenviron ments, either with or without APIs, to provide a\nconsistent developer experienc e across different environments.\n\nExample uses of this error model include:\n\ n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operati ons. If a client uses batch request and batch response, the\n `Status` messag e should be used directly inside batch response, one for\n each error sub-res ponse.\n\n- Asynchronous operations. If an API call embeds asynchronous operatio n\n results in its response, the status of those operations should be\n re presented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any s tripping needed for security/privacy reasons.",
2944 "id": "Status", 3020 "id": "Status",
2945 "properties": { 3021 "properties": {
2946 "details": { 3022 "details": {
2947 "description": "A list of messages that carry the error deta ils. There will be a\ncommon set of message types for APIs to use.", 3023 "description": "A list of messages that carry the error deta ils. There will be a\ncommon set of message types for APIs to use.",
(...skipping 62 matching lines...) Expand 10 before | Expand all | Expand 10 after
3010 "workItems": { 3086 "workItems": {
3011 "description": "A list of the leased WorkItems.", 3087 "description": "A list of the leased WorkItems.",
3012 "items": { 3088 "items": {
3013 "$ref": "WorkItem" 3089 "$ref": "WorkItem"
3014 }, 3090 },
3015 "type": "array" 3091 "type": "array"
3016 } 3092 }
3017 }, 3093 },
3018 "type": "object" 3094 "type": "object"
3019 }, 3095 },
3096 "TransformSummary": {
3097 "description": "Description of the type, names/ids, and input/output s for a transform.",
3098 "id": "TransformSummary",
3099 "properties": {
3100 "name": {
3101 "description": "User provided name for this transform instan ce.",
3102 "type": "string"
3103 },
3104 "id": {
3105 "description": "SDK generated id of this transform instance. ",
3106 "type": "string"
3107 },
3108 "displayData": {
3109 "description": "Transform-specific display data.",
3110 "items": {
3111 "$ref": "DisplayData"
3112 },
3113 "type": "array"
3114 },
3115 "outputCollectionName": {
3116 "description": "User names for all collection outputs to th is transform.",
3117 "items": {
3118 "type": "string"
3119 },
3120 "type": "array"
3121 },
3122 "kind": {
3123 "description": "Type of transform.",
3124 "enum": [
3125 "UNKNOWN_KIND",
3126 "PAR_DO_KIND",
3127 "GROUP_BY_KEY_KIND",
3128 "FLATTEN_KIND",
3129 "READ_KIND",
3130 "WRITE_KIND",
3131 "CONSTANT_KIND",
3132 "SINGLETON_KIND",
3133 "SHUFFLE_KIND"
3134 ],
3135 "enumDescriptions": [
3136 "Unrecognized transform type.",
3137 "ParDo transform.",
3138 "Group By Key transform.",
3139 "Flatten transform.",
3140 "Read transform.",
3141 "Write transform.",
3142 "Constructs from a constant value, such as with Create.o f.",
3143 "Creates a Singleton view of a collection.",
3144 "Opening or closing a shuffle session, often as part of a GroupByKey."
3145 ],
3146 "type": "string"
3147 },
3148 "inputCollectionName": {
3149 "description": "User names for all collection inputs to this transform.",
3150 "items": {
3151 "type": "string"
3152 },
3153 "type": "array"
3154 }
3155 },
3156 "type": "object"
3157 },
3020 "StreamingComputationConfig": { 3158 "StreamingComputationConfig": {
3021 "description": "Configuration information for a single streaming com putation.", 3159 "description": "Configuration information for a single streaming com putation.",
3022 "id": "StreamingComputationConfig", 3160 "id": "StreamingComputationConfig",
3023 "properties": { 3161 "properties": {
3024 "computationId": { 3162 "computationId": {
3025 "description": "Unique identifier for this computation.", 3163 "description": "Unique identifier for this computation.",
3026 "type": "string" 3164 "type": "string"
3027 }, 3165 },
3028 "systemName": { 3166 "systemName": {
3029 "description": "System defined name for this computation.", 3167 "description": "System defined name for this computation.",
(...skipping 29 matching lines...) Expand all
3059 "additionalProperties": { 3197 "additionalProperties": {
3060 "description": "Properties of the object.", 3198 "description": "Properties of the object.",
3061 "type": "any" 3199 "type": "any"
3062 }, 3200 },
3063 "description": "The sink to write to, plus its parameters.", 3201 "description": "The sink to write to, plus its parameters.",
3064 "type": "object" 3202 "type": "object"
3065 } 3203 }
3066 }, 3204 },
3067 "type": "object" 3205 "type": "object"
3068 }, 3206 },
3207 "LaunchTemplateParameters": {
3208 "description": "Parameters to provide to the template being launched .",
3209 "id": "LaunchTemplateParameters",
3210 "properties": {
3211 "environment": {
3212 "$ref": "RuntimeEnvironment",
3213 "description": "The runtime environment for the job."
3214 },
3215 "parameters": {
3216 "additionalProperties": {
3217 "type": "string"
3218 },
3219 "description": "The runtime parameters to pass to the job.",
3220 "type": "object"
3221 },
3222 "jobName": {
3223 "description": "Required. The job name to use for the create d job.",
3224 "type": "string"
3225 }
3226 },
3227 "type": "object"
3228 },
3069 "FlattenInstruction": { 3229 "FlattenInstruction": {
3070 "description": "An instruction that copies its inputs (zero or more) to its (single) output.", 3230 "description": "An instruction that copies its inputs (zero or more) to its (single) output.",
3071 "id": "FlattenInstruction", 3231 "id": "FlattenInstruction",
3072 "properties": { 3232 "properties": {
3073 "inputs": { 3233 "inputs": {
3074 "description": "Describes the inputs to the flatten instruct ion.", 3234 "description": "Describes the inputs to the flatten instruct ion.",
3075 "items": { 3235 "items": {
3076 "$ref": "InstructionInput" 3236 "$ref": "InstructionInput"
3077 }, 3237 },
3078 "type": "array" 3238 "type": "array"
(...skipping 18 matching lines...) Expand all
3097 "description": "Properties of the object.", 3257 "description": "Properties of the object.",
3098 "type": "any" 3258 "type": "any"
3099 }, 3259 },
3100 "description": "The codec to use for interpreting an element in the input PTable.", 3260 "description": "The codec to use for interpreting an element in the input PTable.",
3101 "type": "object" 3261 "type": "object"
3102 }, 3262 },
3103 "originalCombineValuesInputStoreName": { 3263 "originalCombineValuesInputStoreName": {
3104 "description": "If this instruction includes a combining fun ction this is the name of the\nintermediate store between the GBK and the Combin eValues.", 3264 "description": "If this instruction includes a combining fun ction this is the name of the\nintermediate store between the GBK and the Combin eValues.",
3105 "type": "string" 3265 "type": "string"
3106 }, 3266 },
3107 "originalCombineValuesStepName": {
3108 "description": "If this instruction includes a combining fun ction, this is the name of the\nCombineValues instruction lifted into this instr uction.",
3109 "type": "string"
3110 },
3111 "sideInputs": { 3267 "sideInputs": {
3112 "description": "Zero or more side inputs.", 3268 "description": "Zero or more side inputs.",
3113 "items": { 3269 "items": {
3114 "$ref": "SideInputInfo" 3270 "$ref": "SideInputInfo"
3115 }, 3271 },
3116 "type": "array" 3272 "type": "array"
3117 }, 3273 },
3274 "originalCombineValuesStepName": {
3275 "description": "If this instruction includes a combining fun ction, this is the name of the\nCombineValues instruction lifted into this instr uction.",
3276 "type": "string"
3277 },
3118 "input": { 3278 "input": {
3119 "$ref": "InstructionInput", 3279 "$ref": "InstructionInput",
3120 "description": "Describes the input to the partial group-by- key instruction." 3280 "description": "Describes the input to the partial group-by- key instruction."
3121 } 3281 }
3122 }, 3282 },
3123 "type": "object" 3283 "type": "object"
3124 }, 3284 },
3125 "InstructionInput": { 3285 "InstructionInput": {
3126 "description": "An input of an instruction, as a reference to an out put of a\nproducer instruction.", 3286 "description": "An input of an instruction, as a reference to an out put of a\nproducer instruction.",
3127 "id": "InstructionInput", 3287 "id": "InstructionInput",
3128 "properties": { 3288 "properties": {
3129 "producerInstructionIndex": { 3289 "producerInstructionIndex": {
3130 "description": "The index (origin zero) of the parallel inst ruction that produces\nthe output to be consumed by this input. This index is r elative\nto the list of instructions in this input's instruction's\ncontaining M apTask.", 3290 "description": "The index (origin zero) of the parallel inst ruction that produces\nthe output to be consumed by this input. This index is r elative\nto the list of instructions in this input's instruction's\ncontaining M apTask.",
3131 "format": "int32", 3291 "format": "int32",
3132 "type": "integer" 3292 "type": "integer"
3133 }, 3293 },
3134 "outputNum": { 3294 "outputNum": {
3135 "description": "The output index (origin zero) within the pr oducer.", 3295 "description": "The output index (origin zero) within the pr oducer.",
3136 "format": "int32", 3296 "format": "int32",
3137 "type": "integer" 3297 "type": "integer"
3138 } 3298 }
3139 }, 3299 },
3140 "type": "object" 3300 "type": "object"
3141 }, 3301 },
3302 "StageSource": {
3303 "description": "Description of an input or output of an execution st age.",
3304 "id": "StageSource",
3305 "properties": {
3306 "originalTransformOrCollection": {
3307 "description": "User name for the original user transform or collection with which this\nsource is most closely associated.",
3308 "type": "string"
3309 },
3310 "name": {
3311 "description": "Dataflow service generated name for this sou rce.",
3312 "type": "string"
3313 },
3314 "sizeBytes": {
3315 "description": "Size of the source, if measurable.",
3316 "format": "int64",
3317 "type": "string"
3318 },
3319 "userName": {
3320 "description": "Human-readable name for this source; may be user or system generated.",
3321 "type": "string"
3322 }
3323 },
3324 "type": "object"
3325 },
3142 "StringList": { 3326 "StringList": {
3143 "description": "A metric value representing a list of strings.", 3327 "description": "A metric value representing a list of strings.",
3144 "id": "StringList", 3328 "id": "StringList",
3145 "properties": { 3329 "properties": {
3146 "elements": { 3330 "elements": {
3147 "description": "Elements of the list.", 3331 "description": "Elements of the list.",
3148 "items": { 3332 "items": {
3149 "type": "string" 3333 "type": "string"
3150 }, 3334 },
3151 "type": "array" 3335 "type": "array"
3152 } 3336 }
3153 }, 3337 },
3154 "type": "object" 3338 "type": "object"
3155 }, 3339 },
3340 "DisplayData": {
3341 "description": "Data provided with a pipeline or transform to provid e descriptive info.",
3342 "id": "DisplayData",
3343 "properties": {
3344 "durationValue": {
3345 "description": "Contains value if the data is of duration ty pe.",
3346 "format": "google-duration",
3347 "type": "string"
3348 },
3349 "int64Value": {
3350 "description": "Contains value if the data is of int64 type. ",
3351 "format": "int64",
3352 "type": "string"
3353 },
3354 "namespace": {
3355 "description": "The namespace for the key. This is usually a class name or programming\nlanguage namespace (i.e. python module) which define s the display data.\nThis allows a dax monitoring system to specially handle the data\nand perform custom rendering.",
3356 "type": "string"
3357 },
3358 "floatValue": {
3359 "description": "Contains value if the data is of float type. ",
3360 "format": "float",
3361 "type": "number"
3362 },
3363 "key": {
3364 "description": "The key identifying the display data.\nThis is intended to be used as a label for the display data\nwhen viewed in a dax mon itoring system.",
3365 "type": "string"
3366 },
3367 "shortStrValue": {
3368 "description": "A possible additional shorter value to displ ay.\nFor example a java_class_name_value of com.mypackage.MyDoFn\nwill be stored with MyDoFn as the short_str_value and\ncom.mypackage.MyDoFn as the java_class_ name value.\nshort_str_value can be displayed and java_class_name_value\nwill be displayed as a tooltip.",
3369 "type": "string"
3370 },
3371 "label": {
3372 "description": "An optional label to display in a dax UI for the element.",
3373 "type": "string"
3374 },
3375 "url": {
3376 "description": "An optional full URL.",
3377 "type": "string"
3378 },
3379 "timestampValue": {
3380 "description": "Contains value if the data is of timestamp t ype.",
3381 "format": "google-datetime",
3382 "type": "string"
3383 },
3384 "javaClassValue": {
3385 "description": "Contains value if the data is of java class type.",
3386 "type": "string"
3387 },
3388 "boolValue": {
3389 "description": "Contains value if the data is of a boolean t ype.",
3390 "type": "boolean"
3391 },
3392 "strValue": {
3393 "description": "Contains value if the data is of string type .",
3394 "type": "string"
3395 }
3396 },
3397 "type": "object"
3398 },
3399 "GetDebugConfigRequest": {
3400 "description": "Request to get updated debug configuration for compo nent.",
3401 "id": "GetDebugConfigRequest",
3402 "properties": {
3403 "workerId": {
3404 "description": "The worker id, i.e., VM hostname.",
3405 "type": "string"
3406 },
3407 "componentId": {
3408 "description": "The internal component id for which debug co nfiguration is\nrequested.",
3409 "type": "string"
3410 }
3411 },
3412 "type": "object"
3413 },
3156 "LeaseWorkItemRequest": { 3414 "LeaseWorkItemRequest": {
3157 "description": "Request to lease WorkItems.", 3415 "description": "Request to lease WorkItems.",
3158 "id": "LeaseWorkItemRequest", 3416 "id": "LeaseWorkItemRequest",
3159 "properties": { 3417 "properties": {
3418 "currentWorkerTime": {
3419 "description": "The current timestamp at the worker.",
3420 "format": "google-datetime",
3421 "type": "string"
3422 },
3423 "location": {
3424 "description": "The location which contains the WorkItem's j ob.",
3425 "type": "string"
3426 },
3427 "workItemTypes": {
3428 "description": "Filter for WorkItem type.",
3429 "items": {
3430 "type": "string"
3431 },
3432 "type": "array"
3433 },
3160 "workerCapabilities": { 3434 "workerCapabilities": {
3161 "description": "Worker capabilities. WorkItems might be limi ted to workers with specific\ncapabilities.", 3435 "description": "Worker capabilities. WorkItems might be limi ted to workers with specific\ncapabilities.",
3162 "items": { 3436 "items": {
3163 "type": "string" 3437 "type": "string"
3164 }, 3438 },
3165 "type": "array" 3439 "type": "array"
3166 }, 3440 },
3167 "workerId": { 3441 "workerId": {
3168 "description": "Identifies the worker leasing work -- typica lly the ID of the\nvirtual machine running the worker.", 3442 "description": "Identifies the worker leasing work -- typica lly the ID of the\nvirtual machine running the worker.",
3169 "type": "string" 3443 "type": "string"
3170 }, 3444 },
3171 "requestedLeaseDuration": { 3445 "requestedLeaseDuration": {
3172 "description": "The initial lease period.", 3446 "description": "The initial lease period.",
3173 "format": "google-duration", 3447 "format": "google-duration",
3174 "type": "string" 3448 "type": "string"
3175 },
3176 "currentWorkerTime": {
3177 "description": "The current timestamp at the worker.",
3178 "format": "google-datetime",
3179 "type": "string"
3180 },
3181 "workItemTypes": {
3182 "description": "Filter for WorkItem type.",
3183 "items": {
3184 "type": "string"
3185 },
3186 "type": "array"
3187 },
3188 "location": {
3189 "description": "The location which contains the WorkItem's j ob.",
3190 "type": "string"
3191 } 3449 }
3192 }, 3450 },
3193 "type": "object" 3451 "type": "object"
3194 }, 3452 },
3195 "GetDebugConfigRequest": { 3453 "GetTemplateResponse": {
3196 "description": "Request to get updated debug configuration for compo nent.", 3454 "description": "The response to a GetTemplate request.",
3197 "id": "GetDebugConfigRequest", 3455 "id": "GetTemplateResponse",
3198 "properties": { 3456 "properties": {
3199 "componentId": { 3457 "status": {
3200 "description": "The internal component id for which debug co nfiguration is\nrequested.", 3458 "$ref": "Status",
3201 "type": "string" 3459 "description": "The status of the get template request. Any problems with the\nrequest will be indicated in the error_details."
3202 }, 3460 },
3203 "workerId": { 3461 "metadata": {
3204 "description": "The worker id, i.e., VM hostname.", 3462 "$ref": "TemplateMetadata",
3205 "type": "string" 3463 "description": "The template metadata describing the templat e name, available\nparameters, etc."
3206 } 3464 }
3207 }, 3465 },
3208 "type": "object" 3466 "type": "object"
3209 }, 3467 },
3210 "ReportWorkItemStatusRequest": { 3468 "ReportWorkItemStatusRequest": {
3211 "description": "Request to report the status of WorkItems.", 3469 "description": "Request to report the status of WorkItems.",
3212 "id": "ReportWorkItemStatusRequest", 3470 "id": "ReportWorkItemStatusRequest",
3213 "properties": { 3471 "properties": {
3214 "workerId": { 3472 "workerId": {
3215 "description": "The ID of the worker reporting the WorkItem status. If this\ndoes not match the ID of the worker which the Dataflow service \nbelieves currently has the lease on the WorkItem, the report\nwill be dropped (with an error response).", 3473 "description": "The ID of the worker reporting the WorkItem status. If this\ndoes not match the ID of the worker which the Dataflow service \nbelieves currently has the lease on the WorkItem, the report\nwill be dropped (with an error response).",
(...skipping 15 matching lines...) Expand all
3231 }, 3489 },
3232 "type": "array" 3490 "type": "array"
3233 } 3491 }
3234 }, 3492 },
3235 "type": "object" 3493 "type": "object"
3236 }, 3494 },
3237 "StreamingConfigTask": { 3495 "StreamingConfigTask": {
3238 "description": "A task that carries configuration information for st reaming computations.", 3496 "description": "A task that carries configuration information for st reaming computations.",
3239 "id": "StreamingConfigTask", 3497 "id": "StreamingConfigTask",
3240 "properties": { 3498 "properties": {
3499 "streamingComputationConfigs": {
3500 "description": "Set of computation configuration information .",
3501 "items": {
3502 "$ref": "StreamingComputationConfig"
3503 },
3504 "type": "array"
3505 },
3241 "userStepToStateFamilyNameMap": { 3506 "userStepToStateFamilyNameMap": {
3242 "additionalProperties": { 3507 "additionalProperties": {
3243 "type": "string" 3508 "type": "string"
3244 }, 3509 },
3245 "description": "Map from user step names to state families." , 3510 "description": "Map from user step names to state families." ,
3246 "type": "object" 3511 "type": "object"
3512 }
3513 },
3514 "type": "object"
3515 },
3516 "PipelineDescription": {
3517 "description": "A descriptive representation of submitted pipeline a s well as the executed\nform. This data is provided by the Dataflow service for ease of visualizing\nthe pipeline and interpretting Dataflow provided metrics." ,
3518 "id": "PipelineDescription",
3519 "properties": {
3520 "originalPipelineTransform": {
3521 "description": "Description of each transform in the pipelin e and collections between them.",
3522 "items": {
3523 "$ref": "TransformSummary"
3524 },
3525 "type": "array"
3247 }, 3526 },
3248 "streamingComputationConfigs": { 3527 "displayData": {
3249 "description": "Set of computation configuration information .", 3528 "description": "Pipeline level display data.",
3250 "items": { 3529 "items": {
3251 "$ref": "StreamingComputationConfig" 3530 "$ref": "DisplayData"
3531 },
3532 "type": "array"
3533 },
3534 "executionPipelineStage": {
3535 "description": "Description of each stage of execution of th e pipeline.",
3536 "items": {
3537 "$ref": "ExecutionStageSummary"
3252 }, 3538 },
3253 "type": "array" 3539 "type": "array"
3254 } 3540 }
3255 }, 3541 },
3256 "type": "object" 3542 "type": "object"
3257 },
3258 "JobExecutionInfo": {
3259 "description": "Additional information about how a Cloud Dataflow jo b will be executed that\nisn't contained in the submitted job.",
3260 "id": "JobExecutionInfo",
3261 "properties": {
3262 "stages": {
3263 "additionalProperties": {
3264 "$ref": "JobExecutionStageInfo"
3265 },
3266 "description": "A mapping from each stage to the information about that stage.",
3267 "type": "object"
3268 }
3269 },
3270 "type": "object"
3271 }, 3543 },
3272 "Step": { 3544 "Step": {
3273 "description": "Defines a particular step within a Cloud Dataflow jo b.\n\nA job consists of multiple steps, each of which performs some\nspecific op eration as part of the overall job. Data is typically\npassed from one step to another as part of the job.\n\nHere's an example of a sequence of steps which to gether implement a\nMap-Reduce job:\n\n * Read a collection of data from some s ource, parsing the\n collection's elements.\n\n * Validate the elements.\n\n * Apply a user-defined function to map each element to some value\n and ext ract an element-specific key value.\n\n * Group elements with the same key into a single element with\n that key, transforming a multiply-keyed collection i nto a\n uniquely-keyed collection.\n\n * Write the elements out to some data sink.\n\nNote that the Cloud Dataflow service may be used to run many different \ntypes of jobs, not just Map-Reduce.", 3545 "description": "Defines a particular step within a Cloud Dataflow jo b.\n\nA job consists of multiple steps, each of which performs some\nspecific op eration as part of the overall job. Data is typically\npassed from one step to another as part of the job.\n\nHere's an example of a sequence of steps which to gether implement a\nMap-Reduce job:\n\n * Read a collection of data from some s ource, parsing the\n collection's elements.\n\n * Validate the elements.\n\n * Apply a user-defined function to map each element to some value\n and ext ract an element-specific key value.\n\n * Group elements with the same key into a single element with\n that key, transforming a multiply-keyed collection i nto a\n uniquely-keyed collection.\n\n * Write the elements out to some data sink.\n\nNote that the Cloud Dataflow service may be used to run many different \ntypes of jobs, not just Map-Reduce.",
3274 "id": "Step", 3546 "id": "Step",
3275 "properties": { 3547 "properties": {
3276 "name": { 3548 "name": {
3277 "description": "The name that identifies the step. This must be unique for each\nstep with respect to all other steps in the Cloud Dataflow job.", 3549 "description": "The name that identifies the step. This must be unique for each\nstep with respect to all other steps in the Cloud Dataflow job.",
3278 "type": "string" 3550 "type": "string"
3279 }, 3551 },
3280 "kind": { 3552 "kind": {
3281 "description": "The kind of step in the Cloud Dataflow job." , 3553 "description": "The kind of step in the Cloud Dataflow job." ,
3282 "type": "string" 3554 "type": "string"
3283 }, 3555 },
3284 "properties": { 3556 "properties": {
3285 "additionalProperties": { 3557 "additionalProperties": {
3286 "description": "Properties of the object.", 3558 "description": "Properties of the object.",
3287 "type": "any" 3559 "type": "any"
3288 }, 3560 },
3289 "description": "Named properties associated with the step. E ach kind of\npredefined step has its own required set of properties.", 3561 "description": "Named properties associated with the step. E ach kind of\npredefined step has its own required set of properties.\nMust be pr ovided on Create. Only retrieved with JOB_VIEW_ALL.",
3290 "type": "object" 3562 "type": "object"
3291 } 3563 }
3292 }, 3564 },
3565 "type": "object"
3566 },
3567 "JobExecutionInfo": {
3568 "description": "Additional information about how a Cloud Dataflow jo b will be executed that\nisn't contained in the submitted job.",
3569 "id": "JobExecutionInfo",
3570 "properties": {
3571 "stages": {
3572 "additionalProperties": {
3573 "$ref": "JobExecutionStageInfo"
3574 },
3575 "description": "A mapping from each stage to the information about that stage.",
3576 "type": "object"
3577 }
3578 },
3293 "type": "object" 3579 "type": "object"
3294 }, 3580 },
3295 "FailedLocation": { 3581 "FailedLocation": {
3296 "description": "Indicates which location failed to respond to a requ est for data.", 3582 "description": "Indicates which location failed to respond to a requ est for data.",
3297 "id": "FailedLocation", 3583 "id": "FailedLocation",
3298 "properties": { 3584 "properties": {
3299 "name": { 3585 "name": {
3300 "description": "The name of the failed location.", 3586 "description": "The name of the failed location.",
3301 "type": "string" 3587 "type": "string"
3302 } 3588 }
(...skipping 13 matching lines...) Expand all
3316 "description": "Disk storage type, as defined by Google Comp ute Engine. This\nmust be a disk type appropriate to the project and zone in wh ich\nthe workers will run. If unknown or unspecified, the service\nwill attempt to choose a reasonable default.\n\nFor example, the standard persistent disk ty pe is a resource name\ntypically ending in \"pd-standard\". If SSD persistent d isks are\navailable, the resource name typically ends with \"pd-ssd\". The\nact ual valid values are defined the Google Compute Engine API,\nnot by the Cloud Da taflow API; consult the Google Compute Engine\ndocumentation for more informatio n about determining the set of\navailable disk types for a particular project an d zone.\n\nGoogle Compute Engine Disk types are local to a particular\nproject i n a particular zone, and so the resource name will\ntypically look something lik e this:\n\ncompute.googleapis.com/projects/project-id/zones/zone/diskTypes/pd-st andard", 3602 "description": "Disk storage type, as defined by Google Comp ute Engine. This\nmust be a disk type appropriate to the project and zone in wh ich\nthe workers will run. If unknown or unspecified, the service\nwill attempt to choose a reasonable default.\n\nFor example, the standard persistent disk ty pe is a resource name\ntypically ending in \"pd-standard\". If SSD persistent d isks are\navailable, the resource name typically ends with \"pd-ssd\". The\nact ual valid values are defined the Google Compute Engine API,\nnot by the Cloud Da taflow API; consult the Google Compute Engine\ndocumentation for more informatio n about determining the set of\navailable disk types for a particular project an d zone.\n\nGoogle Compute Engine Disk types are local to a particular\nproject i n a particular zone, and so the resource name will\ntypically look something lik e this:\n\ncompute.googleapis.com/projects/project-id/zones/zone/diskTypes/pd-st andard",
3317 "type": "string" 3603 "type": "string"
3318 }, 3604 },
3319 "mountPoint": { 3605 "mountPoint": {
3320 "description": "Directory in a VM where disk is mounted.", 3606 "description": "Directory in a VM where disk is mounted.",
3321 "type": "string" 3607 "type": "string"
3322 } 3608 }
3323 }, 3609 },
3324 "type": "object" 3610 "type": "object"
3325 }, 3611 },
3326 "ListJobMessagesResponse": {
3327 "description": "Response to a request to list job messages.",
3328 "id": "ListJobMessagesResponse",
3329 "properties": {
3330 "jobMessages": {
3331 "description": "Messages in ascending timestamp order.",
3332 "items": {
3333 "$ref": "JobMessage"
3334 },
3335 "type": "array"
3336 },
3337 "nextPageToken": {
3338 "description": "The token to obtain the next page of results if there are more.",
3339 "type": "string"
3340 }
3341 },
3342 "type": "object"
3343 },
3344 "CounterMetadata": { 3612 "CounterMetadata": {
3345 "description": "CounterMetadata includes all static non-name non-val ue counter attributes.", 3613 "description": "CounterMetadata includes all static non-name non-val ue counter attributes.",
3346 "id": "CounterMetadata", 3614 "id": "CounterMetadata",
3347 "properties": { 3615 "properties": {
3348 "standardUnits": { 3616 "standardUnits": {
3349 "description": "System defined Units, see above enum.", 3617 "description": "System defined Units, see above enum.",
3350 "enum": [ 3618 "enum": [
3351 "BYTES", 3619 "BYTES",
3352 "BYTES_PER_SEC", 3620 "BYTES_PER_SEC",
3353 "MILLISECONDS", 3621 "MILLISECONDS",
(...skipping 45 matching lines...) Expand 10 before | Expand all | Expand 10 after
3399 ], 3667 ],
3400 "type": "string" 3668 "type": "string"
3401 }, 3669 },
3402 "description": { 3670 "description": {
3403 "description": "Human-readable description of the counter se mantics.", 3671 "description": "Human-readable description of the counter se mantics.",
3404 "type": "string" 3672 "type": "string"
3405 } 3673 }
3406 }, 3674 },
3407 "type": "object" 3675 "type": "object"
3408 }, 3676 },
3677 "ListJobMessagesResponse": {
3678 "description": "Response to a request to list job messages.",
3679 "id": "ListJobMessagesResponse",
3680 "properties": {
3681 "jobMessages": {
3682 "description": "Messages in ascending timestamp order.",
3683 "items": {
3684 "$ref": "JobMessage"
3685 },
3686 "type": "array"
3687 },
3688 "nextPageToken": {
3689 "description": "The token to obtain the next page of results if there are more.",
3690 "type": "string"
3691 }
3692 },
3693 "type": "object"
3694 },
3409 "ApproximateReportedProgress": { 3695 "ApproximateReportedProgress": {
3410 "description": "A progress measurement of a WorkItem by a worker.", 3696 "description": "A progress measurement of a WorkItem by a worker.",
3411 "id": "ApproximateReportedProgress", 3697 "id": "ApproximateReportedProgress",
3412 "properties": { 3698 "properties": {
3413 "remainingParallelism": {
3414 "$ref": "ReportedParallelism",
3415 "description": "Total amount of parallelism in the input of this task that remains,\n(i.e. can be delegated to this task and any new tasks v ia dynamic\nsplitting). Always at least 1 for non-finished work items and 0 for\ nfinished.\n\n\"Amount of parallelism\" refers to how many non-empty parts of th e input\ncan be read in parallel. This does not necessarily equal number\nof rec ords. An input that can be read in parallel down to the\nindividual records is c alled \"perfectly splittable\".\nAn example of non-perfectly parallelizable inpu t is a block-compressed\nfile format where a block of records has to be read as a whole,\nbut different blocks can be read in parallel.\n\nExamples:\n* If we ar e processing record #30 (starting at 1) out of 50 in a perfectly\n splittable 5 0-record input, this value should be 21 (20 remaining + 1\n current).\n* If we are reading through block 3 in a block-compressed file consisting\n of 5 blocks , this value should be 3 (since blocks 4 and 5 can be\n processed in parallel b y new tasks via dynamic splitting and the current\n task remains processing blo ck 3).\n* If we are reading through the last block in a block-compressed file,\n or reading or processing the last record in a perfectly splittable\n input, t his value should be 1, because apart from the current task, no\n additional rem ainder can be split off."
3416 },
3417 "position": { 3699 "position": {
3418 "$ref": "Position", 3700 "$ref": "Position",
3419 "description": "A Position within the work to represent a pr ogress." 3701 "description": "A Position within the work to represent a pr ogress."
3420 }, 3702 },
3421 "fractionConsumed": { 3703 "fractionConsumed": {
3422 "description": "Completion as fraction of the input consumed , from 0.0 (beginning, nothing\nconsumed), to 1.0 (end of the input, entire inpu t consumed).", 3704 "description": "Completion as fraction of the input consumed , from 0.0 (beginning, nothing\nconsumed), to 1.0 (end of the input, entire inpu t consumed).",
3423 "format": "double", 3705 "format": "double",
3424 "type": "number" 3706 "type": "number"
3425 }, 3707 },
3426 "consumedParallelism": { 3708 "consumedParallelism": {
3427 "$ref": "ReportedParallelism", 3709 "$ref": "ReportedParallelism",
3428 "description": "Total amount of parallelism in the portion o f input of this task that has\nalready been consumed and is no longer active. In the first two examples\nabove (see remaining_parallelism), the value should be 29 or 2\nrespectively. The sum of remaining_parallelism and consumed_parallelis m\nshould equal the total amount of parallelism in this work item. If\nspecifie d, must be finite." 3710 "description": "Total amount of parallelism in the portion o f input of this task that has\nalready been consumed and is no longer active. In the first two examples\nabove (see remaining_parallelism), the value should be 29 or 2\nrespectively. The sum of remaining_parallelism and consumed_parallelis m\nshould equal the total amount of parallelism in this work item. If\nspecifie d, must be finite."
3711 },
3712 "remainingParallelism": {
3713 "$ref": "ReportedParallelism",
3714 "description": "Total amount of parallelism in the input of this task that remains,\n(i.e. can be delegated to this task and any new tasks v ia dynamic\nsplitting). Always at least 1 for non-finished work items and 0 for\ nfinished.\n\n\"Amount of parallelism\" refers to how many non-empty parts of th e input\ncan be read in parallel. This does not necessarily equal number\nof rec ords. An input that can be read in parallel down to the\nindividual records is c alled \"perfectly splittable\".\nAn example of non-perfectly parallelizable inpu t is a block-compressed\nfile format where a block of records has to be read as a whole,\nbut different blocks can be read in parallel.\n\nExamples:\n* If we ar e processing record #30 (starting at 1) out of 50 in a perfectly\n splittable 5 0-record input, this value should be 21 (20 remaining + 1\n current).\n* If we are reading through block 3 in a block-compressed file consisting\n of 5 blocks , this value should be 3 (since blocks 4 and 5 can be\n processed in parallel b y new tasks via dynamic splitting and the current\n task remains processing blo ck 3).\n* If we are reading through the last block in a block-compressed file,\n or reading or processing the last record in a perfectly splittable\n input, t his value should be 1, because apart from the current task, no\n additional rem ainder can be split off."
3429 } 3715 }
3430 }, 3716 },
3431 "type": "object" 3717 "type": "object"
3432 }, 3718 },
3433 "StateFamilyConfig": { 3719 "StateFamilyConfig": {
3434 "description": "State family configuration.", 3720 "description": "State family configuration.",
3435 "id": "StateFamilyConfig", 3721 "id": "StateFamilyConfig",
3436 "properties": { 3722 "properties": {
3437 "stateFamily": { 3723 "stateFamily": {
3438 "description": "The state family value.", 3724 "description": "The state family value.",
(...skipping 58 matching lines...) Expand 10 before | Expand all | Expand 10 after
3497 }, 3783 },
3498 "type": "array" 3784 "type": "array"
3499 } 3785 }
3500 }, 3786 },
3501 "type": "object" 3787 "type": "object"
3502 }, 3788 },
3503 "ParallelInstruction": { 3789 "ParallelInstruction": {
3504 "description": "Describes a particular operation comprising a MapTas k.", 3790 "description": "Describes a particular operation comprising a MapTas k.",
3505 "id": "ParallelInstruction", 3791 "id": "ParallelInstruction",
3506 "properties": { 3792 "properties": {
3507 "name": {
3508 "description": "User-provided name of this operation.",
3509 "type": "string"
3510 },
3511 "parDo": {
3512 "$ref": "ParDoInstruction",
3513 "description": "Additional information for ParDo instruction s."
3514 },
3515 "read": {
3516 "$ref": "ReadInstruction",
3517 "description": "Additional information for Read instructions ."
3518 },
3519 "flatten": { 3793 "flatten": {
3520 "$ref": "FlattenInstruction", 3794 "$ref": "FlattenInstruction",
3521 "description": "Additional information for Flatten instructi ons." 3795 "description": "Additional information for Flatten instructi ons."
3522 }, 3796 },
3523 "originalName": { 3797 "originalName": {
3524 "description": "System-defined name for the operation in the original workflow graph.", 3798 "description": "System-defined name for the operation in the original workflow graph.",
3525 "type": "string" 3799 "type": "string"
3526 }, 3800 },
3527 "write": { 3801 "write": {
3528 "$ref": "WriteInstruction", 3802 "$ref": "WriteInstruction",
3529 "description": "Additional information for Write instruction s." 3803 "description": "Additional information for Write instruction s."
3530 }, 3804 },
3531 "systemName": { 3805 "systemName": {
3532 "description": "System-defined name of this operation.\nUniq ue across the workflow.", 3806 "description": "System-defined name of this operation.\nUniq ue across the workflow.",
3533 "type": "string" 3807 "type": "string"
3534 }, 3808 },
3535 "partialGroupByKey": { 3809 "partialGroupByKey": {
3536 "$ref": "PartialGroupByKeyInstruction", 3810 "$ref": "PartialGroupByKeyInstruction",
3537 "description": "Additional information for PartialGroupByKey instructions." 3811 "description": "Additional information for PartialGroupByKey instructions."
3538 }, 3812 },
3539 "outputs": { 3813 "outputs": {
3540 "description": "Describes the outputs of the instruction.", 3814 "description": "Describes the outputs of the instruction.",
3541 "items": { 3815 "items": {
3542 "$ref": "InstructionOutput" 3816 "$ref": "InstructionOutput"
3543 }, 3817 },
3544 "type": "array" 3818 "type": "array"
3819 },
3820 "name": {
3821 "description": "User-provided name of this operation.",
3822 "type": "string"
3823 },
3824 "parDo": {
3825 "$ref": "ParDoInstruction",
3826 "description": "Additional information for ParDo instruction s."
3827 },
3828 "read": {
3829 "$ref": "ReadInstruction",
3830 "description": "Additional information for Read instructions ."
3545 } 3831 }
3546 }, 3832 },
3547 "type": "object" 3833 "type": "object"
3548 }, 3834 },
3549 "KeyRangeDataDiskAssignment": { 3835 "KeyRangeDataDiskAssignment": {
3550 "description": "Data disk assignment information for a specific key- range of a sharded\ncomputation.\nCurrently we only support UTF-8 character spli ts to simplify encoding into\nJSON.", 3836 "description": "Data disk assignment information for a specific key- range of a sharded\ncomputation.\nCurrently we only support UTF-8 character spli ts to simplify encoding into\nJSON.",
3551 "id": "KeyRangeDataDiskAssignment", 3837 "id": "KeyRangeDataDiskAssignment",
3552 "properties": { 3838 "properties": {
3553 "start": { 3839 "start": {
3554 "description": "The start (inclusive) of the key range.", 3840 "description": "The start (inclusive) of the key range.",
(...skipping 56 matching lines...) Expand 10 before | Expand all | Expand 10 after
3611 "description": "The user function to invoke.", 3897 "description": "The user function to invoke.",
3612 "type": "object" 3898 "type": "object"
3613 }, 3899 },
3614 "input": { 3900 "input": {
3615 "$ref": "InstructionInput", 3901 "$ref": "InstructionInput",
3616 "description": "The input." 3902 "description": "The input."
3617 } 3903 }
3618 }, 3904 },
3619 "type": "object" 3905 "type": "object"
3620 }, 3906 },
3621 "MetricUpdate": {
3622 "description": "Describes the state of a metric.",
3623 "id": "MetricUpdate",
3624 "properties": {
3625 "meanSum": {
3626 "description": "Worker-computed aggregate value for the \"Me an\" aggregation kind.\nThis holds the sum of the aggregated values and is used in combination\nwith mean_count below to obtain the actual mean aggregate value. \nThe only possible value types are Long and Double.",
3627 "type": "any"
3628 },
3629 "updateTime": {
3630 "description": "Timestamp associated with the metric value. Optional when workers are\nreporting work progress; it will be filled in respons es from the\nmetrics API.",
3631 "format": "google-datetime",
3632 "type": "string"
3633 },
3634 "name": {
3635 "$ref": "MetricStructuredName",
3636 "description": "Name of the metric."
3637 },
3638 "set": {
3639 "description": "Worker-computed aggregate value for the \"Se t\" aggregation kind. The only\npossible value type is a list of Values whose t ype can be Long, Double,\nor String, according to the metric's type. All Values in the list must\nbe of the same type.",
3640 "type": "any"
3641 },
3642 "internal": {
3643 "description": "Worker-computed aggregate value for internal use by the Dataflow\nservice.",
3644 "type": "any"
3645 },
3646 "cumulative": {
3647 "description": "True if this metric is reported as the total cumulative aggregate\nvalue accumulated since the worker started working on thi s WorkItem.\nBy default this is false, indicating that this metric is reported\n as a delta that is not associated with any WorkItem.",
3648 "type": "boolean"
3649 },
3650 "kind": {
3651 "description": "Metric aggregation kind. The possible metri c aggregation kinds are\n\"Sum\", \"Max\", \"Min\", \"Mean\", \"Set\", \"And\", and \"Or\".\nThe specified aggregation kind is case-insensitive.\n\nIf omitted, this is not an aggregated value but instead\na single metric sample value.",
3652 "type": "string"
3653 },
3654 "scalar": {
3655 "description": "Worker-computed aggregate value for aggregat ion kinds \"Sum\", \"Max\", \"Min\",\n\"And\", and \"Or\". The possible value t ypes are Long, Double, and Boolean.",
3656 "type": "any"
3657 },
3658 "meanCount": {
3659 "description": "Worker-computed aggregate value for the \"Me an\" aggregation kind.\nThis holds the count of the aggregated values and is use d in combination\nwith mean_sum above to obtain the actual mean aggregate value. \nThe only possible value type is Long.",
3660 "type": "any"
3661 }
3662 },
3663 "type": "object"
3664 },
3665 "CounterStructuredName": { 3907 "CounterStructuredName": {
3666 "description": "Identifies a counter within a per-job namespace. Cou nters whose structured\nnames are the same get merged into a single value for th e job.", 3908 "description": "Identifies a counter within a per-job namespace. Cou nters whose structured\nnames are the same get merged into a single value for th e job.",
3667 "id": "CounterStructuredName", 3909 "id": "CounterStructuredName",
3668 "properties": { 3910 "properties": {
3911 "componentStepName": {
3912 "description": "Name of the optimized step being executed by the workers.",
3913 "type": "string"
3914 },
3915 "portion": {
3916 "description": "Portion of this counter, either key or value .",
3917 "enum": [
3918 "ALL",
3919 "KEY",
3920 "VALUE"
3921 ],
3922 "enumDescriptions": [
3923 "Counter portion has not been set.",
3924 "Counter reports a key.",
3925 "Counter reports a value."
3926 ],
3927 "type": "string"
3928 },
3929 "originalStepName": {
3930 "description": "System generated name of the original step i n the user's graph, before\noptimization.",
3931 "type": "string"
3932 },
3669 "workerId": { 3933 "workerId": {
3670 "description": "ID of a particular worker.", 3934 "description": "ID of a particular worker.",
3671 "type": "string" 3935 "type": "string"
3672 }, 3936 },
3673 "originNamespace": { 3937 "originNamespace": {
3674 "description": "A string containing a more specific namespac e of the counter's origin.", 3938 "description": "A string containing a more specific namespac e of the counter's origin.",
3675 "type": "string" 3939 "type": "string"
3676 }, 3940 },
3677 "origin": { 3941 "origin": {
3678 "description": "One of the standard Origins defined above.", 3942 "description": "One of the standard Origins defined above.",
3679 "enum": [ 3943 "enum": [
3680 "SYSTEM", 3944 "SYSTEM",
3681 "USER" 3945 "USER"
3682 ], 3946 ],
3683 "enumDescriptions": [ 3947 "enumDescriptions": [
3684 "Counter was created by the Dataflow system.", 3948 "Counter was created by the Dataflow system.",
3685 "Counter was created by the user." 3949 "Counter was created by the user."
3686 ], 3950 ],
3687 "type": "string" 3951 "type": "string"
3688 }, 3952 },
3689 "name": {
3690 "description": "Counter name. Not necessarily globally-uniqu e, but unique within the\ncontext of the other fields.\nRequired.",
3691 "type": "string"
3692 },
3693 "executionStepName": { 3953 "executionStepName": {
3694 "description": "Name of the stage. An execution step contain s multiple component steps.", 3954 "description": "Name of the stage. An execution step contain s multiple component steps.",
3695 "type": "string" 3955 "type": "string"
3696 }, 3956 },
3697 "componentStepName": { 3957 "name": {
3698 "description": "Name of the optimized step being executed by the workers.", 3958 "description": "Counter name. Not necessarily globally-uniqu e, but unique within the\ncontext of the other fields.\nRequired.",
3699 "type": "string"
3700 },
3701 "portion": {
3702 "description": "Portion of this counter, either key or value .",
3703 "enum": [
3704 "ALL",
3705 "KEY",
3706 "VALUE"
3707 ],
3708 "enumDescriptions": [
3709 "Counter portion has not been set.",
3710 "Counter reports a key.",
3711 "Counter reports a value."
3712 ],
3713 "type": "string"
3714 },
3715 "originalStepName": {
3716 "description": "System generated name of the original step i n the user's graph, before\noptimization.",
3717 "type": "string" 3959 "type": "string"
3718 } 3960 }
3719 }, 3961 },
3720 "type": "object" 3962 "type": "object"
3963 },
3964 "MetricUpdate": {
3965 "description": "Describes the state of a metric.",
3966 "id": "MetricUpdate",
3967 "properties": {
3968 "kind": {
3969 "description": "Metric aggregation kind. The possible metri c aggregation kinds are\n\"Sum\", \"Max\", \"Min\", \"Mean\", \"Set\", \"And\", and \"Or\".\nThe specified aggregation kind is case-insensitive.\n\nIf omitted, this is not an aggregated value but instead\na single metric sample value.",
3970 "type": "string"
3971 },
3972 "scalar": {
3973 "description": "Worker-computed aggregate value for aggregat ion kinds \"Sum\", \"Max\", \"Min\",\n\"And\", and \"Or\". The possible value t ypes are Long, Double, and Boolean.",
3974 "type": "any"
3975 },
3976 "meanCount": {
3977 "description": "Worker-computed aggregate value for the \"Me an\" aggregation kind.\nThis holds the count of the aggregated values and is use d in combination\nwith mean_sum above to obtain the actual mean aggregate value. \nThe only possible value type is Long.",
3978 "type": "any"
3979 },
3980 "meanSum": {
3981 "description": "Worker-computed aggregate value for the \"Me an\" aggregation kind.\nThis holds the sum of the aggregated values and is used in combination\nwith mean_count below to obtain the actual mean aggregate value. \nThe only possible value types are Long and Double.",
3982 "type": "any"
3983 },
3984 "updateTime": {
3985 "description": "Timestamp associated with the metric value. Optional when workers are\nreporting work progress; it will be filled in respons es from the\nmetrics API.",
3986 "format": "google-datetime",
3987 "type": "string"
3988 },
3989 "name": {
3990 "$ref": "MetricStructuredName",
3991 "description": "Name of the metric."
3992 },
3993 "set": {
3994 "description": "Worker-computed aggregate value for the \"Se t\" aggregation kind. The only\npossible value type is a list of Values whose t ype can be Long, Double,\nor String, according to the metric's type. All Values in the list must\nbe of the same type.",
3995 "type": "any"
3996 },
3997 "cumulative": {
3998 "description": "True if this metric is reported as the total cumulative aggregate\nvalue accumulated since the worker started working on thi s WorkItem.\nBy default this is false, indicating that this metric is reported\n as a delta that is not associated with any WorkItem.",
3999 "type": "boolean"
4000 },
4001 "internal": {
4002 "description": "Worker-computed aggregate value for internal use by the Dataflow\nservice.",
4003 "type": "any"
4004 }
4005 },
4006 "type": "object"
3721 }, 4007 },
3722 "ApproximateProgress": { 4008 "ApproximateProgress": {
3723 "description": "Obsolete in favor of ApproximateReportedProgress and ApproximateSplitRequest.", 4009 "description": "Obsolete in favor of ApproximateReportedProgress and ApproximateSplitRequest.",
3724 "id": "ApproximateProgress", 4010 "id": "ApproximateProgress",
3725 "properties": { 4011 "properties": {
4012 "position": {
4013 "$ref": "Position",
4014 "description": "Obsolete."
4015 },
3726 "percentComplete": { 4016 "percentComplete": {
3727 "description": "Obsolete.", 4017 "description": "Obsolete.",
3728 "format": "float", 4018 "format": "float",
3729 "type": "number" 4019 "type": "number"
3730 }, 4020 },
3731 "remainingTime": { 4021 "remainingTime": {
3732 "description": "Obsolete.", 4022 "description": "Obsolete.",
3733 "format": "google-duration", 4023 "format": "google-duration",
3734 "type": "string" 4024 "type": "string"
3735 },
3736 "position": {
3737 "$ref": "Position",
3738 "description": "Obsolete."
3739 } 4025 }
3740 }, 4026 },
3741 "type": "object" 4027 "type": "object"
3742 }, 4028 },
3743 "WorkerMessageResponse": { 4029 "WorkerMessageResponse": {
3744 "description": "A worker_message response allows the server to pass information to the\nsender.", 4030 "description": "A worker_message response allows the server to pass information to the\nsender.",
3745 "id": "WorkerMessageResponse", 4031 "id": "WorkerMessageResponse",
3746 "properties": { 4032 "properties": {
3747 "workerMetricsResponse": { 4033 "workerMetricsResponse": {
3748 "$ref": "ResourceUtilizationReportResponse", 4034 "$ref": "ResourceUtilizationReportResponse",
3749 "description": "Service's response to reporting worker metri cs (currently empty)." 4035 "description": "Service's response to reporting worker metri cs (currently empty)."
3750 }, 4036 },
3751 "workerHealthReportResponse": { 4037 "workerHealthReportResponse": {
3752 "$ref": "WorkerHealthReportResponse", 4038 "$ref": "WorkerHealthReportResponse",
3753 "description": "The service's response to a worker's health report." 4039 "description": "The service's response to a worker's health report."
3754 } 4040 }
3755 }, 4041 },
3756 "type": "object" 4042 "type": "object"
3757 }, 4043 },
4044 "TemplateMetadata": {
4045 "description": "Metadata describing a template.",
4046 "id": "TemplateMetadata",
4047 "properties": {
4048 "name": {
4049 "description": "Required. The name of the template.",
4050 "type": "string"
4051 },
4052 "parameters": {
4053 "description": "The parameters for the template.",
4054 "items": {
4055 "$ref": "ParameterMetadata"
4056 },
4057 "type": "array"
4058 },
4059 "description": {
4060 "description": "Optional. A description of the template.",
4061 "type": "string"
4062 },
4063 "bypassTempDirValidation": {
4064 "description": "If true, will bypass the validation that the temp directory is\nwritable. This should only be used with templates for pipeli nes\nthat are guaranteed not to need to write to the temp directory,\nwhich is s ubject to change based on the optimizer.",
4065 "type": "boolean"
4066 }
4067 },
4068 "type": "object"
4069 },
3758 "WorkerMessage": { 4070 "WorkerMessage": {
3759 "description": "WorkerMessage provides information to the backend ab out a worker.", 4071 "description": "WorkerMessage provides information to the backend ab out a worker.",
3760 "id": "WorkerMessage", 4072 "id": "WorkerMessage",
3761 "properties": { 4073 "properties": {
3762 "workerMessageCode": { 4074 "workerMessageCode": {
3763 "$ref": "WorkerMessageCode", 4075 "$ref": "WorkerMessageCode",
3764 "description": "A worker message code." 4076 "description": "A worker message code."
3765 }, 4077 },
3766 "workerMetrics": { 4078 "workerMetrics": {
3767 "$ref": "ResourceUtilizationReport", 4079 "$ref": "ResourceUtilizationReport",
(...skipping 49 matching lines...) Expand 10 before | Expand all | Expand 10 after
3817 }, 4129 },
3818 "type": "array" 4130 "type": "array"
3819 } 4131 }
3820 }, 4132 },
3821 "type": "object" 4133 "type": "object"
3822 }, 4134 },
3823 "CounterUpdate": { 4135 "CounterUpdate": {
3824 "description": "An update to a Counter sent from a worker.", 4136 "description": "An update to a Counter sent from a worker.",
3825 "id": "CounterUpdate", 4137 "id": "CounterUpdate",
3826 "properties": { 4138 "properties": {
3827 "shortId": {
3828 "description": "The service-generated short identifier for t his counter.\nThe short_id -> (name, metadata) mapping is constant for the lifet ime of\na job.",
3829 "format": "int64",
3830 "type": "string"
3831 },
3832 "floatingPointList": {
3833 "$ref": "FloatingPointList",
3834 "description": "List of floating point numbers, for Set."
3835 },
3836 "integer": {
3837 "$ref": "SplitInt64",
3838 "description": "Integer value for Sum, Max, Min."
3839 },
3840 "structuredNameAndMetadata": { 4139 "structuredNameAndMetadata": {
3841 "$ref": "CounterStructuredNameAndMetadata", 4140 "$ref": "CounterStructuredNameAndMetadata",
3842 "description": "Counter structured name and metadata." 4141 "description": "Counter structured name and metadata."
3843 }, 4142 },
3844 "integerList": { 4143 "integerList": {
3845 "$ref": "IntegerList", 4144 "$ref": "IntegerList",
3846 "description": "List of integers, for Set." 4145 "description": "List of integers, for Set."
3847 }, 4146 },
3848 "floatingPoint": { 4147 "floatingPoint": {
3849 "description": "Floating point value for Sum, Max, Min.", 4148 "description": "Floating point value for Sum, Max, Min.",
3850 "format": "double", 4149 "format": "double",
3851 "type": "number" 4150 "type": "number"
3852 }, 4151 },
3853 "integerMean": { 4152 "integerMean": {
3854 "$ref": "IntegerMean", 4153 "$ref": "IntegerMean",
3855 "description": "Integer mean aggregation value for Mean." 4154 "description": "Integer mean aggregation value for Mean."
3856 }, 4155 },
4156 "internal": {
4157 "description": "Value for internally-defined counters used b y the Dataflow service.",
4158 "type": "any"
4159 },
3857 "cumulative": { 4160 "cumulative": {
3858 "description": "True if this counter is reported as the tota l cumulative aggregate\nvalue accumulated since the worker started working on th is WorkItem.\nBy default this is false, indicating that this counter is reported \nas a delta.", 4161 "description": "True if this counter is reported as the tota l cumulative aggregate\nvalue accumulated since the worker started working on th is WorkItem.\nBy default this is false, indicating that this counter is reported \nas a delta.",
3859 "type": "boolean" 4162 "type": "boolean"
3860 }, 4163 },
3861 "internal": {
3862 "description": "Value for internally-defined counters used b y the Dataflow service.",
3863 "type": "any"
3864 },
3865 "floatingPointMean": { 4164 "floatingPointMean": {
3866 "$ref": "FloatingPointMean", 4165 "$ref": "FloatingPointMean",
3867 "description": "Floating point mean aggregation value for Me an." 4166 "description": "Floating point mean aggregation value for Me an."
3868 }, 4167 },
3869 "boolean": { 4168 "boolean": {
3870 "description": "Boolean value for And, Or.", 4169 "description": "Boolean value for And, Or.",
3871 "type": "boolean" 4170 "type": "boolean"
3872 }, 4171 },
3873 "nameAndKind": { 4172 "nameAndKind": {
3874 "$ref": "NameAndKind", 4173 "$ref": "NameAndKind",
3875 "description": "Counter name and aggregation type." 4174 "description": "Counter name and aggregation type."
3876 }, 4175 },
3877 "stringList": { 4176 "stringList": {
3878 "$ref": "StringList", 4177 "$ref": "StringList",
3879 "description": "List of strings, for Set." 4178 "description": "List of strings, for Set."
3880 }, 4179 },
3881 "distribution": { 4180 "distribution": {
3882 "$ref": "DistributionUpdate", 4181 "$ref": "DistributionUpdate",
3883 "description": "Distribution data" 4182 "description": "Distribution data"
4183 },
4184 "shortId": {
4185 "description": "The service-generated short identifier for t his counter.\nThe short_id -> (name, metadata) mapping is constant for the lifet ime of\na job.",
4186 "format": "int64",
4187 "type": "string"
4188 },
4189 "floatingPointList": {
4190 "$ref": "FloatingPointList",
4191 "description": "List of floating point numbers, for Set."
4192 },
4193 "integer": {
4194 "$ref": "SplitInt64",
4195 "description": "Integer value for Sum, Max, Min."
3884 } 4196 }
3885 }, 4197 },
3886 "type": "object" 4198 "type": "object"
3887 }, 4199 },
3888 "SourceMetadata": { 4200 "SourceMetadata": {
3889 "description": "Metadata about a Source useful for automatically opt imizing\nand tuning the pipeline, etc.", 4201 "description": "Metadata about a Source useful for automatically opt imizing\nand tuning the pipeline, etc.",
3890 "id": "SourceMetadata", 4202 "id": "SourceMetadata",
3891 "properties": { 4203 "properties": {
3892 "producesSortedKeys": { 4204 "producesSortedKeys": {
3893 "description": "Whether this source is known to produce key/ value pairs with\nthe (encoded) keys in lexicographically sorted order.", 4205 "description": "Whether this source is known to produce key/ value pairs with\nthe (encoded) keys in lexicographically sorted order.",
(...skipping 32 matching lines...) Expand 10 before | Expand all | Expand 10 after
3926 "$ref": "SplitInt64", 4238 "$ref": "SplitInt64",
3927 "description": "The maximum value present in the distributio n." 4239 "description": "The maximum value present in the distributio n."
3928 }, 4240 },
3929 "sum": { 4241 "sum": {
3930 "$ref": "SplitInt64", 4242 "$ref": "SplitInt64",
3931 "description": "Use an int64 since we'd prefer the added pre cision. If overflow is a common\nproblem we can detect it and use an additional int64 or a double." 4243 "description": "Use an int64 since we'd prefer the added pre cision. If overflow is a common\nproblem we can detect it and use an additional int64 or a double."
3932 } 4244 }
3933 }, 4245 },
3934 "type": "object" 4246 "type": "object"
3935 }, 4247 },
4248 "WorkerHealthReportResponse": {
4249 "description": "WorkerHealthReportResponse contains information retu rned to the worker\nin response to a health ping.",
4250 "id": "WorkerHealthReportResponse",
4251 "properties": {
4252 "reportInterval": {
4253 "description": "A positive value indicates the worker should change its reporting interval\nto the specified value.\n\nThe default value of zero means no change in report rate is requested by\nthe server.",
4254 "format": "google-duration",
4255 "type": "string"
4256 }
4257 },
4258 "type": "object"
4259 },
3936 "SourceFork": { 4260 "SourceFork": {
3937 "description": "DEPRECATED in favor of DynamicSourceSplit.", 4261 "description": "DEPRECATED in favor of DynamicSourceSplit.",
3938 "id": "SourceFork", 4262 "id": "SourceFork",
3939 "properties": { 4263 "properties": {
4264 "residual": {
4265 "$ref": "SourceSplitShard",
4266 "description": "DEPRECATED"
4267 },
3940 "residualSource": { 4268 "residualSource": {
3941 "$ref": "DerivedSource", 4269 "$ref": "DerivedSource",
3942 "description": "DEPRECATED" 4270 "description": "DEPRECATED"
3943 }, 4271 },
3944 "primary": { 4272 "primary": {
3945 "$ref": "SourceSplitShard", 4273 "$ref": "SourceSplitShard",
3946 "description": "DEPRECATED" 4274 "description": "DEPRECATED"
3947 }, 4275 },
3948 "primarySource": { 4276 "primarySource": {
3949 "$ref": "DerivedSource", 4277 "$ref": "DerivedSource",
3950 "description": "DEPRECATED" 4278 "description": "DEPRECATED"
3951 },
3952 "residual": {
3953 "$ref": "SourceSplitShard",
3954 "description": "DEPRECATED"
3955 } 4279 }
3956 }, 4280 },
3957 "type": "object" 4281 "type": "object"
3958 }, 4282 },
3959 "WorkerHealthReportResponse": { 4283 "WorkItemStatus": {
3960 "description": "WorkerHealthReportResponse contains information retu rned to the worker\nin response to a health ping.", 4284 "description": "Conveys a worker's progress through the work describ ed by a WorkItem.",
3961 "id": "WorkerHealthReportResponse", 4285 "id": "WorkItemStatus",
3962 "properties": { 4286 "properties": {
3963 "reportInterval": { 4287 "sourceFork": {
3964 "description": "A positive value indicates the worker should change its reporting interval\nto the specified value.\n\nThe default value of zero means no change in report rate is requested by\nthe server.", 4288 "$ref": "SourceFork",
4289 "description": "DEPRECATED in favor of dynamic_source_split. "
4290 },
4291 "counterUpdates": {
4292 "description": "Worker output counters for this WorkItem.",
4293 "items": {
4294 "$ref": "CounterUpdate"
4295 },
4296 "type": "array"
4297 },
4298 "workItemId": {
4299 "description": "Identifies the WorkItem.",
4300 "type": "string"
4301 },
4302 "metricUpdates": {
4303 "description": "DEPRECATED in favor of counter_updates.",
4304 "items": {
4305 "$ref": "MetricUpdate"
4306 },
4307 "type": "array"
4308 },
4309 "errors": {
4310 "description": "Specifies errors which occurred during proce ssing. If errors are\nprovided, and completed = true, then the WorkItem is cons idered\nto have failed.",
4311 "items": {
4312 "$ref": "Status"
4313 },
4314 "type": "array"
4315 },
4316 "dynamicSourceSplit": {
4317 "$ref": "DynamicSourceSplit",
4318 "description": "See documentation of stop_position."
4319 },
4320 "sourceOperationResponse": {
4321 "$ref": "SourceOperationResponse",
4322 "description": "If the work item represented a SourceOperati onRequest, and the work\nis completed, contains the result of the operation."
4323 },
4324 "progress": {
4325 "$ref": "ApproximateProgress",
4326 "description": "DEPRECATED in favor of reported_progress."
4327 },
4328 "requestedLeaseDuration": {
4329 "description": "Amount of time the worker requests for its l ease.",
3965 "format": "google-duration", 4330 "format": "google-duration",
3966 "type": "string" 4331 "type": "string"
4332 },
4333 "reportIndex": {
4334 "description": "The report index. When a WorkItem is leased , the lease will\ncontain an initial report index. When a WorkItem's status is\ nreported to the system, the report should be sent with\nthat report index, and the response will contain the index the\nworker should use for the next report. Reports received with\nunexpected index values will be rejected by the service. \n\nIn order to preserve idempotency, the worker should not alter the\ncontents of a report, even if the worker must submit the same\nreport multiple times befo re getting back a response. The worker\nshould not submit a subsequent report u ntil the response for the\nprevious report had been received from the service.",
4335 "format": "int64",
4336 "type": "string"
4337 },
4338 "stopPosition": {
4339 "$ref": "Position",
4340 "description": "A worker may split an active map task in two parts, \"primary\" and\n\"residual\", continuing to process the primary part an d returning the\nresidual part into the pool of available work.\nThis event is c alled a \"dynamic split\" and is critical to the dynamic\nwork rebalancing featu re. The two obtained sub-tasks are called\n\"parts\" of the split.\nThe parts, i f concatenated, must represent the same input as would\nbe read by the current t ask if the split did not happen.\nThe exact way in which the original task is de composed into the two\nparts is specified either as a position demarcating them\ n(stop_position), or explicitly as two DerivedSources, if this\ntask consumes a user-defined source type (dynamic_source_split).\n\nThe \"current\" task is adju sted as a result of the split: after a task\nwith range [A, B) sends a stop_posi tion update at C, its range is\nconsidered to be [A, C), e.g.:\n* Progress shoul d be interpreted relative to the new range, e.g.\n \"75% completed\" means \"75 % of [A, C) completed\"\n* The worker should interpret proposed_stop_position re lative to the\n new range, e.g. \"split at 68%\" should be interpreted as\n \" split at 68% of [A, C)\".\n* If the worker chooses to split again using stop_pos ition, only\n stop_positions in [A, C) will be accepted.\n* Etc.\ndynamic_sourc e_split has similar semantics: e.g., if a task with\nsource S splits using dynam ic_source_split into {P, R}\n(where P and R must be together equivalent to S), t hen subsequent\nprogress and proposed_stop_position should be interpreted relati ve\nto P, and in a potential subsequent dynamic_source_split into {P', R'},\nP' and R' must be together equivalent to P, etc."
4341 },
4342 "completed": {
4343 "description": "True if the WorkItem was completed (successf ully or unsuccessfully).",
4344 "type": "boolean"
4345 },
4346 "reportedProgress": {
4347 "$ref": "ApproximateReportedProgress",
4348 "description": "The worker's progress through this WorkItem. "
4349 }
4350 },
4351 "type": "object"
4352 },
4353 "ComponentSource": {
4354 "description": "Description of an interstitial value between transfo rms in an execution\nstage.",
4355 "id": "ComponentSource",
4356 "properties": {
4357 "originalTransformOrCollection": {
4358 "description": "User name for the original user transform or collection with which this\nsource is most closely associated.",
4359 "type": "string"
4360 },
4361 "name": {
4362 "description": "Dataflow service generated name for this sou rce.",
4363 "type": "string"
4364 },
4365 "userName": {
4366 "description": "Human-readable name for this transform; may be user or system generated.",
4367 "type": "string"
3967 } 4368 }
3968 }, 4369 },
3969 "type": "object" 4370 "type": "object"
4371 },
4372 "WorkItemServiceState": {
4373 "description": "The Dataflow service's idea of the current state of a WorkItem\nbeing processed by a worker.",
4374 "id": "WorkItemServiceState",
4375 "properties": {
4376 "suggestedStopPosition": {
4377 "$ref": "Position",
4378 "description": "Obsolete, always empty."
4379 },
4380 "reportStatusInterval": {
4381 "description": "New recommended reporting interval.",
4382 "format": "google-duration",
4383 "type": "string"
4384 },
4385 "harnessData": {
4386 "additionalProperties": {
4387 "description": "Properties of the object.",
4388 "type": "any"
4389 },
4390 "description": "Other data returned by the service, specific to the particular\nworker harness.",
4391 "type": "object"
4392 },
4393 "leaseExpireTime": {
4394 "description": "Time at which the current lease will expire. ",
4395 "format": "google-datetime",
4396 "type": "string"
4397 },
4398 "metricShortId": {
4399 "description": "The short ids that workers should use in sub sequent metric updates.\nWorkers should strive to use short ids whenever possibl e, but it is ok\nto request the short_id again if a worker lost track of it\n(e. g. if the worker is recovering from a crash).\nNOTE: it is possible that the res ponse may have short ids for a subset\nof the metrics.",
4400 "items": {
4401 "$ref": "MetricShortId"
4402 },
4403 "type": "array"
4404 },
4405 "nextReportIndex": {
4406 "description": "The index value to use for the next report s ent by the worker.\nNote: If the report call fails for whatever reason, the work er should\nreuse this index for subsequent report attempts.",
4407 "format": "int64",
4408 "type": "string"
4409 },
4410 "suggestedStopPoint": {
4411 "$ref": "ApproximateProgress",
4412 "description": "DEPRECATED in favor of split_request."
4413 },
4414 "splitRequest": {
4415 "$ref": "ApproximateSplitRequest",
4416 "description": "The progress point in the WorkItem where the Dataflow service\nsuggests that the worker truncate the task."
4417 }
4418 },
4419 "type": "object"
4420 },
4421 "MetricStructuredName": {
4422 "description": "Identifies a metric, by describing the source which generated the\nmetric.",
4423 "id": "MetricStructuredName",
4424 "properties": {
4425 "context": {
4426 "additionalProperties": {
4427 "type": "string"
4428 },
4429 "description": "Zero or more labeled fields which identify t he part of the job this\nmetric is associated with, such as the name of a step o r collection.\n\nFor example, built-in counters associated with steps will have\ ncontext['step'] = <step-name>. Counters associated with PCollections\nin the SD K will have context['pcollection'] = <pcollection-name>.",
4430 "type": "object"
4431 },
4432 "origin": {
4433 "description": "Origin (namespace) of metric name. May be bl ank for user-define metrics;\nwill be \"dataflow\" for metrics defined by the Da taflow service or SDK.",
4434 "type": "string"
4435 },
4436 "name": {
4437 "description": "Worker-defined metric name.",
4438 "type": "string"
4439 }
4440 },
4441 "type": "object"
3970 } 4442 }
3971 }, 4443 },
3972 "servicePath": "", 4444 "servicePath": "",
3973 "title": "Google Dataflow API", 4445 "title": "Google Dataflow API",
3974 "version": "v1b3" 4446 "version": "v1b3"
3975 } 4447 }
OLDNEW
« no previous file with comments | « discovery/googleapis_beta/cloudresourcemanager__v1beta1.json ('k') | discovery/googleapis_beta/dataproc__v1beta1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698