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

Issues Search
    My Issues | Starred     Open | Closed | All

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

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