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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 3006323002: Api-Roll 54: 2017-09-11 (Closed)
Patch Set: use 2.0.0-dev.infinity sdk constraint in pubspecs Created 3 years, 3 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/clouduseraccounts__beta.json ('k') | discovery/googleapis_beta/dlp__v2beta1.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": {
6 "description": "View and manage your data across Google Clou d Platform services"
7 },
8 "https://www.googleapis.com/auth/userinfo.email": { 5 "https://www.googleapis.com/auth/userinfo.email": {
9 "description": "View your email address" 6 "description": "View your email address"
10 }, 7 },
11 "https://www.googleapis.com/auth/compute.readonly": { 8 "https://www.googleapis.com/auth/compute.readonly": {
12 "description": "View your Google Compute Engine resources" 9 "description": "View your Google Compute Engine resources"
13 }, 10 },
14 "https://www.googleapis.com/auth/compute": { 11 "https://www.googleapis.com/auth/compute": {
15 "description": "View and manage your Google Compute Engine r esources" 12 "description": "View and manage your Google Compute Engine r esources"
13 },
14 "https://www.googleapis.com/auth/cloud-platform": {
15 "description": "View and manage your data across Google Clou d Platform services"
16 } 16 }
17 } 17 }
18 } 18 }
19 }, 19 },
20 "basePath": "", 20 "basePath": "",
21 "baseUrl": "https://dataflow.googleapis.com/", 21 "baseUrl": "https://dataflow.googleapis.com/",
22 "batchPath": "batch", 22 "batchPath": "batch",
23 "description": "Manages Google Cloud Dataflow projects on Google Cloud Platf orm.", 23 "description": "Manages Google Cloud Dataflow projects on Google Cloud Platf orm.",
24 "discoveryVersion": "v1", 24 "discoveryVersion": "v1",
25 "documentationLink": "https://cloud.google.com/dataflow", 25 "documentationLink": "https://cloud.google.com/dataflow",
26 "icons": { 26 "icons": {
27 "x16": "http://www.google.com/images/icons/product/search-16.gif", 27 "x16": "http://www.google.com/images/icons/product/search-16.gif",
28 "x32": "http://www.google.com/images/icons/product/search-32.gif" 28 "x32": "http://www.google.com/images/icons/product/search-32.gif"
29 }, 29 },
30 "id": "dataflow:v1b3", 30 "id": "dataflow:v1b3",
31 "kind": "discovery#restDescription", 31 "kind": "discovery#restDescription",
32 "name": "dataflow", 32 "name": "dataflow",
33 "ownerDomain": "google.com", 33 "ownerDomain": "google.com",
34 "ownerName": "Google", 34 "ownerName": "Google",
35 "parameters": { 35 "parameters": {
36 "upload_protocol": {
37 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
38 "location": "query",
39 "type": "string"
40 },
41 "prettyPrint": {
42 "default": "true",
43 "description": "Returns response with indentations and line breaks." ,
44 "location": "query",
45 "type": "boolean"
46 },
47 "fields": {
48 "description": "Selector specifying which fields to include in a par tial response.",
49 "location": "query",
50 "type": "string"
51 },
52 "uploadType": {
53 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
54 "location": "query",
55 "type": "string"
56 },
57 "callback": {
58 "description": "JSONP",
59 "location": "query",
60 "type": "string"
61 },
62 "$.xgafv": {
63 "description": "V1 error format.",
64 "enum": [
65 "1",
66 "2"
67 ],
68 "enumDescriptions": [
69 "v1 error format",
70 "v2 error format"
71 ],
72 "location": "query",
73 "type": "string"
74 },
36 "alt": { 75 "alt": {
37 "default": "json", 76 "default": "json",
38 "description": "Data format for response.", 77 "description": "Data format for response.",
39 "enum": [ 78 "enum": [
40 "json", 79 "json",
41 "media", 80 "media",
42 "proto" 81 "proto"
43 ], 82 ],
44 "enumDescriptions": [ 83 "enumDescriptions": [
45 "Responses with Content-Type of application/json", 84 "Responses with Content-Type of application/json",
(...skipping 17 matching lines...) Expand all
63 "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.", 102 "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.",
64 "location": "query", 103 "location": "query",
65 "type": "string" 104 "type": "string"
66 }, 105 },
67 "pp": { 106 "pp": {
68 "default": "true", 107 "default": "true",
69 "description": "Pretty-print response.", 108 "description": "Pretty-print response.",
70 "location": "query", 109 "location": "query",
71 "type": "boolean" 110 "type": "boolean"
72 }, 111 },
73 "bearer_token": {
74 "description": "OAuth bearer token.",
75 "location": "query",
76 "type": "string"
77 },
78 "oauth_token": { 112 "oauth_token": {
79 "description": "OAuth 2.0 token for the current user.", 113 "description": "OAuth 2.0 token for the current user.",
80 "location": "query", 114 "location": "query",
81 "type": "string" 115 "type": "string"
82 }, 116 },
83 "upload_protocol": { 117 "bearer_token": {
84 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").", 118 "description": "OAuth bearer token.",
85 "location": "query",
86 "type": "string"
87 },
88 "prettyPrint": {
89 "default": "true",
90 "description": "Returns response with indentations and line breaks." ,
91 "location": "query",
92 "type": "boolean"
93 },
94 "fields": {
95 "description": "Selector specifying which fields to include in a par tial response.",
96 "location": "query",
97 "type": "string"
98 },
99 "uploadType": {
100 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
101 "location": "query",
102 "type": "string"
103 },
104 "$.xgafv": {
105 "description": "V1 error format.",
106 "enum": [
107 "1",
108 "2"
109 ],
110 "enumDescriptions": [
111 "v1 error format",
112 "v2 error format"
113 ],
114 "location": "query",
115 "type": "string"
116 },
117 "callback": {
118 "description": "JSONP",
119 "location": "query", 119 "location": "query",
120 "type": "string" 120 "type": "string"
121 } 121 }
122 }, 122 },
123 "protocol": "rest", 123 "protocol": "rest",
124 "resources": { 124 "resources": {
125 "projects": { 125 "projects": {
126 "methods": { 126 "methods": {
127 "workerMessages": { 127 "workerMessages": {
128 "description": "Send a worker_message to the service.", 128 "description": "Send a worker_message to the service.",
(...skipping 19 matching lines...) Expand all
148 }, 148 },
149 "scopes": [ 149 "scopes": [
150 "https://www.googleapis.com/auth/cloud-platform", 150 "https://www.googleapis.com/auth/cloud-platform",
151 "https://www.googleapis.com/auth/compute", 151 "https://www.googleapis.com/auth/compute",
152 "https://www.googleapis.com/auth/compute.readonly", 152 "https://www.googleapis.com/auth/compute.readonly",
153 "https://www.googleapis.com/auth/userinfo.email" 153 "https://www.googleapis.com/auth/userinfo.email"
154 ] 154 ]
155 } 155 }
156 }, 156 },
157 "resources": { 157 "resources": {
158 "locations": { 158 "jobs": {
159 "methods": { 159 "methods": {
160 "workerMessages": { 160 "get": {
161 "description": "Send a worker_message to the service .", 161 "description": "Gets the state of the specified Clou d Dataflow job.",
162 "httpMethod": "POST", 162 "httpMethod": "GET",
163 "id": "dataflow.projects.locations.workerMessages", 163 "id": "dataflow.projects.jobs.get",
164 "parameterOrder": [ 164 "parameterOrder": [
165 "projectId", 165 "projectId",
166 "location" 166 "jobId"
167 ], 167 ],
168 "parameters": { 168 "parameters": {
169 "location": { 169 "location": {
170 "description": "The location which contains the job", 170 "description": "The location that contains t his job.",
171 "location": "query",
172 "type": "string"
173 },
174 "view": {
175 "description": "The level of information req uested in response.",
176 "enum": [
177 "JOB_VIEW_UNKNOWN",
178 "JOB_VIEW_SUMMARY",
179 "JOB_VIEW_ALL",
180 "JOB_VIEW_DESCRIPTION"
181 ],
182 "location": "query",
183 "type": "string"
184 },
185 "jobId": {
186 "description": "The job ID.",
171 "location": "path", 187 "location": "path",
172 "required": true, 188 "required": true,
173 "type": "string" 189 "type": "string"
174 }, 190 },
175 "projectId": { 191 "projectId": {
176 "description": "The project to send the Work erMessages to.", 192 "description": "The ID of the Cloud Platform project that the job belongs to.",
177 "location": "path", 193 "location": "path",
178 "required": true, 194 "required": true,
179 "type": "string" 195 "type": "string"
180 } 196 }
181 }, 197 },
182 "path": "v1b3/projects/{projectId}/locations/{locati on}/WorkerMessages", 198 "path": "v1b3/projects/{projectId}/jobs/{jobId}",
183 "request": {
184 "$ref": "SendWorkerMessagesRequest"
185 },
186 "response": { 199 "response": {
187 "$ref": "SendWorkerMessagesResponse" 200 "$ref": "Job"
188 }, 201 },
189 "scopes": [ 202 "scopes": [
190 "https://www.googleapis.com/auth/cloud-platform" , 203 "https://www.googleapis.com/auth/cloud-platform" ,
204 "https://www.googleapis.com/auth/compute",
205 "https://www.googleapis.com/auth/compute.readonl y",
206 "https://www.googleapis.com/auth/userinfo.email"
207 ]
208 },
209 "update": {
210 "description": "Updates the state of an existing Clo ud Dataflow job.",
211 "httpMethod": "PUT",
212 "id": "dataflow.projects.jobs.update",
213 "parameterOrder": [
214 "projectId",
215 "jobId"
216 ],
217 "parameters": {
218 "location": {
219 "description": "The location that contains t his job.",
220 "location": "query",
221 "type": "string"
222 },
223 "jobId": {
224 "description": "The job ID.",
225 "location": "path",
226 "required": true,
227 "type": "string"
228 },
229 "projectId": {
230 "description": "The ID of the Cloud Platform project that the job belongs to.",
231 "location": "path",
232 "required": true,
233 "type": "string"
234 }
235 },
236 "path": "v1b3/projects/{projectId}/jobs/{jobId}",
237 "request": {
238 "$ref": "Job"
239 },
240 "response": {
241 "$ref": "Job"
242 },
243 "scopes": [
244 "https://www.googleapis.com/auth/cloud-platform" ,
191 "https://www.googleapis.com/auth/compute", 245 "https://www.googleapis.com/auth/compute",
192 "https://www.googleapis.com/auth/compute.readonl y", 246 "https://www.googleapis.com/auth/compute.readonl y",
193 "https://www.googleapis.com/auth/userinfo.email" 247 "https://www.googleapis.com/auth/userinfo.email"
194 ] 248 ]
249 },
250 "aggregated": {
251 "description": "List the jobs of a project across al l regions.",
252 "httpMethod": "GET",
253 "id": "dataflow.projects.jobs.aggregated",
254 "parameterOrder": [
255 "projectId"
256 ],
257 "parameters": {
258 "view": {
259 "description": "Level of information request ed in response. Default is `JOB_VIEW_SUMMARY`.",
260 "enum": [
261 "JOB_VIEW_UNKNOWN",
262 "JOB_VIEW_SUMMARY",
263 "JOB_VIEW_ALL",
264 "JOB_VIEW_DESCRIPTION"
265 ],
266 "location": "query",
267 "type": "string"
268 },
269 "projectId": {
270 "description": "The project which owns the j obs.",
271 "location": "path",
272 "required": true,
273 "type": "string"
274 },
275 "filter": {
276 "description": "The kind of filter to use.",
277 "enum": [
278 "UNKNOWN",
279 "ALL",
280 "TERMINATED",
281 "ACTIVE"
282 ],
283 "location": "query",
284 "type": "string"
285 },
286 "location": {
287 "description": "The location that contains t his job.",
288 "location": "query",
289 "type": "string"
290 },
291 "pageToken": {
292 "description": "Set this to the 'next_page_t oken' field of a previous response\nto request additional results in a long list .",
293 "location": "query",
294 "type": "string"
295 },
296 "pageSize": {
297 "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.",
298 "format": "int32",
299 "location": "query",
300 "type": "integer"
301 }
302 },
303 "path": "v1b3/projects/{projectId}/jobs:aggregated",
304 "response": {
305 "$ref": "ListJobsResponse"
306 },
307 "scopes": [
308 "https://www.googleapis.com/auth/cloud-platform" ,
309 "https://www.googleapis.com/auth/compute",
310 "https://www.googleapis.com/auth/compute.readonl y",
311 "https://www.googleapis.com/auth/userinfo.email"
312 ]
313 },
314 "list": {
315 "description": "List the jobs of a project in a give n region.",
316 "httpMethod": "GET",
317 "id": "dataflow.projects.jobs.list",
318 "parameterOrder": [
319 "projectId"
320 ],
321 "parameters": {
322 "projectId": {
323 "description": "The project which owns the j obs.",
324 "location": "path",
325 "required": true,
326 "type": "string"
327 },
328 "filter": {
329 "description": "The kind of filter to use.",
330 "enum": [
331 "UNKNOWN",
332 "ALL",
333 "TERMINATED",
334 "ACTIVE"
335 ],
336 "location": "query",
337 "type": "string"
338 },
339 "location": {
340 "description": "The location that contains t his job.",
341 "location": "query",
342 "type": "string"
343 },
344 "pageToken": {
345 "description": "Set this to the 'next_page_t oken' field of a previous response\nto request additional results in a long list .",
346 "location": "query",
347 "type": "string"
348 },
349 "pageSize": {
350 "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.",
351 "format": "int32",
352 "location": "query",
353 "type": "integer"
354 },
355 "view": {
356 "description": "Level of information request ed in response. Default is `JOB_VIEW_SUMMARY`.",
357 "enum": [
358 "JOB_VIEW_UNKNOWN",
359 "JOB_VIEW_SUMMARY",
360 "JOB_VIEW_ALL",
361 "JOB_VIEW_DESCRIPTION"
362 ],
363 "location": "query",
364 "type": "string"
365 }
366 },
367 "path": "v1b3/projects/{projectId}/jobs",
368 "response": {
369 "$ref": "ListJobsResponse"
370 },
371 "scopes": [
372 "https://www.googleapis.com/auth/cloud-platform" ,
373 "https://www.googleapis.com/auth/compute",
374 "https://www.googleapis.com/auth/compute.readonl y",
375 "https://www.googleapis.com/auth/userinfo.email"
376 ]
377 },
378 "create": {
379 "description": "Creates a Cloud Dataflow job.",
380 "httpMethod": "POST",
381 "id": "dataflow.projects.jobs.create",
382 "parameterOrder": [
383 "projectId"
384 ],
385 "parameters": {
386 "location": {
387 "description": "The location that contains t his job.",
388 "location": "query",
389 "type": "string"
390 },
391 "replaceJobId": {
392 "description": "Deprecated. This field is no w in the Job message.",
393 "location": "query",
394 "type": "string"
395 },
396 "view": {
397 "description": "The level of information req uested in response.",
398 "enum": [
399 "JOB_VIEW_UNKNOWN",
400 "JOB_VIEW_SUMMARY",
401 "JOB_VIEW_ALL",
402 "JOB_VIEW_DESCRIPTION"
403 ],
404 "location": "query",
405 "type": "string"
406 },
407 "projectId": {
408 "description": "The ID of the Cloud Platform project that the job belongs to.",
409 "location": "path",
410 "required": true,
411 "type": "string"
412 }
413 },
414 "path": "v1b3/projects/{projectId}/jobs",
415 "request": {
416 "$ref": "Job"
417 },
418 "response": {
419 "$ref": "Job"
420 },
421 "scopes": [
422 "https://www.googleapis.com/auth/cloud-platform" ,
423 "https://www.googleapis.com/auth/compute",
424 "https://www.googleapis.com/auth/compute.readonl y",
425 "https://www.googleapis.com/auth/userinfo.email"
426 ]
427 },
428 "getMetrics": {
429 "description": "Request the job status.",
430 "httpMethod": "GET",
431 "id": "dataflow.projects.jobs.getMetrics",
432 "parameterOrder": [
433 "projectId",
434 "jobId"
435 ],
436 "parameters": {
437 "location": {
438 "description": "The location which contains the job specified by job_id.",
439 "location": "query",
440 "type": "string"
441 },
442 "startTime": {
443 "description": "Return only metric data that has changed since this time.\nDefault is to return all information about all me trics for the job.",
444 "format": "google-datetime",
445 "location": "query",
446 "type": "string"
447 },
448 "jobId": {
449 "description": "The job to get messages for. ",
450 "location": "path",
451 "required": true,
452 "type": "string"
453 },
454 "projectId": {
455 "description": "A project id.",
456 "location": "path",
457 "required": true,
458 "type": "string"
459 }
460 },
461 "path": "v1b3/projects/{projectId}/jobs/{jobId}/metr ics",
462 "response": {
463 "$ref": "JobMetrics"
464 },
465 "scopes": [
466 "https://www.googleapis.com/auth/cloud-platform" ,
467 "https://www.googleapis.com/auth/compute",
468 "https://www.googleapis.com/auth/compute.readonl y",
469 "https://www.googleapis.com/auth/userinfo.email"
470 ]
195 } 471 }
196 }, 472 },
197 "resources": { 473 "resources": {
198 "templates": { 474 "workItems": {
199 "methods": { 475 "methods": {
200 "get": { 476 "reportStatus": {
201 "description": "Get the template associated with a template.", 477 "description": "Reports the status of datafl ow WorkItems leased by a worker.",
202 "httpMethod": "GET", 478 "httpMethod": "POST",
203 "id": "dataflow.projects.locations.templates .get", 479 "id": "dataflow.projects.jobs.workItems.repo rtStatus",
204 "parameterOrder": [ 480 "parameterOrder": [
205 "projectId", 481 "projectId",
206 "location" 482 "jobId"
207 ], 483 ],
208 "parameters": { 484 "parameters": {
209 "location": { 485 "jobId": {
210 "description": "The location to whic h to direct the request.", 486 "description": "The job which the Wo rkItem is part of.",
211 "location": "path",
212 "required": true,
213 "type": "string"
214 },
215 "view": {
216 "description": "The view to retrieve . Defaults to METADATA_ONLY.",
217 "enum": [
218 "METADATA_ONLY"
219 ],
220 "location": "query",
221 "type": "string"
222 },
223 "projectId": {
224 "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
225 "location": "path",
226 "required": true,
227 "type": "string"
228 },
229 "gcsPath": {
230 "description": "Required. A Cloud St orage path to the template from which to\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`.",
231 "location": "query",
232 "type": "string"
233 }
234 },
235 "path": "v1b3/projects/{projectId}/locations /{location}/templates:get",
236 "response": {
237 "$ref": "GetTemplateResponse"
238 },
239 "scopes": [
240 "https://www.googleapis.com/auth/cloud-p latform",
241 "https://www.googleapis.com/auth/compute ",
242 "https://www.googleapis.com/auth/compute .readonly",
243 "https://www.googleapis.com/auth/userinf o.email"
244 ]
245 },
246 "create": {
247 "description": "Creates a Cloud Dataflow job from a template.",
248 "httpMethod": "POST",
249 "id": "dataflow.projects.locations.templates .create",
250 "parameterOrder": [
251 "projectId",
252 "location"
253 ],
254 "parameters": {
255 "location": {
256 "description": "The location to whic h to direct the request.",
257 "location": "path", 487 "location": "path",
258 "required": true, 488 "required": true,
259 "type": "string" 489 "type": "string"
260 }, 490 },
261 "projectId": { 491 "projectId": {
262 "description": "Required. The ID of the Cloud Platform project that the job belongs to.", 492 "description": "The project which ow ns the WorkItem's job.",
263 "location": "path", 493 "location": "path",
264 "required": true, 494 "required": true,
265 "type": "string" 495 "type": "string"
266 } 496 }
267 }, 497 },
268 "path": "v1b3/projects/{projectId}/locations /{location}/templates", 498 "path": "v1b3/projects/{projectId}/jobs/{job Id}/workItems:reportStatus",
269 "request": { 499 "request": {
270 "$ref": "CreateJobFromTemplateRequest" 500 "$ref": "ReportWorkItemStatusRequest"
271 }, 501 },
272 "response": { 502 "response": {
273 "$ref": "Job" 503 "$ref": "ReportWorkItemStatusResponse"
274 }, 504 },
275 "scopes": [ 505 "scopes": [
276 "https://www.googleapis.com/auth/cloud-p latform", 506 "https://www.googleapis.com/auth/cloud-p latform",
277 "https://www.googleapis.com/auth/compute ", 507 "https://www.googleapis.com/auth/compute ",
278 "https://www.googleapis.com/auth/compute .readonly", 508 "https://www.googleapis.com/auth/compute .readonly",
279 "https://www.googleapis.com/auth/userinf o.email" 509 "https://www.googleapis.com/auth/userinf o.email"
280 ] 510 ]
281 }, 511 },
282 "launch": { 512 "lease": {
283 "description": "Launch a template.", 513 "description": "Leases a dataflow WorkItem t o run.",
284 "httpMethod": "POST", 514 "httpMethod": "POST",
285 "id": "dataflow.projects.locations.templates .launch", 515 "id": "dataflow.projects.jobs.workItems.leas e",
286 "parameterOrder": [ 516 "parameterOrder": [
287 "projectId", 517 "projectId",
288 "location" 518 "jobId"
289 ], 519 ],
290 "parameters": { 520 "parameters": {
291 "projectId": { 521 "jobId": {
292 "description": "Required. The ID of the Cloud Platform project that the job belongs to.", 522 "description": "Identifies the workf low job this worker belongs to.",
293 "location": "path", 523 "location": "path",
294 "required": true, 524 "required": true,
295 "type": "string" 525 "type": "string"
296 }, 526 },
297 "gcsPath": { 527 "projectId": {
298 "description": "Required. A Cloud St orage path to the template from which to create\nthe job.\nMust be valid Cloud S torage URL, beginning with 'gs://'.", 528 "description": "Identifies the proje ct this worker belongs to.",
299 "location": "query",
300 "type": "string"
301 },
302 "location": {
303 "description": "The location to whic h to direct the request.",
304 "location": "path", 529 "location": "path",
305 "required": true, 530 "required": true,
306 "type": "string" 531 "type": "string"
307 },
308 "validateOnly": {
309 "description": "If true, the request is validated but not actually executed.\nDefaults to false.",
310 "location": "query",
311 "type": "boolean"
312 } 532 }
313 }, 533 },
314 "path": "v1b3/projects/{projectId}/locations /{location}/templates:launch", 534 "path": "v1b3/projects/{projectId}/jobs/{job Id}/workItems:lease",
315 "request": { 535 "request": {
316 "$ref": "LaunchTemplateParameters" 536 "$ref": "LeaseWorkItemRequest"
317 }, 537 },
318 "response": { 538 "response": {
319 "$ref": "LaunchTemplateResponse" 539 "$ref": "LeaseWorkItemResponse"
320 }, 540 },
321 "scopes": [ 541 "scopes": [
322 "https://www.googleapis.com/auth/cloud-p latform", 542 "https://www.googleapis.com/auth/cloud-p latform",
323 "https://www.googleapis.com/auth/compute ", 543 "https://www.googleapis.com/auth/compute ",
324 "https://www.googleapis.com/auth/compute .readonly", 544 "https://www.googleapis.com/auth/compute .readonly",
325 "https://www.googleapis.com/auth/userinf o.email" 545 "https://www.googleapis.com/auth/userinf o.email"
326 ] 546 ]
327 } 547 }
328 } 548 }
329 }, 549 },
330 "jobs": { 550 "debug": {
331 "methods": { 551 "methods": {
332 "getMetrics": { 552 "sendCapture": {
333 "description": "Request the job status.", 553 "description": "Send encoded debug capture d ata for component.",
334 "httpMethod": "GET", 554 "httpMethod": "POST",
335 "id": "dataflow.projects.locations.jobs.getM etrics", 555 "id": "dataflow.projects.jobs.debug.sendCapt ure",
336 "parameterOrder": [ 556 "parameterOrder": [
337 "projectId", 557 "projectId",
338 "location",
339 "jobId" 558 "jobId"
340 ], 559 ],
341 "parameters": { 560 "parameters": {
342 "jobId": { 561 "jobId": {
343 "description": "The job to get messa ges for.", 562 "description": "The job id.",
344 "location": "path", 563 "location": "path",
345 "required": true, 564 "required": true,
346 "type": "string" 565 "type": "string"
347 }, 566 },
348 "projectId": { 567 "projectId": {
349 "description": "A project id.", 568 "description": "The project id.",
569 "location": "path",
570 "required": true,
571 "type": "string"
572 }
573 },
574 "path": "v1b3/projects/{projectId}/jobs/{job Id}/debug/sendCapture",
575 "request": {
576 "$ref": "SendDebugCaptureRequest"
577 },
578 "response": {
579 "$ref": "SendDebugCaptureResponse"
580 },
581 "scopes": [
582 "https://www.googleapis.com/auth/cloud-p latform",
583 "https://www.googleapis.com/auth/compute ",
584 "https://www.googleapis.com/auth/compute .readonly",
585 "https://www.googleapis.com/auth/userinf o.email"
586 ]
587 },
588 "getConfig": {
589 "description": "Get encoded debug configurat ion for component. Not cacheable.",
590 "httpMethod": "POST",
591 "id": "dataflow.projects.jobs.debug.getConfi g",
592 "parameterOrder": [
593 "projectId",
594 "jobId"
595 ],
596 "parameters": {
597 "jobId": {
598 "description": "The job id.",
350 "location": "path", 599 "location": "path",
351 "required": true, 600 "required": true,
352 "type": "string" 601 "type": "string"
353 }, 602 },
354 "location": { 603 "projectId": {
355 "description": "The location which c ontains the job specified by job_id.", 604 "description": "The project id.",
356 "location": "path", 605 "location": "path",
357 "required": true, 606 "required": true,
358 "type": "string" 607 "type": "string"
359 },
360 "startTime": {
361 "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.",
362 "format": "google-datetime",
363 "location": "query",
364 "type": "string"
365 } 608 }
366 }, 609 },
367 "path": "v1b3/projects/{projectId}/locations /{location}/jobs/{jobId}/metrics", 610 "path": "v1b3/projects/{projectId}/jobs/{job Id}/debug/getConfig",
611 "request": {
612 "$ref": "GetDebugConfigRequest"
613 },
368 "response": { 614 "response": {
369 "$ref": "JobMetrics" 615 "$ref": "GetDebugConfigResponse"
370 }, 616 },
371 "scopes": [ 617 "scopes": [
372 "https://www.googleapis.com/auth/cloud-p latform", 618 "https://www.googleapis.com/auth/cloud-p latform",
373 "https://www.googleapis.com/auth/compute ", 619 "https://www.googleapis.com/auth/compute ",
374 "https://www.googleapis.com/auth/compute .readonly", 620 "https://www.googleapis.com/auth/compute .readonly",
375 "https://www.googleapis.com/auth/userinf o.email" 621 "https://www.googleapis.com/auth/userinf o.email"
376 ] 622 ]
377 }, 623 }
624 }
625 },
626 "messages": {
627 "methods": {
378 "list": { 628 "list": {
379 "description": "List the jobs of a project i n a given region.", 629 "description": "Request the job status.",
380 "httpMethod": "GET", 630 "httpMethod": "GET",
381 "id": "dataflow.projects.locations.jobs.list ", 631 "id": "dataflow.projects.jobs.messages.list" ,
382 "parameterOrder": [ 632 "parameterOrder": [
383 "projectId", 633 "projectId",
384 "location" 634 "jobId"
385 ], 635 ],
386 "parameters": { 636 "parameters": {
387 "projectId": { 637 "jobId": {
388 "description": "The project which ow ns the jobs.", 638 "description": "The job to get messa ges about.",
389 "location": "path", 639 "location": "path",
390 "required": true, 640 "required": true,
391 "type": "string" 641 "type": "string"
392 }, 642 },
393 "filter": { 643 "projectId": {
394 "description": "The kind of filter t o use.", 644 "description": "A project id.",
395 "enum": [
396 "UNKNOWN",
397 "ALL",
398 "TERMINATED",
399 "ACTIVE"
400 ],
401 "location": "query",
402 "type": "string"
403 },
404 "location": {
405 "description": "The location that co ntains this job.",
406 "location": "path", 645 "location": "path",
407 "required": true, 646 "required": true,
408 "type": "string" 647 "type": "string"
409 }, 648 },
649 "location": {
650 "description": "The location which c ontains the job specified by job_id.",
651 "location": "query",
652 "type": "string"
653 },
654 "endTime": {
655 "description": "Return only messages with timestamps < end_time. The default is now\n(i.e. return up to the latest m essages available).",
656 "format": "google-datetime",
657 "location": "query",
658 "type": "string"
659 },
410 "pageToken": { 660 "pageToken": {
411 "description": "Set this to the 'nex t_page_token' field of a previous response\nto request additional results in a l ong list.", 661 "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.",
662 "location": "query",
663 "type": "string"
664 },
665 "startTime": {
666 "description": "If specified, return only messages with timestamps >= start_time.\nThe default is the job creation t ime (i.e. beginning of messages).",
667 "format": "google-datetime",
412 "location": "query", 668 "location": "query",
413 "type": "string" 669 "type": "string"
414 }, 670 },
415 "pageSize": { 671 "pageSize": {
416 "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.", 672 "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.",
417 "format": "int32", 673 "format": "int32",
418 "location": "query", 674 "location": "query",
419 "type": "integer" 675 "type": "integer"
420 }, 676 },
421 "view": { 677 "minimumImportance": {
422 "description": "Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.", 678 "description": "Filter to only get m essages with importance >= level",
423 "enum": [ 679 "enum": [
424 "JOB_VIEW_UNKNOWN", 680 "JOB_MESSAGE_IMPORTANCE_UNKNOWN" ,
425 "JOB_VIEW_SUMMARY", 681 "JOB_MESSAGE_DEBUG",
426 "JOB_VIEW_ALL", 682 "JOB_MESSAGE_DETAILED",
427 "JOB_VIEW_DESCRIPTION" 683 "JOB_MESSAGE_BASIC",
684 "JOB_MESSAGE_WARNING",
685 "JOB_MESSAGE_ERROR"
428 ], 686 ],
429 "location": "query", 687 "location": "query",
430 "type": "string" 688 "type": "string"
431 } 689 }
432 }, 690 },
433 "path": "v1b3/projects/{projectId}/locations /{location}/jobs", 691 "path": "v1b3/projects/{projectId}/jobs/{job Id}/messages",
434 "response": { 692 "response": {
435 "$ref": "ListJobsResponse" 693 "$ref": "ListJobMessagesResponse"
436 }, 694 },
437 "scopes": [ 695 "scopes": [
438 "https://www.googleapis.com/auth/cloud-p latform", 696 "https://www.googleapis.com/auth/cloud-p latform",
439 "https://www.googleapis.com/auth/compute ", 697 "https://www.googleapis.com/auth/compute ",
440 "https://www.googleapis.com/auth/compute .readonly", 698 "https://www.googleapis.com/auth/compute .readonly",
441 "https://www.googleapis.com/auth/userinf o.email" 699 "https://www.googleapis.com/auth/userinf o.email"
442 ] 700 ]
701 }
702 }
703 }
704 }
705 },
706 "locations": {
707 "methods": {
708 "workerMessages": {
709 "description": "Send a worker_message to the service .",
710 "httpMethod": "POST",
711 "id": "dataflow.projects.locations.workerMessages",
712 "parameterOrder": [
713 "projectId",
714 "location"
715 ],
716 "parameters": {
717 "projectId": {
718 "description": "The project to send the Work erMessages to.",
719 "location": "path",
720 "required": true,
721 "type": "string"
443 }, 722 },
444 "get": { 723 "location": {
445 "description": "Gets the state of the specif ied Cloud Dataflow job.", 724 "description": "The location which contains the job",
446 "httpMethod": "GET", 725 "location": "path",
447 "id": "dataflow.projects.locations.jobs.get" , 726 "required": true,
727 "type": "string"
728 }
729 },
730 "path": "v1b3/projects/{projectId}/locations/{locati on}/WorkerMessages",
731 "request": {
732 "$ref": "SendWorkerMessagesRequest"
733 },
734 "response": {
735 "$ref": "SendWorkerMessagesResponse"
736 },
737 "scopes": [
738 "https://www.googleapis.com/auth/cloud-platform" ,
739 "https://www.googleapis.com/auth/compute",
740 "https://www.googleapis.com/auth/compute.readonl y",
741 "https://www.googleapis.com/auth/userinfo.email"
742 ]
743 }
744 },
745 "resources": {
746 "templates": {
747 "methods": {
748 "launch": {
749 "description": "Launch a template.",
750 "httpMethod": "POST",
751 "id": "dataflow.projects.locations.templates .launch",
448 "parameterOrder": [ 752 "parameterOrder": [
449 "projectId", 753 "projectId",
450 "location", 754 "location"
451 "jobId"
452 ], 755 ],
453 "parameters": { 756 "parameters": {
454 "location": { 757 "validateOnly": {
455 "description": "The location that co ntains this job.", 758 "description": "If true, the request is validated but not actually executed.\nDefaults to false.",
759 "location": "query",
760 "type": "boolean"
761 },
762 "projectId": {
763 "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
456 "location": "path", 764 "location": "path",
457 "required": true, 765 "required": true,
458 "type": "string" 766 "type": "string"
459 }, 767 },
460 "view": { 768 "gcsPath": {
461 "description": "The level of informa tion requested in response.", 769 "description": "Required. A Cloud St orage path to the template from which to create\nthe job.\nMust be valid Cloud S torage URL, beginning with 'gs://'.",
462 "enum": [
463 "JOB_VIEW_UNKNOWN",
464 "JOB_VIEW_SUMMARY",
465 "JOB_VIEW_ALL",
466 "JOB_VIEW_DESCRIPTION"
467 ],
468 "location": "query", 770 "location": "query",
469 "type": "string" 771 "type": "string"
470 }, 772 },
471 "jobId": { 773 "location": {
472 "description": "The job ID.", 774 "description": "The location to whic h to direct the request.",
473 "location": "path",
474 "required": true,
475 "type": "string"
476 },
477 "projectId": {
478 "description": "The ID of the Cloud Platform project that the job belongs to.",
479 "location": "path", 775 "location": "path",
480 "required": true, 776 "required": true,
481 "type": "string" 777 "type": "string"
482 } 778 }
483 }, 779 },
484 "path": "v1b3/projects/{projectId}/locations /{location}/jobs/{jobId}", 780 "path": "v1b3/projects/{projectId}/locations /{location}/templates:launch",
781 "request": {
782 "$ref": "LaunchTemplateParameters"
783 },
485 "response": { 784 "response": {
486 "$ref": "Job" 785 "$ref": "LaunchTemplateResponse"
487 }, 786 },
488 "scopes": [ 787 "scopes": [
489 "https://www.googleapis.com/auth/cloud-p latform", 788 "https://www.googleapis.com/auth/cloud-p latform",
490 "https://www.googleapis.com/auth/compute ", 789 "https://www.googleapis.com/auth/compute ",
491 "https://www.googleapis.com/auth/compute .readonly", 790 "https://www.googleapis.com/auth/compute .readonly",
492 "https://www.googleapis.com/auth/userinf o.email" 791 "https://www.googleapis.com/auth/userinf o.email"
493 ] 792 ]
494 }, 793 },
495 "update": { 794 "get": {
496 "description": "Updates the state of an exis ting Cloud Dataflow job.", 795 "description": "Get the template associated with a template.",
497 "httpMethod": "PUT", 796 "httpMethod": "GET",
498 "id": "dataflow.projects.locations.jobs.upda te", 797 "id": "dataflow.projects.locations.templates .get",
499 "parameterOrder": [ 798 "parameterOrder": [
500 "projectId", 799 "projectId",
501 "location", 800 "location"
502 "jobId"
503 ], 801 ],
504 "parameters": { 802 "parameters": {
505 "jobId": { 803 "view": {
506 "description": "The job ID.", 804 "description": "The view to retrieve . Defaults to METADATA_ONLY.",
805 "enum": [
806 "METADATA_ONLY"
807 ],
808 "location": "query",
809 "type": "string"
810 },
811 "projectId": {
812 "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
507 "location": "path", 813 "location": "path",
508 "required": true, 814 "required": true,
509 "type": "string" 815 "type": "string"
510 }, 816 },
511 "projectId": { 817 "gcsPath": {
512 "description": "The ID of the Cloud Platform project that the job belongs to.", 818 "description": "Required. A Cloud St orage path to the template from which to\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`.",
513 "location": "path", 819 "location": "query",
514 "required": true,
515 "type": "string" 820 "type": "string"
516 }, 821 },
517 "location": { 822 "location": {
518 "description": "The location that co ntains this job.", 823 "description": "The location to whic h to direct the request.",
519 "location": "path", 824 "location": "path",
520 "required": true, 825 "required": true,
521 "type": "string" 826 "type": "string"
522 } 827 }
523 }, 828 },
524 "path": "v1b3/projects/{projectId}/locations /{location}/jobs/{jobId}", 829 "path": "v1b3/projects/{projectId}/locations /{location}/templates:get",
525 "request": {
526 "$ref": "Job"
527 },
528 "response": { 830 "response": {
529 "$ref": "Job" 831 "$ref": "GetTemplateResponse"
530 }, 832 },
531 "scopes": [ 833 "scopes": [
532 "https://www.googleapis.com/auth/cloud-p latform", 834 "https://www.googleapis.com/auth/cloud-p latform",
533 "https://www.googleapis.com/auth/compute ", 835 "https://www.googleapis.com/auth/compute ",
534 "https://www.googleapis.com/auth/compute .readonly", 836 "https://www.googleapis.com/auth/compute .readonly",
535 "https://www.googleapis.com/auth/userinf o.email" 837 "https://www.googleapis.com/auth/userinf o.email"
536 ] 838 ]
537 }, 839 },
538 "create": { 840 "create": {
841 "description": "Creates a Cloud Dataflow job from a template.",
842 "httpMethod": "POST",
843 "id": "dataflow.projects.locations.templates .create",
844 "parameterOrder": [
845 "projectId",
846 "location"
847 ],
848 "parameters": {
849 "location": {
850 "description": "The location to whic h to direct the request.",
851 "location": "path",
852 "required": true,
853 "type": "string"
854 },
855 "projectId": {
856 "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
857 "location": "path",
858 "required": true,
859 "type": "string"
860 }
861 },
862 "path": "v1b3/projects/{projectId}/locations /{location}/templates",
863 "request": {
864 "$ref": "CreateJobFromTemplateRequest"
865 },
866 "response": {
867 "$ref": "Job"
868 },
869 "scopes": [
870 "https://www.googleapis.com/auth/cloud-p latform",
871 "https://www.googleapis.com/auth/compute ",
872 "https://www.googleapis.com/auth/compute .readonly",
873 "https://www.googleapis.com/auth/userinf o.email"
874 ]
875 }
876 }
877 },
878 "jobs": {
879 "methods": {
880 "list": {
881 "description": "List the jobs of a project i n a given region.",
882 "httpMethod": "GET",
883 "id": "dataflow.projects.locations.jobs.list ",
884 "parameterOrder": [
885 "projectId",
886 "location"
887 ],
888 "parameters": {
889 "pageToken": {
890 "description": "Set this to the 'nex t_page_token' field of a previous response\nto request additional results in a l ong list.",
891 "location": "query",
892 "type": "string"
893 },
894 "pageSize": {
895 "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.",
896 "format": "int32",
897 "location": "query",
898 "type": "integer"
899 },
900 "view": {
901 "description": "Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.",
902 "enum": [
903 "JOB_VIEW_UNKNOWN",
904 "JOB_VIEW_SUMMARY",
905 "JOB_VIEW_ALL",
906 "JOB_VIEW_DESCRIPTION"
907 ],
908 "location": "query",
909 "type": "string"
910 },
911 "projectId": {
912 "description": "The project which ow ns the jobs.",
913 "location": "path",
914 "required": true,
915 "type": "string"
916 },
917 "filter": {
918 "description": "The kind of filter t o use.",
919 "enum": [
920 "UNKNOWN",
921 "ALL",
922 "TERMINATED",
923 "ACTIVE"
924 ],
925 "location": "query",
926 "type": "string"
927 },
928 "location": {
929 "description": "The location that co ntains this job.",
930 "location": "path",
931 "required": true,
932 "type": "string"
933 }
934 },
935 "path": "v1b3/projects/{projectId}/locations /{location}/jobs",
936 "response": {
937 "$ref": "ListJobsResponse"
938 },
939 "scopes": [
940 "https://www.googleapis.com/auth/cloud-p latform",
941 "https://www.googleapis.com/auth/compute ",
942 "https://www.googleapis.com/auth/compute .readonly",
943 "https://www.googleapis.com/auth/userinf o.email"
944 ]
945 },
946 "get": {
947 "description": "Gets the state of the specif ied Cloud Dataflow job.",
948 "httpMethod": "GET",
949 "id": "dataflow.projects.locations.jobs.get" ,
950 "parameterOrder": [
951 "projectId",
952 "location",
953 "jobId"
954 ],
955 "parameters": {
956 "view": {
957 "description": "The level of informa tion requested in response.",
958 "enum": [
959 "JOB_VIEW_UNKNOWN",
960 "JOB_VIEW_SUMMARY",
961 "JOB_VIEW_ALL",
962 "JOB_VIEW_DESCRIPTION"
963 ],
964 "location": "query",
965 "type": "string"
966 },
967 "jobId": {
968 "description": "The job ID.",
969 "location": "path",
970 "required": true,
971 "type": "string"
972 },
973 "projectId": {
974 "description": "The ID of the Cloud Platform project that the job belongs to.",
975 "location": "path",
976 "required": true,
977 "type": "string"
978 },
979 "location": {
980 "description": "The location that co ntains this job.",
981 "location": "path",
982 "required": true,
983 "type": "string"
984 }
985 },
986 "path": "v1b3/projects/{projectId}/locations /{location}/jobs/{jobId}",
987 "response": {
988 "$ref": "Job"
989 },
990 "scopes": [
991 "https://www.googleapis.com/auth/cloud-p latform",
992 "https://www.googleapis.com/auth/compute ",
993 "https://www.googleapis.com/auth/compute .readonly",
994 "https://www.googleapis.com/auth/userinf o.email"
995 ]
996 },
997 "update": {
998 "description": "Updates the state of an exis ting Cloud Dataflow job.",
999 "httpMethod": "PUT",
1000 "id": "dataflow.projects.locations.jobs.upda te",
1001 "parameterOrder": [
1002 "projectId",
1003 "location",
1004 "jobId"
1005 ],
1006 "parameters": {
1007 "location": {
1008 "description": "The location that co ntains this job.",
1009 "location": "path",
1010 "required": true,
1011 "type": "string"
1012 },
1013 "jobId": {
1014 "description": "The job ID.",
1015 "location": "path",
1016 "required": true,
1017 "type": "string"
1018 },
1019 "projectId": {
1020 "description": "The ID of the Cloud Platform project that the job belongs to.",
1021 "location": "path",
1022 "required": true,
1023 "type": "string"
1024 }
1025 },
1026 "path": "v1b3/projects/{projectId}/locations /{location}/jobs/{jobId}",
1027 "request": {
1028 "$ref": "Job"
1029 },
1030 "response": {
1031 "$ref": "Job"
1032 },
1033 "scopes": [
1034 "https://www.googleapis.com/auth/cloud-p latform",
1035 "https://www.googleapis.com/auth/compute ",
1036 "https://www.googleapis.com/auth/compute .readonly",
1037 "https://www.googleapis.com/auth/userinf o.email"
1038 ]
1039 },
1040 "create": {
539 "description": "Creates a Cloud Dataflow job .", 1041 "description": "Creates a Cloud Dataflow job .",
540 "httpMethod": "POST", 1042 "httpMethod": "POST",
541 "id": "dataflow.projects.locations.jobs.crea te", 1043 "id": "dataflow.projects.locations.jobs.crea te",
542 "parameterOrder": [ 1044 "parameterOrder": [
543 "projectId", 1045 "projectId",
544 "location" 1046 "location"
545 ], 1047 ],
546 "parameters": { 1048 "parameters": {
547 "location": { 1049 "location": {
548 "description": "The location that co ntains this job.", 1050 "description": "The location that co ntains this job.",
(...skipping 30 matching lines...) Expand all
579 }, 1081 },
580 "response": { 1082 "response": {
581 "$ref": "Job" 1083 "$ref": "Job"
582 }, 1084 },
583 "scopes": [ 1085 "scopes": [
584 "https://www.googleapis.com/auth/cloud-p latform", 1086 "https://www.googleapis.com/auth/cloud-p latform",
585 "https://www.googleapis.com/auth/compute ", 1087 "https://www.googleapis.com/auth/compute ",
586 "https://www.googleapis.com/auth/compute .readonly", 1088 "https://www.googleapis.com/auth/compute .readonly",
587 "https://www.googleapis.com/auth/userinf o.email" 1089 "https://www.googleapis.com/auth/userinf o.email"
588 ] 1090 ]
1091 },
1092 "getMetrics": {
1093 "description": "Request the job status.",
1094 "httpMethod": "GET",
1095 "id": "dataflow.projects.locations.jobs.getM etrics",
1096 "parameterOrder": [
1097 "projectId",
1098 "location",
1099 "jobId"
1100 ],
1101 "parameters": {
1102 "startTime": {
1103 "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.",
1104 "format": "google-datetime",
1105 "location": "query",
1106 "type": "string"
1107 },
1108 "jobId": {
1109 "description": "The job to get messa ges for.",
1110 "location": "path",
1111 "required": true,
1112 "type": "string"
1113 },
1114 "projectId": {
1115 "description": "A project id.",
1116 "location": "path",
1117 "required": true,
1118 "type": "string"
1119 },
1120 "location": {
1121 "description": "The location which c ontains the job specified by job_id.",
1122 "location": "path",
1123 "required": true,
1124 "type": "string"
1125 }
1126 },
1127 "path": "v1b3/projects/{projectId}/locations /{location}/jobs/{jobId}/metrics",
1128 "response": {
1129 "$ref": "JobMetrics"
1130 },
1131 "scopes": [
1132 "https://www.googleapis.com/auth/cloud-p latform",
1133 "https://www.googleapis.com/auth/compute ",
1134 "https://www.googleapis.com/auth/compute .readonly",
1135 "https://www.googleapis.com/auth/userinf o.email"
1136 ]
589 } 1137 }
590 }, 1138 },
591 "resources": { 1139 "resources": {
592 "messages": { 1140 "workItems": {
593 "methods": { 1141 "methods": {
594 "list": { 1142 "lease": {
595 "description": "Request the job stat us.", 1143 "description": "Leases a dataflow Wo rkItem to run.",
596 "httpMethod": "GET", 1144 "httpMethod": "POST",
597 "id": "dataflow.projects.locations.j obs.messages.list", 1145 "id": "dataflow.projects.locations.j obs.workItems.lease",
598 "parameterOrder": [ 1146 "parameterOrder": [
599 "projectId", 1147 "projectId",
600 "location", 1148 "location",
601 "jobId" 1149 "jobId"
602 ], 1150 ],
603 "parameters": { 1151 "parameters": {
604 "projectId": { 1152 "jobId": {
605 "description": "A project id .", 1153 "description": "Identifies t he workflow job this worker belongs to.",
606 "location": "path", 1154 "location": "path",
607 "required": true, 1155 "required": true,
608 "type": "string" 1156 "type": "string"
609 }, 1157 },
610 "jobId": { 1158 "projectId": {
611 "description": "The job to g et messages about.", 1159 "description": "Identifies t he project this worker belongs to.",
612 "location": "path", 1160 "location": "path",
613 "required": true, 1161 "required": true,
614 "type": "string" 1162 "type": "string"
615 }, 1163 },
616 "location": { 1164 "location": {
617 "description": "The location which contains the job specified by job_id.", 1165 "description": "The location which contains the WorkItem's job.",
618 "location": "path", 1166 "location": "path",
619 "required": true, 1167 "required": true,
620 "type": "string" 1168 "type": "string"
621 },
622 "endTime": {
623 "description": "Return only messages with timestamps < end_time. The default is now\n(i.e. return up to the latest messages available).",
624 "format": "google-datetime",
625 "location": "query",
626 "type": "string"
627 },
628 "startTime": {
629 "description": "If specified , return only messages with timestamps >= start_time.\nThe default is the job cr eation time (i.e. beginning of messages).",
630 "format": "google-datetime",
631 "location": "query",
632 "type": "string"
633 },
634 "pageToken": {
635 "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.",
636 "location": "query",
637 "type": "string"
638 },
639 "pageSize": {
640 "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.",
641 "format": "int32",
642 "location": "query",
643 "type": "integer"
644 },
645 "minimumImportance": {
646 "description": "Filter to on ly get messages with importance >= level",
647 "enum": [
648 "JOB_MESSAGE_IMPORTANCE_ UNKNOWN",
649 "JOB_MESSAGE_DEBUG",
650 "JOB_MESSAGE_DETAILED",
651 "JOB_MESSAGE_BASIC",
652 "JOB_MESSAGE_WARNING",
653 "JOB_MESSAGE_ERROR"
654 ],
655 "location": "query",
656 "type": "string"
657 } 1169 }
658 }, 1170 },
659 "path": "v1b3/projects/{projectId}/l ocations/{location}/jobs/{jobId}/messages", 1171 "path": "v1b3/projects/{projectId}/l ocations/{location}/jobs/{jobId}/workItems:lease",
1172 "request": {
1173 "$ref": "LeaseWorkItemRequest"
1174 },
660 "response": { 1175 "response": {
661 "$ref": "ListJobMessagesResponse " 1176 "$ref": "LeaseWorkItemResponse"
662 }, 1177 },
663 "scopes": [ 1178 "scopes": [
664 "https://www.googleapis.com/auth /cloud-platform", 1179 "https://www.googleapis.com/auth /cloud-platform",
665 "https://www.googleapis.com/auth /compute", 1180 "https://www.googleapis.com/auth /compute",
666 "https://www.googleapis.com/auth /compute.readonly", 1181 "https://www.googleapis.com/auth /compute.readonly",
667 "https://www.googleapis.com/auth /userinfo.email" 1182 "https://www.googleapis.com/auth /userinfo.email"
668 ] 1183 ]
669 } 1184 },
670 }
671 },
672 "workItems": {
673 "methods": {
674 "reportStatus": { 1185 "reportStatus": {
675 "description": "Reports the status o f dataflow WorkItems leased by a worker.", 1186 "description": "Reports the status o f dataflow WorkItems leased by a worker.",
676 "httpMethod": "POST", 1187 "httpMethod": "POST",
677 "id": "dataflow.projects.locations.j obs.workItems.reportStatus", 1188 "id": "dataflow.projects.locations.j obs.workItems.reportStatus",
678 "parameterOrder": [ 1189 "parameterOrder": [
679 "projectId", 1190 "projectId",
680 "location", 1191 "location",
681 "jobId" 1192 "jobId"
682 ], 1193 ],
683 "parameters": { 1194 "parameters": {
(...skipping 22 matching lines...) Expand all
706 }, 1217 },
707 "response": { 1218 "response": {
708 "$ref": "ReportWorkItemStatusRes ponse" 1219 "$ref": "ReportWorkItemStatusRes ponse"
709 }, 1220 },
710 "scopes": [ 1221 "scopes": [
711 "https://www.googleapis.com/auth /cloud-platform", 1222 "https://www.googleapis.com/auth /cloud-platform",
712 "https://www.googleapis.com/auth /compute", 1223 "https://www.googleapis.com/auth /compute",
713 "https://www.googleapis.com/auth /compute.readonly", 1224 "https://www.googleapis.com/auth /compute.readonly",
714 "https://www.googleapis.com/auth /userinfo.email" 1225 "https://www.googleapis.com/auth /userinfo.email"
715 ] 1226 ]
716 }, 1227 }
717 "lease": { 1228 }
718 "description": "Leases a dataflow Wo rkItem to run.", 1229 },
1230 "debug": {
1231 "methods": {
1232 "sendCapture": {
1233 "description": "Send encoded debug c apture data for component.",
719 "httpMethod": "POST", 1234 "httpMethod": "POST",
720 "id": "dataflow.projects.locations.j obs.workItems.lease", 1235 "id": "dataflow.projects.locations.j obs.debug.sendCapture",
721 "parameterOrder": [ 1236 "parameterOrder": [
722 "projectId", 1237 "projectId",
723 "location", 1238 "location",
724 "jobId" 1239 "jobId"
725 ], 1240 ],
726 "parameters": { 1241 "parameters": {
727 "location": {
728 "description": "The location which contains the WorkItem's job.",
729 "location": "path",
730 "required": true,
731 "type": "string"
732 },
733 "jobId": { 1242 "jobId": {
734 "description": "Identifies t he workflow job this worker belongs to.", 1243 "description": "The job id." ,
735 "location": "path", 1244 "location": "path",
736 "required": true, 1245 "required": true,
737 "type": "string" 1246 "type": "string"
738 }, 1247 },
739 "projectId": { 1248 "projectId": {
740 "description": "Identifies t he project this worker belongs to.", 1249 "description": "The project id.",
1250 "location": "path",
1251 "required": true,
1252 "type": "string"
1253 },
1254 "location": {
1255 "description": "The location which contains the job specified by job_id.",
741 "location": "path", 1256 "location": "path",
742 "required": true, 1257 "required": true,
743 "type": "string" 1258 "type": "string"
744 } 1259 }
745 }, 1260 },
746 "path": "v1b3/projects/{projectId}/l ocations/{location}/jobs/{jobId}/workItems:lease", 1261 "path": "v1b3/projects/{projectId}/l ocations/{location}/jobs/{jobId}/debug/sendCapture",
747 "request": { 1262 "request": {
748 "$ref": "LeaseWorkItemRequest" 1263 "$ref": "SendDebugCaptureRequest "
749 }, 1264 },
750 "response": { 1265 "response": {
751 "$ref": "LeaseWorkItemResponse" 1266 "$ref": "SendDebugCaptureRespons e"
752 }, 1267 },
753 "scopes": [ 1268 "scopes": [
754 "https://www.googleapis.com/auth /cloud-platform", 1269 "https://www.googleapis.com/auth /cloud-platform",
755 "https://www.googleapis.com/auth /compute", 1270 "https://www.googleapis.com/auth /compute",
756 "https://www.googleapis.com/auth /compute.readonly", 1271 "https://www.googleapis.com/auth /compute.readonly",
757 "https://www.googleapis.com/auth /userinfo.email" 1272 "https://www.googleapis.com/auth /userinfo.email"
758 ] 1273 ]
759 } 1274 },
760 } 1275 "getConfig": {
761 }, 1276 "description": "Get encoded debug co nfiguration for component. Not cacheable.",
762 "debug": {
763 "methods": {
764 "sendCapture": {
765 "description": "Send encoded debug c apture data for component.",
766 "httpMethod": "POST", 1277 "httpMethod": "POST",
767 "id": "dataflow.projects.locations.j obs.debug.sendCapture", 1278 "id": "dataflow.projects.locations.j obs.debug.getConfig",
768 "parameterOrder": [ 1279 "parameterOrder": [
769 "projectId", 1280 "projectId",
770 "location", 1281 "location",
771 "jobId" 1282 "jobId"
772 ], 1283 ],
773 "parameters": { 1284 "parameters": {
774 "location": {
775 "description": "The location which contains the job specified by job_id.",
776 "location": "path",
777 "required": true,
778 "type": "string"
779 },
780 "jobId": { 1285 "jobId": {
781 "description": "The job id." , 1286 "description": "The job id." ,
782 "location": "path", 1287 "location": "path",
783 "required": true, 1288 "required": true,
784 "type": "string" 1289 "type": "string"
785 }, 1290 },
786 "projectId": { 1291 "projectId": {
787 "description": "The project id.", 1292 "description": "The project id.",
788 "location": "path", 1293 "location": "path",
789 "required": true, 1294 "required": true,
790 "type": "string" 1295 "type": "string"
1296 },
1297 "location": {
1298 "description": "The location which contains the job specified by job_id.",
1299 "location": "path",
1300 "required": true,
1301 "type": "string"
791 } 1302 }
792 }, 1303 },
793 "path": "v1b3/projects/{projectId}/l ocations/{location}/jobs/{jobId}/debug/sendCapture", 1304 "path": "v1b3/projects/{projectId}/l ocations/{location}/jobs/{jobId}/debug/getConfig",
794 "request": { 1305 "request": {
795 "$ref": "SendDebugCaptureRequest " 1306 "$ref": "GetDebugConfigRequest"
796 }, 1307 },
797 "response": { 1308 "response": {
798 "$ref": "SendDebugCaptureRespons e" 1309 "$ref": "GetDebugConfigResponse"
799 }, 1310 },
800 "scopes": [ 1311 "scopes": [
801 "https://www.googleapis.com/auth /cloud-platform", 1312 "https://www.googleapis.com/auth /cloud-platform",
802 "https://www.googleapis.com/auth /compute", 1313 "https://www.googleapis.com/auth /compute",
803 "https://www.googleapis.com/auth /compute.readonly", 1314 "https://www.googleapis.com/auth /compute.readonly",
804 "https://www.googleapis.com/auth /userinfo.email" 1315 "https://www.googleapis.com/auth /userinfo.email"
805 ] 1316 ]
806 }, 1317 }
807 "getConfig": { 1318 }
808 "description": "Get encoded debug co nfiguration for component. Not cacheable.", 1319 },
809 "httpMethod": "POST", 1320 "messages": {
810 "id": "dataflow.projects.locations.j obs.debug.getConfig", 1321 "methods": {
1322 "list": {
1323 "description": "Request the job stat us.",
1324 "httpMethod": "GET",
1325 "id": "dataflow.projects.locations.j obs.messages.list",
811 "parameterOrder": [ 1326 "parameterOrder": [
812 "projectId", 1327 "projectId",
813 "location", 1328 "location",
814 "jobId" 1329 "jobId"
815 ], 1330 ],
816 "parameters": { 1331 "parameters": {
1332 "jobId": {
1333 "description": "The job to g et messages about.",
1334 "location": "path",
1335 "required": true,
1336 "type": "string"
1337 },
1338 "projectId": {
1339 "description": "A project id .",
1340 "location": "path",
1341 "required": true,
1342 "type": "string"
1343 },
1344 "endTime": {
1345 "description": "Return only messages with timestamps < end_time. The default is now\n(i.e. return up to the latest messages available).",
1346 "format": "google-datetime",
1347 "location": "query",
1348 "type": "string"
1349 },
817 "location": { 1350 "location": {
818 "description": "The location which contains the job specified by job_id.", 1351 "description": "The location which contains the job specified by job_id.",
819 "location": "path", 1352 "location": "path",
820 "required": true, 1353 "required": true,
821 "type": "string" 1354 "type": "string"
822 }, 1355 },
823 "jobId": { 1356 "pageToken": {
824 "description": "The job id." , 1357 "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.",
825 "location": "path", 1358 "location": "query",
826 "required": true,
827 "type": "string" 1359 "type": "string"
828 }, 1360 },
829 "projectId": { 1361 "startTime": {
830 "description": "The project id.", 1362 "description": "If specified , return only messages with timestamps >= start_time.\nThe default is the job cr eation time (i.e. beginning of messages).",
831 "location": "path", 1363 "format": "google-datetime",
832 "required": true, 1364 "location": "query",
1365 "type": "string"
1366 },
1367 "pageSize": {
1368 "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.",
1369 "format": "int32",
1370 "location": "query",
1371 "type": "integer"
1372 },
1373 "minimumImportance": {
1374 "description": "Filter to on ly get messages with importance >= level",
1375 "enum": [
1376 "JOB_MESSAGE_IMPORTANCE_ UNKNOWN",
1377 "JOB_MESSAGE_DEBUG",
1378 "JOB_MESSAGE_DETAILED",
1379 "JOB_MESSAGE_BASIC",
1380 "JOB_MESSAGE_WARNING",
1381 "JOB_MESSAGE_ERROR"
1382 ],
1383 "location": "query",
833 "type": "string" 1384 "type": "string"
834 } 1385 }
835 }, 1386 },
836 "path": "v1b3/projects/{projectId}/l ocations/{location}/jobs/{jobId}/debug/getConfig", 1387 "path": "v1b3/projects/{projectId}/l ocations/{location}/jobs/{jobId}/messages",
837 "request": {
838 "$ref": "GetDebugConfigRequest"
839 },
840 "response": { 1388 "response": {
841 "$ref": "GetDebugConfigResponse" 1389 "$ref": "ListJobMessagesResponse "
842 }, 1390 },
843 "scopes": [ 1391 "scopes": [
844 "https://www.googleapis.com/auth /cloud-platform", 1392 "https://www.googleapis.com/auth /cloud-platform",
845 "https://www.googleapis.com/auth /compute", 1393 "https://www.googleapis.com/auth /compute",
846 "https://www.googleapis.com/auth /compute.readonly", 1394 "https://www.googleapis.com/auth /compute.readonly",
847 "https://www.googleapis.com/auth /userinfo.email" 1395 "https://www.googleapis.com/auth /userinfo.email"
848 ] 1396 ]
849 } 1397 }
850 } 1398 }
851 } 1399 }
852 } 1400 }
853 } 1401 }
854 } 1402 }
855 }, 1403 },
856 "templates": { 1404 "templates": {
857 "methods": { 1405 "methods": {
858 "get": {
859 "description": "Get the template associated with a t emplate.",
860 "httpMethod": "GET",
861 "id": "dataflow.projects.templates.get",
862 "parameterOrder": [
863 "projectId"
864 ],
865 "parameters": {
866 "location": {
867 "description": "The location to which to dir ect the request.",
868 "location": "query",
869 "type": "string"
870 },
871 "view": {
872 "description": "The view to retrieve. Defaul ts to METADATA_ONLY.",
873 "enum": [
874 "METADATA_ONLY"
875 ],
876 "location": "query",
877 "type": "string"
878 },
879 "projectId": {
880 "description": "Required. The ID of the Clou d Platform project that the job belongs to.",
881 "location": "path",
882 "required": true,
883 "type": "string"
884 },
885 "gcsPath": {
886 "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://`.",
887 "location": "query",
888 "type": "string"
889 }
890 },
891 "path": "v1b3/projects/{projectId}/templates:get",
892 "response": {
893 "$ref": "GetTemplateResponse"
894 },
895 "scopes": [
896 "https://www.googleapis.com/auth/cloud-platform" ,
897 "https://www.googleapis.com/auth/compute",
898 "https://www.googleapis.com/auth/compute.readonl y",
899 "https://www.googleapis.com/auth/userinfo.email"
900 ]
901 },
902 "create": { 1406 "create": {
903 "description": "Creates a Cloud Dataflow job from a template.", 1407 "description": "Creates a Cloud Dataflow job from a template.",
904 "httpMethod": "POST", 1408 "httpMethod": "POST",
905 "id": "dataflow.projects.templates.create", 1409 "id": "dataflow.projects.templates.create",
906 "parameterOrder": [ 1410 "parameterOrder": [
907 "projectId" 1411 "projectId"
908 ], 1412 ],
909 "parameters": { 1413 "parameters": {
910 "projectId": { 1414 "projectId": {
911 "description": "Required. The ID of the Clou d Platform project that the job belongs to.", 1415 "description": "Required. The ID of the Clou d Platform project that the job belongs to.",
(...skipping 52 matching lines...) Expand 10 before | Expand all | Expand 10 after
964 }, 1468 },
965 "response": { 1469 "response": {
966 "$ref": "LaunchTemplateResponse" 1470 "$ref": "LaunchTemplateResponse"
967 }, 1471 },
968 "scopes": [ 1472 "scopes": [
969 "https://www.googleapis.com/auth/cloud-platform" , 1473 "https://www.googleapis.com/auth/cloud-platform" ,
970 "https://www.googleapis.com/auth/compute", 1474 "https://www.googleapis.com/auth/compute",
971 "https://www.googleapis.com/auth/compute.readonl y", 1475 "https://www.googleapis.com/auth/compute.readonl y",
972 "https://www.googleapis.com/auth/userinfo.email" 1476 "https://www.googleapis.com/auth/userinfo.email"
973 ] 1477 ]
974 }
975 }
976 },
977 "jobs": {
978 "methods": {
979 "get": {
980 "description": "Gets the state of the specified Clou d Dataflow job.",
981 "httpMethod": "GET",
982 "id": "dataflow.projects.jobs.get",
983 "parameterOrder": [
984 "projectId",
985 "jobId"
986 ],
987 "parameters": {
988 "location": {
989 "description": "The location that contains t his job.",
990 "location": "query",
991 "type": "string"
992 },
993 "view": {
994 "description": "The level of information req uested in response.",
995 "enum": [
996 "JOB_VIEW_UNKNOWN",
997 "JOB_VIEW_SUMMARY",
998 "JOB_VIEW_ALL",
999 "JOB_VIEW_DESCRIPTION"
1000 ],
1001 "location": "query",
1002 "type": "string"
1003 },
1004 "jobId": {
1005 "description": "The job ID.",
1006 "location": "path",
1007 "required": true,
1008 "type": "string"
1009 },
1010 "projectId": {
1011 "description": "The ID of the Cloud Platform project that the job belongs to.",
1012 "location": "path",
1013 "required": true,
1014 "type": "string"
1015 }
1016 },
1017 "path": "v1b3/projects/{projectId}/jobs/{jobId}",
1018 "response": {
1019 "$ref": "Job"
1020 },
1021 "scopes": [
1022 "https://www.googleapis.com/auth/cloud-platform" ,
1023 "https://www.googleapis.com/auth/compute",
1024 "https://www.googleapis.com/auth/compute.readonl y",
1025 "https://www.googleapis.com/auth/userinfo.email"
1026 ]
1027 }, 1478 },
1028 "update": { 1479 "get": {
1029 "description": "Updates the state of an existing Clo ud Dataflow job.", 1480 "description": "Get the template associated with a t emplate.",
1030 "httpMethod": "PUT",
1031 "id": "dataflow.projects.jobs.update",
1032 "parameterOrder": [
1033 "projectId",
1034 "jobId"
1035 ],
1036 "parameters": {
1037 "jobId": {
1038 "description": "The job ID.",
1039 "location": "path",
1040 "required": true,
1041 "type": "string"
1042 },
1043 "projectId": {
1044 "description": "The ID of the Cloud Platform project that the job belongs to.",
1045 "location": "path",
1046 "required": true,
1047 "type": "string"
1048 },
1049 "location": {
1050 "description": "The location that contains t his job.",
1051 "location": "query",
1052 "type": "string"
1053 }
1054 },
1055 "path": "v1b3/projects/{projectId}/jobs/{jobId}",
1056 "request": {
1057 "$ref": "Job"
1058 },
1059 "response": {
1060 "$ref": "Job"
1061 },
1062 "scopes": [
1063 "https://www.googleapis.com/auth/cloud-platform" ,
1064 "https://www.googleapis.com/auth/compute",
1065 "https://www.googleapis.com/auth/compute.readonl y",
1066 "https://www.googleapis.com/auth/userinfo.email"
1067 ]
1068 },
1069 "aggregated": {
1070 "description": "List the jobs of a project across al l regions.",
1071 "httpMethod": "GET", 1481 "httpMethod": "GET",
1072 "id": "dataflow.projects.jobs.aggregated", 1482 "id": "dataflow.projects.templates.get",
1073 "parameterOrder": [ 1483 "parameterOrder": [
1074 "projectId" 1484 "projectId"
1075 ], 1485 ],
1076 "parameters": { 1486 "parameters": {
1077 "filter": { 1487 "view": {
1078 "description": "The kind of filter to use.", 1488 "description": "The view to retrieve. Defaul ts to METADATA_ONLY.",
1079 "enum": [ 1489 "enum": [
1080 "UNKNOWN", 1490 "METADATA_ONLY"
1081 "ALL",
1082 "TERMINATED",
1083 "ACTIVE"
1084 ],
1085 "location": "query",
1086 "type": "string"
1087 },
1088 "location": {
1089 "description": "The location that contains t his job.",
1090 "location": "query",
1091 "type": "string"
1092 },
1093 "pageToken": {
1094 "description": "Set this to the 'next_page_t oken' field of a previous response\nto request additional results in a long list .",
1095 "location": "query",
1096 "type": "string"
1097 },
1098 "pageSize": {
1099 "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.",
1100 "format": "int32",
1101 "location": "query",
1102 "type": "integer"
1103 },
1104 "view": {
1105 "description": "Level of information request ed in response. Default is `JOB_VIEW_SUMMARY`.",
1106 "enum": [
1107 "JOB_VIEW_UNKNOWN",
1108 "JOB_VIEW_SUMMARY",
1109 "JOB_VIEW_ALL",
1110 "JOB_VIEW_DESCRIPTION"
1111 ], 1491 ],
1112 "location": "query", 1492 "location": "query",
1113 "type": "string" 1493 "type": "string"
1114 }, 1494 },
1115 "projectId": { 1495 "projectId": {
1116 "description": "The project which owns the j obs.", 1496 "description": "Required. The ID of the Clou d Platform project that the job belongs to.",
1117 "location": "path",
1118 "required": true,
1119 "type": "string"
1120 }
1121 },
1122 "path": "v1b3/projects/{projectId}/jobs:aggregated",
1123 "response": {
1124 "$ref": "ListJobsResponse"
1125 },
1126 "scopes": [
1127 "https://www.googleapis.com/auth/cloud-platform" ,
1128 "https://www.googleapis.com/auth/compute",
1129 "https://www.googleapis.com/auth/compute.readonl y",
1130 "https://www.googleapis.com/auth/userinfo.email"
1131 ]
1132 },
1133 "list": {
1134 "description": "List the jobs of a project in a give n region.",
1135 "httpMethod": "GET",
1136 "id": "dataflow.projects.jobs.list",
1137 "parameterOrder": [
1138 "projectId"
1139 ],
1140 "parameters": {
1141 "view": {
1142 "description": "Level of information request ed in response. Default is `JOB_VIEW_SUMMARY`.",
1143 "enum": [
1144 "JOB_VIEW_UNKNOWN",
1145 "JOB_VIEW_SUMMARY",
1146 "JOB_VIEW_ALL",
1147 "JOB_VIEW_DESCRIPTION"
1148 ],
1149 "location": "query",
1150 "type": "string"
1151 },
1152 "projectId": {
1153 "description": "The project which owns the j obs.",
1154 "location": "path", 1497 "location": "path",
1155 "required": true, 1498 "required": true,
1156 "type": "string" 1499 "type": "string"
1157 }, 1500 },
1158 "filter": { 1501 "gcsPath": {
1159 "description": "The kind of filter to use.", 1502 "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://`.",
1160 "enum": [
1161 "UNKNOWN",
1162 "ALL",
1163 "TERMINATED",
1164 "ACTIVE"
1165 ],
1166 "location": "query", 1503 "location": "query",
1167 "type": "string" 1504 "type": "string"
1168 }, 1505 },
1169 "location": { 1506 "location": {
1170 "description": "The location that contains t his job.", 1507 "description": "The location to which to dir ect the request.",
1171 "location": "query",
1172 "type": "string"
1173 },
1174 "pageToken": {
1175 "description": "Set this to the 'next_page_t oken' field of a previous response\nto request additional results in a long list .",
1176 "location": "query",
1177 "type": "string"
1178 },
1179 "pageSize": {
1180 "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.",
1181 "format": "int32",
1182 "location": "query",
1183 "type": "integer"
1184 }
1185 },
1186 "path": "v1b3/projects/{projectId}/jobs",
1187 "response": {
1188 "$ref": "ListJobsResponse"
1189 },
1190 "scopes": [
1191 "https://www.googleapis.com/auth/cloud-platform" ,
1192 "https://www.googleapis.com/auth/compute",
1193 "https://www.googleapis.com/auth/compute.readonl y",
1194 "https://www.googleapis.com/auth/userinfo.email"
1195 ]
1196 },
1197 "create": {
1198 "description": "Creates a Cloud Dataflow job.",
1199 "httpMethod": "POST",
1200 "id": "dataflow.projects.jobs.create",
1201 "parameterOrder": [
1202 "projectId"
1203 ],
1204 "parameters": {
1205 "location": {
1206 "description": "The location that contains t his job.",
1207 "location": "query",
1208 "type": "string"
1209 },
1210 "replaceJobId": {
1211 "description": "Deprecated. This field is no w in the Job message.",
1212 "location": "query",
1213 "type": "string"
1214 },
1215 "view": {
1216 "description": "The level of information req uested in response.",
1217 "enum": [
1218 "JOB_VIEW_UNKNOWN",
1219 "JOB_VIEW_SUMMARY",
1220 "JOB_VIEW_ALL",
1221 "JOB_VIEW_DESCRIPTION"
1222 ],
1223 "location": "query",
1224 "type": "string"
1225 },
1226 "projectId": {
1227 "description": "The ID of the Cloud Platform project that the job belongs to.",
1228 "location": "path",
1229 "required": true,
1230 "type": "string"
1231 }
1232 },
1233 "path": "v1b3/projects/{projectId}/jobs",
1234 "request": {
1235 "$ref": "Job"
1236 },
1237 "response": {
1238 "$ref": "Job"
1239 },
1240 "scopes": [
1241 "https://www.googleapis.com/auth/cloud-platform" ,
1242 "https://www.googleapis.com/auth/compute",
1243 "https://www.googleapis.com/auth/compute.readonl y",
1244 "https://www.googleapis.com/auth/userinfo.email"
1245 ]
1246 },
1247 "getMetrics": {
1248 "description": "Request the job status.",
1249 "httpMethod": "GET",
1250 "id": "dataflow.projects.jobs.getMetrics",
1251 "parameterOrder": [
1252 "projectId",
1253 "jobId"
1254 ],
1255 "parameters": {
1256 "jobId": {
1257 "description": "The job to get messages for. ",
1258 "location": "path",
1259 "required": true,
1260 "type": "string"
1261 },
1262 "projectId": {
1263 "description": "A project id.",
1264 "location": "path",
1265 "required": true,
1266 "type": "string"
1267 },
1268 "location": {
1269 "description": "The location which contains the job specified by job_id.",
1270 "location": "query",
1271 "type": "string"
1272 },
1273 "startTime": {
1274 "description": "Return only metric data that has changed since this time.\nDefault is to return all information about all me trics for the job.",
1275 "format": "google-datetime",
1276 "location": "query", 1508 "location": "query",
1277 "type": "string" 1509 "type": "string"
1278 } 1510 }
1279 }, 1511 },
1280 "path": "v1b3/projects/{projectId}/jobs/{jobId}/metr ics", 1512 "path": "v1b3/projects/{projectId}/templates:get",
1281 "response": { 1513 "response": {
1282 "$ref": "JobMetrics" 1514 "$ref": "GetTemplateResponse"
1283 }, 1515 },
1284 "scopes": [ 1516 "scopes": [
1285 "https://www.googleapis.com/auth/cloud-platform" , 1517 "https://www.googleapis.com/auth/cloud-platform" ,
1286 "https://www.googleapis.com/auth/compute", 1518 "https://www.googleapis.com/auth/compute",
1287 "https://www.googleapis.com/auth/compute.readonl y", 1519 "https://www.googleapis.com/auth/compute.readonl y",
1288 "https://www.googleapis.com/auth/userinfo.email" 1520 "https://www.googleapis.com/auth/userinfo.email"
1289 ] 1521 ]
1290 } 1522 }
1291 },
1292 "resources": {
1293 "messages": {
1294 "methods": {
1295 "list": {
1296 "description": "Request the job status.",
1297 "httpMethod": "GET",
1298 "id": "dataflow.projects.jobs.messages.list" ,
1299 "parameterOrder": [
1300 "projectId",
1301 "jobId"
1302 ],
1303 "parameters": {
1304 "projectId": {
1305 "description": "A project id.",
1306 "location": "path",
1307 "required": true,
1308 "type": "string"
1309 },
1310 "jobId": {
1311 "description": "The job to get messa ges about.",
1312 "location": "path",
1313 "required": true,
1314 "type": "string"
1315 },
1316 "location": {
1317 "description": "The location which c ontains the job specified by job_id.",
1318 "location": "query",
1319 "type": "string"
1320 },
1321 "endTime": {
1322 "description": "Return only messages with timestamps < end_time. The default is now\n(i.e. return up to the latest m essages available).",
1323 "format": "google-datetime",
1324 "location": "query",
1325 "type": "string"
1326 },
1327 "startTime": {
1328 "description": "If specified, return only messages with timestamps >= start_time.\nThe default is the job creation t ime (i.e. beginning of messages).",
1329 "format": "google-datetime",
1330 "location": "query",
1331 "type": "string"
1332 },
1333 "pageToken": {
1334 "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.",
1335 "location": "query",
1336 "type": "string"
1337 },
1338 "pageSize": {
1339 "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.",
1340 "format": "int32",
1341 "location": "query",
1342 "type": "integer"
1343 },
1344 "minimumImportance": {
1345 "description": "Filter to only get m essages with importance >= level",
1346 "enum": [
1347 "JOB_MESSAGE_IMPORTANCE_UNKNOWN" ,
1348 "JOB_MESSAGE_DEBUG",
1349 "JOB_MESSAGE_DETAILED",
1350 "JOB_MESSAGE_BASIC",
1351 "JOB_MESSAGE_WARNING",
1352 "JOB_MESSAGE_ERROR"
1353 ],
1354 "location": "query",
1355 "type": "string"
1356 }
1357 },
1358 "path": "v1b3/projects/{projectId}/jobs/{job Id}/messages",
1359 "response": {
1360 "$ref": "ListJobMessagesResponse"
1361 },
1362 "scopes": [
1363 "https://www.googleapis.com/auth/cloud-p latform",
1364 "https://www.googleapis.com/auth/compute ",
1365 "https://www.googleapis.com/auth/compute .readonly",
1366 "https://www.googleapis.com/auth/userinf o.email"
1367 ]
1368 }
1369 }
1370 },
1371 "workItems": {
1372 "methods": {
1373 "reportStatus": {
1374 "description": "Reports the status of datafl ow WorkItems leased by a worker.",
1375 "httpMethod": "POST",
1376 "id": "dataflow.projects.jobs.workItems.repo rtStatus",
1377 "parameterOrder": [
1378 "projectId",
1379 "jobId"
1380 ],
1381 "parameters": {
1382 "jobId": {
1383 "description": "The job which the Wo rkItem is part of.",
1384 "location": "path",
1385 "required": true,
1386 "type": "string"
1387 },
1388 "projectId": {
1389 "description": "The project which ow ns the WorkItem's job.",
1390 "location": "path",
1391 "required": true,
1392 "type": "string"
1393 }
1394 },
1395 "path": "v1b3/projects/{projectId}/jobs/{job Id}/workItems:reportStatus",
1396 "request": {
1397 "$ref": "ReportWorkItemStatusRequest"
1398 },
1399 "response": {
1400 "$ref": "ReportWorkItemStatusResponse"
1401 },
1402 "scopes": [
1403 "https://www.googleapis.com/auth/cloud-p latform",
1404 "https://www.googleapis.com/auth/compute ",
1405 "https://www.googleapis.com/auth/compute .readonly",
1406 "https://www.googleapis.com/auth/userinf o.email"
1407 ]
1408 },
1409 "lease": {
1410 "description": "Leases a dataflow WorkItem t o run.",
1411 "httpMethod": "POST",
1412 "id": "dataflow.projects.jobs.workItems.leas e",
1413 "parameterOrder": [
1414 "projectId",
1415 "jobId"
1416 ],
1417 "parameters": {
1418 "jobId": {
1419 "description": "Identifies the workf low job this worker belongs to.",
1420 "location": "path",
1421 "required": true,
1422 "type": "string"
1423 },
1424 "projectId": {
1425 "description": "Identifies the proje ct this worker belongs to.",
1426 "location": "path",
1427 "required": true,
1428 "type": "string"
1429 }
1430 },
1431 "path": "v1b3/projects/{projectId}/jobs/{job Id}/workItems:lease",
1432 "request": {
1433 "$ref": "LeaseWorkItemRequest"
1434 },
1435 "response": {
1436 "$ref": "LeaseWorkItemResponse"
1437 },
1438 "scopes": [
1439 "https://www.googleapis.com/auth/cloud-p latform",
1440 "https://www.googleapis.com/auth/compute ",
1441 "https://www.googleapis.com/auth/compute .readonly",
1442 "https://www.googleapis.com/auth/userinf o.email"
1443 ]
1444 }
1445 }
1446 },
1447 "debug": {
1448 "methods": {
1449 "sendCapture": {
1450 "description": "Send encoded debug capture d ata for component.",
1451 "httpMethod": "POST",
1452 "id": "dataflow.projects.jobs.debug.sendCapt ure",
1453 "parameterOrder": [
1454 "projectId",
1455 "jobId"
1456 ],
1457 "parameters": {
1458 "jobId": {
1459 "description": "The job id.",
1460 "location": "path",
1461 "required": true,
1462 "type": "string"
1463 },
1464 "projectId": {
1465 "description": "The project id.",
1466 "location": "path",
1467 "required": true,
1468 "type": "string"
1469 }
1470 },
1471 "path": "v1b3/projects/{projectId}/jobs/{job Id}/debug/sendCapture",
1472 "request": {
1473 "$ref": "SendDebugCaptureRequest"
1474 },
1475 "response": {
1476 "$ref": "SendDebugCaptureResponse"
1477 },
1478 "scopes": [
1479 "https://www.googleapis.com/auth/cloud-p latform",
1480 "https://www.googleapis.com/auth/compute ",
1481 "https://www.googleapis.com/auth/compute .readonly",
1482 "https://www.googleapis.com/auth/userinf o.email"
1483 ]
1484 },
1485 "getConfig": {
1486 "description": "Get encoded debug configurat ion for component. Not cacheable.",
1487 "httpMethod": "POST",
1488 "id": "dataflow.projects.jobs.debug.getConfi g",
1489 "parameterOrder": [
1490 "projectId",
1491 "jobId"
1492 ],
1493 "parameters": {
1494 "jobId": {
1495 "description": "The job id.",
1496 "location": "path",
1497 "required": true,
1498 "type": "string"
1499 },
1500 "projectId": {
1501 "description": "The project id.",
1502 "location": "path",
1503 "required": true,
1504 "type": "string"
1505 }
1506 },
1507 "path": "v1b3/projects/{projectId}/jobs/{job Id}/debug/getConfig",
1508 "request": {
1509 "$ref": "GetDebugConfigRequest"
1510 },
1511 "response": {
1512 "$ref": "GetDebugConfigResponse"
1513 },
1514 "scopes": [
1515 "https://www.googleapis.com/auth/cloud-p latform",
1516 "https://www.googleapis.com/auth/compute ",
1517 "https://www.googleapis.com/auth/compute .readonly",
1518 "https://www.googleapis.com/auth/userinf o.email"
1519 ]
1520 }
1521 }
1522 }
1523 } 1523 }
1524 } 1524 }
1525 } 1525 }
1526 } 1526 }
1527 }, 1527 },
1528 "revision": "20170809", 1528 "revision": "20170823",
1529 "rootUrl": "https://dataflow.googleapis.com/", 1529 "rootUrl": "https://dataflow.googleapis.com/",
1530 "schemas": { 1530 "schemas": {
1531 "ParallelInstruction": { 1531 "SideInputId": {
1532 "description": "Describes a particular operation comprising a MapTas k.", 1532 "description": "Uniquely identifies a side input.",
1533 "id": "ParallelInstruction", 1533 "id": "SideInputId",
1534 "properties": { 1534 "properties": {
1535 "partialGroupByKey": { 1535 "inputIndex": {
1536 "$ref": "PartialGroupByKeyInstruction", 1536 "description": "The index of the side input, from the list o f non_parallel_inputs.",
1537 "description": "Additional information for PartialGroupByKey instructions." 1537 "format": "int32",
1538 }, 1538 "type": "integer"
1539 "outputs": { 1539 },
1540 "description": "Describes the outputs of the instruction.", 1540 "declaringStepName": {
1541 "items": { 1541 "description": "The step that receives and usually consumes this side input.",
1542 "$ref": "InstructionOutput" 1542 "type": "string"
1543 }, 1543 }
1544 "type": "array" 1544 },
1545 }, 1545 "type": "object"
1546 },
1547 "SourceOperationResponse": {
1548 "description": "The result of a SourceOperationRequest, specified in \nReportWorkItemStatusRequest.source_operation when the work item\nis completed. ",
1549 "id": "SourceOperationResponse",
1550 "properties": {
1551 "getMetadata": {
1552 "$ref": "SourceGetMetadataResponse",
1553 "description": "A response to a request to get metadata abou t a source."
1554 },
1555 "split": {
1556 "$ref": "SourceSplitResponse",
1557 "description": "A response to a request to split a source."
1558 }
1559 },
1560 "type": "object"
1561 },
1562 "SendDebugCaptureResponse": {
1563 "description": "Response to a send capture request.\nnothing",
1564 "id": "SendDebugCaptureResponse",
1565 "properties": {},
1566 "type": "object"
1567 },
1568 "SideInputInfo": {
1569 "description": "Information about a side input of a DoFn or an input of a SeqDoFn.",
1570 "id": "SideInputInfo",
1571 "properties": {
1572 "tag": {
1573 "description": "The id of the tag the user code will access this side input by;\nthis should correspond to the tag of some MultiOutputInfo." ,
1574 "type": "string"
1575 },
1576 "kind": {
1577 "additionalProperties": {
1578 "description": "Properties of the object.",
1579 "type": "any"
1580 },
1581 "description": "How to interpret the source element(s) as a side input value.",
1582 "type": "object"
1583 },
1584 "sources": {
1585 "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.",
1586 "items": {
1587 "$ref": "Source"
1588 },
1589 "type": "array"
1590 }
1591 },
1592 "type": "object"
1593 },
1594 "CounterStructuredNameAndMetadata": {
1595 "description": "A single message which encapsulates structured name and metadata for a given\ncounter.",
1596 "id": "CounterStructuredNameAndMetadata",
1597 "properties": {
1546 "name": { 1598 "name": {
1547 "description": "User-provided name of this operation.", 1599 "$ref": "CounterStructuredName",
1548 "type": "string" 1600 "description": "Structured name of the counter."
1549 }, 1601 },
1550 "read": { 1602 "metadata": {
1551 "$ref": "ReadInstruction", 1603 "$ref": "CounterMetadata",
1552 "description": "Additional information for Read instructions ." 1604 "description": "Metadata associated with a counter"
1553 }, 1605 }
1554 "parDo": { 1606 },
1555 "$ref": "ParDoInstruction", 1607 "type": "object"
1556 "description": "Additional information for ParDo instruction s." 1608 },
1557 }, 1609 "ConcatPosition": {
1558 "originalName": { 1610 "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.",
1559 "description": "System-defined name for the operation in the original workflow graph.", 1611 "id": "ConcatPosition",
1560 "type": "string" 1612 "properties": {
1561 }, 1613 "position": {
1562 "flatten": { 1614 "$ref": "Position",
1563 "$ref": "FlattenInstruction", 1615 "description": "Position within the inner source."
1564 "description": "Additional information for Flatten instructi ons." 1616 },
1565 }, 1617 "index": {
1566 "write": { 1618 "description": "Index of the inner source.",
1567 "$ref": "WriteInstruction", 1619 "format": "int32",
1568 "description": "Additional information for Write instruction s." 1620 "type": "integer"
1569 }, 1621 }
1570 "systemName": { 1622 },
1571 "description": "System-defined name of this operation.\nUniq ue across the workflow.", 1623 "type": "object"
1572 "type": "string" 1624 },
1573 } 1625 "WriteInstruction": {
1574 }, 1626 "description": "An instruction that writes records.\nTakes one input , produces no outputs.",
1575 "type": "object" 1627 "id": "WriteInstruction",
1576 },
1577 "KeyRangeDataDiskAssignment": {
1578 "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.",
1579 "id": "KeyRangeDataDiskAssignment",
1580 "properties": {
1581 "end": {
1582 "description": "The end (exclusive) of the key range.",
1583 "type": "string"
1584 },
1585 "dataDisk": {
1586 "description": "The name of the data disk where data for thi s range is stored.\nThis name is local 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\".",
1587 "type": "string"
1588 },
1589 "start": {
1590 "description": "The start (inclusive) of the key range.",
1591 "type": "string"
1592 }
1593 },
1594 "type": "object"
1595 },
1596 "Package": {
1597 "description": "The packages that must be installed in order for a w orker to run the\nsteps of the Cloud Dataflow job that will be assigned to its w orker\npool.\n\nThis is the mechanism by which the Cloud Dataflow SDK causes cod e to\nbe loaded onto the workers. For example, the Cloud Dataflow Java SDK\nmigh t use this to install jars containing the user's code and all of the\nvarious de pendencies (libraries, data files, etc.) required in order\nfor that code to run .",
1598 "id": "Package",
1599 "properties": {
1600 "name": {
1601 "description": "The name of the package.",
1602 "type": "string"
1603 },
1604 "location": {
1605 "description": "The resource to read the package from. The s upported resource type is:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/ {bucket}\n bucket.storage.googleapis.com/",
1606 "type": "string"
1607 }
1608 },
1609 "type": "object"
1610 },
1611 "ParDoInstruction": {
1612 "description": "An instruction that does a ParDo operation.\nTakes o ne main input and zero or more side inputs, and produces\nzero or more outputs.\ nRuns user code.",
1613 "id": "ParDoInstruction",
1614 "properties": { 1628 "properties": {
1615 "input": { 1629 "input": {
1616 "$ref": "InstructionInput", 1630 "$ref": "InstructionInput",
1617 "description": "The input." 1631 "description": "The input."
1618 }, 1632 },
1619 "numOutputs": { 1633 "sink": {
1620 "description": "The number of outputs.", 1634 "$ref": "Sink",
1635 "description": "The sink to write to."
1636 }
1637 },
1638 "type": "object"
1639 },
1640 "StreamingComputationRanges": {
1641 "description": "Describes full or partial data disk assignment infor mation of the computation\nranges.",
1642 "id": "StreamingComputationRanges",
1643 "properties": {
1644 "rangeAssignments": {
1645 "description": "Data disk assignments for ranges from this c omputation.",
1646 "items": {
1647 "$ref": "KeyRangeDataDiskAssignment"
1648 },
1649 "type": "array"
1650 },
1651 "computationId": {
1652 "description": "The ID of the computation.",
1653 "type": "string"
1654 }
1655 },
1656 "type": "object"
1657 },
1658 "AutoscalingSettings": {
1659 "description": "Settings for WorkerPool autoscaling.",
1660 "id": "AutoscalingSettings",
1661 "properties": {
1662 "algorithm": {
1663 "description": "The algorithm to use for autoscaling.",
1664 "enum": [
1665 "AUTOSCALING_ALGORITHM_UNKNOWN",
1666 "AUTOSCALING_ALGORITHM_NONE",
1667 "AUTOSCALING_ALGORITHM_BASIC"
1668 ],
1669 "enumDescriptions": [
1670 "The algorithm is unknown, or unspecified.",
1671 "Disable autoscaling.",
1672 "Increase worker count over time to reduce job execution time."
1673 ],
1674 "type": "string"
1675 },
1676 "maxNumWorkers": {
1677 "description": "The maximum number of workers to cap scaling at.",
1621 "format": "int32", 1678 "format": "int32",
1622 "type": "integer" 1679 "type": "integer"
1623 }, 1680 }
1624 "sideInputs": { 1681 },
1625 "description": "Zero or more side inputs.", 1682 "type": "object"
1626 "items": { 1683 },
1627 "$ref": "SideInputInfo" 1684 "ExecutionStageSummary": {
1628 }, 1685 "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.",
1629 "type": "array" 1686 "id": "ExecutionStageSummary",
1630 }, 1687 "properties": {
1631 "multiOutputInfos": { 1688 "componentTransform": {
1632 "description": "Information about each of the outputs, if us er_fn is a MultiDoFn.", 1689 "description": "Transforms that comprise this execution stag e.",
1633 "items": { 1690 "items": {
1634 "$ref": "MultiOutputInfo" 1691 "$ref": "ComponentTransform"
1635 }, 1692 },
1636 "type": "array" 1693 "type": "array"
1637 }, 1694 },
1638 "userFn": { 1695 "componentSource": {
1696 "description": "Collections produced and consumed by compone nt transforms of this stage.",
1697 "items": {
1698 "$ref": "ComponentSource"
1699 },
1700 "type": "array"
1701 },
1702 "kind": {
1703 "description": "Type of tranform this stage is executing.",
1704 "enum": [
1705 "UNKNOWN_KIND",
1706 "PAR_DO_KIND",
1707 "GROUP_BY_KEY_KIND",
1708 "FLATTEN_KIND",
1709 "READ_KIND",
1710 "WRITE_KIND",
1711 "CONSTANT_KIND",
1712 "SINGLETON_KIND",
1713 "SHUFFLE_KIND"
1714 ],
1715 "enumDescriptions": [
1716 "Unrecognized transform type.",
1717 "ParDo transform.",
1718 "Group By Key transform.",
1719 "Flatten transform.",
1720 "Read transform.",
1721 "Write transform.",
1722 "Constructs from a constant value, such as with Create.o f.",
1723 "Creates a Singleton view of a collection.",
1724 "Opening or closing a shuffle session, often as part of a GroupByKey."
1725 ],
1726 "type": "string"
1727 },
1728 "outputSource": {
1729 "description": "Output sources for this stage.",
1730 "items": {
1731 "$ref": "StageSource"
1732 },
1733 "type": "array"
1734 },
1735 "name": {
1736 "description": "Dataflow service generated name for this sta ge.",
1737 "type": "string"
1738 },
1739 "inputSource": {
1740 "description": "Input sources for this stage.",
1741 "items": {
1742 "$ref": "StageSource"
1743 },
1744 "type": "array"
1745 },
1746 "id": {
1747 "description": "Dataflow service generated id for this stage .",
1748 "type": "string"
1749 }
1750 },
1751 "type": "object"
1752 },
1753 "SendWorkerMessagesRequest": {
1754 "description": "A request for sending worker messages to the service .",
1755 "id": "SendWorkerMessagesRequest",
1756 "properties": {
1757 "workerMessages": {
1758 "description": "The WorkerMessages to send.",
1759 "items": {
1760 "$ref": "WorkerMessage"
1761 },
1762 "type": "array"
1763 },
1764 "location": {
1765 "description": "The location which contains the job",
1766 "type": "string"
1767 }
1768 },
1769 "type": "object"
1770 },
1771 "LogBucket": {
1772 "description": "Bucket of values for Distribution's logarithmic hist ogram.",
1773 "id": "LogBucket",
1774 "properties": {
1775 "log": {
1776 "description": "floor(log2(value)); defined to be zero for n onpositive values.\n log(-1) = 0\n log(0) = 0\n log(1) = 0\n log(2) = 1\n l og(3) = 1\n log(4) = 2\n log(5) = 2",
1777 "format": "int32",
1778 "type": "integer"
1779 },
1780 "count": {
1781 "description": "Number of values in this bucket.",
1782 "format": "int64",
1783 "type": "string"
1784 }
1785 },
1786 "type": "object"
1787 },
1788 "SourceSplitShard": {
1789 "description": "DEPRECATED in favor of DerivedSource.",
1790 "id": "SourceSplitShard",
1791 "properties": {
1792 "source": {
1793 "$ref": "Source",
1794 "description": "DEPRECATED"
1795 },
1796 "derivationMode": {
1797 "description": "DEPRECATED",
1798 "enum": [
1799 "SOURCE_DERIVATION_MODE_UNKNOWN",
1800 "SOURCE_DERIVATION_MODE_INDEPENDENT",
1801 "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT",
1802 "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT"
1803 ],
1804 "enumDescriptions": [
1805 "The source derivation is unknown, or unspecified.",
1806 "Produce a completely independent Source with no base.",
1807 "Produce a Source based on the Source being split.",
1808 "Produce a Source based on the base of the Source being split."
1809 ],
1810 "type": "string"
1811 }
1812 },
1813 "type": "object"
1814 },
1815 "CPUTime": {
1816 "description": "Modeled after information exposed by /proc/stat.",
1817 "id": "CPUTime",
1818 "properties": {
1819 "totalMs": {
1820 "description": "Total active CPU time across all cores (ie., non-idle) in milliseconds\nsince start-up.",
1821 "format": "uint64",
1822 "type": "string"
1823 },
1824 "rate": {
1825 "description": "Average CPU utilization rate (% non-idle cpu / second) since previous\nsample.",
1826 "format": "double",
1827 "type": "number"
1828 },
1829 "timestamp": {
1830 "description": "Timestamp of the measurement.",
1831 "format": "google-datetime",
1832 "type": "string"
1833 }
1834 },
1835 "type": "object"
1836 },
1837 "Environment": {
1838 "description": "Describes the environment in which a Dataflow Job ru ns.",
1839 "id": "Environment",
1840 "properties": {
1841 "userAgent": {
1639 "additionalProperties": { 1842 "additionalProperties": {
1640 "description": "Properties of the object.", 1843 "description": "Properties of the object.",
1641 "type": "any" 1844 "type": "any"
1642 }, 1845 },
1643 "description": "The user function to invoke.", 1846 "description": "A description of the process that generated the request.",
1644 "type": "object" 1847 "type": "object"
1645 } 1848 },
1646 }, 1849 "sdkPipelineOptions": {
1647 "type": "object" 1850 "additionalProperties": {
1648 }, 1851 "description": "Properties of the object.",
1649 "CounterStructuredName": { 1852 "type": "any"
1650 "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.", 1853 },
1651 "id": "CounterStructuredName", 1854 "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.",
1652 "properties": { 1855 "type": "object"
1653 "componentStepName": { 1856 },
1654 "description": "Name of the optimized step being executed by the workers.", 1857 "clusterManagerApiService": {
1655 "type": "string" 1858 "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\".",
1656 }, 1859 "type": "string"
1657 "portion": { 1860 },
1658 "description": "Portion of this counter, either key or value .", 1861 "tempStoragePrefix": {
1862 "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}",
1863 "type": "string"
1864 },
1865 "workerPools": {
1866 "description": "The worker pools. At least one \"harness\" w orker pool must be\nspecified in order for the job to have workers.",
1867 "items": {
1868 "$ref": "WorkerPool"
1869 },
1870 "type": "array"
1871 },
1872 "dataset": {
1873 "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}",
1874 "type": "string"
1875 },
1876 "experiments": {
1877 "description": "The list of experiments to enable.",
1878 "items": {
1879 "type": "string"
1880 },
1881 "type": "array"
1882 },
1883 "version": {
1884 "additionalProperties": {
1885 "description": "Properties of the object.",
1886 "type": "any"
1887 },
1888 "description": "A structure describing which components and their versions of the service\nare required in order to run the job.",
1889 "type": "object"
1890 },
1891 "internalExperiments": {
1892 "additionalProperties": {
1893 "description": "Properties of the object. Contains field @type with type URL.",
1894 "type": "any"
1895 },
1896 "description": "Experimental settings.",
1897 "type": "object"
1898 },
1899 "serviceAccountEmail": {
1900 "description": "Identity to run virtual machines as. Default s to the default account.",
1901 "type": "string"
1902 }
1903 },
1904 "type": "object"
1905 },
1906 "StreamingComputationTask": {
1907 "description": "A task which describes what action should be perform ed for the specified\nstreaming computation ranges.",
1908 "id": "StreamingComputationTask",
1909 "properties": {
1910 "computationRanges": {
1911 "description": "Contains ranges of a streaming computation t his task should apply to.",
1912 "items": {
1913 "$ref": "StreamingComputationRanges"
1914 },
1915 "type": "array"
1916 },
1917 "dataDisks": {
1918 "description": "Describes the set of data disks this task sh ould apply to.",
1919 "items": {
1920 "$ref": "MountedDataDisk"
1921 },
1922 "type": "array"
1923 },
1924 "taskType": {
1925 "description": "A type of streaming computation task.",
1659 "enum": [ 1926 "enum": [
1660 "ALL", 1927 "STREAMING_COMPUTATION_TASK_UNKNOWN",
1661 "KEY", 1928 "STREAMING_COMPUTATION_TASK_STOP",
1662 "VALUE" 1929 "STREAMING_COMPUTATION_TASK_START"
1663 ], 1930 ],
1664 "enumDescriptions": [ 1931 "enumDescriptions": [
1665 "Counter portion has not been set.", 1932 "The streaming computation task is unknown, or unspecifi ed.",
1666 "Counter reports a key.", 1933 "Stop processing specified streaming computation range(s ).",
1667 "Counter reports a value." 1934 "Start processing specified streaming computation range( s)."
1668 ], 1935 ],
1669 "type": "string" 1936 "type": "string"
1670 }, 1937 }
1671 "originalStepName": { 1938 },
1672 "description": "System generated name of the original step i n the user's graph, before\noptimization.", 1939 "type": "object"
1940 },
1941 "SendDebugCaptureRequest": {
1942 "description": "Request to send encoded debug information.",
1943 "id": "SendDebugCaptureRequest",
1944 "properties": {
1945 "componentId": {
1946 "description": "The internal component id for which debug in formation is sent.",
1673 "type": "string" 1947 "type": "string"
1674 }, 1948 },
1675 "workerId": { 1949 "workerId": {
1676 "description": "ID of a particular worker.", 1950 "description": "The worker id, i.e., VM hostname.",
1677 "type": "string" 1951 "type": "string"
1678 }, 1952 },
1679 "originNamespace": { 1953 "location": {
1680 "description": "A string containing a more specific namespac e of the counter's origin.", 1954 "description": "The location which contains the job specifie d by job_id.",
1681 "type": "string" 1955 "type": "string"
1682 }, 1956 },
1683 "origin": { 1957 "data": {
1684 "description": "One of the standard Origins defined above.", 1958 "description": "The encoded debug information.",
1685 "enum": [ 1959 "type": "string"
1686 "SYSTEM", 1960 }
1687 "USER" 1961 },
1688 ], 1962 "type": "object"
1689 "enumDescriptions": [ 1963 },
1690 "Counter was created by the Dataflow system.", 1964 "GetDebugConfigResponse": {
1691 "Counter was created by the user." 1965 "description": "Response to a get debug configuration request.",
1692 ], 1966 "id": "GetDebugConfigResponse",
1693 "type": "string" 1967 "properties": {
1694 }, 1968 "config": {
1695 "name": { 1969 "description": "The encoded debug configuration for the requ ested component.",
1696 "description": "Counter name. Not necessarily globally-uniqu e, but unique within the\ncontext of the other fields.\nRequired.", 1970 "type": "string"
1697 "type": "string" 1971 }
1698 }, 1972 },
1699 "executionStepName": { 1973 "type": "object"
1700 "description": "Name of the stage. An execution step contain s multiple component steps.", 1974 },
1701 "type": "string" 1975 "ComponentTransform": {
1702 } 1976 "description": "Description of a transform executed as part of an ex ecution stage.",
1703 }, 1977 "id": "ComponentTransform",
1704 "type": "object" 1978 "properties": {
1705 }, 1979 "originalTransform": {
1706 "MetricUpdate": { 1980 "description": "User name for the original user transform wi th which this transform is\nmost closely associated.",
1707 "description": "Describes the state of a metric.", 1981 "type": "string"
1708 "id": "MetricUpdate", 1982 },
1709 "properties": {
1710 "name": {
1711 "$ref": "MetricStructuredName",
1712 "description": "Name of the metric."
1713 },
1714 "distribution": {
1715 "description": "A struct value describing properties of a di stribution of numeric values.",
1716 "type": "any"
1717 },
1718 "set": {
1719 "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.",
1720 "type": "any"
1721 },
1722 "cumulative": {
1723 "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.",
1724 "type": "boolean"
1725 },
1726 "internal": {
1727 "description": "Worker-computed aggregate value for internal use by the Dataflow\nservice.",
1728 "type": "any"
1729 },
1730 "kind": {
1731 "description": "Metric aggregation kind. The possible metri c aggregation kinds are\n\"Sum\", \"Max\", \"Min\", \"Mean\", \"Set\", \"And\", \"Or\", and \"Distribution\".\nThe specified aggregation kind is case-insensitiv e.\n\nIf omitted, this is not an aggregated value but instead\na single metric s ample value.",
1732 "type": "string"
1733 },
1734 "scalar": {
1735 "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.",
1736 "type": "any"
1737 },
1738 "meanCount": {
1739 "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.",
1740 "type": "any"
1741 },
1742 "meanSum": {
1743 "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.",
1744 "type": "any"
1745 },
1746 "updateTime": {
1747 "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.",
1748 "format": "google-datetime",
1749 "type": "string"
1750 }
1751 },
1752 "type": "object"
1753 },
1754 "ApproximateProgress": {
1755 "description": "Obsolete in favor of ApproximateReportedProgress and ApproximateSplitRequest.",
1756 "id": "ApproximateProgress",
1757 "properties": {
1758 "position": {
1759 "$ref": "Position",
1760 "description": "Obsolete."
1761 },
1762 "percentComplete": {
1763 "description": "Obsolete.",
1764 "format": "float",
1765 "type": "number"
1766 },
1767 "remainingTime": {
1768 "description": "Obsolete.",
1769 "format": "google-duration",
1770 "type": "string"
1771 }
1772 },
1773 "type": "object"
1774 },
1775 "WorkerMessageResponse": {
1776 "description": "A worker_message response allows the server to pass information to the\nsender.",
1777 "id": "WorkerMessageResponse",
1778 "properties": {
1779 "workerMetricsResponse": {
1780 "$ref": "ResourceUtilizationReportResponse",
1781 "description": "Service's response to reporting worker metri cs (currently empty)."
1782 },
1783 "workerHealthReportResponse": {
1784 "$ref": "WorkerHealthReportResponse",
1785 "description": "The service's response to a worker's health report."
1786 }
1787 },
1788 "type": "object"
1789 },
1790 "TemplateMetadata": {
1791 "description": "Metadata describing a template.",
1792 "id": "TemplateMetadata",
1793 "properties": {
1794 "parameters": {
1795 "description": "The parameters for the template.",
1796 "items": {
1797 "$ref": "ParameterMetadata"
1798 },
1799 "type": "array"
1800 },
1801 "name": {
1802 "description": "Required. The name of the template.",
1803 "type": "string"
1804 },
1805 "description": {
1806 "description": "Optional. A description of the template.",
1807 "type": "string"
1808 }
1809 },
1810 "type": "object"
1811 },
1812 "WorkerMessage": {
1813 "description": "WorkerMessage provides information to the backend ab out a worker.",
1814 "id": "WorkerMessage",
1815 "properties": {
1816 "time": {
1817 "description": "The timestamp of the worker_message.",
1818 "format": "google-datetime",
1819 "type": "string"
1820 },
1821 "workerHealthReport": {
1822 "$ref": "WorkerHealthReport",
1823 "description": "The health of a worker."
1824 },
1825 "workerMetrics": {
1826 "$ref": "ResourceUtilizationReport",
1827 "description": "Resource metrics reported by workers."
1828 },
1829 "workerMessageCode": {
1830 "$ref": "WorkerMessageCode",
1831 "description": "A worker message code."
1832 },
1833 "labels": {
1834 "additionalProperties": {
1835 "type": "string"
1836 },
1837 "description": "Labels are used to group WorkerMessages.\nFo r example, a worker_message about a particular container\nmight have the labels: \n{ \"JOB_ID\": \"2015-04-22\",\n \"WORKER_ID\": \"wordcount-vm-2015…\"\n \"CO NTAINER_TYPE\": \"worker\",\n \"CONTAINER_ID\": \"ac1234def\"}\nLabel tags typi cally correspond to Label enum values. However, for ease\nof development other s trings can be used as tags. LABEL_UNSPECIFIED should\nnot be used here.",
1838 "type": "object"
1839 }
1840 },
1841 "type": "object"
1842 },
1843 "JobMetrics": {
1844 "description": "JobMetrics contains a collection of metrics descibin g the detailed progress\nof a Dataflow job. Metrics correspond to user-defined a nd system-defined\nmetrics in the job.\n\nThis resource captures only the most r ecent values of each metric;\ntime-series data can be queried for them (under th e same metric names)\nfrom Cloud Monitoring.",
1845 "id": "JobMetrics",
1846 "properties": {
1847 "metrics": {
1848 "description": "All metrics for this job.",
1849 "items": {
1850 "$ref": "MetricUpdate"
1851 },
1852 "type": "array"
1853 },
1854 "metricTime": {
1855 "description": "Timestamp as of which metric values are curr ent.",
1856 "format": "google-datetime",
1857 "type": "string"
1858 }
1859 },
1860 "type": "object"
1861 },
1862 "FloatingPointList": {
1863 "description": "A metric value representing a list of floating point numbers.",
1864 "id": "FloatingPointList",
1865 "properties": {
1866 "elements": {
1867 "description": "Elements of the list.",
1868 "items": {
1869 "format": "double",
1870 "type": "number"
1871 },
1872 "type": "array"
1873 }
1874 },
1875 "type": "object"
1876 },
1877 "CounterUpdate": {
1878 "description": "An update to a Counter sent from a worker.",
1879 "id": "CounterUpdate",
1880 "properties": {
1881 "nameAndKind": {
1882 "$ref": "NameAndKind",
1883 "description": "Counter name and aggregation type."
1884 },
1885 "stringList": {
1886 "$ref": "StringList",
1887 "description": "List of strings, for Set."
1888 },
1889 "distribution": {
1890 "$ref": "DistributionUpdate",
1891 "description": "Distribution data"
1892 },
1893 "shortId": {
1894 "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.",
1895 "format": "int64",
1896 "type": "string"
1897 },
1898 "floatingPointList": {
1899 "$ref": "FloatingPointList",
1900 "description": "List of floating point numbers, for Set."
1901 },
1902 "integer": {
1903 "$ref": "SplitInt64",
1904 "description": "Integer value for Sum, Max, Min."
1905 },
1906 "structuredNameAndMetadata": {
1907 "$ref": "CounterStructuredNameAndMetadata",
1908 "description": "Counter structured name and metadata."
1909 },
1910 "integerList": {
1911 "$ref": "IntegerList",
1912 "description": "List of integers, for Set."
1913 },
1914 "floatingPoint": {
1915 "description": "Floating point value for Sum, Max, Min.",
1916 "format": "double",
1917 "type": "number"
1918 },
1919 "integerMean": {
1920 "$ref": "IntegerMean",
1921 "description": "Integer mean aggregation value for Mean."
1922 },
1923 "internal": {
1924 "description": "Value for internally-defined counters used b y the Dataflow service.",
1925 "type": "any"
1926 },
1927 "cumulative": {
1928 "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.",
1929 "type": "boolean"
1930 },
1931 "floatingPointMean": {
1932 "$ref": "FloatingPointMean",
1933 "description": "Floating point mean aggregation value for Me an."
1934 },
1935 "boolean": {
1936 "description": "Boolean value for And, Or.",
1937 "type": "boolean"
1938 }
1939 },
1940 "type": "object"
1941 },
1942 "SourceMetadata": {
1943 "description": "Metadata about a Source useful for automatically opt imizing\nand tuning the pipeline, etc.",
1944 "id": "SourceMetadata",
1945 "properties": {
1946 "estimatedSizeBytes": {
1947 "description": "An estimate of the total size (in bytes) of the data that would be\nread from this source. This estimate is in terms of ext ernal storage\nsize, before any decompression or other processing done by the re ader.",
1948 "format": "int64",
1949 "type": "string"
1950 },
1951 "infinite": {
1952 "description": "Specifies that the size of this source is kn own to be infinite\n(this is a streaming source).",
1953 "type": "boolean"
1954 },
1955 "producesSortedKeys": {
1956 "description": "Whether this source is known to produce key/ value pairs with\nthe (encoded) keys in lexicographically sorted order.",
1957 "type": "boolean"
1958 }
1959 },
1960 "type": "object"
1961 },
1962 "DistributionUpdate": {
1963 "description": "A metric value representing a distribution.",
1964 "id": "DistributionUpdate",
1965 "properties": {
1966 "max": {
1967 "$ref": "SplitInt64",
1968 "description": "The maximum value present in the distributio n."
1969 },
1970 "logBuckets": {
1971 "description": "(Optional) Logarithmic histogram of values.\ nEach log may be in no more than one bucket. Order does not matter.",
1972 "items": {
1973 "$ref": "LogBucket"
1974 },
1975 "type": "array"
1976 },
1977 "count": {
1978 "$ref": "SplitInt64",
1979 "description": "The count of the number of elements present in the distribution."
1980 },
1981 "min": {
1982 "$ref": "SplitInt64",
1983 "description": "The minimum value present in the distributio n."
1984 },
1985 "sumOfSquares": {
1986 "description": "Use a double since the sum of squares is lik ely to overflow int64.",
1987 "format": "double",
1988 "type": "number"
1989 },
1990 "sum": {
1991 "$ref": "SplitInt64",
1992 "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."
1993 }
1994 },
1995 "type": "object"
1996 },
1997 "SourceFork": {
1998 "description": "DEPRECATED in favor of DynamicSourceSplit.",
1999 "id": "SourceFork",
2000 "properties": {
2001 "residual": {
2002 "$ref": "SourceSplitShard",
2003 "description": "DEPRECATED"
2004 },
2005 "residualSource": {
2006 "$ref": "DerivedSource",
2007 "description": "DEPRECATED"
2008 },
2009 "primary": {
2010 "$ref": "SourceSplitShard",
2011 "description": "DEPRECATED"
2012 },
2013 "primarySource": {
2014 "$ref": "DerivedSource",
2015 "description": "DEPRECATED"
2016 }
2017 },
2018 "type": "object"
2019 },
2020 "WorkerHealthReportResponse": {
2021 "description": "WorkerHealthReportResponse contains information retu rned to the worker\nin response to a health ping.",
2022 "id": "WorkerHealthReportResponse",
2023 "properties": {
2024 "reportInterval": {
2025 "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.",
2026 "format": "google-duration",
2027 "type": "string"
2028 }
2029 },
2030 "type": "object"
2031 },
2032 "WorkItemStatus": {
2033 "description": "Conveys a worker's progress through the work describ ed by a WorkItem.",
2034 "id": "WorkItemStatus",
2035 "properties": {
2036 "sourceFork": {
2037 "$ref": "SourceFork",
2038 "description": "DEPRECATED in favor of dynamic_source_split. "
2039 },
2040 "counterUpdates": {
2041 "description": "Worker output counters for this WorkItem.",
2042 "items": {
2043 "$ref": "CounterUpdate"
2044 },
2045 "type": "array"
2046 },
2047 "workItemId": {
2048 "description": "Identifies the WorkItem.",
2049 "type": "string"
2050 },
2051 "errors": {
2052 "description": "Specifies errors which occurred during proce ssing. If errors are\nprovided, and completed = true, then the WorkItem is cons idered\nto have failed.",
2053 "items": {
2054 "$ref": "Status"
2055 },
2056 "type": "array"
2057 },
2058 "metricUpdates": {
2059 "description": "DEPRECATED in favor of counter_updates.",
2060 "items": {
2061 "$ref": "MetricUpdate"
2062 },
2063 "type": "array"
2064 },
2065 "dynamicSourceSplit": {
2066 "$ref": "DynamicSourceSplit",
2067 "description": "See documentation of stop_position."
2068 },
2069 "sourceOperationResponse": {
2070 "$ref": "SourceOperationResponse",
2071 "description": "If the work item represented a SourceOperati onRequest, and the work\nis completed, contains the result of the operation."
2072 },
2073 "progress": {
2074 "$ref": "ApproximateProgress",
2075 "description": "DEPRECATED in favor of reported_progress."
2076 },
2077 "requestedLeaseDuration": {
2078 "description": "Amount of time the worker requests for its l ease.",
2079 "format": "google-duration",
2080 "type": "string"
2081 },
2082 "reportIndex": {
2083 "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.",
2084 "format": "int64",
2085 "type": "string"
2086 },
2087 "stopPosition": {
2088 "$ref": "Position",
2089 "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."
2090 },
2091 "completed": {
2092 "description": "True if the WorkItem was completed (successf ully or unsuccessfully).",
2093 "type": "boolean"
2094 },
2095 "reportedProgress": {
2096 "$ref": "ApproximateReportedProgress",
2097 "description": "The worker's progress through this WorkItem. "
2098 }
2099 },
2100 "type": "object"
2101 },
2102 "ComponentSource": {
2103 "description": "Description of an interstitial value between transfo rms in an execution\nstage.",
2104 "id": "ComponentSource",
2105 "properties": {
2106 "name": { 1983 "name": {
2107 "description": "Dataflow service generated name for this sou rce.", 1984 "description": "Dataflow service generated name for this sou rce.",
2108 "type": "string" 1985 "type": "string"
2109 }, 1986 },
2110 "userName": { 1987 "userName": {
2111 "description": "Human-readable name for this transform; may be user or system generated.", 1988 "description": "Human-readable name for this transform; may be user or system generated.",
2112 "type": "string" 1989 "type": "string"
2113 },
2114 "originalTransformOrCollection": {
2115 "description": "User name for the original user transform or collection with which this\nsource is most closely associated.",
2116 "type": "string"
2117 } 1990 }
2118 }, 1991 },
2119 "type": "object" 1992 "type": "object"
2120 }, 1993 },
2121 "WorkItemServiceState": { 1994 "StreamingSetupTask": {
2122 "description": "The Dataflow service's idea of the current state of a WorkItem\nbeing processed by a worker.", 1995 "description": "A task which initializes part of a streaming Dataflo w job.",
2123 "id": "WorkItemServiceState", 1996 "id": "StreamingSetupTask",
2124 "properties": { 1997 "properties": {
2125 "suggestedStopPoint": { 1998 "streamingComputationTopology": {
2126 "$ref": "ApproximateProgress", 1999 "$ref": "TopologyConfig",
2127 "description": "DEPRECATED in favor of split_request." 2000 "description": "The global topology of the streaming Dataflo w job."
2128 }, 2001 },
2129 "splitRequest": { 2002 "drain": {
2130 "$ref": "ApproximateSplitRequest", 2003 "description": "The user has requested drain.",
2131 "description": "The progress point in the WorkItem where the Dataflow service\nsuggests that the worker truncate the task." 2004 "type": "boolean"
2132 }, 2005 },
2133 "suggestedStopPosition": { 2006 "workerHarnessPort": {
2134 "$ref": "Position", 2007 "description": "The TCP port used by the worker to communica te with the Dataflow\nworker harness.",
2135 "description": "Obsolete, always empty." 2008 "format": "int32",
2009 "type": "integer"
2136 }, 2010 },
2137 "reportStatusInterval": { 2011 "receiveWorkPort": {
2138 "description": "New recommended reporting interval.", 2012 "description": "The TCP port on which the worker should list en for messages from\nother streaming computation workers.",
2139 "format": "google-duration", 2013 "format": "int32",
2014 "type": "integer"
2015 }
2016 },
2017 "type": "object"
2018 },
2019 "PubsubLocation": {
2020 "description": "Identifies a pubsub location to use for transferring data into or\nout of a streaming Dataflow job.",
2021 "id": "PubsubLocation",
2022 "properties": {
2023 "topic": {
2024 "description": "A pubsub topic, in the form of\n\"pubsub.goo gleapis.com/topics/<project-id>/<topic-name>\"",
2140 "type": "string" 2025 "type": "string"
2141 }, 2026 },
2142 "harnessData": { 2027 "timestampLabel": {
2143 "additionalProperties": { 2028 "description": "If set, contains a pubsub label from which t o extract record timestamps.\nIf left empty, record timestamps will be generated upon arrival.",
2144 "description": "Properties of the object.",
2145 "type": "any"
2146 },
2147 "description": "Other data returned by the service, specific to the particular\nworker harness.",
2148 "type": "object"
2149 },
2150 "leaseExpireTime": {
2151 "description": "Time at which the current lease will expire. ",
2152 "format": "google-datetime",
2153 "type": "string" 2029 "type": "string"
2154 }, 2030 },
2155 "metricShortId": { 2031 "subscription": {
2156 "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.", 2032 "description": "A pubsub subscription, in the form of\n\"pub sub.googleapis.com/subscriptions/<project-id>/<subscription-name>\"",
2157 "items": { 2033 "type": "string"
2158 "$ref": "MetricShortId"
2159 },
2160 "type": "array"
2161 }, 2034 },
2162 "nextReportIndex": { 2035 "dropLateData": {
2163 "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.", 2036 "description": "Indicates whether the pipeline allows late-a rriving data.",
2164 "format": "int64", 2037 "type": "boolean"
2038 },
2039 "trackingSubscription": {
2040 "description": "If set, specifies the pubsub subscription th at will be used for tracking\ncustom time timestamps for watermark estimation.",
2041 "type": "string"
2042 },
2043 "withAttributes": {
2044 "description": "If true, then the client has requested to ge t pubsub attributes.",
2045 "type": "boolean"
2046 },
2047 "idLabel": {
2048 "description": "If set, contains a pubsub label from which t o extract record ids.\nIf left empty, record deduplication will be strictly best effort.",
2165 "type": "string" 2049 "type": "string"
2166 } 2050 }
2167 }, 2051 },
2168 "type": "object" 2052 "type": "object"
2169 }, 2053 },
2170 "MetricStructuredName": { 2054 "WorkerHealthReport": {
2171 "description": "Identifies a metric, by describing the source which generated the\nmetric.", 2055 "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.",
2172 "id": "MetricStructuredName", 2056 "id": "WorkerHealthReport",
2173 "properties": { 2057 "properties": {
2174 "context": { 2058 "pods": {
2175 "additionalProperties": { 2059 "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.",
2176 "type": "string" 2060 "items": {
2061 "additionalProperties": {
2062 "description": "Properties of the object.",
2063 "type": "any"
2064 },
2065 "type": "object"
2177 }, 2066 },
2178 "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>.", 2067 "type": "array"
2179 "type": "object"
2180 }, 2068 },
2181 "name": { 2069 "vmStartupTime": {
2182 "description": "Worker-defined metric name.", 2070 "description": "The time the VM was booted.",
2071 "format": "google-datetime",
2183 "type": "string" 2072 "type": "string"
2184 }, 2073 },
2185 "origin": { 2074 "reportInterval": {
2186 "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.", 2075 "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.",
2076 "format": "google-duration",
2077 "type": "string"
2078 },
2079 "vmIsHealthy": {
2080 "description": "Whether the VM is healthy.",
2081 "type": "boolean"
2082 }
2083 },
2084 "type": "object"
2085 },
2086 "JobMessage": {
2087 "description": "A particular message pertaining to a Dataflow job.",
2088 "id": "JobMessage",
2089 "properties": {
2090 "messageImportance": {
2091 "description": "Importance level of the message.",
2092 "enum": [
2093 "JOB_MESSAGE_IMPORTANCE_UNKNOWN",
2094 "JOB_MESSAGE_DEBUG",
2095 "JOB_MESSAGE_DETAILED",
2096 "JOB_MESSAGE_BASIC",
2097 "JOB_MESSAGE_WARNING",
2098 "JOB_MESSAGE_ERROR"
2099 ],
2100 "enumDescriptions": [
2101 "The message importance isn't specified, or is unknown." ,
2102 "The message is at the 'debug' level: typically only use ful for\nsoftware engineers working on the code the job is running.\nTypically, Dataflow pipeline runners do not display log messages\nat this level by default. ",
2103 "The message is at the 'detailed' level: somewhat verbos e, but\npotentially useful to users. Typically, Dataflow pipeline\nrunners do n ot display log messages at this level by default.\nThese messages are displayed by default in the Dataflow\nmonitoring UI.",
2104 "The message is at the 'basic' level: useful for keeping \ntrack of the execution of a Dataflow pipeline. Typically,\nDataflow pipeline runners display log messages at this level by\ndefault, and these messages are d isplayed by default in the\nDataflow monitoring UI.",
2105 "The message is at the 'warning' level: indicating a con dition\npertaining to a job which may require human intervention.\nTypically, Da taflow pipeline runners display log messages at this\nlevel by default, and thes e messages are displayed by default in\nthe Dataflow monitoring UI.",
2106 "The message is at the 'error' level: indicating a condi tion\npreventing a job from succeeding. Typically, Dataflow pipeline\nrunners d isplay log messages at this level by default, and these\nmessages are displayed by default in the Dataflow monitoring UI."
2107 ],
2108 "type": "string"
2109 },
2110 "messageText": {
2111 "description": "The text of the message.",
2112 "type": "string"
2113 },
2114 "time": {
2115 "description": "The timestamp of the message.",
2116 "format": "google-datetime",
2117 "type": "string"
2118 },
2119 "id": {
2120 "description": "Deprecated.",
2187 "type": "string" 2121 "type": "string"
2188 } 2122 }
2189 }, 2123 },
2190 "type": "object" 2124 "type": "object"
2191 }, 2125 },
2192 "SeqMapTaskOutputInfo": { 2126 "ParameterMetadata": {
2193 "description": "Information about an output of a SeqMapTask.", 2127 "description": "Metadata for a specific parameter.",
2194 "id": "SeqMapTaskOutputInfo", 2128 "id": "ParameterMetadata",
2195 "properties": { 2129 "properties": {
2196 "tag": { 2130 "label": {
2197 "description": "The id of the TupleTag the user code will ta g the output value by.", 2131 "description": "Required. The label to display for the param eter.",
2198 "type": "string" 2132 "type": "string"
2199 }, 2133 },
2200 "sink": { 2134 "helpText": {
2201 "$ref": "Sink", 2135 "description": "Required. The help text to display for the p arameter.",
2202 "description": "The sink to write the output value to." 2136 "type": "string"
2203 } 2137 },
2204 }, 2138 "isOptional": {
2205 "type": "object" 2139 "description": "Optional. Whether the parameter is optional. Defaults to false.",
2206 }, 2140 "type": "boolean"
2207 "JobExecutionStageInfo": { 2141 },
2208 "description": "Contains information about how a particular\ngoogle. dataflow.v1beta3.Step will be executed.", 2142 "name": {
2209 "id": "JobExecutionStageInfo", 2143 "description": "Required. The name of the parameter.",
2210 "properties": { 2144 "type": "string"
2211 "stepName": { 2145 },
2212 "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.", 2146 "regexes": {
2147 "description": "Optional. Regexes that the parameter must ma tch.",
2213 "items": { 2148 "items": {
2214 "type": "string" 2149 "type": "string"
2215 }, 2150 },
2216 "type": "array" 2151 "type": "array"
2217 } 2152 }
2218 }, 2153 },
2219 "type": "object" 2154 "type": "object"
2220 }, 2155 },
2221 "KeyRangeLocation": { 2156 "MultiOutputInfo": {
2222 "description": "Location information for a specific key-range of a s harded computation.\nCurrently we only support UTF-8 character splits to simplif y encoding into\nJSON.", 2157 "description": "Information about an output of a multi-output DoFn." ,
2223 "id": "KeyRangeLocation", 2158 "id": "MultiOutputInfo",
2224 "properties": { 2159 "properties": {
2225 "deprecatedPersistentDirectory": { 2160 "tag": {
2226 "description": "DEPRECATED. The location of the persistent s tate for this range, as a\npersistent directory in the worker local filesystem." , 2161 "description": "The id of the tag the user code will emit to this output by; this\nshould correspond to the tag of some SideInputInfo.",
2227 "type": "string" 2162 "type": "string"
2228 }, 2163 }
2229 "deliveryEndpoint": { 2164 },
2230 "description": "The physical location of this range assignme nt to be used for\nstreaming computation cross-worker message delivery.", 2165 "type": "object"
2231 "type": "string" 2166 },
2232 }, 2167 "SourceSplitRequest": {
2233 "dataDisk": { 2168 "description": "Represents the operation to split a high-level Sourc e specification\ninto bundles (parts for parallel processing).\n\nAt a high leve l, splitting of a source into bundles happens as follows:\nSourceSplitRequest is applied to the source. If it returns\nSOURCE_SPLIT_OUTCOME_USE_CURRENT, no furt her splitting happens and the source\nis used \"as is\". Otherwise, splitting is applied recursively to each\nproduced DerivedSource.\n\nAs an optimization, for any Source, if its does_not_need_splitting is\ntrue, the framework assumes that splitting this source would return\nSOURCE_SPLIT_OUTCOME_USE_CURRENT, and doesn 't initiate a SourceSplitRequest.\nThis applies both to the initial source being split and to bundles\nproduced from it.",
2234 "description": "The name of the data disk where data for thi s range is stored.\nThis name is local 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\".", 2169 "id": "SourceSplitRequest",
2235 "type": "string" 2170 "properties": {
2236 }, 2171 "options": {
2237 "start": { 2172 "$ref": "SourceSplitOptions",
2238 "description": "The start (inclusive) of the key range.", 2173 "description": "Hints for tuning the splitting process."
2239 "type": "string" 2174 },
2240 },
2241 "end": {
2242 "description": "The end (exclusive) of the key range.",
2243 "type": "string"
2244 }
2245 },
2246 "type": "object"
2247 },
2248 "SourceGetMetadataRequest": {
2249 "description": "A request to compute the SourceMetadata of a Source. ",
2250 "id": "SourceGetMetadataRequest",
2251 "properties": {
2252 "source": { 2175 "source": {
2253 "$ref": "Source", 2176 "$ref": "Source",
2254 "description": "Specification of the source whose metadata s hould be computed." 2177 "description": "Specification of the source to be split."
2255 } 2178 }
2256 }, 2179 },
2257 "type": "object" 2180 "type": "object"
2258 }, 2181 },
2259 "NameAndKind": { 2182 "SourceGetMetadataResponse": {
2260 "description": "Basic metadata about a counter.", 2183 "description": "The result of a SourceGetMetadataOperation.",
2261 "id": "NameAndKind", 2184 "id": "SourceGetMetadataResponse",
2262 "properties": { 2185 "properties": {
2263 "name": { 2186 "metadata": {
2264 "description": "Name of the counter.", 2187 "$ref": "SourceMetadata",
2265 "type": "string" 2188 "description": "The computed metadata."
2266 }, 2189 }
2267 "kind": { 2190 },
2268 "description": "Counter aggregation kind.", 2191 "type": "object"
2192 },
2193 "AutoscalingEvent": {
2194 "description": "A structured message reporting an autoscaling decisi on made by the Dataflow\nservice.",
2195 "id": "AutoscalingEvent",
2196 "properties": {
2197 "eventType": {
2198 "description": "The type of autoscaling event to report.",
2269 "enum": [ 2199 "enum": [
2270 "INVALID", 2200 "TYPE_UNKNOWN",
2271 "SUM", 2201 "TARGET_NUM_WORKERS_CHANGED",
2272 "MAX", 2202 "CURRENT_NUM_WORKERS_CHANGED",
2273 "MIN", 2203 "ACTUATION_FAILURE",
2274 "MEAN", 2204 "NO_CHANGE"
2275 "OR",
2276 "AND",
2277 "SET",
2278 "DISTRIBUTION"
2279 ], 2205 ],
2280 "enumDescriptions": [ 2206 "enumDescriptions": [
2281 "Counter aggregation kind was not set.", 2207 "Default type for the enum. Value should never be retur ned.",
2282 "Aggregated value is the sum of all contributed values." , 2208 "The TARGET_NUM_WORKERS_CHANGED type should be used when the target\nworker pool size has changed at the start of an actuation. An event \nshould always be specified as TARGET_NUM_WORKERS_CHANGED if it reflects\na cha nge in the target_num_workers.",
2283 "Aggregated value is the max of all contributed values." , 2209 "The CURRENT_NUM_WORKERS_CHANGED type should be used whe n actual worker\npool size has been changed, but the target_num_workers has not changed.",
2284 "Aggregated value is the min of all contributed values." , 2210 "The ACTUATION_FAILURE type should be used when we want to report\nan error to the user indicating why the current number of workers\nin the pool could not be changed.\nDisplayed in the current status and history wid gets.",
2285 "Aggregated value is the mean of all contributed values. ", 2211 "Used when we want to report to the user a reason why we are\nnot currently adjusting the number of workers.\nShould specify both target _num_workers, current_num_workers and a\ndecision_message."
2286 "Aggregated value represents the logical 'or' of all con tributed values.", 2212 ],
2287 "Aggregated value represents the logical 'and' of all co ntributed values.", 2213 "type": "string"
2288 "Aggregated value is a set of unique contributed values. ", 2214 },
2289 "Aggregated value captures statistics about a distributi on." 2215 "targetNumWorkers": {
2290 ], 2216 "description": "The target number of workers the worker pool wants to resize to use.",
2291 "type": "string" 2217 "format": "int64",
2292 } 2218 "type": "string"
2293 }, 2219 },
2294 "type": "object" 2220 "currentNumWorkers": {
2295 }, 2221 "description": "The current number of workers the job has.",
2296 "SeqMapTask": { 2222 "format": "int64",
2297 "description": "Describes a particular function to invoke.", 2223 "type": "string"
2298 "id": "SeqMapTask", 2224 },
2299 "properties": { 2225 "time": {
2300 "userFn": { 2226 "description": "The time this event was emitted to indicate a new target or current\nnum_workers value.",
2301 "additionalProperties": { 2227 "format": "google-datetime",
2302 "description": "Properties of the object.", 2228 "type": "string"
2303 "type": "any" 2229 },
2304 }, 2230 "description": {
2305 "description": "The user function to invoke.", 2231 "$ref": "StructuredMessage",
2306 "type": "object" 2232 "description": "A message describing why the system decided to adjust the current\nnumber of workers, why it failed, or why the system decid ed to\nnot make any changes to the number of workers."
2307 }, 2233 }
2308 "name": { 2234 },
2309 "description": "The user-provided name of the SeqDo operatio n.", 2235 "type": "object"
2310 "type": "string" 2236 },
2311 }, 2237 "MetricShortId": {
2312 "outputInfos": { 2238 "description": "The metric short id is returned to the user alongsid e an offset into\nReportWorkItemStatusRequest",
2313 "description": "Information about each of the outputs.", 2239 "id": "MetricShortId",
2314 "items": { 2240 "properties": {
2315 "$ref": "SeqMapTaskOutputInfo" 2241 "metricIndex": {
2316 }, 2242 "description": "The index of the corresponding metric in\nth e ReportWorkItemStatusRequest. Required.",
2317 "type": "array" 2243 "format": "int32",
2318 }, 2244 "type": "integer"
2319 "inputs": { 2245 },
2320 "description": "Information about each of the inputs.", 2246 "shortId": {
2321 "items": { 2247 "description": "The service-generated short identifier for t he metric.",
2322 "$ref": "SideInputInfo" 2248 "format": "int64",
2323 }, 2249 "type": "string"
2324 "type": "array" 2250 }
2325 }, 2251 },
2326 "stageName": { 2252 "type": "object"
2327 "description": "System-defined name of the stage containing the SeqDo operation.\nUnique across the workflow.", 2253 },
2328 "type": "string" 2254 "ShellTask": {
2329 }, 2255 "description": "A task which consists of a shell command for the wor ker to execute.",
2330 "systemName": { 2256 "id": "ShellTask",
2331 "description": "System-defined name of the SeqDo operation.\ nUnique across the workflow.", 2257 "properties": {
2332 "type": "string" 2258 "command": {
2333 } 2259 "description": "The shell command to run.",
2334 }, 2260 "type": "string"
2335 "type": "object" 2261 },
2336 }, 2262 "exitCode": {
2337 "WorkerMessageCode": { 2263 "description": "Exit code for the task.",
2338 "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).", 2264 "format": "int32",
2339 "id": "WorkerMessageCode", 2265 "type": "integer"
2340 "properties": { 2266 }
2341 "code": { 2267 },
2342 "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.", 2268 "type": "object"
2343 "type": "string" 2269 },
2344 }, 2270 "TaskRunnerSettings": {
2345 "parameters": { 2271 "description": "Taskrunner configuration settings.",
2346 "additionalProperties": { 2272 "id": "TaskRunnerSettings",
2347 "description": "Properties of the object.", 2273 "properties": {
2348 "type": "any" 2274 "harnessCommand": {
2349 }, 2275 "description": "The command to launch the worker harness.",
2350 "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.", 2276 "type": "string"
2351 "type": "object" 2277 },
2352 } 2278 "logDir": {
2353 }, 2279 "description": "The directory on the VM to store logs.",
2354 "type": "object" 2280 "type": "string"
2355 }, 2281 },
2356 "CustomSourceLocation": { 2282 "oauthScopes": {
2357 "description": "Identifies the location of a custom souce.", 2283 "description": "The OAuth2 scopes to be requested by the tas krunner in order to\naccess the Cloud Dataflow API.",
2358 "id": "CustomSourceLocation", 2284 "items": {
2359 "properties": { 2285 "type": "string"
2360 "stateful": { 2286 },
2361 "description": "Whether this source is stateful.", 2287 "type": "array"
2288 },
2289 "dataflowApiVersion": {
2290 "description": "The API version of endpoint, e.g. \"v1b3\"",
2291 "type": "string"
2292 },
2293 "logUploadLocation": {
2294 "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}",
2295 "type": "string"
2296 },
2297 "streamingWorkerMainClass": {
2298 "description": "The streaming worker main class name.",
2299 "type": "string"
2300 },
2301 "workflowFileName": {
2302 "description": "The file to store the workflow in.",
2303 "type": "string"
2304 },
2305 "languageHint": {
2306 "description": "The suggested backend language.",
2307 "type": "string"
2308 },
2309 "commandlinesFileName": {
2310 "description": "The file to store preprocessing commands in. ",
2311 "type": "string"
2312 },
2313 "baseTaskDir": {
2314 "description": "The location on the worker for task-specific subdirectories.",
2315 "type": "string"
2316 },
2317 "tempStoragePrefix": {
2318 "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}",
2319 "type": "string"
2320 },
2321 "baseUrl": {
2322 "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/\"",
2323 "type": "string"
2324 },
2325 "logToSerialconsole": {
2326 "description": "Whether to send taskrunner log info to Googl e Compute Engine VM serial\nconsole.",
2362 "type": "boolean" 2327 "type": "boolean"
2363 } 2328 },
2364 }, 2329 "continueOnException": {
2365 "type": "object" 2330 "description": "Whether to continue taskrunner if an excepti on is hit.",
2366 }, 2331 "type": "boolean"
2367 "MapTask": { 2332 },
2368 "description": "MapTask consists of an ordered set of instructions, each of which\ndescribes one particular low-level operation for the worker to\np erform in order to accomplish the MapTask's WorkItem.\n\nEach instruction must a ppear in the list before any instructions which\ndepends on its output.", 2333 "parallelWorkerSettings": {
2369 "id": "MapTask", 2334 "$ref": "WorkerSettings",
2370 "properties": { 2335 "description": "The settings to pass to the parallel worker harness."
2371 "stageName": { 2336 },
2372 "description": "System-defined name of the stage containing this MapTask.\nUnique across the workflow.", 2337 "taskUser": {
2373 "type": "string" 2338 "description": "The UNIX user ID on the worker VM to use for tasks launched by\ntaskrunner; e.g. \"root\".",
2374 }, 2339 "type": "string"
2375 "systemName": { 2340 },
2376 "description": "System-defined name of this MapTask.\nUnique across the workflow.", 2341 "vmId": {
2377 "type": "string" 2342 "description": "The ID string of the VM.",
2378 }, 2343 "type": "string"
2379 "instructions": { 2344 },
2380 "description": "The instructions in the MapTask.", 2345 "alsologtostderr": {
2381 "items": { 2346 "description": "Whether to also send taskrunner log info to stderr.",
2382 "$ref": "ParallelInstruction" 2347 "type": "boolean"
2383 }, 2348 },
2384 "type": "array" 2349 "taskGroup": {
2385 } 2350 "description": "The UNIX group ID on the worker VM to use fo r tasks launched by\ntaskrunner; e.g. \"wheel\".",
2386 }, 2351 "type": "string"
2387 "type": "object" 2352 }
2388 }, 2353 },
2389 "FloatingPointMean": { 2354 "type": "object"
2390 "description": "A representation of a floating point mean metric con tribution.", 2355 },
2391 "id": "FloatingPointMean", 2356 "Position": {
2392 "properties": { 2357 "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.",
2393 "count": { 2358 "id": "Position",
2394 "$ref": "SplitInt64", 2359 "properties": {
2395 "description": "The number of values being aggregated." 2360 "recordIndex": {
2396 }, 2361 "description": "Position is a record index.",
2397 "sum": { 2362 "format": "int64",
2398 "description": "The sum of all values being aggregated.", 2363 "type": "string"
2399 "format": "double", 2364 },
2400 "type": "number" 2365 "shufflePosition": {
2401 } 2366 "description": "CloudPosition is a base64 encoded BatchShuff lePosition (with FIXED\nsharding).",
2402 }, 2367 "type": "string"
2403 "type": "object" 2368 },
2404 }, 2369 "concatPosition": {
2405 "ReportWorkItemStatusResponse": { 2370 "$ref": "ConcatPosition",
2406 "description": "Response from a request to report the status of Work Items.", 2371 "description": "CloudPosition is a concat position."
2407 "id": "ReportWorkItemStatusResponse", 2372 },
2408 "properties": { 2373 "byteOffset": {
2409 "workItemServiceStates": { 2374 "description": "Position is a byte offset.",
2410 "description": "A set of messages indicating the service-sid e state for each\nWorkItem whose status was reported, in the same order as the\n WorkItemStatus messages in the ReportWorkItemStatusRequest which\nresulting in t his response.", 2375 "format": "int64",
2411 "items": { 2376 "type": "string"
2412 "$ref": "WorkItemServiceState" 2377 },
2413 }, 2378 "end": {
2414 "type": "array" 2379 "description": "Position is past all other positions. Also u seful for the end\nposition of an unbounded range.",
2415 } 2380 "type": "boolean"
2416 }, 2381 },
2417 "type": "object" 2382 "key": {
2418 }, 2383 "description": "Position is a string key, ordered lexicograp hically.",
2419 "InstructionOutput": { 2384 "type": "string"
2420 "description": "An output of an instruction.", 2385 }
2421 "id": "InstructionOutput", 2386 },
2422 "properties": { 2387 "type": "object"
2423 "onlyCountValueBytes": { 2388 },
2424 "description": "For system-generated byte and mean byte metr ics, certain instructions\nshould only report the value size.", 2389 "SplitInt64": {
2390 "description": "A representation of an int64, n, that is immune to p recision loss when\nencoded in JSON.",
2391 "id": "SplitInt64",
2392 "properties": {
2393 "lowBits": {
2394 "description": "The low order bits: n & 0xffffffff.",
2395 "format": "uint32",
2396 "type": "integer"
2397 },
2398 "highBits": {
2399 "description": "The high order bits, including the sign: n > > 32.",
2400 "format": "int32",
2401 "type": "integer"
2402 }
2403 },
2404 "type": "object"
2405 },
2406 "Source": {
2407 "description": "A source that records can be read and decoded from." ,
2408 "id": "Source",
2409 "properties": {
2410 "doesNotNeedSplitting": {
2411 "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.",
2425 "type": "boolean" 2412 "type": "boolean"
2426 }, 2413 },
2427 "codec": { 2414 "codec": {
2428 "additionalProperties": { 2415 "additionalProperties": {
2429 "description": "Properties of the object.", 2416 "description": "Properties of the object.",
2430 "type": "any" 2417 "type": "any"
2431 }, 2418 },
2432 "description": "The codec to use to encode data being writte n via this output.", 2419 "description": "The codec to use to decode data read from th e source.",
2433 "type": "object" 2420 "type": "object"
2434 }, 2421 },
2435 "name": { 2422 "spec": {
2436 "description": "The user-provided name of this output.", 2423 "additionalProperties": {
2437 "type": "string" 2424 "description": "Properties of the object.",
2438 }, 2425 "type": "any"
2439 "originalName": { 2426 },
2440 "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.", 2427 "description": "The source to read from, plus its parameters .",
2441 "type": "string" 2428 "type": "object"
2442 }, 2429 },
2443 "systemName": { 2430 "metadata": {
2444 "description": "System-defined name of this output.\nUnique across the workflow.", 2431 "$ref": "SourceMetadata",
2445 "type": "string" 2432 "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."
2446 }, 2433 },
2447 "onlyCountKeyBytes": { 2434 "baseSpecs": {
2448 "description": "For system-generated byte and mean byte metr ics, certain instructions\nshould only report the key size.", 2435 "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).",
2449 "type": "boolean" 2436 "items": {
2450 } 2437 "additionalProperties": {
2451 }, 2438 "description": "Properties of the object.",
2452 "type": "object" 2439 "type": "any"
2453 }, 2440 },
2454 "CreateJobFromTemplateRequest": { 2441 "type": "object"
2455 "description": "A request to create a Cloud Dataflow job from a temp late.", 2442 },
2456 "id": "CreateJobFromTemplateRequest", 2443 "type": "array"
2457 "properties": { 2444 }
2458 "jobName": { 2445 },
2459 "description": "Required. The job name to use for the create d job.", 2446 "type": "object"
2460 "type": "string" 2447 },
2461 }, 2448 "WorkerPool": {
2462 "gcsPath": { 2449 "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.",
2463 "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://`.", 2450 "id": "WorkerPool",
2464 "type": "string" 2451 "properties": {
2465 }, 2452 "dataDisks": {
2466 "environment": { 2453 "description": "Data disks that are used by a VM in this wor kflow.",
2467 "$ref": "RuntimeEnvironment", 2454 "items": {
2468 "description": "The runtime environment for the job." 2455 "$ref": "Disk"
2469 }, 2456 },
2470 "location": { 2457 "type": "array"
2471 "description": "The location to which to direct the request. ", 2458 },
2472 "type": "string" 2459 "subnetwork": {
2473 }, 2460 "description": "Subnetwork to which VMs will be assigned, if desired. Expected to be of\nthe form \"regions/REGION/subnetworks/SUBNETWORK\" .",
2474 "parameters": { 2461 "type": "string"
2462 },
2463 "ipConfiguration": {
2464 "description": "Configuration for VM IPs.",
2465 "enum": [
2466 "WORKER_IP_UNSPECIFIED",
2467 "WORKER_IP_PUBLIC",
2468 "WORKER_IP_PRIVATE"
2469 ],
2470 "enumDescriptions": [
2471 "The configuration is unknown, or unspecified.",
2472 "Workers should have public IP addresses.",
2473 "Workers should have private IP addresses."
2474 ],
2475 "type": "string"
2476 },
2477 "autoscalingSettings": {
2478 "$ref": "AutoscalingSettings",
2479 "description": "Settings for autoscaling of this WorkerPool. "
2480 },
2481 "taskrunnerSettings": {
2482 "$ref": "TaskRunnerSettings",
2483 "description": "Settings passed through to Google Compute En gine workers when\nusing the standard Dataflow task runner. Users should ignore \nthis field."
2484 },
2485 "metadata": {
2475 "additionalProperties": { 2486 "additionalProperties": {
2476 "type": "string" 2487 "type": "string"
2477 }, 2488 },
2478 "description": "The runtime parameters to pass to the job.", 2489 "description": "Metadata to set on the Google Compute Engine VMs.",
2479 "type": "object" 2490 "type": "object"
2480 } 2491 },
2481 }, 2492 "network": {
2482 "type": "object" 2493 "description": "Network to which VMs will be assigned. If e mpty or unspecified,\nthe service will use the network \"default\".",
2483 }, 2494 "type": "string"
2484 "IntegerMean": { 2495 },
2485 "description": "A representation of an integer mean metric contribut ion.", 2496 "defaultPackageSet": {
2486 "id": "IntegerMean", 2497 "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.",
2487 "properties": { 2498 "enum": [
2488 "count": { 2499 "DEFAULT_PACKAGE_SET_UNKNOWN",
2489 "$ref": "SplitInt64", 2500 "DEFAULT_PACKAGE_SET_NONE",
2490 "description": "The number of values being aggregated." 2501 "DEFAULT_PACKAGE_SET_JAVA",
2491 }, 2502 "DEFAULT_PACKAGE_SET_PYTHON"
2492 "sum": { 2503 ],
2493 "$ref": "SplitInt64", 2504 "enumDescriptions": [
2494 "description": "The sum of all values being aggregated." 2505 "The default set of packages to stage is unknown, or uns pecified.",
2495 } 2506 "Indicates that no packages should be staged at the work er unless\nexplicitly specified by the job.",
2496 }, 2507 "Stage packages typically useful to workers written in J ava.",
2497 "type": "object" 2508 "Stage pacakges typically useful to workers written in P ython."
2498 }, 2509 ],
2499 "ListJobsResponse": { 2510 "type": "string"
2500 "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.", 2511 },
2501 "id": "ListJobsResponse", 2512 "numThreadsPerWorker": {
2502 "properties": { 2513 "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).",
2503 "failedLocation": { 2514 "format": "int32",
2504 "description": "Zero or more messages describing locations t hat failed to respond.", 2515 "type": "integer"
2505 "items": { 2516 },
2506 "$ref": "FailedLocation" 2517 "numWorkers": {
2507 }, 2518 "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.",
2508 "type": "array" 2519 "format": "int32",
2509 }, 2520 "type": "integer"
2510 "nextPageToken": { 2521 },
2511 "description": "Set if there may be more results than fit in this response.", 2522 "zone": {
2512 "type": "string" 2523 "description": "Zone to run the worker pools in. If empty o r unspecified, the service\nwill attempt to choose a reasonable default.",
2513 }, 2524 "type": "string"
2514 "jobs": { 2525 },
2515 "description": "A subset of the requested job information.", 2526 "diskSourceImage": {
2516 "items": { 2527 "description": "Fully qualified source image for disks.",
2517 "$ref": "Job" 2528 "type": "string"
2518 }, 2529 },
2519 "type": "array" 2530 "packages": {
2520 } 2531 "description": "Packages to be installed on workers.",
2521 }, 2532 "items": {
2522 "type": "object" 2533 "$ref": "Package"
2523 }, 2534 },
2524 "ComputationTopology": { 2535 "type": "array"
2525 "description": "All configuration data for a particular Computation. ", 2536 },
2526 "id": "ComputationTopology", 2537 "teardownPolicy": {
2527 "properties": { 2538 "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.",
2528 "outputs": { 2539 "enum": [
2529 "description": "The outputs from the computation.", 2540 "TEARDOWN_POLICY_UNKNOWN",
2530 "items": { 2541 "TEARDOWN_ALWAYS",
2531 "$ref": "StreamLocation" 2542 "TEARDOWN_ON_SUCCESS",
2532 }, 2543 "TEARDOWN_NEVER"
2533 "type": "array" 2544 ],
2534 }, 2545 "enumDescriptions": [
2535 "stateFamilies": { 2546 "The teardown policy isn't specified, or is unknown.",
2536 "description": "The state family values.", 2547 "Always teardown the resource.",
2537 "items": { 2548 "Teardown the resource on success. This is useful for de bugging\nfailures.",
2538 "$ref": "StateFamilyConfig" 2549 "Never teardown the resource. This is useful for debuggi ng and\ndevelopment."
2539 }, 2550 ],
2540 "type": "array" 2551 "type": "string"
2541 }, 2552 },
2542 "systemStageName": { 2553 "onHostMaintenance": {
2543 "description": "The system stage name.", 2554 "description": "The action to take on host maintenance, as d efined by the Google\nCompute Engine API.",
2544 "type": "string" 2555 "type": "string"
2545 }, 2556 },
2546 "computationId": { 2557 "poolArgs": {
2547 "description": "The ID of the computation.", 2558 "additionalProperties": {
2548 "type": "string" 2559 "description": "Properties of the object. Contains field @type with type URL.",
2549 }, 2560 "type": "any"
2550 "inputs": { 2561 },
2551 "description": "The inputs to the computation.", 2562 "description": "Extra arguments for this worker pool.",
2552 "items": { 2563 "type": "object"
2553 "$ref": "StreamLocation" 2564 },
2554 }, 2565 "diskSizeGb": {
2555 "type": "array" 2566 "description": "Size of root disk for VMs, in GB. If zero o r unspecified, the service will\nattempt to choose a reasonable default.",
2556 }, 2567 "format": "int32",
2557 "keyRanges": { 2568 "type": "integer"
2558 "description": "The key ranges processed by the computation. ", 2569 },
2559 "items": { 2570 "workerHarnessContainerImage": {
2560 "$ref": "KeyRangeLocation" 2571 "description": "Required. Docker container image that execut es the Cloud Dataflow worker\nharness, residing in Google Container Registry.",
2561 }, 2572 "type": "string"
2562 "type": "array" 2573 },
2563 }
2564 },
2565 "type": "object"
2566 },
2567 "RuntimeEnvironment": {
2568 "description": "The environment values to set at runtime.",
2569 "id": "RuntimeEnvironment",
2570 "properties": {
2571 "machineType": { 2574 "machineType": {
2572 "description": "The machine type to use for the job. Default s to the value from the\ntemplate if not specified.", 2575 "description": "Machine type (e.g. \"n1-standard-1\"). If e mpty or unspecified, the\nservice will attempt to choose a reasonable default.",
2573 "type": "string" 2576 "type": "string"
2574 }, 2577 },
2575 "zone": { 2578 "diskType": {
2576 "description": "The Compute Engine [availability\nzone](http s://cloud.google.com/compute/docs/regions-zones/regions-zones)\nfor launching wo rker instances to run your pipeline.", 2579 "description": "Type of root disk for VMs. If empty or unsp ecified, the service will\nattempt to choose a reasonable default.",
2577 "type": "string" 2580 "type": "string"
2578 }, 2581 },
2579 "maxWorkers": { 2582 "kind": {
2580 "description": "The maximum number of Google Compute Engine instances to be made\navailable to your pipeline during execution, from 1 to 100 0.", 2583 "description": "The kind of the worker pool; currently only `harness` and `shuffle`\nare supported.",
2584 "type": "string"
2585 }
2586 },
2587 "type": "object"
2588 },
2589 "SourceOperationRequest": {
2590 "description": "A work item that represents the different operations that can be\nperformed on a user-defined Source specification.",
2591 "id": "SourceOperationRequest",
2592 "properties": {
2593 "getMetadata": {
2594 "$ref": "SourceGetMetadataRequest",
2595 "description": "Information about a request to get metadata about a source."
2596 },
2597 "split": {
2598 "$ref": "SourceSplitRequest",
2599 "description": "Information about a request to split a sourc e."
2600 }
2601 },
2602 "type": "object"
2603 },
2604 "StructuredMessage": {
2605 "description": "A rich message format, including a human readable st ring, a key for\nidentifying the message, and structured data associated with th e message for\nprogrammatic consumption.",
2606 "id": "StructuredMessage",
2607 "properties": {
2608 "messageKey": {
2609 "description": "Idenfier for this message type. Used by ext ernal systems to\ninternationalize or personalize message.",
2610 "type": "string"
2611 },
2612 "messageText": {
2613 "description": "Human-readable version of message.",
2614 "type": "string"
2615 },
2616 "parameters": {
2617 "description": "The structured data associated with this mes sage.",
2618 "items": {
2619 "$ref": "Parameter"
2620 },
2621 "type": "array"
2622 }
2623 },
2624 "type": "object"
2625 },
2626 "WorkItem": {
2627 "description": "WorkItem represents basic information about a WorkIt em to be executed\nin the cloud.",
2628 "id": "WorkItem",
2629 "properties": {
2630 "initialReportIndex": {
2631 "description": "The initial index to use when reporting the status of the WorkItem.",
2632 "format": "int64",
2633 "type": "string"
2634 },
2635 "streamingComputationTask": {
2636 "$ref": "StreamingComputationTask",
2637 "description": "Additional information for StreamingComputat ionTask WorkItems."
2638 },
2639 "shellTask": {
2640 "$ref": "ShellTask",
2641 "description": "Additional information for ShellTask WorkIte ms."
2642 },
2643 "jobId": {
2644 "description": "Identifies the workflow job this WorkItem be longs to.",
2645 "type": "string"
2646 },
2647 "id": {
2648 "description": "Identifies this WorkItem.",
2649 "format": "int64",
2650 "type": "string"
2651 },
2652 "configuration": {
2653 "description": "Work item-specific configuration as an opaqu e blob.",
2654 "type": "string"
2655 },
2656 "mapTask": {
2657 "$ref": "MapTask",
2658 "description": "Additional information for MapTask WorkItems ."
2659 },
2660 "seqMapTask": {
2661 "$ref": "SeqMapTask",
2662 "description": "Additional information for SeqMapTask WorkIt ems."
2663 },
2664 "packages": {
2665 "description": "Any required packages that need to be fetche d in order to execute\nthis WorkItem.",
2666 "items": {
2667 "$ref": "Package"
2668 },
2669 "type": "array"
2670 },
2671 "projectId": {
2672 "description": "Identifies the cloud project this WorkItem b elongs to.",
2673 "type": "string"
2674 },
2675 "streamingSetupTask": {
2676 "$ref": "StreamingSetupTask",
2677 "description": "Additional information for StreamingSetupTas k WorkItems."
2678 },
2679 "reportStatusInterval": {
2680 "description": "Recommended reporting interval.",
2681 "format": "google-duration",
2682 "type": "string"
2683 },
2684 "sourceOperationTask": {
2685 "$ref": "SourceOperationRequest",
2686 "description": "Additional information for source operation WorkItems."
2687 },
2688 "leaseExpireTime": {
2689 "description": "Time when the lease on this Work will expire .",
2690 "format": "google-datetime",
2691 "type": "string"
2692 },
2693 "streamingConfigTask": {
2694 "$ref": "StreamingConfigTask",
2695 "description": "Additional information for StreamingConfigTa sk WorkItems."
2696 }
2697 },
2698 "type": "object"
2699 },
2700 "ResourceUtilizationReport": {
2701 "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.",
2702 "id": "ResourceUtilizationReport",
2703 "properties": {
2704 "cpuTime": {
2705 "description": "CPU utilization samples.",
2706 "items": {
2707 "$ref": "CPUTime"
2708 },
2709 "type": "array"
2710 }
2711 },
2712 "type": "object"
2713 },
2714 "ReportedParallelism": {
2715 "description": "Represents the level of parallelism in a WorkItem's input,\nreported by the worker.",
2716 "id": "ReportedParallelism",
2717 "properties": {
2718 "isInfinite": {
2719 "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.",
2720 "type": "boolean"
2721 },
2722 "value": {
2723 "description": "Specifies the level of parallelism in case i t is finite.",
2724 "format": "double",
2725 "type": "number"
2726 }
2727 },
2728 "type": "object"
2729 },
2730 "TopologyConfig": {
2731 "description": "Global topology of the streaming Dataflow job, inclu ding all\ncomputations and their sharded locations.",
2732 "id": "TopologyConfig",
2733 "properties": {
2734 "persistentStateVersion": {
2735 "description": "Version number for persistent state.",
2581 "format": "int32", 2736 "format": "int32",
2582 "type": "integer" 2737 "type": "integer"
2583 }, 2738 },
2584 "serviceAccountEmail": { 2739 "dataDiskAssignments": {
2585 "description": "The email address of the service account to run the job as.", 2740 "description": "The disks assigned to a streaming Dataflow j ob.",
2586 "type": "string" 2741 "items": {
2587 }, 2742 "$ref": "DataDiskAssignment"
2588 "tempLocation": { 2743 },
2589 "description": "The Cloud Storage path to use for temporary files.\nMust be a valid Cloud Storage URL, beginning with `gs://`.", 2744 "type": "array"
2590 "type": "string" 2745 },
2591 }, 2746 "forwardingKeyBits": {
2592 "bypassTempDirValidation": { 2747 "description": "The size (in bits) of keys that will be assi gned to source messages.",
2593 "description": "Whether to bypass the safety checks for the job's temporary directory.\nUse with caution.", 2748 "format": "int32",
2594 "type": "boolean" 2749 "type": "integer"
2595 } 2750 },
2596 }, 2751 "userStageToComputationNameMap": {
2597 "type": "object" 2752 "additionalProperties": {
2598 }, 2753 "type": "string"
2599 "StreamingSideInputLocation": { 2754 },
2600 "description": "Identifies the location of a streaming side input.", 2755 "description": "Maps user stage names to stable computation names.",
2601 "id": "StreamingSideInputLocation", 2756 "type": "object"
2602 "properties": { 2757 },
2603 "tag": { 2758 "computations": {
2604 "description": "Identifies the particular side input within the streaming Dataflow job.", 2759 "description": "The computations associated with a streaming Dataflow job.",
2605 "type": "string" 2760 "items": {
2606 }, 2761 "$ref": "ComputationTopology"
2607 "stateFamily": { 2762 },
2608 "description": "Identifies the state family where this side input is stored.", 2763 "type": "array"
2609 "type": "string" 2764 }
2610 } 2765 },
2611 }, 2766 "type": "object"
2612 "type": "object" 2767 },
2613 }, 2768 "SourceSplitOptions": {
2614 "MountedDataDisk": { 2769 "description": "Hints for splitting a Source into bundles (parts for parallel\nprocessing) using SourceSplitRequest.",
2615 "description": "Describes mounted data disk.", 2770 "id": "SourceSplitOptions",
2616 "id": "MountedDataDisk", 2771 "properties": {
2617 "properties": { 2772 "desiredBundleSizeBytes": {
2618 "dataDisk": { 2773 "description": "The source should be split into a set of bun dles where the estimated size\nof each is approximately this many bytes.",
2619 "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\".", 2774 "format": "int64",
2620 "type": "string" 2775 "type": "string"
2621 } 2776 },
2622 }, 2777 "desiredShardSizeBytes": {
2623 "type": "object" 2778 "description": "DEPRECATED in favor of desired_bundle_size_b ytes.",
2624 }, 2779 "format": "int64",
2625 "LaunchTemplateResponse": { 2780 "type": "string"
2626 "description": "Response to the request to launch a template.", 2781 }
2627 "id": "LaunchTemplateResponse", 2782 },
2628 "properties": { 2783 "type": "object"
2629 "job": { 2784 },
2630 "$ref": "Job", 2785 "ReadInstruction": {
2631 "description": "The job that was launched, if the request wa s not a dry run and\nthe job was successfully launched." 2786 "description": "An instruction that reads records.\nTakes no inputs, produces one output.",
2632 } 2787 "id": "ReadInstruction",
2633 },
2634 "type": "object"
2635 },
2636 "DerivedSource": {
2637 "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.",
2638 "id": "DerivedSource",
2639 "properties": { 2788 "properties": {
2640 "source": { 2789 "source": {
2641 "$ref": "Source", 2790 "$ref": "Source",
2642 "description": "Specification of the source." 2791 "description": "The source to read from."
2643 }, 2792 }
2644 "derivationMode": { 2793 },
2645 "description": "What source to base the produced source on ( if any).", 2794 "type": "object"
2646 "enum": [ 2795 },
2647 "SOURCE_DERIVATION_MODE_UNKNOWN", 2796 "WorkerSettings": {
2648 "SOURCE_DERIVATION_MODE_INDEPENDENT", 2797 "description": "Provides data to pass through to the worker harness. ",
2649 "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT", 2798 "id": "WorkerSettings",
2650 "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT" 2799 "properties": {
2651 ], 2800 "reportingEnabled": {
2652 "enumDescriptions": [ 2801 "description": "Whether to send work progress updates to the service.",
2653 "The source derivation is unknown, or unspecified.", 2802 "type": "boolean"
2654 "Produce a completely independent Source with no base.", 2803 },
2655 "Produce a Source based on the Source being split.", 2804 "baseUrl": {
2656 "Produce a Source based on the base of the Source being split." 2805 "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/\"",
2657 ], 2806 "type": "string"
2658 "type": "string" 2807 },
2659 } 2808 "servicePath": {
2660 }, 2809 "description": "The Cloud Dataflow service path relative to the root URL, for example,\n\"dataflow/v1b3/projects\".",
2661 "type": "object" 2810 "type": "string"
2662 }, 2811 },
2663 "DynamicSourceSplit": { 2812 "shuffleServicePath": {
2664 "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.", 2813 "description": "The Shuffle service path relative to the roo t URL, for example,\n\"shuffle/v1beta1\".",
2665 "id": "DynamicSourceSplit", 2814 "type": "string"
2666 "properties": { 2815 },
2667 "residual": { 2816 "workerId": {
2668 "$ref": "DerivedSource", 2817 "description": "The ID of the worker running this pipeline." ,
2669 "description": "Residual part (returned to the pool of work) .\nSpecified relative to the previously-current source." 2818 "type": "string"
2670 }, 2819 },
2671 "primary": { 2820 "tempStoragePrefix": {
2672 "$ref": "DerivedSource", 2821 "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}",
2673 "description": "Primary part (continued to be processed by w orker).\nSpecified relative to the previously-current source.\nBecomes current." 2822 "type": "string"
2674 } 2823 }
2675 }, 2824 },
2676 "type": "object" 2825 "type": "object"
2677 }, 2826 },
2678 "Job": { 2827 "DataDiskAssignment": {
2679 "description": "Defines a job to be run by the Cloud Dataflow servic e.", 2828 "description": "Data disk assignment for a given VM instance.",
2680 "id": "Job", 2829 "id": "DataDiskAssignment",
2681 "properties": { 2830 "properties": {
2682 "name": { 2831 "vmInstance": {
2683 "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])?`", 2832 "description": "VM instance name the data disks mounted to, for example\n\"myproject-1014-104817-4c2-harness-0\".",
2684 "type": "string" 2833 "type": "string"
2685 }, 2834 },
2686 "steps": { 2835 "dataDisks": {
2687 "description": "The top-level steps that constitute the enti re job.", 2836 "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\" }.",
2688 "items": { 2837 "items": {
2689 "$ref": "Step" 2838 "type": "string"
2690 }, 2839 },
2691 "type": "array" 2840 "type": "array"
2692 }, 2841 }
2693 "replacedByJobId": { 2842 },
2694 "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.", 2843 "type": "object"
2695 "type": "string" 2844 },
2696 }, 2845 "StreamingStageLocation": {
2697 "id": { 2846 "description": "Identifies the location of a streaming computation s tage, for\nstage-to-stage communication.",
2698 "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.", 2847 "id": "StreamingStageLocation",
2699 "type": "string" 2848 "properties": {
2700 }, 2849 "streamId": {
2701 "executionInfo": { 2850 "description": "Identifies the particular stream within the streaming Dataflow\njob.",
2702 "$ref": "JobExecutionInfo", 2851 "type": "string"
2703 "description": "Deprecated." 2852 }
2704 }, 2853 },
2705 "currentState": { 2854 "type": "object"
2706 "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 .", 2855 },
2856 "ApproximateSplitRequest": {
2857 "description": "A suggestion by the service to the worker to dynamic ally split the WorkItem.",
2858 "id": "ApproximateSplitRequest",
2859 "properties": {
2860 "position": {
2861 "$ref": "Position",
2862 "description": "A Position at which to split the work item."
2863 },
2864 "fractionConsumed": {
2865 "description": "A fraction at which to split the work item, from 0.0 (beginning of the\ninput) to 1.0 (end of the input).",
2866 "format": "double",
2867 "type": "number"
2868 }
2869 },
2870 "type": "object"
2871 },
2872 "Status": {
2873 "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` that can be used for common error conditions.\n\n# Lang uage 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` mess age is\nexposed in different client libraries and different wire protocols, it c an be\nmapped differently. For example, it will likely be mapped to some excepti ons\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\nenvironm ents, either with or without APIs, to provide a\nconsistent developer experience 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 m ay\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\ n- Asynchronous operations. If an API call embeds asynchronous operation\n re sults in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are store d in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
2874 "id": "Status",
2875 "properties": {
2876 "code": {
2877 "description": "The status code, which should be an enum val ue of google.rpc.Code.",
2878 "format": "int32",
2879 "type": "integer"
2880 },
2881 "message": {
2882 "description": "A developer-facing error message, which shou ld be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
2883 "type": "string"
2884 },
2885 "details": {
2886 "description": "A list of messages that carry the error deta ils. There is a common set of\nmessage types for APIs to use.",
2887 "items": {
2888 "additionalProperties": {
2889 "description": "Properties of the object. Contains f ield @type with type URL.",
2890 "type": "any"
2891 },
2892 "type": "object"
2893 },
2894 "type": "array"
2895 }
2896 },
2897 "type": "object"
2898 },
2899 "ExecutionStageState": {
2900 "description": "A message describing the state of a particular execu tion stage.",
2901 "id": "ExecutionStageState",
2902 "properties": {
2903 "executionStageName": {
2904 "description": "The name of the execution stage.",
2905 "type": "string"
2906 },
2907 "currentStateTime": {
2908 "description": "The time at which the stage transitioned to this state.",
2909 "format": "google-datetime",
2910 "type": "string"
2911 },
2912 "executionStageState": {
2913 "description": "Executions stage states allow the same set o f values as JobState.",
2707 "enum": [ 2914 "enum": [
2708 "JOB_STATE_UNKNOWN", 2915 "JOB_STATE_UNKNOWN",
2709 "JOB_STATE_STOPPED", 2916 "JOB_STATE_STOPPED",
2710 "JOB_STATE_RUNNING", 2917 "JOB_STATE_RUNNING",
2711 "JOB_STATE_DONE", 2918 "JOB_STATE_DONE",
2712 "JOB_STATE_FAILED", 2919 "JOB_STATE_FAILED",
2713 "JOB_STATE_CANCELLED", 2920 "JOB_STATE_CANCELLED",
2714 "JOB_STATE_UPDATED", 2921 "JOB_STATE_UPDATED",
2715 "JOB_STATE_DRAINING", 2922 "JOB_STATE_DRAINING",
2716 "JOB_STATE_DRAINED", 2923 "JOB_STATE_DRAINED",
2717 "JOB_STATE_PENDING", 2924 "JOB_STATE_PENDING",
2718 "JOB_STATE_CANCELLING" 2925 "JOB_STATE_CANCELLING"
2719 ], 2926 ],
2720 "enumDescriptions": [ 2927 "enumDescriptions": [
2721 "The job's run state isn't specified.", 2928 "The job's run state isn't specified.",
2722 "`JOB_STATE_STOPPED` indicates that the job has not\nyet started to run.", 2929 "`JOB_STATE_STOPPED` indicates that the job has not\nyet started to run.",
2723 "`JOB_STATE_RUNNING` indicates that the job is currently running.", 2930 "`JOB_STATE_RUNNING` indicates that the job is currently running.",
2724 "`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.", 2931 "`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.",
2725 "`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`.", 2932 "`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`.",
2726 "`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.", 2933 "`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.",
2727 "`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`.", 2934 "`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`.",
2728 "`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`.", 2935 "`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`.",
2729 "`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`.", 2936 "`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`.",
2730 "'JOB_STATE_PENDING' indicates that the job has been cre ated but is not yet\nrunning. Jobs that are pending may only transition to `JOB _STATE_RUNNING`,\nor `JOB_STATE_FAILED`.", 2937 "'JOB_STATE_PENDING' indicates that the job has been cre ated but is not yet\nrunning. Jobs that are pending may only transition to `JOB _STATE_RUNNING`,\nor `JOB_STATE_FAILED`.",
2731 "'JOB_STATE_CANCELLING' indicates that the job has been explicitly cancelled\nand is in the process of stopping. Jobs that are cancelli ng may only\ntransition to 'JOB_STATE_CANCELLED' or 'JOB_STATE_FAILED'." 2938 "'JOB_STATE_CANCELLING' indicates that the job has been explicitly cancelled\nand is in the process of stopping. Jobs that are cancelli ng may only\ntransition to 'JOB_STATE_CANCELLED' or 'JOB_STATE_FAILED'."
2732 ], 2939 ],
2733 "type": "string" 2940 "type": "string"
2734 }, 2941 }
2735 "location": { 2942 },
2736 "description": "The location that contains this job.", 2943 "type": "object"
2737 "type": "string" 2944 },
2738 }, 2945 "StreamLocation": {
2739 "currentStateTime": { 2946 "description": "Describes a stream of data, either as input to be pr ocessed or as\noutput of a streaming Dataflow job.",
2740 "description": "The timestamp associated with the current st ate.", 2947 "id": "StreamLocation",
2741 "format": "google-datetime", 2948 "properties": {
2742 "type": "string" 2949 "customSourceLocation": {
2743 }, 2950 "$ref": "CustomSourceLocation",
2744 "transformNameMapping": { 2951 "description": "The stream is a custom source."
2745 "additionalProperties": { 2952 },
2953 "sideInputLocation": {
2954 "$ref": "StreamingSideInputLocation",
2955 "description": "The stream is a streaming side input."
2956 },
2957 "pubsubLocation": {
2958 "$ref": "PubsubLocation",
2959 "description": "The stream is a pubsub stream."
2960 },
2961 "streamingStageLocation": {
2962 "$ref": "StreamingStageLocation",
2963 "description": "The stream is part of another computation wi thin the current\nstreaming Dataflow job."
2964 }
2965 },
2966 "type": "object"
2967 },
2968 "SendWorkerMessagesResponse": {
2969 "description": "The response to the worker messages.",
2970 "id": "SendWorkerMessagesResponse",
2971 "properties": {
2972 "workerMessageResponses": {
2973 "description": "The servers response to the worker messages. ",
2974 "items": {
2975 "$ref": "WorkerMessageResponse"
2976 },
2977 "type": "array"
2978 }
2979 },
2980 "type": "object"
2981 },
2982 "StreamingComputationConfig": {
2983 "description": "Configuration information for a single streaming com putation.",
2984 "id": "StreamingComputationConfig",
2985 "properties": {
2986 "stageName": {
2987 "description": "Stage name of this computation.",
2988 "type": "string"
2989 },
2990 "systemName": {
2991 "description": "System defined name for this computation.",
2992 "type": "string"
2993 },
2994 "instructions": {
2995 "description": "Instructions that comprise the computation." ,
2996 "items": {
2997 "$ref": "ParallelInstruction"
2998 },
2999 "type": "array"
3000 },
3001 "computationId": {
3002 "description": "Unique identifier for this computation.",
3003 "type": "string"
3004 }
3005 },
3006 "type": "object"
3007 },
3008 "TransformSummary": {
3009 "description": "Description of the type, names/ids, and input/output s for a transform.",
3010 "id": "TransformSummary",
3011 "properties": {
3012 "id": {
3013 "description": "SDK generated id of this transform instance. ",
3014 "type": "string"
3015 },
3016 "displayData": {
3017 "description": "Transform-specific display data.",
3018 "items": {
3019 "$ref": "DisplayData"
3020 },
3021 "type": "array"
3022 },
3023 "outputCollectionName": {
3024 "description": "User names for all collection outputs to th is transform.",
3025 "items": {
2746 "type": "string" 3026 "type": "string"
2747 }, 3027 },
2748 "description": "The map of transform name prefixes of the jo b to be replaced to the\ncorresponding name prefixes of the new job.", 3028 "type": "array"
2749 "type": "object"
2750 },
2751 "labels": {
2752 "additionalProperties": {
2753 "type": "string"
2754 },
2755 "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.",
2756 "type": "object"
2757 },
2758 "environment": {
2759 "$ref": "Environment",
2760 "description": "The environment for the job."
2761 },
2762 "createTime": {
2763 "description": "The timestamp when the job was initially cre ated. Immutable and set by the\nCloud Dataflow service.",
2764 "format": "google-datetime",
2765 "type": "string"
2766 },
2767 "stageStates": {
2768 "description": "This field may be mutated by the Cloud Dataf low service;\ncallers cannot mutate it.",
2769 "items": {
2770 "$ref": "ExecutionStageState"
2771 },
2772 "type": "array"
2773 },
2774 "type": {
2775 "description": "The type of Cloud Dataflow job.",
2776 "enum": [
2777 "JOB_TYPE_UNKNOWN",
2778 "JOB_TYPE_BATCH",
2779 "JOB_TYPE_STREAMING"
2780 ],
2781 "enumDescriptions": [
2782 "The type of the job is unspecified, or unknown.",
2783 "A batch job with a well-defined end point: data is read , data is\nprocessed, data is written, and the job is done.",
2784 "A continuously streaming job with no end: data is read, \nprocessed, and written continuously."
2785 ],
2786 "type": "string"
2787 },
2788 "projectId": {
2789 "description": "The ID of the Cloud Platform project that th e job belongs to.",
2790 "type": "string"
2791 },
2792 "pipelineDescription": {
2793 "$ref": "PipelineDescription",
2794 "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."
2795 },
2796 "replaceJobId": {
2797 "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.",
2798 "type": "string"
2799 },
2800 "requestedState": {
2801 "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.",
2802 "enum": [
2803 "JOB_STATE_UNKNOWN",
2804 "JOB_STATE_STOPPED",
2805 "JOB_STATE_RUNNING",
2806 "JOB_STATE_DONE",
2807 "JOB_STATE_FAILED",
2808 "JOB_STATE_CANCELLED",
2809 "JOB_STATE_UPDATED",
2810 "JOB_STATE_DRAINING",
2811 "JOB_STATE_DRAINED",
2812 "JOB_STATE_PENDING",
2813 "JOB_STATE_CANCELLING"
2814 ],
2815 "enumDescriptions": [
2816 "The job's run state isn't specified.",
2817 "`JOB_STATE_STOPPED` indicates that the job has not\nyet started to run.",
2818 "`JOB_STATE_RUNNING` indicates that the job is currently running.",
2819 "`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.",
2820 "`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`.",
2821 "`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.",
2822 "`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`.",
2823 "`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`.",
2824 "`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`.",
2825 "'JOB_STATE_PENDING' indicates that the job has been cre ated but is not yet\nrunning. Jobs that are pending may only transition to `JOB _STATE_RUNNING`,\nor `JOB_STATE_FAILED`.",
2826 "'JOB_STATE_CANCELLING' indicates that the job has been explicitly cancelled\nand is in the process of stopping. Jobs that are cancelli ng may only\ntransition to 'JOB_STATE_CANCELLED' or 'JOB_STATE_FAILED'."
2827 ],
2828 "type": "string"
2829 },
2830 "tempFiles": {
2831 "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}",
2832 "items": {
2833 "type": "string"
2834 },
2835 "type": "array"
2836 },
2837 "clientRequestId": {
2838 "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.",
2839 "type": "string"
2840 }
2841 },
2842 "type": "object"
2843 },
2844 "SourceOperationResponse": {
2845 "description": "The result of a SourceOperationRequest, specified in \nReportWorkItemStatusRequest.source_operation when the work item\nis completed. ",
2846 "id": "SourceOperationResponse",
2847 "properties": {
2848 "getMetadata": {
2849 "$ref": "SourceGetMetadataResponse",
2850 "description": "A response to a request to get metadata abou t a source."
2851 },
2852 "split": {
2853 "$ref": "SourceSplitResponse",
2854 "description": "A response to a request to split a source."
2855 }
2856 },
2857 "type": "object"
2858 },
2859 "SideInputInfo": {
2860 "description": "Information about a side input of a DoFn or an input of a SeqDoFn.",
2861 "id": "SideInputInfo",
2862 "properties": {
2863 "tag": {
2864 "description": "The id of the tag the user code will access this side input by;\nthis should correspond to the tag of some MultiOutputInfo." ,
2865 "type": "string"
2866 }, 3029 },
2867 "kind": { 3030 "kind": {
2868 "additionalProperties": { 3031 "description": "Type of transform.",
2869 "description": "Properties of the object.",
2870 "type": "any"
2871 },
2872 "description": "How to interpret the source element(s) as a side input value.",
2873 "type": "object"
2874 },
2875 "sources": {
2876 "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.",
2877 "items": {
2878 "$ref": "Source"
2879 },
2880 "type": "array"
2881 }
2882 },
2883 "type": "object"
2884 },
2885 "SendDebugCaptureResponse": {
2886 "description": "Response to a send capture request.\nnothing",
2887 "id": "SendDebugCaptureResponse",
2888 "properties": {},
2889 "type": "object"
2890 },
2891 "WriteInstruction": {
2892 "description": "An instruction that writes records.\nTakes one input , produces no outputs.",
2893 "id": "WriteInstruction",
2894 "properties": {
2895 "input": {
2896 "$ref": "InstructionInput",
2897 "description": "The input."
2898 },
2899 "sink": {
2900 "$ref": "Sink",
2901 "description": "The sink to write to."
2902 }
2903 },
2904 "type": "object"
2905 },
2906 "ConcatPosition": {
2907 "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.",
2908 "id": "ConcatPosition",
2909 "properties": {
2910 "position": {
2911 "$ref": "Position",
2912 "description": "Position within the inner source."
2913 },
2914 "index": {
2915 "description": "Index of the inner source.",
2916 "format": "int32",
2917 "type": "integer"
2918 }
2919 },
2920 "type": "object"
2921 },
2922 "CounterStructuredNameAndMetadata": {
2923 "description": "A single message which encapsulates structured name and metadata for a given\ncounter.",
2924 "id": "CounterStructuredNameAndMetadata",
2925 "properties": {
2926 "metadata": {
2927 "$ref": "CounterMetadata",
2928 "description": "Metadata associated with a counter"
2929 },
2930 "name": {
2931 "$ref": "CounterStructuredName",
2932 "description": "Structured name of the counter."
2933 }
2934 },
2935 "type": "object"
2936 },
2937 "AutoscalingSettings": {
2938 "description": "Settings for WorkerPool autoscaling.",
2939 "id": "AutoscalingSettings",
2940 "properties": {
2941 "algorithm": {
2942 "description": "The algorithm to use for autoscaling.",
2943 "enum": [
2944 "AUTOSCALING_ALGORITHM_UNKNOWN",
2945 "AUTOSCALING_ALGORITHM_NONE",
2946 "AUTOSCALING_ALGORITHM_BASIC"
2947 ],
2948 "enumDescriptions": [
2949 "The algorithm is unknown, or unspecified.",
2950 "Disable autoscaling.",
2951 "Increase worker count over time to reduce job execution time."
2952 ],
2953 "type": "string"
2954 },
2955 "maxNumWorkers": {
2956 "description": "The maximum number of workers to cap scaling at.",
2957 "format": "int32",
2958 "type": "integer"
2959 }
2960 },
2961 "type": "object"
2962 },
2963 "StreamingComputationRanges": {
2964 "description": "Describes full or partial data disk assignment infor mation of the computation\nranges.",
2965 "id": "StreamingComputationRanges",
2966 "properties": {
2967 "computationId": {
2968 "description": "The ID of the computation.",
2969 "type": "string"
2970 },
2971 "rangeAssignments": {
2972 "description": "Data disk assignments for ranges from this c omputation.",
2973 "items": {
2974 "$ref": "KeyRangeDataDiskAssignment"
2975 },
2976 "type": "array"
2977 }
2978 },
2979 "type": "object"
2980 },
2981 "ExecutionStageSummary": {
2982 "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.",
2983 "id": "ExecutionStageSummary",
2984 "properties": {
2985 "name": {
2986 "description": "Dataflow service generated name for this sta ge.",
2987 "type": "string"
2988 },
2989 "inputSource": {
2990 "description": "Input sources for this stage.",
2991 "items": {
2992 "$ref": "StageSource"
2993 },
2994 "type": "array"
2995 },
2996 "id": {
2997 "description": "Dataflow service generated id for this stage .",
2998 "type": "string"
2999 },
3000 "componentTransform": {
3001 "description": "Transforms that comprise this execution stag e.",
3002 "items": {
3003 "$ref": "ComponentTransform"
3004 },
3005 "type": "array"
3006 },
3007 "componentSource": {
3008 "description": "Collections produced and consumed by compone nt transforms of this stage.",
3009 "items": {
3010 "$ref": "ComponentSource"
3011 },
3012 "type": "array"
3013 },
3014 "kind": {
3015 "description": "Type of tranform this stage is executing.",
3016 "enum": [ 3032 "enum": [
3017 "UNKNOWN_KIND", 3033 "UNKNOWN_KIND",
3018 "PAR_DO_KIND", 3034 "PAR_DO_KIND",
3019 "GROUP_BY_KEY_KIND", 3035 "GROUP_BY_KEY_KIND",
3020 "FLATTEN_KIND", 3036 "FLATTEN_KIND",
3021 "READ_KIND", 3037 "READ_KIND",
3022 "WRITE_KIND", 3038 "WRITE_KIND",
3023 "CONSTANT_KIND", 3039 "CONSTANT_KIND",
3024 "SINGLETON_KIND", 3040 "SINGLETON_KIND",
3025 "SHUFFLE_KIND" 3041 "SHUFFLE_KIND"
3026 ], 3042 ],
3027 "enumDescriptions": [ 3043 "enumDescriptions": [
3028 "Unrecognized transform type.", 3044 "Unrecognized transform type.",
3029 "ParDo transform.", 3045 "ParDo transform.",
3030 "Group By Key transform.", 3046 "Group By Key transform.",
3031 "Flatten transform.", 3047 "Flatten transform.",
3032 "Read transform.", 3048 "Read transform.",
3033 "Write transform.", 3049 "Write transform.",
3034 "Constructs from a constant value, such as with Create.o f.", 3050 "Constructs from a constant value, such as with Create.o f.",
3035 "Creates a Singleton view of a collection.", 3051 "Creates a Singleton view of a collection.",
3036 "Opening or closing a shuffle session, often as part of a GroupByKey." 3052 "Opening or closing a shuffle session, often as part of a GroupByKey."
3037 ], 3053 ],
3038 "type": "string" 3054 "type": "string"
3039 }, 3055 },
3040 "outputSource": { 3056 "inputCollectionName": {
3041 "description": "Output sources for this stage.", 3057 "description": "User names for all collection inputs to this transform.",
3042 "items": { 3058 "items": {
3043 "$ref": "StageSource" 3059 "type": "string"
3044 }, 3060 },
3045 "type": "array" 3061 "type": "array"
3046 } 3062 },
3047 }, 3063 "name": {
3048 "type": "object" 3064 "description": "User provided name for this transform instan ce.",
3049 }, 3065 "type": "string"
3050 "LogBucket": { 3066 }
3051 "description": "Bucket of values for Distribution's logarithmic hist ogram.", 3067 },
3052 "id": "LogBucket", 3068 "type": "object"
3053 "properties": { 3069 },
3054 "log": { 3070 "LeaseWorkItemResponse": {
3055 "description": "floor(log2(value)); defined to be zero for n onpositive values.\n log(-1) = 0\n log(0) = 0\n log(1) = 0\n log(2) = 1\n l og(3) = 1\n log(4) = 2\n log(5) = 2", 3071 "description": "Response to a request to lease WorkItems.",
3056 "format": "int32", 3072 "id": "LeaseWorkItemResponse",
3057 "type": "integer" 3073 "properties": {
3058 }, 3074 "workItems": {
3059 "count": { 3075 "description": "A list of the leased WorkItems.",
3060 "description": "Number of values in this bucket.", 3076 "items": {
3061 "format": "int64", 3077 "$ref": "WorkItem"
3062 "type": "string" 3078 },
3063 } 3079 "type": "array"
3064 }, 3080 }
3065 "type": "object" 3081 },
3066 }, 3082 "type": "object"
3067 "SendWorkerMessagesRequest": { 3083 },
3068 "description": "A request for sending worker messages to the service .", 3084 "LaunchTemplateParameters": {
3069 "id": "SendWorkerMessagesRequest", 3085 "description": "Parameters to provide to the template being launched .",
3070 "properties": { 3086 "id": "LaunchTemplateParameters",
3071 "workerMessages": { 3087 "properties": {
3072 "description": "The WorkerMessages to send.", 3088 "parameters": {
3073 "items": {
3074 "$ref": "WorkerMessage"
3075 },
3076 "type": "array"
3077 },
3078 "location": {
3079 "description": "The location which contains the job",
3080 "type": "string"
3081 }
3082 },
3083 "type": "object"
3084 },
3085 "SourceSplitShard": {
3086 "description": "DEPRECATED in favor of DerivedSource.",
3087 "id": "SourceSplitShard",
3088 "properties": {
3089 "derivationMode": {
3090 "description": "DEPRECATED",
3091 "enum": [
3092 "SOURCE_DERIVATION_MODE_UNKNOWN",
3093 "SOURCE_DERIVATION_MODE_INDEPENDENT",
3094 "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT",
3095 "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT"
3096 ],
3097 "enumDescriptions": [
3098 "The source derivation is unknown, or unspecified.",
3099 "Produce a completely independent Source with no base.",
3100 "Produce a Source based on the Source being split.",
3101 "Produce a Source based on the base of the Source being split."
3102 ],
3103 "type": "string"
3104 },
3105 "source": {
3106 "$ref": "Source",
3107 "description": "DEPRECATED"
3108 }
3109 },
3110 "type": "object"
3111 },
3112 "CPUTime": {
3113 "description": "Modeled after information exposed by /proc/stat.",
3114 "id": "CPUTime",
3115 "properties": {
3116 "totalMs": {
3117 "description": "Total active CPU time across all cores (ie., non-idle) in milliseconds\nsince start-up.",
3118 "format": "uint64",
3119 "type": "string"
3120 },
3121 "rate": {
3122 "description": "Average CPU utilization rate (% non-idle cpu / second) since previous\nsample.",
3123 "format": "double",
3124 "type": "number"
3125 },
3126 "timestamp": {
3127 "description": "Timestamp of the measurement.",
3128 "format": "google-datetime",
3129 "type": "string"
3130 }
3131 },
3132 "type": "object"
3133 },
3134 "Environment": {
3135 "description": "Describes the environment in which a Dataflow Job ru ns.",
3136 "id": "Environment",
3137 "properties": {
3138 "userAgent": {
3139 "additionalProperties": { 3089 "additionalProperties": {
3140 "description": "Properties of the object.", 3090 "type": "string"
3141 "type": "any" 3091 },
3142 }, 3092 "description": "The runtime parameters to pass to the job.",
3143 "description": "A description of the process that generated the request.",
3144 "type": "object" 3093 "type": "object"
3145 }, 3094 },
3146 "sdkPipelineOptions": { 3095 "jobName": {
3147 "additionalProperties": { 3096 "description": "Required. The job name to use for the create d job.",
3148 "description": "Properties of the object.", 3097 "type": "string"
3149 "type": "any" 3098 },
3150 }, 3099 "environment": {
3151 "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.", 3100 "$ref": "RuntimeEnvironment",
3152 "type": "object" 3101 "description": "The runtime environment for the job."
3153 }, 3102 }
3154 "clusterManagerApiService": { 3103 },
3155 "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\".", 3104 "type": "object"
3156 "type": "string" 3105 },
3157 }, 3106 "Sink": {
3158 "tempStoragePrefix": { 3107 "description": "A sink that records can be encoded and written to.",
3159 "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}", 3108 "id": "Sink",
3160 "type": "string" 3109 "properties": {
3161 },
3162 "workerPools": {
3163 "description": "The worker pools. At least one \"harness\" w orker pool must be\nspecified in order for the job to have workers.",
3164 "items": {
3165 "$ref": "WorkerPool"
3166 },
3167 "type": "array"
3168 },
3169 "dataset": {
3170 "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}",
3171 "type": "string"
3172 },
3173 "experiments": {
3174 "description": "The list of experiments to enable.",
3175 "items": {
3176 "type": "string"
3177 },
3178 "type": "array"
3179 },
3180 "version": {
3181 "additionalProperties": {
3182 "description": "Properties of the object.",
3183 "type": "any"
3184 },
3185 "description": "A structure describing which components and their versions of the service\nare required in order to run the job.",
3186 "type": "object"
3187 },
3188 "internalExperiments": {
3189 "additionalProperties": {
3190 "description": "Properties of the object. Contains field @type with type URL.",
3191 "type": "any"
3192 },
3193 "description": "Experimental settings.",
3194 "type": "object"
3195 },
3196 "serviceAccountEmail": {
3197 "description": "Identity to run virtual machines as. Default s to the default account.",
3198 "type": "string"
3199 }
3200 },
3201 "type": "object"
3202 },
3203 "StreamingComputationTask": {
3204 "description": "A task which describes what action should be perform ed for the specified\nstreaming computation ranges.",
3205 "id": "StreamingComputationTask",
3206 "properties": {
3207 "taskType": {
3208 "description": "A type of streaming computation task.",
3209 "enum": [
3210 "STREAMING_COMPUTATION_TASK_UNKNOWN",
3211 "STREAMING_COMPUTATION_TASK_STOP",
3212 "STREAMING_COMPUTATION_TASK_START"
3213 ],
3214 "enumDescriptions": [
3215 "The streaming computation task is unknown, or unspecifi ed.",
3216 "Stop processing specified streaming computation range(s ).",
3217 "Start processing specified streaming computation range( s)."
3218 ],
3219 "type": "string"
3220 },
3221 "computationRanges": {
3222 "description": "Contains ranges of a streaming computation t his task should apply to.",
3223 "items": {
3224 "$ref": "StreamingComputationRanges"
3225 },
3226 "type": "array"
3227 },
3228 "dataDisks": {
3229 "description": "Describes the set of data disks this task sh ould apply to.",
3230 "items": {
3231 "$ref": "MountedDataDisk"
3232 },
3233 "type": "array"
3234 }
3235 },
3236 "type": "object"
3237 },
3238 "SendDebugCaptureRequest": {
3239 "description": "Request to send encoded debug information.",
3240 "id": "SendDebugCaptureRequest",
3241 "properties": {
3242 "componentId": {
3243 "description": "The internal component id for which debug in formation is sent.",
3244 "type": "string"
3245 },
3246 "workerId": {
3247 "description": "The worker id, i.e., VM hostname.",
3248 "type": "string"
3249 },
3250 "location": {
3251 "description": "The location which contains the job specifie d by job_id.",
3252 "type": "string"
3253 },
3254 "data": {
3255 "description": "The encoded debug information.",
3256 "type": "string"
3257 }
3258 },
3259 "type": "object"
3260 },
3261 "GetDebugConfigResponse": {
3262 "description": "Response to a get debug configuration request.",
3263 "id": "GetDebugConfigResponse",
3264 "properties": {
3265 "config": {
3266 "description": "The encoded debug configuration for the requ ested component.",
3267 "type": "string"
3268 }
3269 },
3270 "type": "object"
3271 },
3272 "ComponentTransform": {
3273 "description": "Description of a transform executed as part of an ex ecution stage.",
3274 "id": "ComponentTransform",
3275 "properties": {
3276 "originalTransform": {
3277 "description": "User name for the original user transform wi th which this transform is\nmost closely associated.",
3278 "type": "string"
3279 },
3280 "name": {
3281 "description": "Dataflow service generated name for this sou rce.",
3282 "type": "string"
3283 },
3284 "userName": {
3285 "description": "Human-readable name for this transform; may be user or system generated.",
3286 "type": "string"
3287 }
3288 },
3289 "type": "object"
3290 },
3291 "StreamingSetupTask": {
3292 "description": "A task which initializes part of a streaming Dataflo w job.",
3293 "id": "StreamingSetupTask",
3294 "properties": {
3295 "drain": {
3296 "description": "The user has requested drain.",
3297 "type": "boolean"
3298 },
3299 "workerHarnessPort": {
3300 "description": "The TCP port used by the worker to communica te with the Dataflow\nworker harness.",
3301 "format": "int32",
3302 "type": "integer"
3303 },
3304 "receiveWorkPort": {
3305 "description": "The TCP port on which the worker should list en for messages from\nother streaming computation workers.",
3306 "format": "int32",
3307 "type": "integer"
3308 },
3309 "streamingComputationTopology": {
3310 "$ref": "TopologyConfig",
3311 "description": "The global topology of the streaming Dataflo w job."
3312 }
3313 },
3314 "type": "object"
3315 },
3316 "PubsubLocation": {
3317 "description": "Identifies a pubsub location to use for transferring data into or\nout of a streaming Dataflow job.",
3318 "id": "PubsubLocation",
3319 "properties": {
3320 "trackingSubscription": {
3321 "description": "If set, specifies the pubsub subscription th at will be used for tracking\ncustom time timestamps for watermark estimation.",
3322 "type": "string"
3323 },
3324 "withAttributes": {
3325 "description": "If true, then the client has requested to ge t pubsub attributes.",
3326 "type": "boolean"
3327 },
3328 "idLabel": {
3329 "description": "If set, contains a pubsub label from which t o extract record ids.\nIf left empty, record deduplication will be strictly best effort.",
3330 "type": "string"
3331 },
3332 "topic": {
3333 "description": "A pubsub topic, in the form of\n\"pubsub.goo gleapis.com/topics/<project-id>/<topic-name>\"",
3334 "type": "string"
3335 },
3336 "timestampLabel": {
3337 "description": "If set, contains a pubsub label from which t o extract record timestamps.\nIf left empty, record timestamps will be generated upon arrival.",
3338 "type": "string"
3339 },
3340 "subscription": {
3341 "description": "A pubsub subscription, in the form of\n\"pub sub.googleapis.com/subscriptions/<project-id>/<subscription-name>\"",
3342 "type": "string"
3343 },
3344 "dropLateData": {
3345 "description": "Indicates whether the pipeline allows late-a rriving data.",
3346 "type": "boolean"
3347 }
3348 },
3349 "type": "object"
3350 },
3351 "WorkerHealthReport": {
3352 "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.",
3353 "id": "WorkerHealthReport",
3354 "properties": {
3355 "reportInterval": {
3356 "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.",
3357 "format": "google-duration",
3358 "type": "string"
3359 },
3360 "vmIsHealthy": {
3361 "description": "Whether the VM is healthy.",
3362 "type": "boolean"
3363 },
3364 "pods": {
3365 "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.",
3366 "items": {
3367 "additionalProperties": {
3368 "description": "Properties of the object.",
3369 "type": "any"
3370 },
3371 "type": "object"
3372 },
3373 "type": "array"
3374 },
3375 "vmStartupTime": {
3376 "description": "The time the VM was booted.",
3377 "format": "google-datetime",
3378 "type": "string"
3379 }
3380 },
3381 "type": "object"
3382 },
3383 "JobMessage": {
3384 "description": "A particular message pertaining to a Dataflow job.",
3385 "id": "JobMessage",
3386 "properties": {
3387 "messageImportance": {
3388 "description": "Importance level of the message.",
3389 "enum": [
3390 "JOB_MESSAGE_IMPORTANCE_UNKNOWN",
3391 "JOB_MESSAGE_DEBUG",
3392 "JOB_MESSAGE_DETAILED",
3393 "JOB_MESSAGE_BASIC",
3394 "JOB_MESSAGE_WARNING",
3395 "JOB_MESSAGE_ERROR"
3396 ],
3397 "enumDescriptions": [
3398 "The message importance isn't specified, or is unknown." ,
3399 "The message is at the 'debug' level: typically only use ful for\nsoftware engineers working on the code the job is running.\nTypically, Dataflow pipeline runners do not display log messages\nat this level by default. ",
3400 "The message is at the 'detailed' level: somewhat verbos e, but\npotentially useful to users. Typically, Dataflow pipeline\nrunners do n ot display log messages at this level by default.\nThese messages are displayed by default in the Dataflow\nmonitoring UI.",
3401 "The message is at the 'basic' level: useful for keeping \ntrack of the execution of a Dataflow pipeline. Typically,\nDataflow pipeline runners display log messages at this level by\ndefault, and these messages are d isplayed by default in the\nDataflow monitoring UI.",
3402 "The message is at the 'warning' level: indicating a con dition\npertaining to a job which may require human intervention.\nTypically, Da taflow pipeline runners display log messages at this\nlevel by default, and thes e messages are displayed by default in\nthe Dataflow monitoring UI.",
3403 "The message is at the 'error' level: indicating a condi tion\npreventing a job from succeeding. Typically, Dataflow pipeline\nrunners d isplay log messages at this level by default, and these\nmessages are displayed by default in the Dataflow monitoring UI."
3404 ],
3405 "type": "string"
3406 },
3407 "messageText": {
3408 "description": "The text of the message.",
3409 "type": "string"
3410 },
3411 "time": {
3412 "description": "The timestamp of the message.",
3413 "format": "google-datetime",
3414 "type": "string"
3415 },
3416 "id": {
3417 "description": "Deprecated.",
3418 "type": "string"
3419 }
3420 },
3421 "type": "object"
3422 },
3423 "ParameterMetadata": {
3424 "description": "Metadata for a specific parameter.",
3425 "id": "ParameterMetadata",
3426 "properties": {
3427 "helpText": {
3428 "description": "Required. The help text to display for the p arameter.",
3429 "type": "string"
3430 },
3431 "isOptional": {
3432 "description": "Optional. Whether the parameter is optional. Defaults to false.",
3433 "type": "boolean"
3434 },
3435 "name": {
3436 "description": "Required. The name of the parameter.",
3437 "type": "string"
3438 },
3439 "regexes": {
3440 "description": "Optional. Regexes that the parameter must ma tch.",
3441 "items": {
3442 "type": "string"
3443 },
3444 "type": "array"
3445 },
3446 "label": {
3447 "description": "Required. The label to display for the param eter.",
3448 "type": "string"
3449 }
3450 },
3451 "type": "object"
3452 },
3453 "MultiOutputInfo": {
3454 "description": "Information about an output of a multi-output DoFn." ,
3455 "id": "MultiOutputInfo",
3456 "properties": {
3457 "tag": {
3458 "description": "The id of the tag the user code will emit to this output by; this\nshould correspond to the tag of some SideInputInfo.",
3459 "type": "string"
3460 }
3461 },
3462 "type": "object"
3463 },
3464 "SourceSplitRequest": {
3465 "description": "Represents the operation to split a high-level Sourc e specification\ninto bundles (parts for parallel processing).\n\nAt a high leve l, splitting of a source into bundles happens as follows:\nSourceSplitRequest is applied to the source. If it returns\nSOURCE_SPLIT_OUTCOME_USE_CURRENT, no furt her splitting happens and the source\nis used \"as is\". Otherwise, splitting is applied recursively to each\nproduced DerivedSource.\n\nAs an optimization, for any Source, if its does_not_need_splitting is\ntrue, the framework assumes that splitting this source would return\nSOURCE_SPLIT_OUTCOME_USE_CURRENT, and doesn 't initiate a SourceSplitRequest.\nThis applies both to the initial source being split and to bundles\nproduced from it.",
3466 "id": "SourceSplitRequest",
3467 "properties": {
3468 "options": {
3469 "$ref": "SourceSplitOptions",
3470 "description": "Hints for tuning the splitting process."
3471 },
3472 "source": {
3473 "$ref": "Source",
3474 "description": "Specification of the source to be split."
3475 }
3476 },
3477 "type": "object"
3478 },
3479 "SourceGetMetadataResponse": {
3480 "description": "The result of a SourceGetMetadataOperation.",
3481 "id": "SourceGetMetadataResponse",
3482 "properties": {
3483 "metadata": {
3484 "$ref": "SourceMetadata",
3485 "description": "The computed metadata."
3486 }
3487 },
3488 "type": "object"
3489 },
3490 "ShellTask": {
3491 "description": "A task which consists of a shell command for the wor ker to execute.",
3492 "id": "ShellTask",
3493 "properties": {
3494 "exitCode": {
3495 "description": "Exit code for the task.",
3496 "format": "int32",
3497 "type": "integer"
3498 },
3499 "command": {
3500 "description": "The shell command to run.",
3501 "type": "string"
3502 }
3503 },
3504 "type": "object"
3505 },
3506 "MetricShortId": {
3507 "description": "The metric short id is returned to the user alongsid e an offset into\nReportWorkItemStatusRequest",
3508 "id": "MetricShortId",
3509 "properties": {
3510 "metricIndex": {
3511 "description": "The index of the corresponding metric in\nth e ReportWorkItemStatusRequest. Required.",
3512 "format": "int32",
3513 "type": "integer"
3514 },
3515 "shortId": {
3516 "description": "The service-generated short identifier for t he metric.",
3517 "format": "int64",
3518 "type": "string"
3519 }
3520 },
3521 "type": "object"
3522 },
3523 "AutoscalingEvent": {
3524 "description": "A structured message reporting an autoscaling decisi on made by the Dataflow\nservice.",
3525 "id": "AutoscalingEvent",
3526 "properties": {
3527 "eventType": {
3528 "description": "The type of autoscaling event to report.",
3529 "enum": [
3530 "TYPE_UNKNOWN",
3531 "TARGET_NUM_WORKERS_CHANGED",
3532 "CURRENT_NUM_WORKERS_CHANGED",
3533 "ACTUATION_FAILURE",
3534 "NO_CHANGE"
3535 ],
3536 "enumDescriptions": [
3537 "Default type for the enum. Value should never be retur ned.",
3538 "The TARGET_NUM_WORKERS_CHANGED type should be used when the target\nworker pool size has changed at the start of an actuation. An event \nshould always be specified as TARGET_NUM_WORKERS_CHANGED if it reflects\na cha nge in the target_num_workers.",
3539 "The CURRENT_NUM_WORKERS_CHANGED type should be used whe n actual worker\npool size has been changed, but the target_num_workers has not changed.",
3540 "The ACTUATION_FAILURE type should be used when we want to report\nan error to the user indicating why the current number of workers\nin the pool could not be changed.\nDisplayed in the current status and history wid gets.",
3541 "Used when we want to report to the user a reason why we are\nnot currently adjusting the number of workers.\nShould specify both target _num_workers, current_num_workers and a\ndecision_message."
3542 ],
3543 "type": "string"
3544 },
3545 "targetNumWorkers": {
3546 "description": "The target number of workers the worker pool wants to resize to use.",
3547 "format": "int64",
3548 "type": "string"
3549 },
3550 "currentNumWorkers": {
3551 "description": "The current number of workers the job has.",
3552 "format": "int64",
3553 "type": "string"
3554 },
3555 "time": {
3556 "description": "The time this event was emitted to indicate a new target or current\nnum_workers value.",
3557 "format": "google-datetime",
3558 "type": "string"
3559 },
3560 "description": {
3561 "$ref": "StructuredMessage",
3562 "description": "A message describing why the system decided to adjust the current\nnumber of workers, why it failed, or why the system decid ed to\nnot make any changes to the number of workers."
3563 }
3564 },
3565 "type": "object"
3566 },
3567 "TaskRunnerSettings": {
3568 "description": "Taskrunner configuration settings.",
3569 "id": "TaskRunnerSettings",
3570 "properties": {
3571 "vmId": {
3572 "description": "The ID string of the VM.",
3573 "type": "string"
3574 },
3575 "taskUser": {
3576 "description": "The UNIX user ID on the worker VM to use for tasks launched by\ntaskrunner; e.g. \"root\".",
3577 "type": "string"
3578 },
3579 "alsologtostderr": {
3580 "description": "Whether to also send taskrunner log info to stderr.",
3581 "type": "boolean"
3582 },
3583 "taskGroup": {
3584 "description": "The UNIX group ID on the worker VM to use fo r tasks launched by\ntaskrunner; e.g. \"wheel\".",
3585 "type": "string"
3586 },
3587 "harnessCommand": {
3588 "description": "The command to launch the worker harness.",
3589 "type": "string"
3590 },
3591 "logDir": {
3592 "description": "The directory on the VM to store logs.",
3593 "type": "string"
3594 },
3595 "dataflowApiVersion": {
3596 "description": "The API version of endpoint, e.g. \"v1b3\"",
3597 "type": "string"
3598 },
3599 "oauthScopes": {
3600 "description": "The OAuth2 scopes to be requested by the tas krunner in order to\naccess the Cloud Dataflow API.",
3601 "items": {
3602 "type": "string"
3603 },
3604 "type": "array"
3605 },
3606 "streamingWorkerMainClass": {
3607 "description": "The streaming worker main class name.",
3608 "type": "string"
3609 },
3610 "logUploadLocation": {
3611 "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}",
3612 "type": "string"
3613 },
3614 "workflowFileName": {
3615 "description": "The file to store the workflow in.",
3616 "type": "string"
3617 },
3618 "languageHint": {
3619 "description": "The suggested backend language.",
3620 "type": "string"
3621 },
3622 "commandlinesFileName": {
3623 "description": "The file to store preprocessing commands in. ",
3624 "type": "string"
3625 },
3626 "tempStoragePrefix": {
3627 "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}",
3628 "type": "string"
3629 },
3630 "baseTaskDir": {
3631 "description": "The location on the worker for task-specific subdirectories.",
3632 "type": "string"
3633 },
3634 "baseUrl": {
3635 "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/\"",
3636 "type": "string"
3637 },
3638 "logToSerialconsole": {
3639 "description": "Whether to send taskrunner log info to Googl e Compute Engine VM serial\nconsole.",
3640 "type": "boolean"
3641 },
3642 "continueOnException": {
3643 "description": "Whether to continue taskrunner if an excepti on is hit.",
3644 "type": "boolean"
3645 },
3646 "parallelWorkerSettings": {
3647 "$ref": "WorkerSettings",
3648 "description": "The settings to pass to the parallel worker harness."
3649 }
3650 },
3651 "type": "object"
3652 },
3653 "Position": {
3654 "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.",
3655 "id": "Position",
3656 "properties": {
3657 "shufflePosition": {
3658 "description": "CloudPosition is a base64 encoded BatchShuff lePosition (with FIXED\nsharding).",
3659 "type": "string"
3660 },
3661 "byteOffset": {
3662 "description": "Position is a byte offset.",
3663 "format": "int64",
3664 "type": "string"
3665 },
3666 "concatPosition": {
3667 "$ref": "ConcatPosition",
3668 "description": "CloudPosition is a concat position."
3669 },
3670 "end": {
3671 "description": "Position is past all other positions. Also u seful for the end\nposition of an unbounded range.",
3672 "type": "boolean"
3673 },
3674 "key": {
3675 "description": "Position is a string key, ordered lexicograp hically.",
3676 "type": "string"
3677 },
3678 "recordIndex": {
3679 "description": "Position is a record index.",
3680 "format": "int64",
3681 "type": "string"
3682 }
3683 },
3684 "type": "object"
3685 },
3686 "Source": {
3687 "description": "A source that records can be read and decoded from." ,
3688 "id": "Source",
3689 "properties": {
3690 "metadata": {
3691 "$ref": "SourceMetadata",
3692 "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."
3693 },
3694 "baseSpecs": {
3695 "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).",
3696 "items": {
3697 "additionalProperties": {
3698 "description": "Properties of the object.",
3699 "type": "any"
3700 },
3701 "type": "object"
3702 },
3703 "type": "array"
3704 },
3705 "doesNotNeedSplitting": {
3706 "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.",
3707 "type": "boolean"
3708 },
3709 "codec": { 3110 "codec": {
3710 "additionalProperties": { 3111 "additionalProperties": {
3711 "description": "Properties of the object.", 3112 "description": "Properties of the object.",
3712 "type": "any" 3113 "type": "any"
3713 }, 3114 },
3714 "description": "The codec to use to decode data read from th e source.", 3115 "description": "The codec to use to encode data written to t he sink.",
3715 "type": "object" 3116 "type": "object"
3716 }, 3117 },
3717 "spec": { 3118 "spec": {
3718 "additionalProperties": { 3119 "additionalProperties": {
3719 "description": "Properties of the object.", 3120 "description": "Properties of the object.",
3720 "type": "any" 3121 "type": "any"
3721 }, 3122 },
3722 "description": "The source to read from, plus its parameters .", 3123 "description": "The sink to write to, plus its parameters.",
3723 "type": "object" 3124 "type": "object"
3724 } 3125 }
3725 }, 3126 },
3726 "type": "object" 3127 "type": "object"
3727 }, 3128 },
3728 "SplitInt64": { 3129 "FlattenInstruction": {
3729 "description": "A representation of an int64, n, that is immune to p recision loss when\nencoded in JSON.", 3130 "description": "An instruction that copies its inputs (zero or more) to its (single) output.",
3730 "id": "SplitInt64", 3131 "id": "FlattenInstruction",
3731 "properties": { 3132 "properties": {
3732 "lowBits": { 3133 "inputs": {
3733 "description": "The low order bits: n & 0xffffffff.", 3134 "description": "Describes the inputs to the flatten instruct ion.",
3734 "format": "uint32", 3135 "items": {
3735 "type": "integer" 3136 "$ref": "InstructionInput"
3736 }, 3137 },
3737 "highBits": { 3138 "type": "array"
3738 "description": "The high order bits, including the sign: n > > 32.", 3139 }
3140 },
3141 "type": "object"
3142 },
3143 "PartialGroupByKeyInstruction": {
3144 "description": "An instruction that does a partial group-by-key.\nOn e input and one output.",
3145 "id": "PartialGroupByKeyInstruction",
3146 "properties": {
3147 "originalCombineValuesInputStoreName": {
3148 "description": "If this instruction includes a combining fun ction this is the name of the\nintermediate store between the GBK and the Combin eValues.",
3149 "type": "string"
3150 },
3151 "sideInputs": {
3152 "description": "Zero or more side inputs.",
3153 "items": {
3154 "$ref": "SideInputInfo"
3155 },
3156 "type": "array"
3157 },
3158 "originalCombineValuesStepName": {
3159 "description": "If this instruction includes a combining fun ction, this is the name of the\nCombineValues instruction lifted into this instr uction.",
3160 "type": "string"
3161 },
3162 "input": {
3163 "$ref": "InstructionInput",
3164 "description": "Describes the input to the partial group-by- key instruction."
3165 },
3166 "inputElementCodec": {
3167 "additionalProperties": {
3168 "description": "Properties of the object.",
3169 "type": "any"
3170 },
3171 "description": "The codec to use for interpreting an element in the input PTable.",
3172 "type": "object"
3173 },
3174 "valueCombiningFn": {
3175 "additionalProperties": {
3176 "description": "Properties of the object.",
3177 "type": "any"
3178 },
3179 "description": "The value combining function to invoke.",
3180 "type": "object"
3181 }
3182 },
3183 "type": "object"
3184 },
3185 "StageSource": {
3186 "description": "Description of an input or output of an execution st age.",
3187 "id": "StageSource",
3188 "properties": {
3189 "sizeBytes": {
3190 "description": "Size of the source, if measurable.",
3191 "format": "int64",
3192 "type": "string"
3193 },
3194 "name": {
3195 "description": "Dataflow service generated name for this sou rce.",
3196 "type": "string"
3197 },
3198 "userName": {
3199 "description": "Human-readable name for this source; may be user or system generated.",
3200 "type": "string"
3201 },
3202 "originalTransformOrCollection": {
3203 "description": "User name for the original user transform or collection with which this\nsource is most closely associated.",
3204 "type": "string"
3205 }
3206 },
3207 "type": "object"
3208 },
3209 "InstructionInput": {
3210 "description": "An input of an instruction, as a reference to an out put of a\nproducer instruction.",
3211 "id": "InstructionInput",
3212 "properties": {
3213 "producerInstructionIndex": {
3214 "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.",
3739 "format": "int32", 3215 "format": "int32",
3740 "type": "integer" 3216 "type": "integer"
3741 } 3217 },
3742 }, 3218 "outputNum": {
3743 "type": "object" 3219 "description": "The output index (origin zero) within the pr oducer.",
3744 }, 3220 "format": "int32",
3745 "WorkerPool": { 3221 "type": "integer"
3746 "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.", 3222 }
3747 "id": "WorkerPool", 3223 },
3748 "properties": { 3224 "type": "object"
3749 "teardownPolicy": { 3225 },
3750 "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.", 3226 "StringList": {
3227 "description": "A metric value representing a list of strings.",
3228 "id": "StringList",
3229 "properties": {
3230 "elements": {
3231 "description": "Elements of the list.",
3232 "items": {
3233 "type": "string"
3234 },
3235 "type": "array"
3236 }
3237 },
3238 "type": "object"
3239 },
3240 "DisplayData": {
3241 "description": "Data provided with a pipeline or transform to provid e descriptive info.",
3242 "id": "DisplayData",
3243 "properties": {
3244 "strValue": {
3245 "description": "Contains value if the data is of string type .",
3246 "type": "string"
3247 },
3248 "int64Value": {
3249 "description": "Contains value if the data is of int64 type. ",
3250 "format": "int64",
3251 "type": "string"
3252 },
3253 "durationValue": {
3254 "description": "Contains value if the data is of duration ty pe.",
3255 "format": "google-duration",
3256 "type": "string"
3257 },
3258 "namespace": {
3259 "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.",
3260 "type": "string"
3261 },
3262 "floatValue": {
3263 "description": "Contains value if the data is of float type. ",
3264 "format": "float",
3265 "type": "number"
3266 },
3267 "key": {
3268 "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.",
3269 "type": "string"
3270 },
3271 "shortStrValue": {
3272 "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.",
3273 "type": "string"
3274 },
3275 "label": {
3276 "description": "An optional label to display in a dax UI for the element.",
3277 "type": "string"
3278 },
3279 "url": {
3280 "description": "An optional full URL.",
3281 "type": "string"
3282 },
3283 "timestampValue": {
3284 "description": "Contains value if the data is of timestamp t ype.",
3285 "format": "google-datetime",
3286 "type": "string"
3287 },
3288 "javaClassValue": {
3289 "description": "Contains value if the data is of java class type.",
3290 "type": "string"
3291 },
3292 "boolValue": {
3293 "description": "Contains value if the data is of a boolean t ype.",
3294 "type": "boolean"
3295 }
3296 },
3297 "type": "object"
3298 },
3299 "LeaseWorkItemRequest": {
3300 "description": "Request to lease WorkItems.",
3301 "id": "LeaseWorkItemRequest",
3302 "properties": {
3303 "currentWorkerTime": {
3304 "description": "The current timestamp at the worker.",
3305 "format": "google-datetime",
3306 "type": "string"
3307 },
3308 "location": {
3309 "description": "The location which contains the WorkItem's j ob.",
3310 "type": "string"
3311 },
3312 "workItemTypes": {
3313 "description": "Filter for WorkItem type.",
3314 "items": {
3315 "type": "string"
3316 },
3317 "type": "array"
3318 },
3319 "workerId": {
3320 "description": "Identifies the worker leasing work -- typica lly the ID of the\nvirtual machine running the worker.",
3321 "type": "string"
3322 },
3323 "workerCapabilities": {
3324 "description": "Worker capabilities. WorkItems might be limi ted to workers with specific\ncapabilities.",
3325 "items": {
3326 "type": "string"
3327 },
3328 "type": "array"
3329 },
3330 "requestedLeaseDuration": {
3331 "description": "The initial lease period.",
3332 "format": "google-duration",
3333 "type": "string"
3334 }
3335 },
3336 "type": "object"
3337 },
3338 "GetDebugConfigRequest": {
3339 "description": "Request to get updated debug configuration for compo nent.",
3340 "id": "GetDebugConfigRequest",
3341 "properties": {
3342 "componentId": {
3343 "description": "The internal component id for which debug co nfiguration is\nrequested.",
3344 "type": "string"
3345 },
3346 "workerId": {
3347 "description": "The worker id, i.e., VM hostname.",
3348 "type": "string"
3349 },
3350 "location": {
3351 "description": "The location which contains the job specifie d by job_id.",
3352 "type": "string"
3353 }
3354 },
3355 "type": "object"
3356 },
3357 "GetTemplateResponse": {
3358 "description": "The response to a GetTemplate request.",
3359 "id": "GetTemplateResponse",
3360 "properties": {
3361 "status": {
3362 "$ref": "Status",
3363 "description": "The status of the get template request. Any problems with the\nrequest will be indicated in the error_details."
3364 },
3365 "metadata": {
3366 "$ref": "TemplateMetadata",
3367 "description": "The template metadata describing the templat e name, available\nparameters, etc."
3368 }
3369 },
3370 "type": "object"
3371 },
3372 "Parameter": {
3373 "description": "Structured data associated with this message.",
3374 "id": "Parameter",
3375 "properties": {
3376 "key": {
3377 "description": "Key or name for this parameter.",
3378 "type": "string"
3379 },
3380 "value": {
3381 "description": "Value for this parameter.",
3382 "type": "any"
3383 }
3384 },
3385 "type": "object"
3386 },
3387 "ReportWorkItemStatusRequest": {
3388 "description": "Request to report the status of WorkItems.",
3389 "id": "ReportWorkItemStatusRequest",
3390 "properties": {
3391 "currentWorkerTime": {
3392 "description": "The current timestamp at the worker.",
3393 "format": "google-datetime",
3394 "type": "string"
3395 },
3396 "workerId": {
3397 "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).",
3398 "type": "string"
3399 },
3400 "location": {
3401 "description": "The location which contains the WorkItem's j ob.",
3402 "type": "string"
3403 },
3404 "workItemStatuses": {
3405 "description": "The order is unimportant, except that the or der of the\nWorkItemServiceState messages in the ReportWorkItemStatusResponse\nc orresponds to the order of WorkItemStatus messages here.",
3406 "items": {
3407 "$ref": "WorkItemStatus"
3408 },
3409 "type": "array"
3410 }
3411 },
3412 "type": "object"
3413 },
3414 "PipelineDescription": {
3415 "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." ,
3416 "id": "PipelineDescription",
3417 "properties": {
3418 "originalPipelineTransform": {
3419 "description": "Description of each transform in the pipelin e and collections between them.",
3420 "items": {
3421 "$ref": "TransformSummary"
3422 },
3423 "type": "array"
3424 },
3425 "displayData": {
3426 "description": "Pipeline level display data.",
3427 "items": {
3428 "$ref": "DisplayData"
3429 },
3430 "type": "array"
3431 },
3432 "executionPipelineStage": {
3433 "description": "Description of each stage of execution of th e pipeline.",
3434 "items": {
3435 "$ref": "ExecutionStageSummary"
3436 },
3437 "type": "array"
3438 }
3439 },
3440 "type": "object"
3441 },
3442 "StreamingConfigTask": {
3443 "description": "A task that carries configuration information for st reaming computations.",
3444 "id": "StreamingConfigTask",
3445 "properties": {
3446 "streamingComputationConfigs": {
3447 "description": "Set of computation configuration information .",
3448 "items": {
3449 "$ref": "StreamingComputationConfig"
3450 },
3451 "type": "array"
3452 },
3453 "windmillServiceEndpoint": {
3454 "description": "If present, the worker must use this endpoin t to communicate with Windmill\nService dispatchers, otherwise the worker must c ontinue to use whatever\nendpoint it had been using.",
3455 "type": "string"
3456 },
3457 "userStepToStateFamilyNameMap": {
3458 "additionalProperties": {
3459 "type": "string"
3460 },
3461 "description": "Map from user step names to state families." ,
3462 "type": "object"
3463 },
3464 "windmillServicePort": {
3465 "description": "If present, the worker must use this port to communicate with Windmill\nService dispatchers. Only applicable when windmill_s ervice_endpoint is\nspecified.",
3466 "format": "int64",
3467 "type": "string"
3468 }
3469 },
3470 "type": "object"
3471 },
3472 "JobExecutionInfo": {
3473 "description": "Additional information about how a Cloud Dataflow jo b will be executed that\nisn't contained in the submitted job.",
3474 "id": "JobExecutionInfo",
3475 "properties": {
3476 "stages": {
3477 "additionalProperties": {
3478 "$ref": "JobExecutionStageInfo"
3479 },
3480 "description": "A mapping from each stage to the information about that stage.",
3481 "type": "object"
3482 }
3483 },
3484 "type": "object"
3485 },
3486 "Step": {
3487 "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.",
3488 "id": "Step",
3489 "properties": {
3490 "name": {
3491 "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.",
3492 "type": "string"
3493 },
3494 "kind": {
3495 "description": "The kind of step in the Cloud Dataflow job." ,
3496 "type": "string"
3497 },
3498 "properties": {
3499 "additionalProperties": {
3500 "description": "Properties of the object.",
3501 "type": "any"
3502 },
3503 "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.",
3504 "type": "object"
3505 }
3506 },
3507 "type": "object"
3508 },
3509 "FailedLocation": {
3510 "description": "Indicates which location failed to respond to a requ est for data.",
3511 "id": "FailedLocation",
3512 "properties": {
3513 "name": {
3514 "description": "The name of the failed location.",
3515 "type": "string"
3516 }
3517 },
3518 "type": "object"
3519 },
3520 "Disk": {
3521 "description": "Describes the data disk used by a workflow job.",
3522 "id": "Disk",
3523 "properties": {
3524 "diskType": {
3525 "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",
3526 "type": "string"
3527 },
3528 "sizeGb": {
3529 "description": "Size of disk in GB. If zero or unspecified, the service will\nattempt to choose a reasonable default.",
3530 "format": "int32",
3531 "type": "integer"
3532 },
3533 "mountPoint": {
3534 "description": "Directory in a VM where disk is mounted.",
3535 "type": "string"
3536 }
3537 },
3538 "type": "object"
3539 },
3540 "CounterMetadata": {
3541 "description": "CounterMetadata includes all static non-name non-val ue counter attributes.",
3542 "id": "CounterMetadata",
3543 "properties": {
3544 "description": {
3545 "description": "Human-readable description of the counter se mantics.",
3546 "type": "string"
3547 },
3548 "kind": {
3549 "description": "Counter aggregation kind.",
3751 "enum": [ 3550 "enum": [
3752 "TEARDOWN_POLICY_UNKNOWN", 3551 "INVALID",
3753 "TEARDOWN_ALWAYS", 3552 "SUM",
3754 "TEARDOWN_ON_SUCCESS", 3553 "MAX",
3755 "TEARDOWN_NEVER" 3554 "MIN",
3555 "MEAN",
3556 "OR",
3557 "AND",
3558 "SET",
3559 "DISTRIBUTION"
3756 ], 3560 ],
3757 "enumDescriptions": [ 3561 "enumDescriptions": [
3758 "The teardown policy isn't specified, or is unknown.", 3562 "Counter aggregation kind was not set.",
3759 "Always teardown the resource.", 3563 "Aggregated value is the sum of all contributed values." ,
3760 "Teardown the resource on success. This is useful for de bugging\nfailures.", 3564 "Aggregated value is the max of all contributed values." ,
3761 "Never teardown the resource. This is useful for debuggi ng and\ndevelopment." 3565 "Aggregated value is the min of all contributed values." ,
3566 "Aggregated value is the mean of all contributed values. ",
3567 "Aggregated value represents the logical 'or' of all con tributed values.",
3568 "Aggregated value represents the logical 'and' of all co ntributed values.",
3569 "Aggregated value is a set of unique contributed values. ",
3570 "Aggregated value captures statistics about a distributi on."
3762 ], 3571 ],
3763 "type": "string" 3572 "type": "string"
3764 }, 3573 },
3765 "onHostMaintenance": { 3574 "standardUnits": {
3766 "description": "The action to take on host maintenance, as d efined by the Google\nCompute Engine API.", 3575 "description": "System defined Units, see above enum.",
3767 "type": "string" 3576 "enum": [
3768 }, 3577 "BYTES",
3769 "poolArgs": { 3578 "BYTES_PER_SEC",
3770 "additionalProperties": { 3579 "MILLISECONDS",
3771 "description": "Properties of the object. Contains field @type with type URL.", 3580 "MICROSECONDS",
3772 "type": "any" 3581 "NANOSECONDS",
3773 }, 3582 "TIMESTAMP_MSEC",
3774 "description": "Extra arguments for this worker pool.", 3583 "TIMESTAMP_USEC",
3775 "type": "object" 3584 "TIMESTAMP_NSEC"
3776 }, 3585 ],
3777 "diskSizeGb": { 3586 "enumDescriptions": [
3778 "description": "Size of root disk for VMs, in GB. If zero o r unspecified, the service will\nattempt to choose a reasonable default.", 3587 "Counter returns a value in bytes.",
3588 "Counter returns a value in bytes per second.",
3589 "Counter returns a value in milliseconds.",
3590 "Counter returns a value in microseconds.",
3591 "Counter returns a value in nanoseconds.",
3592 "Counter returns a timestamp in milliseconds.",
3593 "Counter returns a timestamp in microseconds.",
3594 "Counter returns a timestamp in nanoseconds."
3595 ],
3596 "type": "string"
3597 },
3598 "otherUnits": {
3599 "description": "A string referring to the unit type.",
3600 "type": "string"
3601 }
3602 },
3603 "type": "object"
3604 },
3605 "ListJobMessagesResponse": {
3606 "description": "Response to a request to list job messages.",
3607 "id": "ListJobMessagesResponse",
3608 "properties": {
3609 "jobMessages": {
3610 "description": "Messages in ascending timestamp order.",
3611 "items": {
3612 "$ref": "JobMessage"
3613 },
3614 "type": "array"
3615 },
3616 "nextPageToken": {
3617 "description": "The token to obtain the next page of results if there are more.",
3618 "type": "string"
3619 },
3620 "autoscalingEvents": {
3621 "description": "Autoscaling events in ascending timestamp or der.",
3622 "items": {
3623 "$ref": "AutoscalingEvent"
3624 },
3625 "type": "array"
3626 }
3627 },
3628 "type": "object"
3629 },
3630 "ApproximateReportedProgress": {
3631 "description": "A progress measurement of a WorkItem by a worker.",
3632 "id": "ApproximateReportedProgress",
3633 "properties": {
3634 "remainingParallelism": {
3635 "$ref": "ReportedParallelism",
3636 "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."
3637 },
3638 "position": {
3639 "$ref": "Position",
3640 "description": "A Position within the work to represent a pr ogress."
3641 },
3642 "fractionConsumed": {
3643 "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).",
3644 "format": "double",
3645 "type": "number"
3646 },
3647 "consumedParallelism": {
3648 "$ref": "ReportedParallelism",
3649 "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."
3650 }
3651 },
3652 "type": "object"
3653 },
3654 "IntegerList": {
3655 "description": "A metric value representing a list of integers.",
3656 "id": "IntegerList",
3657 "properties": {
3658 "elements": {
3659 "description": "Elements of the list.",
3660 "items": {
3661 "$ref": "SplitInt64"
3662 },
3663 "type": "array"
3664 }
3665 },
3666 "type": "object"
3667 },
3668 "StateFamilyConfig": {
3669 "description": "State family configuration.",
3670 "id": "StateFamilyConfig",
3671 "properties": {
3672 "isRead": {
3673 "description": "If true, this family corresponds to a read o peration.",
3674 "type": "boolean"
3675 },
3676 "stateFamily": {
3677 "description": "The state family value.",
3678 "type": "string"
3679 }
3680 },
3681 "type": "object"
3682 },
3683 "ResourceUtilizationReportResponse": {
3684 "description": "Service-side response to WorkerMessage reporting res ource utilization.",
3685 "id": "ResourceUtilizationReportResponse",
3686 "properties": {},
3687 "type": "object"
3688 },
3689 "SourceSplitResponse": {
3690 "description": "The response to a SourceSplitRequest.",
3691 "id": "SourceSplitResponse",
3692 "properties": {
3693 "outcome": {
3694 "description": "Indicates whether splitting happened and pro duced a list of bundles.\nIf this is USE_CURRENT_SOURCE_AS_IS, the current sourc e should\nbe processed \"as is\" without splitting. \"bundles\" is ignored in th is case.\nIf this is SPLITTING_HAPPENED, then \"bundles\" contains a list of\nbu ndles into which the source was split.",
3695 "enum": [
3696 "SOURCE_SPLIT_OUTCOME_UNKNOWN",
3697 "SOURCE_SPLIT_OUTCOME_USE_CURRENT",
3698 "SOURCE_SPLIT_OUTCOME_SPLITTING_HAPPENED"
3699 ],
3700 "enumDescriptions": [
3701 "The source split outcome is unknown, or unspecified.",
3702 "The current source should be processed \"as is\" withou t splitting.",
3703 "Splitting produced a list of bundles."
3704 ],
3705 "type": "string"
3706 },
3707 "bundles": {
3708 "description": "If outcome is SPLITTING_HAPPENED, then this is a list of bundles\ninto which the source was split. Otherwise this field is i gnored.\nThis list can be empty, which means the source represents an empty inpu t.",
3709 "items": {
3710 "$ref": "DerivedSource"
3711 },
3712 "type": "array"
3713 },
3714 "shards": {
3715 "description": "DEPRECATED in favor of bundles.",
3716 "items": {
3717 "$ref": "SourceSplitShard"
3718 },
3719 "type": "array"
3720 }
3721 },
3722 "type": "object"
3723 },
3724 "ParallelInstruction": {
3725 "description": "Describes a particular operation comprising a MapTas k.",
3726 "id": "ParallelInstruction",
3727 "properties": {
3728 "partialGroupByKey": {
3729 "$ref": "PartialGroupByKeyInstruction",
3730 "description": "Additional information for PartialGroupByKey instructions."
3731 },
3732 "outputs": {
3733 "description": "Describes the outputs of the instruction.",
3734 "items": {
3735 "$ref": "InstructionOutput"
3736 },
3737 "type": "array"
3738 },
3739 "name": {
3740 "description": "User-provided name of this operation.",
3741 "type": "string"
3742 },
3743 "read": {
3744 "$ref": "ReadInstruction",
3745 "description": "Additional information for Read instructions ."
3746 },
3747 "parDo": {
3748 "$ref": "ParDoInstruction",
3749 "description": "Additional information for ParDo instruction s."
3750 },
3751 "originalName": {
3752 "description": "System-defined name for the operation in the original workflow graph.",
3753 "type": "string"
3754 },
3755 "flatten": {
3756 "$ref": "FlattenInstruction",
3757 "description": "Additional information for Flatten instructi ons."
3758 },
3759 "write": {
3760 "$ref": "WriteInstruction",
3761 "description": "Additional information for Write instruction s."
3762 },
3763 "systemName": {
3764 "description": "System-defined name of this operation.\nUniq ue across the workflow.",
3765 "type": "string"
3766 }
3767 },
3768 "type": "object"
3769 },
3770 "KeyRangeDataDiskAssignment": {
3771 "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.",
3772 "id": "KeyRangeDataDiskAssignment",
3773 "properties": {
3774 "dataDisk": {
3775 "description": "The name of the data disk where data for thi s range is stored.\nThis name is local 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\".",
3776 "type": "string"
3777 },
3778 "start": {
3779 "description": "The start (inclusive) of the key range.",
3780 "type": "string"
3781 },
3782 "end": {
3783 "description": "The end (exclusive) of the key range.",
3784 "type": "string"
3785 }
3786 },
3787 "type": "object"
3788 },
3789 "Package": {
3790 "description": "The packages that must be installed in order for a w orker to run the\nsteps of the Cloud Dataflow job that will be assigned to its w orker\npool.\n\nThis is the mechanism by which the Cloud Dataflow SDK causes cod e to\nbe loaded onto the workers. For example, the Cloud Dataflow Java SDK\nmigh t use this to install jars containing the user's code and all of the\nvarious de pendencies (libraries, data files, etc.) required in order\nfor that code to run .",
3791 "id": "Package",
3792 "properties": {
3793 "location": {
3794 "description": "The resource to read the package from. The s upported resource type is:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/ {bucket}\n bucket.storage.googleapis.com/",
3795 "type": "string"
3796 },
3797 "name": {
3798 "description": "The name of the package.",
3799 "type": "string"
3800 }
3801 },
3802 "type": "object"
3803 },
3804 "ParDoInstruction": {
3805 "description": "An instruction that does a ParDo operation.\nTakes o ne main input and zero or more side inputs, and produces\nzero or more outputs.\ nRuns user code.",
3806 "id": "ParDoInstruction",
3807 "properties": {
3808 "numOutputs": {
3809 "description": "The number of outputs.",
3779 "format": "int32", 3810 "format": "int32",
3780 "type": "integer" 3811 "type": "integer"
3781 }, 3812 },
3782 "workerHarnessContainerImage": { 3813 "sideInputs": {
3783 "description": "Required. Docker container image that execut es the Cloud Dataflow worker\nharness, residing in Google Container Registry.", 3814 "description": "Zero or more side inputs.",
3784 "type": "string" 3815 "items": {
3785 }, 3816 "$ref": "SideInputInfo"
3786 "diskType": { 3817 },
3787 "description": "Type of root disk for VMs. If empty or unsp ecified, the service will\nattempt to choose a reasonable default.", 3818 "type": "array"
3788 "type": "string" 3819 },
3789 }, 3820 "multiOutputInfos": {
3790 "machineType": { 3821 "description": "Information about each of the outputs, if us er_fn is a MultiDoFn.",
3791 "description": "Machine type (e.g. \"n1-standard-1\"). If e mpty or unspecified, the\nservice will attempt to choose a reasonable default.", 3822 "items": {
3792 "type": "string" 3823 "$ref": "MultiOutputInfo"
3793 }, 3824 },
3794 "kind": { 3825 "type": "array"
3795 "description": "The kind of the worker pool; currently only `harness` and `shuffle`\nare supported.", 3826 },
3796 "type": "string" 3827 "userFn": {
3797 }, 3828 "additionalProperties": {
3798 "dataDisks": { 3829 "description": "Properties of the object.",
3799 "description": "Data disks that are used by a VM in this wor kflow.", 3830 "type": "any"
3800 "items": { 3831 },
3801 "$ref": "Disk" 3832 "description": "The user function to invoke.",
3802 }, 3833 "type": "object"
3803 "type": "array" 3834 },
3804 }, 3835 "input": {
3805 "subnetwork": { 3836 "$ref": "InstructionInput",
3806 "description": "Subnetwork to which VMs will be assigned, if desired. Expected to be of\nthe form \"regions/REGION/subnetworks/SUBNETWORK\" .", 3837 "description": "The input."
3807 "type": "string" 3838 }
3808 }, 3839 },
3809 "ipConfiguration": { 3840 "type": "object"
3810 "description": "Configuration for VM IPs.", 3841 },
3842 "WorkerShutdownNotice": {
3843 "description": "Shutdown notification from workers. This is to be se nt by the shutdown\nscript of the worker VM so that the backend knows that the V M is being\nshut down.",
3844 "id": "WorkerShutdownNotice",
3845 "properties": {
3846 "reason": {
3847 "description": "Optional reason to be attached for the shutd own notice.\nFor example: \"PREEMPTION\" would indicate the VM is being shut dow n because\nof preemption. Other possible reasons may be added in the future.",
3848 "type": "string"
3849 }
3850 },
3851 "type": "object"
3852 },
3853 "CounterStructuredName": {
3854 "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.",
3855 "id": "CounterStructuredName",
3856 "properties": {
3857 "workerId": {
3858 "description": "ID of a particular worker.",
3859 "type": "string"
3860 },
3861 "originNamespace": {
3862 "description": "A string containing a more specific namespac e of the counter's origin.",
3863 "type": "string"
3864 },
3865 "sideInput": {
3866 "$ref": "SideInputId",
3867 "description": "ID of a side input being read from/written t o. Side inputs are identified\nby a pair of (reader, input_index). The reader is usually equal to the\noriginal name, but it may be different, if a ParDo emits it's Iterator /\nMap side input object."
3868 },
3869 "executionStepName": {
3870 "description": "Name of the stage. An execution step contain s multiple component steps.",
3871 "type": "string"
3872 },
3873 "name": {
3874 "description": "Counter name. Not necessarily globally-uniqu e, but unique within the\ncontext of the other fields.\nRequired.",
3875 "type": "string"
3876 },
3877 "origin": {
3878 "description": "One of the standard Origins defined above.",
3811 "enum": [ 3879 "enum": [
3812 "WORKER_IP_UNSPECIFIED", 3880 "SYSTEM",
3813 "WORKER_IP_PUBLIC", 3881 "USER"
3814 "WORKER_IP_PRIVATE"
3815 ], 3882 ],
3816 "enumDescriptions": [ 3883 "enumDescriptions": [
3817 "The configuration is unknown, or unspecified.", 3884 "Counter was created by the Dataflow system.",
3818 "Workers should have public IP addresses.", 3885 "Counter was created by the user."
3819 "Workers should have private IP addresses."
3820 ], 3886 ],
3821 "type": "string" 3887 "type": "string"
3822 }, 3888 },
3823 "autoscalingSettings": { 3889 "componentStepName": {
3824 "$ref": "AutoscalingSettings", 3890 "description": "Name of the optimized step being executed by the workers.",
3825 "description": "Settings for autoscaling of this WorkerPool. " 3891 "type": "string"
3826 }, 3892 },
3827 "taskrunnerSettings": { 3893 "portion": {
3828 "$ref": "TaskRunnerSettings", 3894 "description": "Portion of this counter, either key or value .",
3829 "description": "Settings passed through to Google Compute En gine workers when\nusing the standard Dataflow task runner. Users should ignore \nthis field." 3895 "enum": [
3830 }, 3896 "ALL",
3831 "metadata": { 3897 "KEY",
3898 "VALUE"
3899 ],
3900 "enumDescriptions": [
3901 "Counter portion has not been set.",
3902 "Counter reports a key.",
3903 "Counter reports a value."
3904 ],
3905 "type": "string"
3906 },
3907 "originalShuffleStepName": {
3908 "description": "The GroupByKey step name from the original g raph.",
3909 "type": "string"
3910 },
3911 "originalStepName": {
3912 "description": "System generated name of the original step i n the user's graph, before\noptimization.",
3913 "type": "string"
3914 }
3915 },
3916 "type": "object"
3917 },
3918 "MetricUpdate": {
3919 "description": "Describes the state of a metric.",
3920 "id": "MetricUpdate",
3921 "properties": {
3922 "distribution": {
3923 "description": "A struct value describing properties of a di stribution of numeric values.",
3924 "type": "any"
3925 },
3926 "set": {
3927 "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.",
3928 "type": "any"
3929 },
3930 "internal": {
3931 "description": "Worker-computed aggregate value for internal use by the Dataflow\nservice.",
3932 "type": "any"
3933 },
3934 "cumulative": {
3935 "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.",
3936 "type": "boolean"
3937 },
3938 "kind": {
3939 "description": "Metric aggregation kind. The possible metri c aggregation kinds are\n\"Sum\", \"Max\", \"Min\", \"Mean\", \"Set\", \"And\", \"Or\", and \"Distribution\".\nThe specified aggregation kind is case-insensitiv e.\n\nIf omitted, this is not an aggregated value but instead\na single metric s ample value.",
3940 "type": "string"
3941 },
3942 "scalar": {
3943 "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.",
3944 "type": "any"
3945 },
3946 "meanCount": {
3947 "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.",
3948 "type": "any"
3949 },
3950 "meanSum": {
3951 "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.",
3952 "type": "any"
3953 },
3954 "updateTime": {
3955 "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.",
3956 "format": "google-datetime",
3957 "type": "string"
3958 },
3959 "name": {
3960 "$ref": "MetricStructuredName",
3961 "description": "Name of the metric."
3962 }
3963 },
3964 "type": "object"
3965 },
3966 "ApproximateProgress": {
3967 "description": "Obsolete in favor of ApproximateReportedProgress and ApproximateSplitRequest.",
3968 "id": "ApproximateProgress",
3969 "properties": {
3970 "position": {
3971 "$ref": "Position",
3972 "description": "Obsolete."
3973 },
3974 "percentComplete": {
3975 "description": "Obsolete.",
3976 "format": "float",
3977 "type": "number"
3978 },
3979 "remainingTime": {
3980 "description": "Obsolete.",
3981 "format": "google-duration",
3982 "type": "string"
3983 }
3984 },
3985 "type": "object"
3986 },
3987 "WorkerMessageResponse": {
3988 "description": "A worker_message response allows the server to pass information to the\nsender.",
3989 "id": "WorkerMessageResponse",
3990 "properties": {
3991 "workerShutdownNoticeResponse": {
3992 "$ref": "WorkerShutdownNoticeResponse",
3993 "description": "Service's response to shutdown notice (curre ntly empty)."
3994 },
3995 "workerMetricsResponse": {
3996 "$ref": "ResourceUtilizationReportResponse",
3997 "description": "Service's response to reporting worker metri cs (currently empty)."
3998 },
3999 "workerHealthReportResponse": {
4000 "$ref": "WorkerHealthReportResponse",
4001 "description": "The service's response to a worker's health report."
4002 }
4003 },
4004 "type": "object"
4005 },
4006 "TemplateMetadata": {
4007 "description": "Metadata describing a template.",
4008 "id": "TemplateMetadata",
4009 "properties": {
4010 "parameters": {
4011 "description": "The parameters for the template.",
4012 "items": {
4013 "$ref": "ParameterMetadata"
4014 },
4015 "type": "array"
4016 },
4017 "name": {
4018 "description": "Required. The name of the template.",
4019 "type": "string"
4020 },
4021 "description": {
4022 "description": "Optional. A description of the template.",
4023 "type": "string"
4024 }
4025 },
4026 "type": "object"
4027 },
4028 "WorkerMessage": {
4029 "description": "WorkerMessage provides information to the backend ab out a worker.",
4030 "id": "WorkerMessage",
4031 "properties": {
4032 "workerShutdownNotice": {
4033 "$ref": "WorkerShutdownNotice",
4034 "description": "Shutdown notice by workers."
4035 },
4036 "workerHealthReport": {
4037 "$ref": "WorkerHealthReport",
4038 "description": "The health of a worker."
4039 },
4040 "workerMessageCode": {
4041 "$ref": "WorkerMessageCode",
4042 "description": "A worker message code."
4043 },
4044 "workerMetrics": {
4045 "$ref": "ResourceUtilizationReport",
4046 "description": "Resource metrics reported by workers."
4047 },
4048 "labels": {
3832 "additionalProperties": { 4049 "additionalProperties": {
3833 "type": "string" 4050 "type": "string"
3834 }, 4051 },
3835 "description": "Metadata to set on the Google Compute Engine VMs.", 4052 "description": "Labels are used to group WorkerMessages.\nFo r example, a worker_message about a particular container\nmight have the labels: \n{ \"JOB_ID\": \"2015-04-22\",\n \"WORKER_ID\": \"wordcount-vm-2015…\"\n \"CO NTAINER_TYPE\": \"worker\",\n \"CONTAINER_ID\": \"ac1234def\"}\nLabel tags typi cally correspond to Label enum values. However, for ease\nof development other s trings can be used as tags. LABEL_UNSPECIFIED should\nnot be used here.",
3836 "type": "object" 4053 "type": "object"
3837 }, 4054 },
3838 "defaultPackageSet": { 4055 "time": {
3839 "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.", 4056 "description": "The timestamp of the worker_message.",
4057 "format": "google-datetime",
4058 "type": "string"
4059 }
4060 },
4061 "type": "object"
4062 },
4063 "WorkerShutdownNoticeResponse": {
4064 "description": "Service-side response to WorkerMessage issuing shutd own notice.",
4065 "id": "WorkerShutdownNoticeResponse",
4066 "properties": {},
4067 "type": "object"
4068 },
4069 "JobMetrics": {
4070 "description": "JobMetrics contains a collection of metrics descibin g the detailed progress\nof a Dataflow job. Metrics correspond to user-defined a nd system-defined\nmetrics in the job.\n\nThis resource captures only the most r ecent values of each metric;\ntime-series data can be queried for them (under th e same metric names)\nfrom Cloud Monitoring.",
4071 "id": "JobMetrics",
4072 "properties": {
4073 "metrics": {
4074 "description": "All metrics for this job.",
4075 "items": {
4076 "$ref": "MetricUpdate"
4077 },
4078 "type": "array"
4079 },
4080 "metricTime": {
4081 "description": "Timestamp as of which metric values are curr ent.",
4082 "format": "google-datetime",
4083 "type": "string"
4084 }
4085 },
4086 "type": "object"
4087 },
4088 "FloatingPointList": {
4089 "description": "A metric value representing a list of floating point numbers.",
4090 "id": "FloatingPointList",
4091 "properties": {
4092 "elements": {
4093 "description": "Elements of the list.",
4094 "items": {
4095 "format": "double",
4096 "type": "number"
4097 },
4098 "type": "array"
4099 }
4100 },
4101 "type": "object"
4102 },
4103 "CounterUpdate": {
4104 "description": "An update to a Counter sent from a worker.",
4105 "id": "CounterUpdate",
4106 "properties": {
4107 "boolean": {
4108 "description": "Boolean value for And, Or.",
4109 "type": "boolean"
4110 },
4111 "nameAndKind": {
4112 "$ref": "NameAndKind",
4113 "description": "Counter name and aggregation type."
4114 },
4115 "distribution": {
4116 "$ref": "DistributionUpdate",
4117 "description": "Distribution data"
4118 },
4119 "stringList": {
4120 "$ref": "StringList",
4121 "description": "List of strings, for Set."
4122 },
4123 "shortId": {
4124 "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.",
4125 "format": "int64",
4126 "type": "string"
4127 },
4128 "floatingPointList": {
4129 "$ref": "FloatingPointList",
4130 "description": "List of floating point numbers, for Set."
4131 },
4132 "integer": {
4133 "$ref": "SplitInt64",
4134 "description": "Integer value for Sum, Max, Min."
4135 },
4136 "integerList": {
4137 "$ref": "IntegerList",
4138 "description": "List of integers, for Set."
4139 },
4140 "structuredNameAndMetadata": {
4141 "$ref": "CounterStructuredNameAndMetadata",
4142 "description": "Counter structured name and metadata."
4143 },
4144 "integerMean": {
4145 "$ref": "IntegerMean",
4146 "description": "Integer mean aggregation value for Mean."
4147 },
4148 "floatingPoint": {
4149 "description": "Floating point value for Sum, Max, Min.",
4150 "format": "double",
4151 "type": "number"
4152 },
4153 "cumulative": {
4154 "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.",
4155 "type": "boolean"
4156 },
4157 "internal": {
4158 "description": "Value for internally-defined counters used b y the Dataflow service.",
4159 "type": "any"
4160 },
4161 "floatingPointMean": {
4162 "$ref": "FloatingPointMean",
4163 "description": "Floating point mean aggregation value for Me an."
4164 }
4165 },
4166 "type": "object"
4167 },
4168 "SourceMetadata": {
4169 "description": "Metadata about a Source useful for automatically opt imizing\nand tuning the pipeline, etc.",
4170 "id": "SourceMetadata",
4171 "properties": {
4172 "estimatedSizeBytes": {
4173 "description": "An estimate of the total size (in bytes) of the data that would be\nread from this source. This estimate is in terms of ext ernal storage\nsize, before any decompression or other processing done by the re ader.",
4174 "format": "int64",
4175 "type": "string"
4176 },
4177 "infinite": {
4178 "description": "Specifies that the size of this source is kn own to be infinite\n(this is a streaming source).",
4179 "type": "boolean"
4180 },
4181 "producesSortedKeys": {
4182 "description": "Whether this source is known to produce key/ value pairs with\nthe (encoded) keys in lexicographically sorted order.",
4183 "type": "boolean"
4184 }
4185 },
4186 "type": "object"
4187 },
4188 "DistributionUpdate": {
4189 "description": "A metric value representing a distribution.",
4190 "id": "DistributionUpdate",
4191 "properties": {
4192 "max": {
4193 "$ref": "SplitInt64",
4194 "description": "The maximum value present in the distributio n."
4195 },
4196 "logBuckets": {
4197 "description": "(Optional) Logarithmic histogram of values.\ nEach log may be in no more than one bucket. Order does not matter.",
4198 "items": {
4199 "$ref": "LogBucket"
4200 },
4201 "type": "array"
4202 },
4203 "count": {
4204 "$ref": "SplitInt64",
4205 "description": "The count of the number of elements present in the distribution."
4206 },
4207 "sumOfSquares": {
4208 "description": "Use a double since the sum of squares is lik ely to overflow int64.",
4209 "format": "double",
4210 "type": "number"
4211 },
4212 "min": {
4213 "$ref": "SplitInt64",
4214 "description": "The minimum value present in the distributio n."
4215 },
4216 "sum": {
4217 "$ref": "SplitInt64",
4218 "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."
4219 }
4220 },
4221 "type": "object"
4222 },
4223 "SourceFork": {
4224 "description": "DEPRECATED in favor of DynamicSourceSplit.",
4225 "id": "SourceFork",
4226 "properties": {
4227 "residual": {
4228 "$ref": "SourceSplitShard",
4229 "description": "DEPRECATED"
4230 },
4231 "residualSource": {
4232 "$ref": "DerivedSource",
4233 "description": "DEPRECATED"
4234 },
4235 "primary": {
4236 "$ref": "SourceSplitShard",
4237 "description": "DEPRECATED"
4238 },
4239 "primarySource": {
4240 "$ref": "DerivedSource",
4241 "description": "DEPRECATED"
4242 }
4243 },
4244 "type": "object"
4245 },
4246 "WorkerHealthReportResponse": {
4247 "description": "WorkerHealthReportResponse contains information retu rned to the worker\nin response to a health ping.",
4248 "id": "WorkerHealthReportResponse",
4249 "properties": {
4250 "reportInterval": {
4251 "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.",
4252 "format": "google-duration",
4253 "type": "string"
4254 }
4255 },
4256 "type": "object"
4257 },
4258 "WorkItemStatus": {
4259 "description": "Conveys a worker's progress through the work describ ed by a WorkItem.",
4260 "id": "WorkItemStatus",
4261 "properties": {
4262 "stopPosition": {
4263 "$ref": "Position",
4264 "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."
4265 },
4266 "completed": {
4267 "description": "True if the WorkItem was completed (successf ully or unsuccessfully).",
4268 "type": "boolean"
4269 },
4270 "reportedProgress": {
4271 "$ref": "ApproximateReportedProgress",
4272 "description": "The worker's progress through this WorkItem. "
4273 },
4274 "sourceFork": {
4275 "$ref": "SourceFork",
4276 "description": "DEPRECATED in favor of dynamic_source_split. "
4277 },
4278 "counterUpdates": {
4279 "description": "Worker output counters for this WorkItem.",
4280 "items": {
4281 "$ref": "CounterUpdate"
4282 },
4283 "type": "array"
4284 },
4285 "workItemId": {
4286 "description": "Identifies the WorkItem.",
4287 "type": "string"
4288 },
4289 "metricUpdates": {
4290 "description": "DEPRECATED in favor of counter_updates.",
4291 "items": {
4292 "$ref": "MetricUpdate"
4293 },
4294 "type": "array"
4295 },
4296 "errors": {
4297 "description": "Specifies errors which occurred during proce ssing. If errors are\nprovided, and completed = true, then the WorkItem is cons idered\nto have failed.",
4298 "items": {
4299 "$ref": "Status"
4300 },
4301 "type": "array"
4302 },
4303 "dynamicSourceSplit": {
4304 "$ref": "DynamicSourceSplit",
4305 "description": "See documentation of stop_position."
4306 },
4307 "sourceOperationResponse": {
4308 "$ref": "SourceOperationResponse",
4309 "description": "If the work item represented a SourceOperati onRequest, and the work\nis completed, contains the result of the operation."
4310 },
4311 "progress": {
4312 "$ref": "ApproximateProgress",
4313 "description": "DEPRECATED in favor of reported_progress."
4314 },
4315 "requestedLeaseDuration": {
4316 "description": "Amount of time the worker requests for its l ease.",
4317 "format": "google-duration",
4318 "type": "string"
4319 },
4320 "reportIndex": {
4321 "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.",
4322 "format": "int64",
4323 "type": "string"
4324 }
4325 },
4326 "type": "object"
4327 },
4328 "ComponentSource": {
4329 "description": "Description of an interstitial value between transfo rms in an execution\nstage.",
4330 "id": "ComponentSource",
4331 "properties": {
4332 "originalTransformOrCollection": {
4333 "description": "User name for the original user transform or collection with which this\nsource is most closely associated.",
4334 "type": "string"
4335 },
4336 "name": {
4337 "description": "Dataflow service generated name for this sou rce.",
4338 "type": "string"
4339 },
4340 "userName": {
4341 "description": "Human-readable name for this transform; may be user or system generated.",
4342 "type": "string"
4343 }
4344 },
4345 "type": "object"
4346 },
4347 "WorkItemServiceState": {
4348 "description": "The Dataflow service's idea of the current state of a WorkItem\nbeing processed by a worker.",
4349 "id": "WorkItemServiceState",
4350 "properties": {
4351 "harnessData": {
4352 "additionalProperties": {
4353 "description": "Properties of the object.",
4354 "type": "any"
4355 },
4356 "description": "Other data returned by the service, specific to the particular\nworker harness.",
4357 "type": "object"
4358 },
4359 "leaseExpireTime": {
4360 "description": "Time at which the current lease will expire. ",
4361 "format": "google-datetime",
4362 "type": "string"
4363 },
4364 "metricShortId": {
4365 "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.",
4366 "items": {
4367 "$ref": "MetricShortId"
4368 },
4369 "type": "array"
4370 },
4371 "nextReportIndex": {
4372 "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.",
4373 "format": "int64",
4374 "type": "string"
4375 },
4376 "suggestedStopPoint": {
4377 "$ref": "ApproximateProgress",
4378 "description": "DEPRECATED in favor of split_request."
4379 },
4380 "splitRequest": {
4381 "$ref": "ApproximateSplitRequest",
4382 "description": "The progress point in the WorkItem where the Dataflow service\nsuggests that the worker truncate the task."
4383 },
4384 "suggestedStopPosition": {
4385 "$ref": "Position",
4386 "description": "Obsolete, always empty."
4387 },
4388 "reportStatusInterval": {
4389 "description": "New recommended reporting interval.",
4390 "format": "google-duration",
4391 "type": "string"
4392 }
4393 },
4394 "type": "object"
4395 },
4396 "MetricStructuredName": {
4397 "description": "Identifies a metric, by describing the source which generated the\nmetric.",
4398 "id": "MetricStructuredName",
4399 "properties": {
4400 "name": {
4401 "description": "Worker-defined metric name.",
4402 "type": "string"
4403 },
4404 "origin": {
4405 "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.",
4406 "type": "string"
4407 },
4408 "context": {
4409 "additionalProperties": {
4410 "type": "string"
4411 },
4412 "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>.",
4413 "type": "object"
4414 }
4415 },
4416 "type": "object"
4417 },
4418 "SeqMapTaskOutputInfo": {
4419 "description": "Information about an output of a SeqMapTask.",
4420 "id": "SeqMapTaskOutputInfo",
4421 "properties": {
4422 "tag": {
4423 "description": "The id of the TupleTag the user code will ta g the output value by.",
4424 "type": "string"
4425 },
4426 "sink": {
4427 "$ref": "Sink",
4428 "description": "The sink to write the output value to."
4429 }
4430 },
4431 "type": "object"
4432 },
4433 "JobExecutionStageInfo": {
4434 "description": "Contains information about how a particular\ngoogle. dataflow.v1beta3.Step will be executed.",
4435 "id": "JobExecutionStageInfo",
4436 "properties": {
4437 "stepName": {
4438 "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.",
4439 "items": {
4440 "type": "string"
4441 },
4442 "type": "array"
4443 }
4444 },
4445 "type": "object"
4446 },
4447 "KeyRangeLocation": {
4448 "description": "Location information for a specific key-range of a s harded computation.\nCurrently we only support UTF-8 character splits to simplif y encoding into\nJSON.",
4449 "id": "KeyRangeLocation",
4450 "properties": {
4451 "deliveryEndpoint": {
4452 "description": "The physical location of this range assignme nt to be used for\nstreaming computation cross-worker message delivery.",
4453 "type": "string"
4454 },
4455 "dataDisk": {
4456 "description": "The name of the data disk where data for thi s range is stored.\nThis name is local 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\".",
4457 "type": "string"
4458 },
4459 "start": {
4460 "description": "The start (inclusive) of the key range.",
4461 "type": "string"
4462 },
4463 "end": {
4464 "description": "The end (exclusive) of the key range.",
4465 "type": "string"
4466 },
4467 "deprecatedPersistentDirectory": {
4468 "description": "DEPRECATED. The location of the persistent s tate for this range, as a\npersistent directory in the worker local filesystem." ,
4469 "type": "string"
4470 }
4471 },
4472 "type": "object"
4473 },
4474 "SourceGetMetadataRequest": {
4475 "description": "A request to compute the SourceMetadata of a Source. ",
4476 "id": "SourceGetMetadataRequest",
4477 "properties": {
4478 "source": {
4479 "$ref": "Source",
4480 "description": "Specification of the source whose metadata s hould be computed."
4481 }
4482 },
4483 "type": "object"
4484 },
4485 "NameAndKind": {
4486 "description": "Basic metadata about a counter.",
4487 "id": "NameAndKind",
4488 "properties": {
4489 "name": {
4490 "description": "Name of the counter.",
4491 "type": "string"
4492 },
4493 "kind": {
4494 "description": "Counter aggregation kind.",
3840 "enum": [ 4495 "enum": [
3841 "DEFAULT_PACKAGE_SET_UNKNOWN", 4496 "INVALID",
3842 "DEFAULT_PACKAGE_SET_NONE", 4497 "SUM",
3843 "DEFAULT_PACKAGE_SET_JAVA", 4498 "MAX",
3844 "DEFAULT_PACKAGE_SET_PYTHON" 4499 "MIN",
4500 "MEAN",
4501 "OR",
4502 "AND",
4503 "SET",
4504 "DISTRIBUTION"
3845 ], 4505 ],
3846 "enumDescriptions": [ 4506 "enumDescriptions": [
3847 "The default set of packages to stage is unknown, or uns pecified.", 4507 "Counter aggregation kind was not set.",
3848 "Indicates that no packages should be staged at the work er unless\nexplicitly specified by the job.", 4508 "Aggregated value is the sum of all contributed values." ,
3849 "Stage packages typically useful to workers written in J ava.", 4509 "Aggregated value is the max of all contributed values." ,
3850 "Stage pacakges typically useful to workers written in P ython." 4510 "Aggregated value is the min of all contributed values." ,
4511 "Aggregated value is the mean of all contributed values. ",
4512 "Aggregated value represents the logical 'or' of all con tributed values.",
4513 "Aggregated value represents the logical 'and' of all co ntributed values.",
4514 "Aggregated value is a set of unique contributed values. ",
4515 "Aggregated value captures statistics about a distributi on."
3851 ], 4516 ],
3852 "type": "string" 4517 "type": "string"
3853 }, 4518 }
3854 "network": { 4519 },
3855 "description": "Network to which VMs will be assigned. If e mpty or unspecified,\nthe service will use the network \"default\".", 4520 "type": "object"
3856 "type": "string" 4521 },
3857 }, 4522 "SeqMapTask": {
3858 "zone": { 4523 "description": "Describes a particular function to invoke.",
3859 "description": "Zone to run the worker pools in. If empty o r unspecified, the service\nwill attempt to choose a reasonable default.", 4524 "id": "SeqMapTask",
3860 "type": "string" 4525 "properties": {
3861 }, 4526 "userFn": {
3862 "numWorkers": { 4527 "additionalProperties": {
3863 "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.", 4528 "description": "Properties of the object.",
4529 "type": "any"
4530 },
4531 "description": "The user function to invoke.",
4532 "type": "object"
4533 },
4534 "name": {
4535 "description": "The user-provided name of the SeqDo operatio n.",
4536 "type": "string"
4537 },
4538 "outputInfos": {
4539 "description": "Information about each of the outputs.",
4540 "items": {
4541 "$ref": "SeqMapTaskOutputInfo"
4542 },
4543 "type": "array"
4544 },
4545 "inputs": {
4546 "description": "Information about each of the inputs.",
4547 "items": {
4548 "$ref": "SideInputInfo"
4549 },
4550 "type": "array"
4551 },
4552 "stageName": {
4553 "description": "System-defined name of the stage containing the SeqDo operation.\nUnique across the workflow.",
4554 "type": "string"
4555 },
4556 "systemName": {
4557 "description": "System-defined name of the SeqDo operation.\ nUnique across the workflow.",
4558 "type": "string"
4559 }
4560 },
4561 "type": "object"
4562 },
4563 "WorkerMessageCode": {
4564 "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).",
4565 "id": "WorkerMessageCode",
4566 "properties": {
4567 "parameters": {
4568 "additionalProperties": {
4569 "description": "Properties of the object.",
4570 "type": "any"
4571 },
4572 "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.",
4573 "type": "object"
4574 },
4575 "code": {
4576 "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.",
4577 "type": "string"
4578 }
4579 },
4580 "type": "object"
4581 },
4582 "CustomSourceLocation": {
4583 "description": "Identifies the location of a custom souce.",
4584 "id": "CustomSourceLocation",
4585 "properties": {
4586 "stateful": {
4587 "description": "Whether this source is stateful.",
4588 "type": "boolean"
4589 }
4590 },
4591 "type": "object"
4592 },
4593 "MapTask": {
4594 "description": "MapTask consists of an ordered set of instructions, each of which\ndescribes one particular low-level operation for the worker to\np erform in order to accomplish the MapTask's WorkItem.\n\nEach instruction must a ppear in the list before any instructions which\ndepends on its output.",
4595 "id": "MapTask",
4596 "properties": {
4597 "stageName": {
4598 "description": "System-defined name of the stage containing this MapTask.\nUnique across the workflow.",
4599 "type": "string"
4600 },
4601 "systemName": {
4602 "description": "System-defined name of this MapTask.\nUnique across the workflow.",
4603 "type": "string"
4604 },
4605 "instructions": {
4606 "description": "The instructions in the MapTask.",
4607 "items": {
4608 "$ref": "ParallelInstruction"
4609 },
4610 "type": "array"
4611 }
4612 },
4613 "type": "object"
4614 },
4615 "FloatingPointMean": {
4616 "description": "A representation of a floating point mean metric con tribution.",
4617 "id": "FloatingPointMean",
4618 "properties": {
4619 "sum": {
4620 "description": "The sum of all values being aggregated.",
4621 "format": "double",
4622 "type": "number"
4623 },
4624 "count": {
4625 "$ref": "SplitInt64",
4626 "description": "The number of values being aggregated."
4627 }
4628 },
4629 "type": "object"
4630 },
4631 "ReportWorkItemStatusResponse": {
4632 "description": "Response from a request to report the status of Work Items.",
4633 "id": "ReportWorkItemStatusResponse",
4634 "properties": {
4635 "workItemServiceStates": {
4636 "description": "A set of messages indicating the service-sid e state for each\nWorkItem whose status was reported, in the same order as the\n WorkItemStatus messages in the ReportWorkItemStatusRequest which\nresulting in t his response.",
4637 "items": {
4638 "$ref": "WorkItemServiceState"
4639 },
4640 "type": "array"
4641 }
4642 },
4643 "type": "object"
4644 },
4645 "InstructionOutput": {
4646 "description": "An output of an instruction.",
4647 "id": "InstructionOutput",
4648 "properties": {
4649 "codec": {
4650 "additionalProperties": {
4651 "description": "Properties of the object.",
4652 "type": "any"
4653 },
4654 "description": "The codec to use to encode data being writte n via this output.",
4655 "type": "object"
4656 },
4657 "name": {
4658 "description": "The user-provided name of this output.",
4659 "type": "string"
4660 },
4661 "originalName": {
4662 "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.",
4663 "type": "string"
4664 },
4665 "systemName": {
4666 "description": "System-defined name of this output.\nUnique across the workflow.",
4667 "type": "string"
4668 },
4669 "onlyCountKeyBytes": {
4670 "description": "For system-generated byte and mean byte metr ics, certain instructions\nshould only report the key size.",
4671 "type": "boolean"
4672 },
4673 "onlyCountValueBytes": {
4674 "description": "For system-generated byte and mean byte metr ics, certain instructions\nshould only report the value size.",
4675 "type": "boolean"
4676 }
4677 },
4678 "type": "object"
4679 },
4680 "CreateJobFromTemplateRequest": {
4681 "description": "A request to create a Cloud Dataflow job from a temp late.",
4682 "id": "CreateJobFromTemplateRequest",
4683 "properties": {
4684 "location": {
4685 "description": "The location to which to direct the request. ",
4686 "type": "string"
4687 },
4688 "parameters": {
4689 "additionalProperties": {
4690 "type": "string"
4691 },
4692 "description": "The runtime parameters to pass to the job.",
4693 "type": "object"
4694 },
4695 "jobName": {
4696 "description": "Required. The job name to use for the create d job.",
4697 "type": "string"
4698 },
4699 "gcsPath": {
4700 "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://`.",
4701 "type": "string"
4702 },
4703 "environment": {
4704 "$ref": "RuntimeEnvironment",
4705 "description": "The runtime environment for the job."
4706 }
4707 },
4708 "type": "object"
4709 },
4710 "IntegerMean": {
4711 "description": "A representation of an integer mean metric contribut ion.",
4712 "id": "IntegerMean",
4713 "properties": {
4714 "sum": {
4715 "$ref": "SplitInt64",
4716 "description": "The sum of all values being aggregated."
4717 },
4718 "count": {
4719 "$ref": "SplitInt64",
4720 "description": "The number of values being aggregated."
4721 }
4722 },
4723 "type": "object"
4724 },
4725 "ListJobsResponse": {
4726 "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.",
4727 "id": "ListJobsResponse",
4728 "properties": {
4729 "jobs": {
4730 "description": "A subset of the requested job information.",
4731 "items": {
4732 "$ref": "Job"
4733 },
4734 "type": "array"
4735 },
4736 "failedLocation": {
4737 "description": "Zero or more messages describing locations t hat failed to respond.",
4738 "items": {
4739 "$ref": "FailedLocation"
4740 },
4741 "type": "array"
4742 },
4743 "nextPageToken": {
4744 "description": "Set if there may be more results than fit in this response.",
4745 "type": "string"
4746 }
4747 },
4748 "type": "object"
4749 },
4750 "ComputationTopology": {
4751 "description": "All configuration data for a particular Computation. ",
4752 "id": "ComputationTopology",
4753 "properties": {
4754 "stateFamilies": {
4755 "description": "The state family values.",
4756 "items": {
4757 "$ref": "StateFamilyConfig"
4758 },
4759 "type": "array"
4760 },
4761 "outputs": {
4762 "description": "The outputs from the computation.",
4763 "items": {
4764 "$ref": "StreamLocation"
4765 },
4766 "type": "array"
4767 },
4768 "systemStageName": {
4769 "description": "The system stage name.",
4770 "type": "string"
4771 },
4772 "computationId": {
4773 "description": "The ID of the computation.",
4774 "type": "string"
4775 },
4776 "inputs": {
4777 "description": "The inputs to the computation.",
4778 "items": {
4779 "$ref": "StreamLocation"
4780 },
4781 "type": "array"
4782 },
4783 "keyRanges": {
4784 "description": "The key ranges processed by the computation. ",
4785 "items": {
4786 "$ref": "KeyRangeLocation"
4787 },
4788 "type": "array"
4789 }
4790 },
4791 "type": "object"
4792 },
4793 "RuntimeEnvironment": {
4794 "description": "The environment values to set at runtime.",
4795 "id": "RuntimeEnvironment",
4796 "properties": {
4797 "maxWorkers": {
4798 "description": "The maximum number of Google Compute Engine instances to be made\navailable to your pipeline during execution, from 1 to 100 0.",
3864 "format": "int32", 4799 "format": "int32",
3865 "type": "integer" 4800 "type": "integer"
3866 }, 4801 },
3867 "numThreadsPerWorker": { 4802 "serviceAccountEmail": {
3868 "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).", 4803 "description": "The email address of the service account to run the job as.",
3869 "format": "int32", 4804 "type": "string"
3870 "type": "integer" 4805 },
3871 }, 4806 "tempLocation": {
3872 "diskSourceImage": { 4807 "description": "The Cloud Storage path to use for temporary files.\nMust be a valid Cloud Storage URL, beginning with `gs://`.",
3873 "description": "Fully qualified source image for disks.", 4808 "type": "string"
3874 "type": "string" 4809 },
3875 }, 4810 "bypassTempDirValidation": {
3876 "packages": { 4811 "description": "Whether to bypass the safety checks for the job's temporary directory.\nUse with caution.",
3877 "description": "Packages to be installed on workers.",
3878 "items": {
3879 "$ref": "Package"
3880 },
3881 "type": "array"
3882 }
3883 },
3884 "type": "object"
3885 },
3886 "SourceOperationRequest": {
3887 "description": "A work item that represents the different operations that can be\nperformed on a user-defined Source specification.",
3888 "id": "SourceOperationRequest",
3889 "properties": {
3890 "split": {
3891 "$ref": "SourceSplitRequest",
3892 "description": "Information about a request to split a sourc e."
3893 },
3894 "getMetadata": {
3895 "$ref": "SourceGetMetadataRequest",
3896 "description": "Information about a request to get metadata about a source."
3897 }
3898 },
3899 "type": "object"
3900 },
3901 "WorkItem": {
3902 "description": "WorkItem represents basic information about a WorkIt em to be executed\nin the cloud.",
3903 "id": "WorkItem",
3904 "properties": {
3905 "streamingComputationTask": {
3906 "$ref": "StreamingComputationTask",
3907 "description": "Additional information for StreamingComputat ionTask WorkItems."
3908 },
3909 "shellTask": {
3910 "$ref": "ShellTask",
3911 "description": "Additional information for ShellTask WorkIte ms."
3912 },
3913 "jobId": {
3914 "description": "Identifies the workflow job this WorkItem be longs to.",
3915 "type": "string"
3916 },
3917 "id": {
3918 "description": "Identifies this WorkItem.",
3919 "format": "int64",
3920 "type": "string"
3921 },
3922 "configuration": {
3923 "description": "Work item-specific configuration as an opaqu e blob.",
3924 "type": "string"
3925 },
3926 "mapTask": {
3927 "$ref": "MapTask",
3928 "description": "Additional information for MapTask WorkItems ."
3929 },
3930 "seqMapTask": {
3931 "$ref": "SeqMapTask",
3932 "description": "Additional information for SeqMapTask WorkIt ems."
3933 },
3934 "packages": {
3935 "description": "Any required packages that need to be fetche d in order to execute\nthis WorkItem.",
3936 "items": {
3937 "$ref": "Package"
3938 },
3939 "type": "array"
3940 },
3941 "projectId": {
3942 "description": "Identifies the cloud project this WorkItem b elongs to.",
3943 "type": "string"
3944 },
3945 "sourceOperationTask": {
3946 "$ref": "SourceOperationRequest",
3947 "description": "Additional information for source operation WorkItems."
3948 },
3949 "reportStatusInterval": {
3950 "description": "Recommended reporting interval.",
3951 "format": "google-duration",
3952 "type": "string"
3953 },
3954 "streamingSetupTask": {
3955 "$ref": "StreamingSetupTask",
3956 "description": "Additional information for StreamingSetupTas k WorkItems."
3957 },
3958 "streamingConfigTask": {
3959 "$ref": "StreamingConfigTask",
3960 "description": "Additional information for StreamingConfigTa sk WorkItems."
3961 },
3962 "leaseExpireTime": {
3963 "description": "Time when the lease on this Work will expire .",
3964 "format": "google-datetime",
3965 "type": "string"
3966 },
3967 "initialReportIndex": {
3968 "description": "The initial index to use when reporting the status of the WorkItem.",
3969 "format": "int64",
3970 "type": "string"
3971 }
3972 },
3973 "type": "object"
3974 },
3975 "StructuredMessage": {
3976 "description": "A rich message format, including a human readable st ring, a key for\nidentifying the message, and structured data associated with th e message for\nprogrammatic consumption.",
3977 "id": "StructuredMessage",
3978 "properties": {
3979 "messageKey": {
3980 "description": "Idenfier for this message type. Used by ext ernal systems to\ninternationalize or personalize message.",
3981 "type": "string"
3982 },
3983 "messageText": {
3984 "description": "Human-readable version of message.",
3985 "type": "string"
3986 },
3987 "parameters": {
3988 "description": "The structured data associated with this mes sage.",
3989 "items": {
3990 "$ref": "Parameter"
3991 },
3992 "type": "array"
3993 }
3994 },
3995 "type": "object"
3996 },
3997 "ReportedParallelism": {
3998 "description": "Represents the level of parallelism in a WorkItem's input,\nreported by the worker.",
3999 "id": "ReportedParallelism",
4000 "properties": {
4001 "isInfinite": {
4002 "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.",
4003 "type": "boolean" 4812 "type": "boolean"
4004 }, 4813 },
4005 "value": { 4814 "machineType": {
4006 "description": "Specifies the level of parallelism in case i t is finite.", 4815 "description": "The machine type to use for the job. Default s to the value from the\ntemplate if not specified.",
4007 "format": "double", 4816 "type": "string"
4008 "type": "number" 4817 },
4009 } 4818 "zone": {
4010 }, 4819 "description": "The Compute Engine [availability\nzone](http s://cloud.google.com/compute/docs/regions-zones/regions-zones)\nfor launching wo rker instances to run your pipeline.",
4011 "type": "object" 4820 "type": "string"
4012 }, 4821 }
4013 "ResourceUtilizationReport": { 4822 },
4014 "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.", 4823 "type": "object"
4015 "id": "ResourceUtilizationReport", 4824 },
4016 "properties": { 4825 "MountedDataDisk": {
4017 "cpuTime": { 4826 "description": "Describes mounted data disk.",
4018 "description": "CPU utilization samples.", 4827 "id": "MountedDataDisk",
4019 "items": { 4828 "properties": {
4020 "$ref": "CPUTime" 4829 "dataDisk": {
4021 }, 4830 "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\".",
4022 "type": "array" 4831 "type": "string"
4023 } 4832 }
4024 }, 4833 },
4025 "type": "object" 4834 "type": "object"
4026 }, 4835 },
4027 "TopologyConfig": { 4836 "StreamingSideInputLocation": {
4028 "description": "Global topology of the streaming Dataflow job, inclu ding all\ncomputations and their sharded locations.", 4837 "description": "Identifies the location of a streaming side input.",
4029 "id": "TopologyConfig", 4838 "id": "StreamingSideInputLocation",
4030 "properties": { 4839 "properties": {
4031 "userStageToComputationNameMap": { 4840 "stateFamily": {
4032 "additionalProperties": { 4841 "description": "Identifies the state family where this side input is stored.",
4033 "type": "string" 4842 "type": "string"
4034 }, 4843 },
4035 "description": "Maps user stage names to stable computation names.", 4844 "tag": {
4036 "type": "object" 4845 "description": "Identifies the particular side input within the streaming Dataflow job.",
4037 }, 4846 "type": "string"
4038 "computations": { 4847 }
4039 "description": "The computations associated with a streaming Dataflow job.", 4848 },
4040 "items": { 4849 "type": "object"
4041 "$ref": "ComputationTopology" 4850 },
4042 }, 4851 "LaunchTemplateResponse": {
4043 "type": "array" 4852 "description": "Response to the request to launch a template.",
4044 }, 4853 "id": "LaunchTemplateResponse",
4045 "persistentStateVersion": { 4854 "properties": {
4046 "description": "Version number for persistent state.", 4855 "job": {
4047 "format": "int32", 4856 "$ref": "Job",
4048 "type": "integer" 4857 "description": "The job that was launched, if the request wa s not a dry run and\nthe job was successfully launched."
4049 }, 4858 }
4050 "dataDiskAssignments": { 4859 },
4051 "description": "The disks assigned to a streaming Dataflow j ob.", 4860 "type": "object"
4052 "items": { 4861 },
4053 "$ref": "DataDiskAssignment" 4862 "Job": {
4054 }, 4863 "description": "Defines a job to be run by the Cloud Dataflow servic e.",
4055 "type": "array" 4864 "id": "Job",
4056 }, 4865 "properties": {
4057 "forwardingKeyBits": { 4866 "requestedState": {
4058 "description": "The size (in bits) of keys that will be assi gned to source messages.", 4867 "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.",
4059 "format": "int32",
4060 "type": "integer"
4061 }
4062 },
4063 "type": "object"
4064 },
4065 "SourceSplitOptions": {
4066 "description": "Hints for splitting a Source into bundles (parts for parallel\nprocessing) using SourceSplitRequest.",
4067 "id": "SourceSplitOptions",
4068 "properties": {
4069 "desiredBundleSizeBytes": {
4070 "description": "The source should be split into a set of bun dles where the estimated size\nof each is approximately this many bytes.",
4071 "format": "int64",
4072 "type": "string"
4073 },
4074 "desiredShardSizeBytes": {
4075 "description": "DEPRECATED in favor of desired_bundle_size_b ytes.",
4076 "format": "int64",
4077 "type": "string"
4078 }
4079 },
4080 "type": "object"
4081 },
4082 "ReadInstruction": {
4083 "description": "An instruction that reads records.\nTakes no inputs, produces one output.",
4084 "id": "ReadInstruction",
4085 "properties": {
4086 "source": {
4087 "$ref": "Source",
4088 "description": "The source to read from."
4089 }
4090 },
4091 "type": "object"
4092 },
4093 "WorkerSettings": {
4094 "description": "Provides data to pass through to the worker harness. ",
4095 "id": "WorkerSettings",
4096 "properties": {
4097 "servicePath": {
4098 "description": "The Cloud Dataflow service path relative to the root URL, for example,\n\"dataflow/v1b3/projects\".",
4099 "type": "string"
4100 },
4101 "shuffleServicePath": {
4102 "description": "The Shuffle service path relative to the roo t URL, for example,\n\"shuffle/v1beta1\".",
4103 "type": "string"
4104 },
4105 "workerId": {
4106 "description": "The ID of the worker running this pipeline." ,
4107 "type": "string"
4108 },
4109 "tempStoragePrefix": {
4110 "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}",
4111 "type": "string"
4112 },
4113 "baseUrl": {
4114 "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/\"",
4115 "type": "string"
4116 },
4117 "reportingEnabled": {
4118 "description": "Whether to send work progress updates to the service.",
4119 "type": "boolean"
4120 }
4121 },
4122 "type": "object"
4123 },
4124 "StreamingStageLocation": {
4125 "description": "Identifies the location of a streaming computation s tage, for\nstage-to-stage communication.",
4126 "id": "StreamingStageLocation",
4127 "properties": {
4128 "streamId": {
4129 "description": "Identifies the particular stream within the streaming Dataflow\njob.",
4130 "type": "string"
4131 }
4132 },
4133 "type": "object"
4134 },
4135 "DataDiskAssignment": {
4136 "description": "Data disk assignment for a given VM instance.",
4137 "id": "DataDiskAssignment",
4138 "properties": {
4139 "vmInstance": {
4140 "description": "VM instance name the data disks mounted to, for example\n\"myproject-1014-104817-4c2-harness-0\".",
4141 "type": "string"
4142 },
4143 "dataDisks": {
4144 "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\" }.",
4145 "items": {
4146 "type": "string"
4147 },
4148 "type": "array"
4149 }
4150 },
4151 "type": "object"
4152 },
4153 "ApproximateSplitRequest": {
4154 "description": "A suggestion by the service to the worker to dynamic ally split the WorkItem.",
4155 "id": "ApproximateSplitRequest",
4156 "properties": {
4157 "position": {
4158 "$ref": "Position",
4159 "description": "A Position at which to split the work item."
4160 },
4161 "fractionConsumed": {
4162 "description": "A fraction at which to split the work item, from 0.0 (beginning of the\ninput) to 1.0 (end of the input).",
4163 "format": "double",
4164 "type": "number"
4165 }
4166 },
4167 "type": "object"
4168 },
4169 "Status": {
4170 "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` that can be used for common error conditions.\n\n# Lang uage 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` mess age is\nexposed in different client libraries and different wire protocols, it c an be\nmapped differently. For example, it will likely be mapped to some excepti ons\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\nenvironm ents, either with or without APIs, to provide a\nconsistent developer experience 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 m ay\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\ n- Asynchronous operations. If an API call embeds asynchronous operation\n re sults in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are store d in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
4171 "id": "Status",
4172 "properties": {
4173 "code": {
4174 "description": "The status code, which should be an enum val ue of google.rpc.Code.",
4175 "format": "int32",
4176 "type": "integer"
4177 },
4178 "message": {
4179 "description": "A developer-facing error message, which shou ld be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
4180 "type": "string"
4181 },
4182 "details": {
4183 "description": "A list of messages that carry the error deta ils. There is a common set of\nmessage types for APIs to use.",
4184 "items": {
4185 "additionalProperties": {
4186 "description": "Properties of the object. Contains f ield @type with type URL.",
4187 "type": "any"
4188 },
4189 "type": "object"
4190 },
4191 "type": "array"
4192 }
4193 },
4194 "type": "object"
4195 },
4196 "ExecutionStageState": {
4197 "description": "A message describing the state of a particular execu tion stage.",
4198 "id": "ExecutionStageState",
4199 "properties": {
4200 "executionStageState": {
4201 "description": "Executions stage states allow the same set o f values as JobState.",
4202 "enum": [ 4868 "enum": [
4203 "JOB_STATE_UNKNOWN", 4869 "JOB_STATE_UNKNOWN",
4204 "JOB_STATE_STOPPED", 4870 "JOB_STATE_STOPPED",
4205 "JOB_STATE_RUNNING", 4871 "JOB_STATE_RUNNING",
4206 "JOB_STATE_DONE", 4872 "JOB_STATE_DONE",
4207 "JOB_STATE_FAILED", 4873 "JOB_STATE_FAILED",
4208 "JOB_STATE_CANCELLED", 4874 "JOB_STATE_CANCELLED",
4209 "JOB_STATE_UPDATED", 4875 "JOB_STATE_UPDATED",
4210 "JOB_STATE_DRAINING", 4876 "JOB_STATE_DRAINING",
4211 "JOB_STATE_DRAINED", 4877 "JOB_STATE_DRAINED",
4212 "JOB_STATE_PENDING", 4878 "JOB_STATE_PENDING",
4213 "JOB_STATE_CANCELLING" 4879 "JOB_STATE_CANCELLING"
4214 ], 4880 ],
4215 "enumDescriptions": [ 4881 "enumDescriptions": [
4216 "The job's run state isn't specified.", 4882 "The job's run state isn't specified.",
4217 "`JOB_STATE_STOPPED` indicates that the job has not\nyet started to run.", 4883 "`JOB_STATE_STOPPED` indicates that the job has not\nyet started to run.",
4218 "`JOB_STATE_RUNNING` indicates that the job is currently running.", 4884 "`JOB_STATE_RUNNING` indicates that the job is currently running.",
4219 "`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.", 4885 "`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.",
4220 "`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`.", 4886 "`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`.",
4221 "`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.", 4887 "`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.",
4222 "`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`.", 4888 "`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`.",
4223 "`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`.", 4889 "`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`.",
4224 "`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`.", 4890 "`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`.",
4225 "'JOB_STATE_PENDING' indicates that the job has been cre ated but is not yet\nrunning. Jobs that are pending may only transition to `JOB _STATE_RUNNING`,\nor `JOB_STATE_FAILED`.", 4891 "'JOB_STATE_PENDING' indicates that the job has been cre ated but is not yet\nrunning. Jobs that are pending may only transition to `JOB _STATE_RUNNING`,\nor `JOB_STATE_FAILED`.",
4226 "'JOB_STATE_CANCELLING' indicates that the job has been explicitly cancelled\nand is in the process of stopping. Jobs that are cancelli ng may only\ntransition to 'JOB_STATE_CANCELLED' or 'JOB_STATE_FAILED'." 4892 "'JOB_STATE_CANCELLING' indicates that the job has been explicitly cancelled\nand is in the process of stopping. Jobs that are cancelli ng may only\ntransition to 'JOB_STATE_CANCELLED' or 'JOB_STATE_FAILED'."
4227 ], 4893 ],
4228 "type": "string" 4894 "type": "string"
4229 }, 4895 },
4230 "executionStageName": { 4896 "tempFiles": {
4231 "description": "The name of the execution stage.", 4897 "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}",
4232 "type": "string"
4233 },
4234 "currentStateTime": {
4235 "description": "The time at which the stage transitioned to this state.",
4236 "format": "google-datetime",
4237 "type": "string"
4238 }
4239 },
4240 "type": "object"
4241 },
4242 "StreamLocation": {
4243 "description": "Describes a stream of data, either as input to be pr ocessed or as\noutput of a streaming Dataflow job.",
4244 "id": "StreamLocation",
4245 "properties": {
4246 "customSourceLocation": {
4247 "$ref": "CustomSourceLocation",
4248 "description": "The stream is a custom source."
4249 },
4250 "sideInputLocation": {
4251 "$ref": "StreamingSideInputLocation",
4252 "description": "The stream is a streaming side input."
4253 },
4254 "pubsubLocation": {
4255 "$ref": "PubsubLocation",
4256 "description": "The stream is a pubsub stream."
4257 },
4258 "streamingStageLocation": {
4259 "$ref": "StreamingStageLocation",
4260 "description": "The stream is part of another computation wi thin the current\nstreaming Dataflow job."
4261 }
4262 },
4263 "type": "object"
4264 },
4265 "SendWorkerMessagesResponse": {
4266 "description": "The response to the worker messages.",
4267 "id": "SendWorkerMessagesResponse",
4268 "properties": {
4269 "workerMessageResponses": {
4270 "description": "The servers response to the worker messages. ",
4271 "items": {
4272 "$ref": "WorkerMessageResponse"
4273 },
4274 "type": "array"
4275 }
4276 },
4277 "type": "object"
4278 },
4279 "StreamingComputationConfig": {
4280 "description": "Configuration information for a single streaming com putation.",
4281 "id": "StreamingComputationConfig",
4282 "properties": {
4283 "computationId": {
4284 "description": "Unique identifier for this computation.",
4285 "type": "string"
4286 },
4287 "stageName": {
4288 "description": "Stage name of this computation.",
4289 "type": "string"
4290 },
4291 "systemName": {
4292 "description": "System defined name for this computation.",
4293 "type": "string"
4294 },
4295 "instructions": {
4296 "description": "Instructions that comprise the computation." ,
4297 "items": {
4298 "$ref": "ParallelInstruction"
4299 },
4300 "type": "array"
4301 }
4302 },
4303 "type": "object"
4304 },
4305 "TransformSummary": {
4306 "description": "Description of the type, names/ids, and input/output s for a transform.",
4307 "id": "TransformSummary",
4308 "properties": {
4309 "inputCollectionName": {
4310 "description": "User names for all collection inputs to this transform.",
4311 "items": { 4898 "items": {
4312 "type": "string" 4899 "type": "string"
4313 }, 4900 },
4314 "type": "array" 4901 "type": "array"
4315 }, 4902 },
4903 "clientRequestId": {
4904 "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.",
4905 "type": "string"
4906 },
4316 "name": { 4907 "name": {
4317 "description": "User provided name for this transform instan ce.", 4908 "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])?`",
4909 "type": "string"
4910 },
4911 "steps": {
4912 "description": "The top-level steps that constitute the enti re job.",
4913 "items": {
4914 "$ref": "Step"
4915 },
4916 "type": "array"
4917 },
4918 "replacedByJobId": {
4919 "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.",
4318 "type": "string" 4920 "type": "string"
4319 }, 4921 },
4320 "id": { 4922 "id": {
4321 "description": "SDK generated id of this transform instance. ", 4923 "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.",
4322 "type": "string" 4924 "type": "string"
4323 }, 4925 },
4324 "outputCollectionName": { 4926 "executionInfo": {
4325 "description": "User names for all collection outputs to th is transform.", 4927 "$ref": "JobExecutionInfo",
4326 "items": { 4928 "description": "Deprecated."
4327 "type": "string" 4929 },
4328 }, 4930 "currentState": {
4329 "type": "array" 4931 "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 .",
4330 },
4331 "displayData": {
4332 "description": "Transform-specific display data.",
4333 "items": {
4334 "$ref": "DisplayData"
4335 },
4336 "type": "array"
4337 },
4338 "kind": {
4339 "description": "Type of transform.",
4340 "enum": [ 4932 "enum": [
4341 "UNKNOWN_KIND", 4933 "JOB_STATE_UNKNOWN",
4342 "PAR_DO_KIND", 4934 "JOB_STATE_STOPPED",
4343 "GROUP_BY_KEY_KIND", 4935 "JOB_STATE_RUNNING",
4344 "FLATTEN_KIND", 4936 "JOB_STATE_DONE",
4345 "READ_KIND", 4937 "JOB_STATE_FAILED",
4346 "WRITE_KIND", 4938 "JOB_STATE_CANCELLED",
4347 "CONSTANT_KIND", 4939 "JOB_STATE_UPDATED",
4348 "SINGLETON_KIND", 4940 "JOB_STATE_DRAINING",
4349 "SHUFFLE_KIND" 4941 "JOB_STATE_DRAINED",
4942 "JOB_STATE_PENDING",
4943 "JOB_STATE_CANCELLING"
4350 ], 4944 ],
4351 "enumDescriptions": [ 4945 "enumDescriptions": [
4352 "Unrecognized transform type.", 4946 "The job's run state isn't specified.",
4353 "ParDo transform.", 4947 "`JOB_STATE_STOPPED` indicates that the job has not\nyet started to run.",
4354 "Group By Key transform.", 4948 "`JOB_STATE_RUNNING` indicates that the job is currently running.",
4355 "Flatten transform.", 4949 "`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.",
4356 "Read transform.", 4950 "`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`.",
4357 "Write transform.", 4951 "`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.",
4358 "Constructs from a constant value, such as with Create.o f.", 4952 "`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`.",
4359 "Creates a Singleton view of a collection.", 4953 "`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`.",
4360 "Opening or closing a shuffle session, often as part of a GroupByKey." 4954 "`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`.",
4955 "'JOB_STATE_PENDING' indicates that the job has been cre ated but is not yet\nrunning. Jobs that are pending may only transition to `JOB _STATE_RUNNING`,\nor `JOB_STATE_FAILED`.",
4956 "'JOB_STATE_CANCELLING' indicates that the job has been explicitly cancelled\nand is in the process of stopping. Jobs that are cancelli ng may only\ntransition to 'JOB_STATE_CANCELLED' or 'JOB_STATE_FAILED'."
4361 ], 4957 ],
4362 "type": "string" 4958 "type": "string"
4363 } 4959 },
4364 }, 4960 "location": {
4365 "type": "object" 4961 "description": "The location that contains this job.",
4366 }, 4962 "type": "string"
4367 "LeaseWorkItemResponse": { 4963 },
4368 "description": "Response to a request to lease WorkItems.", 4964 "currentStateTime": {
4369 "id": "LeaseWorkItemResponse", 4965 "description": "The timestamp associated with the current st ate.",
4370 "properties": { 4966 "format": "google-datetime",
4371 "workItems": { 4967 "type": "string"
4372 "description": "A list of the leased WorkItems.", 4968 },
4373 "items": { 4969 "transformNameMapping": {
4374 "$ref": "WorkItem"
4375 },
4376 "type": "array"
4377 }
4378 },
4379 "type": "object"
4380 },
4381 "LaunchTemplateParameters": {
4382 "description": "Parameters to provide to the template being launched .",
4383 "id": "LaunchTemplateParameters",
4384 "properties": {
4385 "parameters": {
4386 "additionalProperties": { 4970 "additionalProperties": {
4387 "type": "string" 4971 "type": "string"
4388 }, 4972 },
4389 "description": "The runtime parameters to pass to the job.", 4973 "description": "The map of transform name prefixes of the jo b to be replaced to the\ncorresponding name prefixes of the new job.",
4390 "type": "object" 4974 "type": "object"
4391 }, 4975 },
4392 "jobName": {
4393 "description": "Required. The job name to use for the create d job.",
4394 "type": "string"
4395 },
4396 "environment": { 4976 "environment": {
4397 "$ref": "RuntimeEnvironment", 4977 "$ref": "Environment",
4398 "description": "The runtime environment for the job." 4978 "description": "The environment for the job."
4399 } 4979 },
4400 }, 4980 "labels": {
4401 "type": "object"
4402 },
4403 "Sink": {
4404 "description": "A sink that records can be encoded and written to.",
4405 "id": "Sink",
4406 "properties": {
4407 "codec": {
4408 "additionalProperties": {
4409 "description": "Properties of the object.",
4410 "type": "any"
4411 },
4412 "description": "The codec to use to encode data written to t he sink.",
4413 "type": "object"
4414 },
4415 "spec": {
4416 "additionalProperties": {
4417 "description": "Properties of the object.",
4418 "type": "any"
4419 },
4420 "description": "The sink to write to, plus its parameters.",
4421 "type": "object"
4422 }
4423 },
4424 "type": "object"
4425 },
4426 "FlattenInstruction": {
4427 "description": "An instruction that copies its inputs (zero or more) to its (single) output.",
4428 "id": "FlattenInstruction",
4429 "properties": {
4430 "inputs": {
4431 "description": "Describes the inputs to the flatten instruct ion.",
4432 "items": {
4433 "$ref": "InstructionInput"
4434 },
4435 "type": "array"
4436 }
4437 },
4438 "type": "object"
4439 },
4440 "PartialGroupByKeyInstruction": {
4441 "description": "An instruction that does a partial group-by-key.\nOn e input and one output.",
4442 "id": "PartialGroupByKeyInstruction",
4443 "properties": {
4444 "sideInputs": {
4445 "description": "Zero or more side inputs.",
4446 "items": {
4447 "$ref": "SideInputInfo"
4448 },
4449 "type": "array"
4450 },
4451 "originalCombineValuesStepName": {
4452 "description": "If this instruction includes a combining fun ction, this is the name of the\nCombineValues instruction lifted into this instr uction.",
4453 "type": "string"
4454 },
4455 "input": {
4456 "$ref": "InstructionInput",
4457 "description": "Describes the input to the partial group-by- key instruction."
4458 },
4459 "valueCombiningFn": {
4460 "additionalProperties": {
4461 "description": "Properties of the object.",
4462 "type": "any"
4463 },
4464 "description": "The value combining function to invoke.",
4465 "type": "object"
4466 },
4467 "inputElementCodec": {
4468 "additionalProperties": {
4469 "description": "Properties of the object.",
4470 "type": "any"
4471 },
4472 "description": "The codec to use for interpreting an element in the input PTable.",
4473 "type": "object"
4474 },
4475 "originalCombineValuesInputStoreName": {
4476 "description": "If this instruction includes a combining fun ction this is the name of the\nintermediate store between the GBK and the Combin eValues.",
4477 "type": "string"
4478 }
4479 },
4480 "type": "object"
4481 },
4482 "StageSource": {
4483 "description": "Description of an input or output of an execution st age.",
4484 "id": "StageSource",
4485 "properties": {
4486 "sizeBytes": {
4487 "description": "Size of the source, if measurable.",
4488 "format": "int64",
4489 "type": "string"
4490 },
4491 "name": {
4492 "description": "Dataflow service generated name for this sou rce.",
4493 "type": "string"
4494 },
4495 "userName": {
4496 "description": "Human-readable name for this source; may be user or system generated.",
4497 "type": "string"
4498 },
4499 "originalTransformOrCollection": {
4500 "description": "User name for the original user transform or collection with which this\nsource is most closely associated.",
4501 "type": "string"
4502 }
4503 },
4504 "type": "object"
4505 },
4506 "InstructionInput": {
4507 "description": "An input of an instruction, as a reference to an out put of a\nproducer instruction.",
4508 "id": "InstructionInput",
4509 "properties": {
4510 "producerInstructionIndex": {
4511 "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.",
4512 "format": "int32",
4513 "type": "integer"
4514 },
4515 "outputNum": {
4516 "description": "The output index (origin zero) within the pr oducer.",
4517 "format": "int32",
4518 "type": "integer"
4519 }
4520 },
4521 "type": "object"
4522 },
4523 "StringList": {
4524 "description": "A metric value representing a list of strings.",
4525 "id": "StringList",
4526 "properties": {
4527 "elements": {
4528 "description": "Elements of the list.",
4529 "items": {
4530 "type": "string"
4531 },
4532 "type": "array"
4533 }
4534 },
4535 "type": "object"
4536 },
4537 "DisplayData": {
4538 "description": "Data provided with a pipeline or transform to provid e descriptive info.",
4539 "id": "DisplayData",
4540 "properties": {
4541 "strValue": {
4542 "description": "Contains value if the data is of string type .",
4543 "type": "string"
4544 },
4545 "durationValue": {
4546 "description": "Contains value if the data is of duration ty pe.",
4547 "format": "google-duration",
4548 "type": "string"
4549 },
4550 "int64Value": {
4551 "description": "Contains value if the data is of int64 type. ",
4552 "format": "int64",
4553 "type": "string"
4554 },
4555 "namespace": {
4556 "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.",
4557 "type": "string"
4558 },
4559 "floatValue": {
4560 "description": "Contains value if the data is of float type. ",
4561 "format": "float",
4562 "type": "number"
4563 },
4564 "key": {
4565 "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.",
4566 "type": "string"
4567 },
4568 "shortStrValue": {
4569 "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.",
4570 "type": "string"
4571 },
4572 "url": {
4573 "description": "An optional full URL.",
4574 "type": "string"
4575 },
4576 "label": {
4577 "description": "An optional label to display in a dax UI for the element.",
4578 "type": "string"
4579 },
4580 "timestampValue": {
4581 "description": "Contains value if the data is of timestamp t ype.",
4582 "format": "google-datetime",
4583 "type": "string"
4584 },
4585 "boolValue": {
4586 "description": "Contains value if the data is of a boolean t ype.",
4587 "type": "boolean"
4588 },
4589 "javaClassValue": {
4590 "description": "Contains value if the data is of java class type.",
4591 "type": "string"
4592 }
4593 },
4594 "type": "object"
4595 },
4596 "GetDebugConfigRequest": {
4597 "description": "Request to get updated debug configuration for compo nent.",
4598 "id": "GetDebugConfigRequest",
4599 "properties": {
4600 "location": {
4601 "description": "The location which contains the job specifie d by job_id.",
4602 "type": "string"
4603 },
4604 "componentId": {
4605 "description": "The internal component id for which debug co nfiguration is\nrequested.",
4606 "type": "string"
4607 },
4608 "workerId": {
4609 "description": "The worker id, i.e., VM hostname.",
4610 "type": "string"
4611 }
4612 },
4613 "type": "object"
4614 },
4615 "LeaseWorkItemRequest": {
4616 "description": "Request to lease WorkItems.",
4617 "id": "LeaseWorkItemRequest",
4618 "properties": {
4619 "currentWorkerTime": {
4620 "description": "The current timestamp at the worker.",
4621 "format": "google-datetime",
4622 "type": "string"
4623 },
4624 "workItemTypes": {
4625 "description": "Filter for WorkItem type.",
4626 "items": {
4627 "type": "string"
4628 },
4629 "type": "array"
4630 },
4631 "location": {
4632 "description": "The location which contains the WorkItem's j ob.",
4633 "type": "string"
4634 },
4635 "workerCapabilities": {
4636 "description": "Worker capabilities. WorkItems might be limi ted to workers with specific\ncapabilities.",
4637 "items": {
4638 "type": "string"
4639 },
4640 "type": "array"
4641 },
4642 "workerId": {
4643 "description": "Identifies the worker leasing work -- typica lly the ID of the\nvirtual machine running the worker.",
4644 "type": "string"
4645 },
4646 "requestedLeaseDuration": {
4647 "description": "The initial lease period.",
4648 "format": "google-duration",
4649 "type": "string"
4650 }
4651 },
4652 "type": "object"
4653 },
4654 "GetTemplateResponse": {
4655 "description": "The response to a GetTemplate request.",
4656 "id": "GetTemplateResponse",
4657 "properties": {
4658 "metadata": {
4659 "$ref": "TemplateMetadata",
4660 "description": "The template metadata describing the templat e name, available\nparameters, etc."
4661 },
4662 "status": {
4663 "$ref": "Status",
4664 "description": "The status of the get template request. Any problems with the\nrequest will be indicated in the error_details."
4665 }
4666 },
4667 "type": "object"
4668 },
4669 "Parameter": {
4670 "description": "Structured data associated with this message.",
4671 "id": "Parameter",
4672 "properties": {
4673 "value": {
4674 "description": "Value for this parameter.",
4675 "type": "any"
4676 },
4677 "key": {
4678 "description": "Key or name for this parameter.",
4679 "type": "string"
4680 }
4681 },
4682 "type": "object"
4683 },
4684 "ReportWorkItemStatusRequest": {
4685 "description": "Request to report the status of WorkItems.",
4686 "id": "ReportWorkItemStatusRequest",
4687 "properties": {
4688 "currentWorkerTime": {
4689 "description": "The current timestamp at the worker.",
4690 "format": "google-datetime",
4691 "type": "string"
4692 },
4693 "workerId": {
4694 "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).",
4695 "type": "string"
4696 },
4697 "location": {
4698 "description": "The location which contains the WorkItem's j ob.",
4699 "type": "string"
4700 },
4701 "workItemStatuses": {
4702 "description": "The order is unimportant, except that the or der of the\nWorkItemServiceState messages in the ReportWorkItemStatusResponse\nc orresponds to the order of WorkItemStatus messages here.",
4703 "items": {
4704 "$ref": "WorkItemStatus"
4705 },
4706 "type": "array"
4707 }
4708 },
4709 "type": "object"
4710 },
4711 "StreamingConfigTask": {
4712 "description": "A task that carries configuration information for st reaming computations.",
4713 "id": "StreamingConfigTask",
4714 "properties": {
4715 "windmillServicePort": {
4716 "description": "If present, the worker must use this port to communicate with Windmill\nService dispatchers. Only applicable when windmill_s ervice_endpoint is\nspecified.",
4717 "format": "int64",
4718 "type": "string"
4719 },
4720 "streamingComputationConfigs": {
4721 "description": "Set of computation configuration information .",
4722 "items": {
4723 "$ref": "StreamingComputationConfig"
4724 },
4725 "type": "array"
4726 },
4727 "windmillServiceEndpoint": {
4728 "description": "If present, the worker must use this endpoin t to communicate with Windmill\nService dispatchers, otherwise the worker must c ontinue to use whatever\nendpoint it had been using.",
4729 "type": "string"
4730 },
4731 "userStepToStateFamilyNameMap": {
4732 "additionalProperties": { 4981 "additionalProperties": {
4733 "type": "string" 4982 "type": "string"
4734 }, 4983 },
4735 "description": "Map from user step names to state families." , 4984 "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.",
4736 "type": "object" 4985 "type": "object"
4737 } 4986 },
4738 }, 4987 "createTime": {
4739 "type": "object" 4988 "description": "The timestamp when the job was initially cre ated. Immutable and set by the\nCloud Dataflow service.",
4740 }, 4989 "format": "google-datetime",
4741 "PipelineDescription": { 4990 "type": "string"
4742 "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." , 4991 },
4743 "id": "PipelineDescription", 4992 "stageStates": {
4744 "properties": { 4993 "description": "This field may be mutated by the Cloud Dataf low service;\ncallers cannot mutate it.",
4745 "displayData": { 4994 "items": {
4746 "description": "Pipeline level display data.", 4995 "$ref": "ExecutionStageState"
4747 "items": { 4996 },
4748 "$ref": "DisplayData" 4997 "type": "array"
4749 }, 4998 },
4750 "type": "array" 4999 "type": {
4751 }, 5000 "description": "The type of Cloud Dataflow job.",
4752 "executionPipelineStage": {
4753 "description": "Description of each stage of execution of th e pipeline.",
4754 "items": {
4755 "$ref": "ExecutionStageSummary"
4756 },
4757 "type": "array"
4758 },
4759 "originalPipelineTransform": {
4760 "description": "Description of each transform in the pipelin e and collections between them.",
4761 "items": {
4762 "$ref": "TransformSummary"
4763 },
4764 "type": "array"
4765 }
4766 },
4767 "type": "object"
4768 },
4769 "Step": {
4770 "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.",
4771 "id": "Step",
4772 "properties": {
4773 "properties": {
4774 "additionalProperties": {
4775 "description": "Properties of the object.",
4776 "type": "any"
4777 },
4778 "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.",
4779 "type": "object"
4780 },
4781 "name": {
4782 "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.",
4783 "type": "string"
4784 },
4785 "kind": {
4786 "description": "The kind of step in the Cloud Dataflow job." ,
4787 "type": "string"
4788 }
4789 },
4790 "type": "object"
4791 },
4792 "JobExecutionInfo": {
4793 "description": "Additional information about how a Cloud Dataflow jo b will be executed that\nisn't contained in the submitted job.",
4794 "id": "JobExecutionInfo",
4795 "properties": {
4796 "stages": {
4797 "additionalProperties": {
4798 "$ref": "JobExecutionStageInfo"
4799 },
4800 "description": "A mapping from each stage to the information about that stage.",
4801 "type": "object"
4802 }
4803 },
4804 "type": "object"
4805 },
4806 "FailedLocation": {
4807 "description": "Indicates which location failed to respond to a requ est for data.",
4808 "id": "FailedLocation",
4809 "properties": {
4810 "name": {
4811 "description": "The name of the failed location.",
4812 "type": "string"
4813 }
4814 },
4815 "type": "object"
4816 },
4817 "Disk": {
4818 "description": "Describes the data disk used by a workflow job.",
4819 "id": "Disk",
4820 "properties": {
4821 "diskType": {
4822 "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",
4823 "type": "string"
4824 },
4825 "sizeGb": {
4826 "description": "Size of disk in GB. If zero or unspecified, the service will\nattempt to choose a reasonable default.",
4827 "format": "int32",
4828 "type": "integer"
4829 },
4830 "mountPoint": {
4831 "description": "Directory in a VM where disk is mounted.",
4832 "type": "string"
4833 }
4834 },
4835 "type": "object"
4836 },
4837 "ListJobMessagesResponse": {
4838 "description": "Response to a request to list job messages.",
4839 "id": "ListJobMessagesResponse",
4840 "properties": {
4841 "jobMessages": {
4842 "description": "Messages in ascending timestamp order.",
4843 "items": {
4844 "$ref": "JobMessage"
4845 },
4846 "type": "array"
4847 },
4848 "nextPageToken": {
4849 "description": "The token to obtain the next page of results if there are more.",
4850 "type": "string"
4851 },
4852 "autoscalingEvents": {
4853 "description": "Autoscaling events in ascending timestamp or der.",
4854 "items": {
4855 "$ref": "AutoscalingEvent"
4856 },
4857 "type": "array"
4858 }
4859 },
4860 "type": "object"
4861 },
4862 "CounterMetadata": {
4863 "description": "CounterMetadata includes all static non-name non-val ue counter attributes.",
4864 "id": "CounterMetadata",
4865 "properties": {
4866 "otherUnits": {
4867 "description": "A string referring to the unit type.",
4868 "type": "string"
4869 },
4870 "description": {
4871 "description": "Human-readable description of the counter se mantics.",
4872 "type": "string"
4873 },
4874 "kind": {
4875 "description": "Counter aggregation kind.",
4876 "enum": [ 5001 "enum": [
4877 "INVALID", 5002 "JOB_TYPE_UNKNOWN",
4878 "SUM", 5003 "JOB_TYPE_BATCH",
4879 "MAX", 5004 "JOB_TYPE_STREAMING"
4880 "MIN",
4881 "MEAN",
4882 "OR",
4883 "AND",
4884 "SET",
4885 "DISTRIBUTION"
4886 ], 5005 ],
4887 "enumDescriptions": [ 5006 "enumDescriptions": [
4888 "Counter aggregation kind was not set.", 5007 "The type of the job is unspecified, or unknown.",
4889 "Aggregated value is the sum of all contributed values." , 5008 "A batch job with a well-defined end point: data is read , data is\nprocessed, data is written, and the job is done.",
4890 "Aggregated value is the max of all contributed values." , 5009 "A continuously streaming job with no end: data is read, \nprocessed, and written continuously."
4891 "Aggregated value is the min of all contributed values." ,
4892 "Aggregated value is the mean of all contributed values. ",
4893 "Aggregated value represents the logical 'or' of all con tributed values.",
4894 "Aggregated value represents the logical 'and' of all co ntributed values.",
4895 "Aggregated value is a set of unique contributed values. ",
4896 "Aggregated value captures statistics about a distributi on."
4897 ], 5010 ],
4898 "type": "string" 5011 "type": "string"
4899 }, 5012 },
4900 "standardUnits": { 5013 "projectId": {
4901 "description": "System defined Units, see above enum.", 5014 "description": "The ID of the Cloud Platform project that th e job belongs to.",
5015 "type": "string"
5016 },
5017 "pipelineDescription": {
5018 "$ref": "PipelineDescription",
5019 "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."
5020 },
5021 "replaceJobId": {
5022 "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.",
5023 "type": "string"
5024 }
5025 },
5026 "type": "object"
5027 },
5028 "DynamicSourceSplit": {
5029 "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.",
5030 "id": "DynamicSourceSplit",
5031 "properties": {
5032 "primary": {
5033 "$ref": "DerivedSource",
5034 "description": "Primary part (continued to be processed by w orker).\nSpecified relative to the previously-current source.\nBecomes current."
5035 },
5036 "residual": {
5037 "$ref": "DerivedSource",
5038 "description": "Residual part (returned to the pool of work) .\nSpecified relative to the previously-current source."
5039 }
5040 },
5041 "type": "object"
5042 },
5043 "DerivedSource": {
5044 "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.",
5045 "id": "DerivedSource",
5046 "properties": {
5047 "derivationMode": {
5048 "description": "What source to base the produced source on ( if any).",
4902 "enum": [ 5049 "enum": [
4903 "BYTES", 5050 "SOURCE_DERIVATION_MODE_UNKNOWN",
4904 "BYTES_PER_SEC", 5051 "SOURCE_DERIVATION_MODE_INDEPENDENT",
4905 "MILLISECONDS", 5052 "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT",
4906 "MICROSECONDS", 5053 "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT"
4907 "NANOSECONDS",
4908 "TIMESTAMP_MSEC",
4909 "TIMESTAMP_USEC",
4910 "TIMESTAMP_NSEC"
4911 ], 5054 ],
4912 "enumDescriptions": [ 5055 "enumDescriptions": [
4913 "Counter returns a value in bytes.", 5056 "The source derivation is unknown, or unspecified.",
4914 "Counter returns a value in bytes per second.", 5057 "Produce a completely independent Source with no base.",
4915 "Counter returns a value in milliseconds.", 5058 "Produce a Source based on the Source being split.",
4916 "Counter returns a value in microseconds.", 5059 "Produce a Source based on the base of the Source being split."
4917 "Counter returns a value in nanoseconds.",
4918 "Counter returns a timestamp in milliseconds.",
4919 "Counter returns a timestamp in microseconds.",
4920 "Counter returns a timestamp in nanoseconds."
4921 ], 5060 ],
4922 "type": "string" 5061 "type": "string"
4923 } 5062 },
4924 }, 5063 "source": {
4925 "type": "object" 5064 "$ref": "Source",
4926 }, 5065 "description": "Specification of the source."
4927 "ApproximateReportedProgress": { 5066 }
4928 "description": "A progress measurement of a WorkItem by a worker.", 5067 },
4929 "id": "ApproximateReportedProgress", 5068 "type": "object"
4930 "properties": {
4931 "position": {
4932 "$ref": "Position",
4933 "description": "A Position within the work to represent a pr ogress."
4934 },
4935 "fractionConsumed": {
4936 "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).",
4937 "format": "double",
4938 "type": "number"
4939 },
4940 "consumedParallelism": {
4941 "$ref": "ReportedParallelism",
4942 "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."
4943 },
4944 "remainingParallelism": {
4945 "$ref": "ReportedParallelism",
4946 "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."
4947 }
4948 },
4949 "type": "object"
4950 },
4951 "StateFamilyConfig": {
4952 "description": "State family configuration.",
4953 "id": "StateFamilyConfig",
4954 "properties": {
4955 "stateFamily": {
4956 "description": "The state family value.",
4957 "type": "string"
4958 },
4959 "isRead": {
4960 "description": "If true, this family corresponds to a read o peration.",
4961 "type": "boolean"
4962 }
4963 },
4964 "type": "object"
4965 },
4966 "IntegerList": {
4967 "description": "A metric value representing a list of integers.",
4968 "id": "IntegerList",
4969 "properties": {
4970 "elements": {
4971 "description": "Elements of the list.",
4972 "items": {
4973 "$ref": "SplitInt64"
4974 },
4975 "type": "array"
4976 }
4977 },
4978 "type": "object"
4979 },
4980 "ResourceUtilizationReportResponse": {
4981 "description": "Service-side response to WorkerMessage reporting res ource utilization.",
4982 "id": "ResourceUtilizationReportResponse",
4983 "properties": {},
4984 "type": "object"
4985 },
4986 "SourceSplitResponse": {
4987 "description": "The response to a SourceSplitRequest.",
4988 "id": "SourceSplitResponse",
4989 "properties": {
4990 "shards": {
4991 "description": "DEPRECATED in favor of bundles.",
4992 "items": {
4993 "$ref": "SourceSplitShard"
4994 },
4995 "type": "array"
4996 },
4997 "outcome": {
4998 "description": "Indicates whether splitting happened and pro duced a list of bundles.\nIf this is USE_CURRENT_SOURCE_AS_IS, the current sourc e should\nbe processed \"as is\" without splitting. \"bundles\" is ignored in th is case.\nIf this is SPLITTING_HAPPENED, then \"bundles\" contains a list of\nbu ndles into which the source was split.",
4999 "enum": [
5000 "SOURCE_SPLIT_OUTCOME_UNKNOWN",
5001 "SOURCE_SPLIT_OUTCOME_USE_CURRENT",
5002 "SOURCE_SPLIT_OUTCOME_SPLITTING_HAPPENED"
5003 ],
5004 "enumDescriptions": [
5005 "The source split outcome is unknown, or unspecified.",
5006 "The current source should be processed \"as is\" withou t splitting.",
5007 "Splitting produced a list of bundles."
5008 ],
5009 "type": "string"
5010 },
5011 "bundles": {
5012 "description": "If outcome is SPLITTING_HAPPENED, then this is a list of bundles\ninto which the source was split. Otherwise this field is i gnored.\nThis list can be empty, which means the source represents an empty inpu t.",
5013 "items": {
5014 "$ref": "DerivedSource"
5015 },
5016 "type": "array"
5017 }
5018 },
5019 "type": "object"
5020 } 5069 }
5021 }, 5070 },
5022 "servicePath": "", 5071 "servicePath": "",
5023 "title": "Google Dataflow API", 5072 "title": "Google Dataflow API",
5024 "version": "v1b3" 5073 "version": "v1b3"
5025 } 5074 }
OLDNEW
« no previous file with comments | « discovery/googleapis_beta/clouduseraccounts__beta.json ('k') | discovery/googleapis_beta/dlp__v2beta1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698