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

Issues Search
    My Issues | Starred     Open | Closed | All

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

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

Powered by Google App Engine
This is Rietveld 408576698