OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
5 "https://www.googleapis.com/auth/cloud-platform": { | 5 "https://www.googleapis.com/auth/cloud-platform": { |
6 "description": "View and manage your data across Google Clou
d Platform services" | 6 "description": "View and manage your data across Google Clou
d Platform services" |
7 } | 7 } |
8 } | 8 } |
9 } | 9 } |
10 }, | 10 }, |
11 "basePath": "", | 11 "basePath": "", |
12 "baseUrl": "https://dataproc.googleapis.com/", | 12 "baseUrl": "https://dataproc.googleapis.com/", |
13 "batchPath": "batch", | 13 "batchPath": "batch", |
14 "description": "Manages Hadoop-based clusters and jobs on Google Cloud Platf
orm.", | 14 "description": "Manages Hadoop-based clusters and jobs on Google Cloud Platf
orm.", |
15 "discoveryVersion": "v1", | 15 "discoveryVersion": "v1", |
16 "documentationLink": "https://cloud.google.com/dataproc/", | 16 "documentationLink": "https://cloud.google.com/dataproc/", |
17 "icons": { | 17 "icons": { |
18 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 18 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
19 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 19 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
20 }, | 20 }, |
21 "id": "dataproc:v1beta1", | 21 "id": "dataproc:v1beta1", |
22 "kind": "discovery#restDescription", | 22 "kind": "discovery#restDescription", |
23 "name": "dataproc", | 23 "name": "dataproc", |
24 "ownerDomain": "google.com", | 24 "ownerDomain": "google.com", |
25 "ownerName": "Google", | 25 "ownerName": "Google", |
26 "parameters": { | 26 "parameters": { |
27 "oauth_token": { | 27 "access_token": { |
28 "description": "OAuth 2.0 token for the current user.", | 28 "description": "OAuth access token.", |
29 "location": "query", | 29 "location": "query", |
30 "type": "string" | 30 "type": "string" |
31 }, | 31 }, |
| 32 "key": { |
| 33 "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.", |
| 34 "location": "query", |
| 35 "type": "string" |
| 36 }, |
| 37 "quotaUser": { |
| 38 "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.", |
| 39 "location": "query", |
| 40 "type": "string" |
| 41 }, |
| 42 "pp": { |
| 43 "default": "true", |
| 44 "description": "Pretty-print response.", |
| 45 "location": "query", |
| 46 "type": "boolean" |
| 47 }, |
32 "bearer_token": { | 48 "bearer_token": { |
33 "description": "OAuth bearer token.", | 49 "description": "OAuth bearer token.", |
34 "location": "query", | 50 "location": "query", |
35 "type": "string" | 51 "type": "string" |
36 }, | 52 }, |
| 53 "oauth_token": { |
| 54 "description": "OAuth 2.0 token for the current user.", |
| 55 "location": "query", |
| 56 "type": "string" |
| 57 }, |
37 "upload_protocol": { | 58 "upload_protocol": { |
38 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 59 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
39 "location": "query", | 60 "location": "query", |
40 "type": "string" | 61 "type": "string" |
41 }, | 62 }, |
42 "prettyPrint": { | 63 "prettyPrint": { |
43 "default": "true", | 64 "default": "true", |
44 "description": "Returns response with indentations and line breaks."
, | 65 "description": "Returns response with indentations and line breaks."
, |
45 "location": "query", | 66 "location": "query", |
46 "type": "boolean" | 67 "type": "boolean" |
47 }, | 68 }, |
| 69 "fields": { |
| 70 "description": "Selector specifying which fields to include in a par
tial response.", |
| 71 "location": "query", |
| 72 "type": "string" |
| 73 }, |
48 "uploadType": { | 74 "uploadType": { |
49 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 75 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
50 "location": "query", | 76 "location": "query", |
51 "type": "string" | 77 "type": "string" |
52 }, | 78 }, |
53 "fields": { | 79 "callback": { |
54 "description": "Selector specifying which fields to include in a par
tial response.", | 80 "description": "JSONP", |
55 "location": "query", | 81 "location": "query", |
56 "type": "string" | 82 "type": "string" |
57 }, | 83 }, |
58 "$.xgafv": { | 84 "$.xgafv": { |
59 "description": "V1 error format.", | 85 "description": "V1 error format.", |
60 "enum": [ | 86 "enum": [ |
61 "1", | 87 "1", |
62 "2" | 88 "2" |
63 ], | 89 ], |
64 "enumDescriptions": [ | 90 "enumDescriptions": [ |
65 "v1 error format", | 91 "v1 error format", |
66 "v2 error format" | 92 "v2 error format" |
67 ], | 93 ], |
68 "location": "query", | 94 "location": "query", |
69 "type": "string" | 95 "type": "string" |
70 }, | 96 }, |
71 "callback": { | |
72 "description": "JSONP", | |
73 "location": "query", | |
74 "type": "string" | |
75 }, | |
76 "alt": { | 97 "alt": { |
77 "default": "json", | 98 "default": "json", |
78 "description": "Data format for response.", | 99 "description": "Data format for response.", |
79 "enum": [ | 100 "enum": [ |
80 "json", | 101 "json", |
81 "media", | 102 "media", |
82 "proto" | 103 "proto" |
83 ], | 104 ], |
84 "enumDescriptions": [ | 105 "enumDescriptions": [ |
85 "Responses with Content-Type of application/json", | 106 "Responses with Content-Type of application/json", |
86 "Media download with context-dependent Content-Type", | 107 "Media download with context-dependent Content-Type", |
87 "Responses with Content-Type of application/x-protobuf" | 108 "Responses with Content-Type of application/x-protobuf" |
88 ], | 109 ], |
89 "location": "query", | 110 "location": "query", |
90 "type": "string" | 111 "type": "string" |
91 }, | |
92 "access_token": { | |
93 "description": "OAuth access token.", | |
94 "location": "query", | |
95 "type": "string" | |
96 }, | |
97 "key": { | |
98 "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.", | |
99 "location": "query", | |
100 "type": "string" | |
101 }, | |
102 "quotaUser": { | |
103 "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.", | |
104 "location": "query", | |
105 "type": "string" | |
106 }, | |
107 "pp": { | |
108 "default": "true", | |
109 "description": "Pretty-print response.", | |
110 "location": "query", | |
111 "type": "boolean" | |
112 } | 112 } |
113 }, | 113 }, |
114 "protocol": "rest", | 114 "protocol": "rest", |
115 "resources": { | 115 "resources": { |
116 "operations": { | 116 "operations": { |
117 "methods": { | 117 "methods": { |
118 "cancel": { | 118 "cancel": { |
119 "description": "Starts asynchronous cancellation on a long-r
unning operation. The server makes a best effort to cancel the operation, but su
ccess is not guaranteed. If the server doesn't support this method, it returns g
oogle.rpc.Code.UNIMPLEMENTED. Clients can use operations.get or other methods to
check whether the cancellation succeeded or whether the operation completed des
pite cancellation.", | 119 "description": "Starts asynchronous cancellation on a long-r
unning operation. The server makes a best effort to cancel the operation, but su
ccess is not guaranteed. If the server doesn't support this method, it returns g
oogle.rpc.Code.UNIMPLEMENTED. Clients can use operations.get or other methods to
check whether the cancellation succeeded or whether the operation completed des
pite cancellation.", |
120 "httpMethod": "POST", | 120 "httpMethod": "POST", |
121 "id": "dataproc.operations.cancel", | 121 "id": "dataproc.operations.cancel", |
(...skipping 105 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
227 "$ref": "ListOperationsResponse" | 227 "$ref": "ListOperationsResponse" |
228 }, | 228 }, |
229 "scopes": [ | 229 "scopes": [ |
230 "https://www.googleapis.com/auth/cloud-platform" | 230 "https://www.googleapis.com/auth/cloud-platform" |
231 ] | 231 ] |
232 } | 232 } |
233 } | 233 } |
234 }, | 234 }, |
235 "projects": { | 235 "projects": { |
236 "resources": { | 236 "resources": { |
| 237 "clusters": { |
| 238 "methods": { |
| 239 "delete": { |
| 240 "description": "Deletes a cluster in a project.", |
| 241 "httpMethod": "DELETE", |
| 242 "id": "dataproc.projects.clusters.delete", |
| 243 "parameterOrder": [ |
| 244 "projectId", |
| 245 "clusterName" |
| 246 ], |
| 247 "parameters": { |
| 248 "clusterName": { |
| 249 "description": "Required The cluster name.", |
| 250 "location": "path", |
| 251 "required": true, |
| 252 "type": "string" |
| 253 }, |
| 254 "projectId": { |
| 255 "description": "Required The ID of the Googl
e Cloud Platform project that the cluster belongs to.", |
| 256 "location": "path", |
| 257 "required": true, |
| 258 "type": "string" |
| 259 } |
| 260 }, |
| 261 "path": "v1beta1/projects/{projectId}/clusters/{clus
terName}", |
| 262 "response": { |
| 263 "$ref": "Operation" |
| 264 }, |
| 265 "scopes": [ |
| 266 "https://www.googleapis.com/auth/cloud-platform" |
| 267 ] |
| 268 }, |
| 269 "diagnose": { |
| 270 "description": "Gets cluster diagnostic information.
After the operation completes, the Operation.response field contains DiagnoseCl
usterOutputLocation.", |
| 271 "httpMethod": "POST", |
| 272 "id": "dataproc.projects.clusters.diagnose", |
| 273 "parameterOrder": [ |
| 274 "projectId", |
| 275 "clusterName" |
| 276 ], |
| 277 "parameters": { |
| 278 "clusterName": { |
| 279 "description": "Required The cluster name.", |
| 280 "location": "path", |
| 281 "required": true, |
| 282 "type": "string" |
| 283 }, |
| 284 "projectId": { |
| 285 "description": "Required The ID of the Googl
e Cloud Platform project that the cluster belongs to.", |
| 286 "location": "path", |
| 287 "required": true, |
| 288 "type": "string" |
| 289 } |
| 290 }, |
| 291 "path": "v1beta1/projects/{projectId}/clusters/{clus
terName}:diagnose", |
| 292 "request": { |
| 293 "$ref": "DiagnoseClusterRequest" |
| 294 }, |
| 295 "response": { |
| 296 "$ref": "Operation" |
| 297 }, |
| 298 "scopes": [ |
| 299 "https://www.googleapis.com/auth/cloud-platform" |
| 300 ] |
| 301 }, |
| 302 "list": { |
| 303 "description": "Lists all clusters in a project.", |
| 304 "httpMethod": "GET", |
| 305 "id": "dataproc.projects.clusters.list", |
| 306 "parameterOrder": [ |
| 307 "projectId" |
| 308 ], |
| 309 "parameters": { |
| 310 "pageToken": { |
| 311 "description": "The standard List page token
.", |
| 312 "location": "query", |
| 313 "type": "string" |
| 314 }, |
| 315 "pageSize": { |
| 316 "description": "The standard List page size.
", |
| 317 "format": "int32", |
| 318 "location": "query", |
| 319 "type": "integer" |
| 320 }, |
| 321 "projectId": { |
| 322 "description": "Required The ID of the Googl
e Cloud Platform project that the cluster belongs to.", |
| 323 "location": "path", |
| 324 "required": true, |
| 325 "type": "string" |
| 326 }, |
| 327 "filter": { |
| 328 "description": "Optional A filter constraini
ng which clusters to list. Valid filters contain label terms such as: labels.key
1 = val1 AND (-labels.k2 = val2 OR labels.k3 = val3)", |
| 329 "location": "query", |
| 330 "type": "string" |
| 331 } |
| 332 }, |
| 333 "path": "v1beta1/projects/{projectId}/clusters", |
| 334 "response": { |
| 335 "$ref": "ListClustersResponse" |
| 336 }, |
| 337 "scopes": [ |
| 338 "https://www.googleapis.com/auth/cloud-platform" |
| 339 ] |
| 340 }, |
| 341 "create": { |
| 342 "description": "Creates a cluster in a project.", |
| 343 "httpMethod": "POST", |
| 344 "id": "dataproc.projects.clusters.create", |
| 345 "parameterOrder": [ |
| 346 "projectId" |
| 347 ], |
| 348 "parameters": { |
| 349 "projectId": { |
| 350 "description": "Required The ID of the Googl
e Cloud Platform project that the cluster belongs to.", |
| 351 "location": "path", |
| 352 "required": true, |
| 353 "type": "string" |
| 354 } |
| 355 }, |
| 356 "path": "v1beta1/projects/{projectId}/clusters", |
| 357 "request": { |
| 358 "$ref": "Cluster" |
| 359 }, |
| 360 "response": { |
| 361 "$ref": "Operation" |
| 362 }, |
| 363 "scopes": [ |
| 364 "https://www.googleapis.com/auth/cloud-platform" |
| 365 ] |
| 366 }, |
| 367 "patch": { |
| 368 "description": "Updates a cluster in a project.", |
| 369 "httpMethod": "PATCH", |
| 370 "id": "dataproc.projects.clusters.patch", |
| 371 "parameterOrder": [ |
| 372 "projectId", |
| 373 "clusterName" |
| 374 ], |
| 375 "parameters": { |
| 376 "updateMask": { |
| 377 "description": "Required Specifies the path,
relative to <code>Cluster</code>, of the field to update. For example, to chang
e the number of workers in a cluster to 5, the <code>update_mask</code> paramete
r would be specified as <code>configuration.worker_configuration.num_instances</
code>, and the PATCH request body would specify the new value, as follows:\n{\n
\"configuration\":{\n \"workerConfiguration\":{\n \"numInstances\":\"5\
"\n }\n }\n}\nSimilarly, to change the number of preemptible workers in a cl
uster to 5, the <code>update_mask</code> parameter would be <code>config.seconda
ry_worker_config.num_instances</code>, and the PATCH request body would be set a
s follows:\n{\n \"config\":{\n \"secondaryWorkerConfig\":{\n \"numInsta
nces\":\"5\"\n }\n }\n}\n<strong>Note:</strong> Currently, <code>config.work
er_config.num_instances</code> and <code>config.secondary_worker_config.num_inst
ances</code> are the only fields that can be updated.", |
| 378 "format": "google-fieldmask", |
| 379 "location": "query", |
| 380 "type": "string" |
| 381 }, |
| 382 "clusterName": { |
| 383 "description": "Required The cluster name.", |
| 384 "location": "path", |
| 385 "required": true, |
| 386 "type": "string" |
| 387 }, |
| 388 "projectId": { |
| 389 "description": "Required The ID of the Googl
e Cloud Platform project the cluster belongs to.", |
| 390 "location": "path", |
| 391 "required": true, |
| 392 "type": "string" |
| 393 } |
| 394 }, |
| 395 "path": "v1beta1/projects/{projectId}/clusters/{clus
terName}", |
| 396 "request": { |
| 397 "$ref": "Cluster" |
| 398 }, |
| 399 "response": { |
| 400 "$ref": "Operation" |
| 401 }, |
| 402 "scopes": [ |
| 403 "https://www.googleapis.com/auth/cloud-platform" |
| 404 ] |
| 405 }, |
| 406 "get": { |
| 407 "description": "Gets the resource representation for
a cluster in a project.", |
| 408 "httpMethod": "GET", |
| 409 "id": "dataproc.projects.clusters.get", |
| 410 "parameterOrder": [ |
| 411 "projectId", |
| 412 "clusterName" |
| 413 ], |
| 414 "parameters": { |
| 415 "clusterName": { |
| 416 "description": "Required The cluster name.", |
| 417 "location": "path", |
| 418 "required": true, |
| 419 "type": "string" |
| 420 }, |
| 421 "projectId": { |
| 422 "description": "Required The ID of the Googl
e Cloud Platform project that the cluster belongs to.", |
| 423 "location": "path", |
| 424 "required": true, |
| 425 "type": "string" |
| 426 } |
| 427 }, |
| 428 "path": "v1beta1/projects/{projectId}/clusters/{clus
terName}", |
| 429 "response": { |
| 430 "$ref": "Cluster" |
| 431 }, |
| 432 "scopes": [ |
| 433 "https://www.googleapis.com/auth/cloud-platform" |
| 434 ] |
| 435 } |
| 436 } |
| 437 }, |
237 "jobs": { | 438 "jobs": { |
238 "methods": { | 439 "methods": { |
239 "submit": { | |
240 "description": "Submits a job to a cluster.", | |
241 "httpMethod": "POST", | |
242 "id": "dataproc.projects.jobs.submit", | |
243 "parameterOrder": [ | |
244 "projectId" | |
245 ], | |
246 "parameters": { | |
247 "projectId": { | |
248 "description": "Required The ID of the Googl
e Cloud Platform project that the job belongs to.", | |
249 "location": "path", | |
250 "required": true, | |
251 "type": "string" | |
252 } | |
253 }, | |
254 "path": "v1beta1/projects/{projectId}/jobs:submit", | |
255 "request": { | |
256 "$ref": "SubmitJobRequest" | |
257 }, | |
258 "response": { | |
259 "$ref": "Job" | |
260 }, | |
261 "scopes": [ | |
262 "https://www.googleapis.com/auth/cloud-platform" | |
263 ] | |
264 }, | |
265 "delete": { | |
266 "description": "Deletes the job from the project. If
the job is active, the delete fails, and the response returns FAILED_PRECONDITI
ON.", | |
267 "httpMethod": "DELETE", | |
268 "id": "dataproc.projects.jobs.delete", | |
269 "parameterOrder": [ | |
270 "projectId", | |
271 "jobId" | |
272 ], | |
273 "parameters": { | |
274 "projectId": { | |
275 "description": "Required The ID of the Googl
e Cloud Platform project that the job belongs to.", | |
276 "location": "path", | |
277 "required": true, | |
278 "type": "string" | |
279 }, | |
280 "jobId": { | |
281 "description": "Required The job ID.", | |
282 "location": "path", | |
283 "required": true, | |
284 "type": "string" | |
285 } | |
286 }, | |
287 "path": "v1beta1/projects/{projectId}/jobs/{jobId}", | |
288 "response": { | |
289 "$ref": "Empty" | |
290 }, | |
291 "scopes": [ | |
292 "https://www.googleapis.com/auth/cloud-platform" | |
293 ] | |
294 }, | |
295 "list": { | |
296 "description": "Lists jobs in a project.", | |
297 "httpMethod": "GET", | |
298 "id": "dataproc.projects.jobs.list", | |
299 "parameterOrder": [ | |
300 "projectId" | |
301 ], | |
302 "parameters": { | |
303 "filter": { | |
304 "description": "Optional A filter constraini
ng which jobs to list. Valid filters contain job state and label terms such as:
labels.key1 = val1 AND (labels.k2 = val2 OR labels.k3 = val3)", | |
305 "location": "query", | |
306 "type": "string" | |
307 }, | |
308 "jobStateMatcher": { | |
309 "description": "Optional Specifies enumerate
d categories of jobs to list.", | |
310 "enum": [ | |
311 "ALL", | |
312 "ACTIVE", | |
313 "NON_ACTIVE" | |
314 ], | |
315 "location": "query", | |
316 "type": "string" | |
317 }, | |
318 "pageToken": { | |
319 "description": "Optional The page token, ret
urned by a previous call, to request the next page of results.", | |
320 "location": "query", | |
321 "type": "string" | |
322 }, | |
323 "pageSize": { | |
324 "description": "Optional The number of resul
ts to return in each response.", | |
325 "format": "int32", | |
326 "location": "query", | |
327 "type": "integer" | |
328 }, | |
329 "clusterName": { | |
330 "description": "Optional If set, the returne
d jobs list includes only jobs that were submitted to the named cluster.", | |
331 "location": "query", | |
332 "type": "string" | |
333 }, | |
334 "projectId": { | |
335 "description": "Required The ID of the Googl
e Cloud Platform project that the job belongs to.", | |
336 "location": "path", | |
337 "required": true, | |
338 "type": "string" | |
339 } | |
340 }, | |
341 "path": "v1beta1/projects/{projectId}/jobs", | |
342 "response": { | |
343 "$ref": "ListJobsResponse" | |
344 }, | |
345 "scopes": [ | |
346 "https://www.googleapis.com/auth/cloud-platform" | |
347 ] | |
348 }, | |
349 "cancel": { | 440 "cancel": { |
350 "description": "Starts a job cancellation request. T
o access the job resource after cancellation, call jobs.list or jobs.get.", | 441 "description": "Starts a job cancellation request. T
o access the job resource after cancellation, call jobs.list or jobs.get.", |
351 "httpMethod": "POST", | 442 "httpMethod": "POST", |
352 "id": "dataproc.projects.jobs.cancel", | 443 "id": "dataproc.projects.jobs.cancel", |
353 "parameterOrder": [ | 444 "parameterOrder": [ |
354 "projectId", | 445 "projectId", |
355 "jobId" | 446 "jobId" |
356 ], | 447 ], |
357 "parameters": { | 448 "parameters": { |
358 "projectId": { | 449 "projectId": { |
(...skipping 81 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
440 "type": "string" | 531 "type": "string" |
441 } | 532 } |
442 }, | 533 }, |
443 "path": "v1beta1/projects/{projectId}/jobs/{jobId}", | 534 "path": "v1beta1/projects/{projectId}/jobs/{jobId}", |
444 "response": { | 535 "response": { |
445 "$ref": "Job" | 536 "$ref": "Job" |
446 }, | 537 }, |
447 "scopes": [ | 538 "scopes": [ |
448 "https://www.googleapis.com/auth/cloud-platform" | 539 "https://www.googleapis.com/auth/cloud-platform" |
449 ] | 540 ] |
450 } | 541 }, |
451 } | 542 "submit": { |
452 }, | 543 "description": "Submits a job to a cluster.", |
453 "clusters": { | 544 "httpMethod": "POST", |
454 "methods": { | 545 "id": "dataproc.projects.jobs.submit", |
455 "get": { | |
456 "description": "Gets the resource representation for
a cluster in a project.", | |
457 "httpMethod": "GET", | |
458 "id": "dataproc.projects.clusters.get", | |
459 "parameterOrder": [ | 546 "parameterOrder": [ |
460 "projectId", | 547 "projectId" |
461 "clusterName" | |
462 ], | 548 ], |
463 "parameters": { | 549 "parameters": { |
464 "clusterName": { | |
465 "description": "Required The cluster name.", | |
466 "location": "path", | |
467 "required": true, | |
468 "type": "string" | |
469 }, | |
470 "projectId": { | 550 "projectId": { |
471 "description": "Required The ID of the Googl
e Cloud Platform project that the cluster belongs to.", | 551 "description": "Required The ID of the Googl
e Cloud Platform project that the job belongs to.", |
472 "location": "path", | 552 "location": "path", |
473 "required": true, | 553 "required": true, |
474 "type": "string" | 554 "type": "string" |
475 } | 555 } |
476 }, | 556 }, |
477 "path": "v1beta1/projects/{projectId}/clusters/{clus
terName}", | 557 "path": "v1beta1/projects/{projectId}/jobs:submit", |
478 "response": { | |
479 "$ref": "Cluster" | |
480 }, | |
481 "scopes": [ | |
482 "https://www.googleapis.com/auth/cloud-platform" | |
483 ] | |
484 }, | |
485 "patch": { | |
486 "description": "Updates a cluster in a project.", | |
487 "httpMethod": "PATCH", | |
488 "id": "dataproc.projects.clusters.patch", | |
489 "parameterOrder": [ | |
490 "projectId", | |
491 "clusterName" | |
492 ], | |
493 "parameters": { | |
494 "clusterName": { | |
495 "description": "Required The cluster name.", | |
496 "location": "path", | |
497 "required": true, | |
498 "type": "string" | |
499 }, | |
500 "projectId": { | |
501 "description": "Required The ID of the Googl
e Cloud Platform project the cluster belongs to.", | |
502 "location": "path", | |
503 "required": true, | |
504 "type": "string" | |
505 }, | |
506 "updateMask": { | |
507 "description": "Required Specifies the path,
relative to <code>Cluster</code>, of the field to update. For example, to chang
e the number of workers in a cluster to 5, the <code>update_mask</code> paramete
r would be specified as <code>configuration.worker_configuration.num_instances</
code>, and the PATCH request body would specify the new value, as follows:\n{\n
\"configuration\":{\n \"workerConfiguration\":{\n \"numInstances\":\"5\
"\n }\n }\n}\nSimilarly, to change the number of preemptible workers in a cl
uster to 5, the <code>update_mask</code> parameter would be <code>config.seconda
ry_worker_config.num_instances</code>, and the PATCH request body would be set a
s follows:\n{\n \"config\":{\n \"secondaryWorkerConfig\":{\n \"numInsta
nces\":\"5\"\n }\n }\n}\n<strong>Note:</strong> Currently, <code>config.work
er_config.num_instances</code> and <code>config.secondary_worker_config.num_inst
ances</code> are the only fields that can be updated.", | |
508 "format": "google-fieldmask", | |
509 "location": "query", | |
510 "type": "string" | |
511 } | |
512 }, | |
513 "path": "v1beta1/projects/{projectId}/clusters/{clus
terName}", | |
514 "request": { | 558 "request": { |
515 "$ref": "Cluster" | 559 "$ref": "SubmitJobRequest" |
516 }, | 560 }, |
517 "response": { | 561 "response": { |
518 "$ref": "Operation" | 562 "$ref": "Job" |
519 }, | |
520 "scopes": [ | |
521 "https://www.googleapis.com/auth/cloud-platform" | |
522 ] | |
523 }, | |
524 "diagnose": { | |
525 "description": "Gets cluster diagnostic information.
After the operation completes, the Operation.response field contains DiagnoseCl
usterOutputLocation.", | |
526 "httpMethod": "POST", | |
527 "id": "dataproc.projects.clusters.diagnose", | |
528 "parameterOrder": [ | |
529 "projectId", | |
530 "clusterName" | |
531 ], | |
532 "parameters": { | |
533 "clusterName": { | |
534 "description": "Required The cluster name.", | |
535 "location": "path", | |
536 "required": true, | |
537 "type": "string" | |
538 }, | |
539 "projectId": { | |
540 "description": "Required The ID of the Googl
e Cloud Platform project that the cluster belongs to.", | |
541 "location": "path", | |
542 "required": true, | |
543 "type": "string" | |
544 } | |
545 }, | |
546 "path": "v1beta1/projects/{projectId}/clusters/{clus
terName}:diagnose", | |
547 "request": { | |
548 "$ref": "DiagnoseClusterRequest" | |
549 }, | |
550 "response": { | |
551 "$ref": "Operation" | |
552 }, | 563 }, |
553 "scopes": [ | 564 "scopes": [ |
554 "https://www.googleapis.com/auth/cloud-platform" | 565 "https://www.googleapis.com/auth/cloud-platform" |
555 ] | 566 ] |
556 }, | 567 }, |
557 "delete": { | 568 "delete": { |
558 "description": "Deletes a cluster in a project.", | 569 "description": "Deletes the job from the project. If
the job is active, the delete fails, and the response returns FAILED_PRECONDITI
ON.", |
559 "httpMethod": "DELETE", | 570 "httpMethod": "DELETE", |
560 "id": "dataproc.projects.clusters.delete", | 571 "id": "dataproc.projects.jobs.delete", |
561 "parameterOrder": [ | 572 "parameterOrder": [ |
562 "projectId", | 573 "projectId", |
563 "clusterName" | 574 "jobId" |
564 ], | 575 ], |
565 "parameters": { | 576 "parameters": { |
566 "clusterName": { | 577 "projectId": { |
567 "description": "Required The cluster name.", | 578 "description": "Required The ID of the Googl
e Cloud Platform project that the job belongs to.", |
568 "location": "path", | 579 "location": "path", |
569 "required": true, | 580 "required": true, |
570 "type": "string" | 581 "type": "string" |
571 }, | 582 }, |
572 "projectId": { | 583 "jobId": { |
573 "description": "Required The ID of the Googl
e Cloud Platform project that the cluster belongs to.", | 584 "description": "Required The job ID.", |
574 "location": "path", | 585 "location": "path", |
575 "required": true, | 586 "required": true, |
576 "type": "string" | 587 "type": "string" |
577 } | 588 } |
578 }, | 589 }, |
579 "path": "v1beta1/projects/{projectId}/clusters/{clus
terName}", | 590 "path": "v1beta1/projects/{projectId}/jobs/{jobId}", |
580 "response": { | 591 "response": { |
581 "$ref": "Operation" | 592 "$ref": "Empty" |
582 }, | 593 }, |
583 "scopes": [ | 594 "scopes": [ |
584 "https://www.googleapis.com/auth/cloud-platform" | 595 "https://www.googleapis.com/auth/cloud-platform" |
585 ] | 596 ] |
586 }, | 597 }, |
587 "list": { | 598 "list": { |
588 "description": "Lists all clusters in a project.", | 599 "description": "Lists jobs in a project.", |
589 "httpMethod": "GET", | 600 "httpMethod": "GET", |
590 "id": "dataproc.projects.clusters.list", | 601 "id": "dataproc.projects.jobs.list", |
591 "parameterOrder": [ | 602 "parameterOrder": [ |
592 "projectId" | 603 "projectId" |
593 ], | 604 ], |
594 "parameters": { | 605 "parameters": { |
595 "filter": { | |
596 "description": "Optional A filter constraini
ng which clusters to list. Valid filters contain label terms such as: labels.key
1 = val1 AND (-labels.k2 = val2 OR labels.k3 = val3)", | |
597 "location": "query", | |
598 "type": "string" | |
599 }, | |
600 "pageToken": { | 606 "pageToken": { |
601 "description": "The standard List page token
.", | 607 "description": "Optional The page token, ret
urned by a previous call, to request the next page of results.", |
602 "location": "query", | 608 "location": "query", |
603 "type": "string" | 609 "type": "string" |
604 }, | 610 }, |
605 "pageSize": { | 611 "pageSize": { |
606 "description": "The standard List page size.
", | 612 "description": "Optional The number of resul
ts to return in each response.", |
607 "format": "int32", | 613 "format": "int32", |
608 "location": "query", | 614 "location": "query", |
609 "type": "integer" | 615 "type": "integer" |
610 }, | 616 }, |
| 617 "clusterName": { |
| 618 "description": "Optional If set, the returne
d jobs list includes only jobs that were submitted to the named cluster.", |
| 619 "location": "query", |
| 620 "type": "string" |
| 621 }, |
611 "projectId": { | 622 "projectId": { |
612 "description": "Required The ID of the Googl
e Cloud Platform project that the cluster belongs to.", | 623 "description": "Required The ID of the Googl
e Cloud Platform project that the job belongs to.", |
613 "location": "path", | 624 "location": "path", |
614 "required": true, | 625 "required": true, |
615 "type": "string" | 626 "type": "string" |
| 627 }, |
| 628 "filter": { |
| 629 "description": "Optional A filter constraini
ng which jobs to list. Valid filters contain job state and label terms such as:
labels.key1 = val1 AND (labels.k2 = val2 OR labels.k3 = val3)", |
| 630 "location": "query", |
| 631 "type": "string" |
| 632 }, |
| 633 "jobStateMatcher": { |
| 634 "description": "Optional Specifies enumerate
d categories of jobs to list.", |
| 635 "enum": [ |
| 636 "ALL", |
| 637 "ACTIVE", |
| 638 "NON_ACTIVE" |
| 639 ], |
| 640 "location": "query", |
| 641 "type": "string" |
616 } | 642 } |
617 }, | 643 }, |
618 "path": "v1beta1/projects/{projectId}/clusters", | 644 "path": "v1beta1/projects/{projectId}/jobs", |
619 "response": { | 645 "response": { |
620 "$ref": "ListClustersResponse" | 646 "$ref": "ListJobsResponse" |
621 }, | 647 }, |
622 "scopes": [ | 648 "scopes": [ |
623 "https://www.googleapis.com/auth/cloud-platform" | 649 "https://www.googleapis.com/auth/cloud-platform" |
624 ] | |
625 }, | |
626 "create": { | |
627 "description": "Creates a cluster in a project.", | |
628 "httpMethod": "POST", | |
629 "id": "dataproc.projects.clusters.create", | |
630 "parameterOrder": [ | |
631 "projectId" | |
632 ], | |
633 "parameters": { | |
634 "projectId": { | |
635 "description": "Required The ID of the Googl
e Cloud Platform project that the cluster belongs to.", | |
636 "location": "path", | |
637 "required": true, | |
638 "type": "string" | |
639 } | |
640 }, | |
641 "path": "v1beta1/projects/{projectId}/clusters", | |
642 "request": { | |
643 "$ref": "Cluster" | |
644 }, | |
645 "response": { | |
646 "$ref": "Operation" | |
647 }, | |
648 "scopes": [ | |
649 "https://www.googleapis.com/auth/cloud-platform" | |
650 ] | 650 ] |
651 } | 651 } |
652 } | 652 } |
653 } | 653 } |
654 } | 654 } |
655 } | 655 } |
656 }, | 656 }, |
657 "revision": "20170228", | 657 "revision": "20170321", |
658 "rootUrl": "https://dataproc.googleapis.com/", | 658 "rootUrl": "https://dataproc.googleapis.com/", |
659 "schemas": { | 659 "schemas": { |
660 "ClusterMetrics": { | 660 "PigJob": { |
661 "description": "Contains cluster daemon metrics, such as HDFS and YA
RN stats.", | 661 "description": "A Cloud Dataproc job for running Pig queries on YARN
.", |
662 "id": "ClusterMetrics", | 662 "id": "PigJob", |
663 "properties": { | 663 "properties": { |
664 "yarnMetrics": { | 664 "continueOnFailure": { |
| 665 "description": "Optional Whether to continue executing queri
es if a query fails. The default value is false. Setting to true can be useful w
hen executing independent parallel queries.", |
| 666 "type": "boolean" |
| 667 }, |
| 668 "queryList": { |
| 669 "$ref": "QueryList", |
| 670 "description": "A list of queries." |
| 671 }, |
| 672 "queryFileUri": { |
| 673 "description": "The HCFS URI of the script that contains the
Pig queries.", |
| 674 "type": "string" |
| 675 }, |
| 676 "jarFileUris": { |
| 677 "description": "Optional HCFS URIs of jar files to add to th
e CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig U
DFs.", |
| 678 "items": { |
| 679 "type": "string" |
| 680 }, |
| 681 "type": "array" |
| 682 }, |
| 683 "scriptVariables": { |
665 "additionalProperties": { | 684 "additionalProperties": { |
666 "format": "int64", | 685 "type": "string" |
667 "type": "string" | 686 }, |
668 }, | 687 "description": "Optional Mapping of query variable names to
values (equivalent to the Pig command: name=[value]).", |
669 "description": "The YARN metrics.", | |
670 "type": "object" | 688 "type": "object" |
671 }, | 689 }, |
672 "hdfsMetrics": { | 690 "loggingConfiguration": { |
| 691 "$ref": "LoggingConfiguration", |
| 692 "description": "Optional The runtime log configuration for j
ob execution." |
| 693 }, |
| 694 "properties": { |
673 "additionalProperties": { | 695 "additionalProperties": { |
674 "format": "int64", | 696 "type": "string" |
675 "type": "string" | 697 }, |
676 }, | 698 "description": "Optional A mapping of property names to valu
es, used to configure Pig. Properties that conflict with values set by the Cloud
Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf
/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.", |
677 "description": "The HDFS metrics.", | |
678 "type": "object" | 699 "type": "object" |
679 } | 700 } |
680 }, | 701 }, |
681 "type": "object" | 702 "type": "object" |
682 }, | 703 }, |
683 "ClusterConfiguration": { | 704 "ClusterStatus": { |
684 "description": "The cluster configuration.", | 705 "description": "The status of a cluster and its instances.", |
685 "id": "ClusterConfiguration", | 706 "id": "ClusterStatus", |
686 "properties": { | 707 "properties": { |
687 "masterConfiguration": { | 708 "state": { |
688 "$ref": "InstanceGroupConfiguration", | 709 "description": "The cluster's state.", |
689 "description": "Optional The Google Compute Engine configura
tion settings for the master instance in a cluster." | 710 "enum": [ |
690 }, | 711 "UNKNOWN", |
691 "secondaryWorkerConfiguration": { | 712 "CREATING", |
692 "$ref": "InstanceGroupConfiguration", | 713 "RUNNING", |
693 "description": "Optional The Google Compute Engine configura
tion settings for additional worker instances in a cluster." | 714 "ERROR", |
694 }, | 715 "DELETING", |
695 "initializationActions": { | 716 "UPDATING" |
696 "description": "Optional Commands to execute on each node af
ter configuration is completed. By default, executables are run on master and al
l worker nodes. You can test a node's <code>role</code> metadata to run an execu
table on a master or worker node, as shown below:\nROLE=$(/usr/share/google/get_
metadata_value attributes/role)\nif [[ \"${ROLE}\" == 'Master' ]]; then\n ... m
aster specific actions ...\nelse\n ... worker specific actions ...\nfi\n", | 717 ], |
697 "items": { | 718 "enumDescriptions": [ |
698 "$ref": "NodeInitializationAction" | 719 "The cluster state is unknown.", |
699 }, | 720 "The cluster is being created and set up. It is not read
y for use.", |
700 "type": "array" | 721 "The cluster is currently running and healthy. It is rea
dy for use.", |
701 }, | 722 "The cluster encountered an error. It is not ready for u
se.", |
702 "workerConfiguration": { | 723 "The cluster is being deleted. It cannot be used.", |
703 "$ref": "InstanceGroupConfiguration", | 724 "The cluster is being updated. It continues to accept an
d process jobs." |
704 "description": "Optional The Google Compute Engine configura
tion settings for worker instances in a cluster." | 725 ], |
705 }, | 726 "type": "string" |
706 "softwareConfiguration": { | 727 }, |
707 "$ref": "SoftwareConfiguration", | 728 "stateStartTime": { |
708 "description": "Optional The configuration settings for soft
ware inside the cluster." | 729 "description": "Time when this state was entered.", |
709 }, | 730 "format": "google-datetime", |
710 "gceClusterConfiguration": { | 731 "type": "string" |
711 "$ref": "GceClusterConfiguration", | 732 }, |
712 "description": "Required The shared Google Compute Engine co
nfiguration settings for all instances in a cluster." | 733 "substate": { |
713 }, | 734 "description": "Output-only Additional state information tha
t includes status reported by the agent.", |
714 "configurationBucket": { | 735 "enum": [ |
715 "description": "Optional A Google Cloud Storage staging buck
et used for sharing generated SSH keys and configuration. If you do not specify
a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage loc
ation (US, ASIA, or EU) for your cluster's staging bucket according to the Googl
e Compute Engine zone where your cluster is deployed, and then it will create an
d manage this project-level, per-location bucket for you.", | 736 "UNSPECIFIED", |
716 "type": "string" | 737 "UNHEALTHY", |
717 } | 738 "STALE_STATUS" |
718 }, | 739 ], |
719 "type": "object" | 740 "enumDescriptions": [ |
720 }, | 741 "", |
721 "LoggingConfiguration": { | 742 "The cluster is known to be in an unhealthy state (for e
xample, critical daemons are not running or HDFS capacity is exhausted).Applies
to RUNNING state.", |
722 "description": "The runtime logging configuration of the job.", | 743 "The agent-reported status is out of date (may occur if
Cloud Dataproc loses communication with Agent).Applies to RUNNING state." |
723 "id": "LoggingConfiguration", | 744 ], |
724 "properties": { | 745 "type": "string" |
725 "driverLogLevels": { | 746 }, |
726 "additionalProperties": { | 747 "detail": { |
727 "enum": [ | 748 "description": "Optional details of cluster's state.", |
728 "LEVEL_UNSPECIFIED", | 749 "type": "string" |
729 "ALL", | 750 } |
730 "TRACE", | 751 }, |
731 "DEBUG", | 752 "type": "object" |
732 "INFO", | 753 }, |
733 "WARN", | 754 "AcceleratorConfiguration": { |
734 "ERROR", | 755 "description": "Specifies the type and number of accelerator cards a
ttached to the instances of an instance group (see GPUs on Compute Engine).", |
735 "FATAL", | 756 "id": "AcceleratorConfiguration", |
736 "OFF" | 757 "properties": { |
737 ], | 758 "acceleratorCount": { |
738 "type": "string" | 759 "description": "The number of the accelerator cards of this
type exposed to this instance.", |
739 }, | |
740 "description": "The per-package log levels for the driver. T
his may include \"root\" package name to configure rootLogger. Examples: 'com.g
oogle = FATAL', 'root = INFO', 'org.apache = DEBUG'", | |
741 "type": "object" | |
742 } | |
743 }, | |
744 "type": "object" | |
745 }, | |
746 "InstanceGroupConfiguration": { | |
747 "description": "The configuration settings for Google Compute Engine
resources in an instance group, such as a master or worker group.", | |
748 "id": "InstanceGroupConfiguration", | |
749 "properties": { | |
750 "numInstances": { | |
751 "description": "The number of VM instances in the instance g
roup. For master instance groups, must be set to 1.", | |
752 "format": "int32", | 760 "format": "int32", |
753 "type": "integer" | 761 "type": "integer" |
754 }, | 762 }, |
755 "diskConfiguration": { | 763 "acceleratorTypeUri": { |
756 "$ref": "DiskConfiguration", | 764 "description": "Full or partial URI of the accelerator type
resource to expose to this instance. See Google Compute Engine AcceleratorTypes(
/compute/docs/reference/beta/acceleratorTypes)", |
757 "description": "Disk option configuration settings." | 765 "type": "string" |
758 }, | 766 } |
759 "isPreemptible": { | 767 }, |
760 "description": "Specifies that this instance group contains
Preemptible Instances.", | 768 "type": "object" |
| 769 }, |
| 770 "ManagedGroupConfiguration": { |
| 771 "description": "Specifies the resources used to actively manage an i
nstance group.", |
| 772 "id": "ManagedGroupConfiguration", |
| 773 "properties": { |
| 774 "instanceGroupManagerName": { |
| 775 "description": "Output-only The name of the Instance Group M
anager for this group.", |
| 776 "type": "string" |
| 777 }, |
| 778 "instanceTemplateName": { |
| 779 "description": "Output-only The name of the Instance Templat
e used for the Managed Instance Group.", |
| 780 "type": "string" |
| 781 } |
| 782 }, |
| 783 "type": "object" |
| 784 }, |
| 785 "ListClustersResponse": { |
| 786 "description": "The list of all clusters in a project.", |
| 787 "id": "ListClustersResponse", |
| 788 "properties": { |
| 789 "clusters": { |
| 790 "description": "Output-only The clusters in the project.", |
| 791 "items": { |
| 792 "$ref": "Cluster" |
| 793 }, |
| 794 "type": "array" |
| 795 }, |
| 796 "nextPageToken": { |
| 797 "description": "The standard List next-page token.", |
| 798 "type": "string" |
| 799 } |
| 800 }, |
| 801 "type": "object" |
| 802 }, |
| 803 "SparkJob": { |
| 804 "description": "A Cloud Dataproc job for running Spark applications
on YARN.", |
| 805 "id": "SparkJob", |
| 806 "properties": { |
| 807 "mainJarFileUri": { |
| 808 "description": "The Hadoop Compatible Filesystem (HCFS) URI
of the jar file that contains the main class.", |
| 809 "type": "string" |
| 810 }, |
| 811 "jarFileUris": { |
| 812 "description": "Optional HCFS URIs of jar files to add to th
e CLASSPATHs of the Spark driver and tasks.", |
| 813 "items": { |
| 814 "type": "string" |
| 815 }, |
| 816 "type": "array" |
| 817 }, |
| 818 "loggingConfiguration": { |
| 819 "$ref": "LoggingConfiguration", |
| 820 "description": "Optional The runtime log configuration for j
ob execution." |
| 821 }, |
| 822 "properties": { |
| 823 "additionalProperties": { |
| 824 "type": "string" |
| 825 }, |
| 826 "description": "Optional A mapping of property names to valu
es, used to configure Spark. Properties that conflict with values set by the Clo
ud Dataproc API may be overwritten. Can include properties set in /etc/spark/con
f/spark-defaults.conf and classes in user code.", |
| 827 "type": "object" |
| 828 }, |
| 829 "args": { |
| 830 "description": "Optional The arguments to pass to the driver
. Do not include arguments, such as --conf, that can be set as job properties, s
ince a collision may occur that causes an incorrect job submission.", |
| 831 "items": { |
| 832 "type": "string" |
| 833 }, |
| 834 "type": "array" |
| 835 }, |
| 836 "fileUris": { |
| 837 "description": "Optional HCFS URIs of files to be copied to
the working directory of Spark drivers and distributed tasks. Useful for naively
parallel tasks.", |
| 838 "items": { |
| 839 "type": "string" |
| 840 }, |
| 841 "type": "array" |
| 842 }, |
| 843 "mainClass": { |
| 844 "description": "The name of the driver's main class. The jar
file that contains the class must be in the default CLASSPATH or specified in j
ar_file_uris.", |
| 845 "type": "string" |
| 846 }, |
| 847 "archiveUris": { |
| 848 "description": "Optional HCFS URIs of archives to be extract
ed in the working directory of Spark drivers and tasks. Supported file types: .j
ar, .tar, .tar.gz, .tgz, and .zip.", |
| 849 "items": { |
| 850 "type": "string" |
| 851 }, |
| 852 "type": "array" |
| 853 } |
| 854 }, |
| 855 "type": "object" |
| 856 }, |
| 857 "Job": { |
| 858 "description": "A Cloud Dataproc job resource.", |
| 859 "id": "Job", |
| 860 "properties": { |
| 861 "interactive": { |
| 862 "description": "Optional If set to true, the driver's stdin
will be kept open and driver_input_uri will be set to provide a path at which ad
ditional input can be sent to the driver.", |
761 "type": "boolean" | 863 "type": "boolean" |
762 }, | 864 }, |
763 "imageUri": { | 865 "driverInputResourceUri": { |
764 "description": "Output-only The Google Compute Engine image
resource used for cluster instances. Inferred from SoftwareConfiguration.image_v
ersion.", | 866 "description": "Output-only A URI pointing to the location o
f the stdin of the job's driver program, only set if the job is interactive.", |
765 "type": "string" | 867 "type": "string" |
766 }, | 868 }, |
767 "machineTypeUri": { | 869 "hadoopJob": { |
768 "description": "The Google Compute Engine machine type used
for cluster instances. Example: https://www.googleapis.com/compute/v1/projects/[
project_id]/zones/us-east1-a/machineTypes/n1-standard-2.", | 870 "$ref": "HadoopJob", |
769 "type": "string" | 871 "description": "Job is a Hadoop job." |
770 }, | 872 }, |
771 "managedGroupConfiguration": { | 873 "status": { |
772 "$ref": "ManagedGroupConfiguration", | 874 "$ref": "JobStatus", |
773 "description": "Output-only The configuration for Google Com
pute Engine Instance Group Manager that manages this group. This is only used fo
r preemptible instance groups." | 875 "description": "Output-only The job status. Additional appli
cation-specific status information may be contained in the <code>type_job</code>
and <code>yarn_applications</code> fields." |
774 }, | 876 }, |
775 "instanceNames": { | 877 "placement": { |
776 "description": "The list of instance names. Dataproc derives
the names from cluster_name, num_instances, and the instance group if not set b
y user (recommended practice is to let Dataproc derive the name).", | 878 "$ref": "JobPlacement", |
777 "items": { | 879 "description": "Required Job information, including how, whe
n, and where to run the job." |
778 "type": "string" | 880 }, |
779 }, | 881 "driverControlFilesUri": { |
780 "type": "array" | 882 "description": "Output-only If present, the location of misc
ellaneous control files which may be used as part of job setup and handling. If
not present, control files may be placed in the same location as driver_output_u
ri.", |
781 }, | 883 "type": "string" |
782 "accelerators": { | 884 }, |
783 "description": "Optional The Google Compute Engine accelerat
or configuration for these instances.", | 885 "submittedBy": { |
784 "items": { | 886 "description": "Output-only The email address of the user su
bmitting the job. For jobs submitted on the cluster, the address is <code>userna
me@hostname</code>.", |
785 "$ref": "AcceleratorConfiguration" | 887 "type": "string" |
786 }, | 888 }, |
787 "type": "array" | 889 "scheduling": { |
788 } | 890 "$ref": "JobScheduling", |
789 }, | 891 "description": "Optional Job scheduling configuration." |
790 "type": "object" | 892 }, |
791 }, | 893 "pigJob": { |
792 "GceClusterConfiguration": { | 894 "$ref": "PigJob", |
793 "description": "Common configuration settings for resources of Googl
e Compute Engine cluster instances, applicable to all instances in the cluster."
, | 895 "description": "Job is a Pig job." |
794 "id": "GceClusterConfiguration", | 896 }, |
795 "properties": { | 897 "hiveJob": { |
796 "networkUri": { | 898 "$ref": "HiveJob", |
797 "description": "The Google Compute Engine network to be used
for machine communications. Cannot be specified with subnetwork_uri. If neither
network_uri nor subnetwork_uri is specified, the \"default\" network of the pro
ject is used, if it exists. Cannot be a \"Custom Subnet Network\" (see https://c
loud.google.com/compute/docs/subnetworks for more information). Example: https:/
/www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default.", | 899 "description": "Job is a Hive job." |
798 "type": "string" | 900 }, |
799 }, | 901 "labels": { |
800 "zoneUri": { | |
801 "description": "Required The zone where the Google Compute E
ngine cluster will be located. Example: https://www.googleapis.com/compute/v1/pr
ojects/[project_id]/zones/[zone].", | |
802 "type": "string" | |
803 }, | |
804 "metadata": { | |
805 "additionalProperties": { | 902 "additionalProperties": { |
806 "type": "string" | 903 "type": "string" |
807 }, | 904 }, |
808 "description": "The Google Compute Engine metadata entries t
o add to all instances.", | 905 "description": "Optional The labels to associate with this j
ob.Label keys must be between 1 and 63 characters long, and must conform to the
following regular expression: \\p{Ll}\\p{Lo}{0,62}Label values must be between 1
and 63 characters long, and must conform to the following regular expression: \
\p{Ll}\\p{Lo}\\p{N}_-{0,63}No more than 64 labels can be associated with a given
job.", |
809 "type": "object" | 906 "type": "object" |
810 }, | 907 }, |
811 "internalIpOnly": { | 908 "driverOutputResourceUri": { |
812 "description": "If true, all instances in the cluser will on
ly have internal IP addresses. By default, clusters are not restricted to intern
al IP addresses, and will have ephemeral external IP addresses assigned to each
instance. This restriction can only be enabled for subnetwork enabled networks,
and all off-cluster dependencies must be configured to be accessible without ext
ernal IP addresses.", | 909 "description": "Output-only A URI pointing to the location o
f the stdout of the job's driver program.", |
813 "type": "boolean" | 910 "type": "string" |
814 }, | 911 }, |
815 "serviceAccountScopes": { | 912 "sparkSqlJob": { |
816 "description": "The URIs of service account scopes to be inc
luded in Google Compute Engine instances. The following base set of scopes is al
ways included: - https://www.googleapis.com/auth/cloud.useraccounts.readonly - h
ttps://www.googleapis.com/auth/devstorage.read_write - https://www.googleapis.co
m/auth/logging.write If no scopes are specfied, the following defaults are also
provided: - https://www.googleapis.com/auth/bigquery - https://www.googleapis.co
m/auth/bigtable.admin.table - https://www.googleapis.com/auth/bigtable.data - ht
tps://www.googleapis.com/auth/devstorage.full_control", | 913 "$ref": "SparkSqlJob", |
817 "items": { | 914 "description": "Job is a SparkSql job." |
818 "type": "string" | 915 }, |
819 }, | 916 "sparkJob": { |
820 "type": "array" | 917 "$ref": "SparkJob", |
821 }, | 918 "description": "Job is a Spark job." |
822 "tags": { | 919 }, |
823 "description": "The Google Compute Engine tags to add to all
instances.", | 920 "statusHistory": { |
824 "items": { | 921 "description": "Output-only The previous job status.", |
825 "type": "string" | 922 "items": { |
826 }, | 923 "$ref": "JobStatus" |
827 "type": "array" | 924 }, |
828 }, | 925 "type": "array" |
829 "serviceAccount": { | 926 }, |
830 "description": "Optional The service account of the instance
s. Defaults to the default Google Compute Engine service account. Custom service
accounts need permissions equivalent to the folloing IAM roles:\nroles/logging.
logWriter\nroles/storage.objectAdmin(see https://cloud.google.com/compute/docs/a
ccess/service-accounts#custom_service_accounts for more information). Example: [
account_id]@[project_id].iam.gserviceaccount.com", | 927 "yarnApplications": { |
831 "type": "string" | 928 "description": "Output-only The collection of YARN applicati
ons spun up by this job.", |
832 }, | 929 "items": { |
833 "subnetworkUri": { | 930 "$ref": "YarnApplication" |
834 "description": "The Google Compute Engine subnetwork to be u
sed for machine communications. Cannot be specified with network_uri. Example: h
ttps://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0
.", | 931 }, |
835 "type": "string" | 932 "type": "array" |
836 } | 933 }, |
837 }, | 934 "pysparkJob": { |
838 "type": "object" | 935 "$ref": "PySparkJob", |
839 }, | 936 "description": "Job is a Pyspark job." |
840 "CancelOperationRequest": { | 937 }, |
841 "description": "The request message for Operations.CancelOperation."
, | 938 "reference": { |
842 "id": "CancelOperationRequest", | 939 "$ref": "JobReference", |
843 "properties": {}, | 940 "description": "Optional The fully qualified reference to th
e job, which can be used to obtain the equivalent REST path of the job resource.
If this property is not specified when a job is created, the server generates a
<code>job_id</code>." |
844 "type": "object" | 941 } |
845 }, | 942 }, |
846 "DiagnoseClusterOutputLocation": { | 943 "type": "object" |
847 "description": "The location of diagnostic output.", | 944 }, |
848 "id": "DiagnoseClusterOutputLocation", | 945 "JobStatus": { |
849 "properties": { | 946 "description": "Cloud Dataproc job status.", |
850 "outputUri": { | 947 "id": "JobStatus", |
851 "description": "Output-only The Google Cloud Storage URI of
the diagnostic output. This is a plain text file with a summary of collected dia
gnostics.", | 948 "properties": { |
852 "type": "string" | 949 "stateStartTime": { |
853 } | 950 "description": "Output-only The time when this state was ent
ered.", |
854 }, | 951 "format": "google-datetime", |
855 "type": "object" | 952 "type": "string" |
856 }, | 953 }, |
857 "Operation": { | 954 "substate": { |
858 "description": "This resource represents a long-running operation th
at is the result of a network API call.", | 955 "description": "Output-only Additional state information, wh
ich includes status reported by the agent.", |
859 "id": "Operation", | 956 "enum": [ |
860 "properties": { | 957 "UNSPECIFIED", |
861 "done": { | 958 "SUBMITTED", |
862 "description": "If the value is false, it means the operatio
n is still in progress. If true, the operation is completed, and either error or
response is available.", | 959 "QUEUED", |
863 "type": "boolean" | 960 "STALE_STATUS" |
864 }, | 961 ], |
865 "response": { | 962 "enumDescriptions": [ |
866 "additionalProperties": { | 963 "", |
867 "description": "Properties of the object. Contains field
@type with type URL.", | 964 "The Job is submitted to the agent.Applies to RUNNING st
ate.", |
868 "type": "any" | 965 "The Job has been received and is awaiting execution (it
may be waiting for a condition to be met). See the \"details\" field for the re
ason for the delay.Applies to RUNNING state.", |
869 }, | 966 "The agent-reported status is out of date, which may be
caused by a loss of communication between the agent and Cloud Dataproc. If the a
gent does not send a timely update, the job will fail.Applies to RUNNING state." |
870 "description": "The normal response of the operation in case
of success. If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty. If the original method is standard Get/Cr
eate/Update, the response should be the resource. For other methods, the respons
e should have the type XxxResponse, where Xxx is the original method name. For e
xample, if the original method name is TakeSnapshot(), the inferred response typ
e is TakeSnapshotResponse.", | 967 ], |
871 "type": "object" | 968 "type": "string" |
872 }, | 969 }, |
873 "name": { | 970 "state": { |
874 "description": "The server-assigned name, which is only uniq
ue within the same service that originally returns it. If you use the default HT
TP mapping, the name should have the format of operations/some/unique/name.", | 971 "description": "Required A state message specifying the over
all job state.", |
875 "type": "string" | 972 "enum": [ |
876 }, | 973 "STATE_UNSPECIFIED", |
877 "error": { | 974 "PENDING", |
878 "$ref": "Status", | 975 "SETUP_DONE", |
879 "description": "The error result of the operation in case of
failure or cancellation." | 976 "RUNNING", |
880 }, | 977 "CANCEL_PENDING", |
881 "metadata": { | 978 "CANCEL_STARTED", |
882 "additionalProperties": { | 979 "CANCELLED", |
883 "description": "Properties of the object. Contains field
@type with type URL.", | 980 "DONE", |
884 "type": "any" | 981 "ERROR", |
885 }, | 982 "ATTEMPT_FAILURE" |
886 "description": "Service-specific metadata associated with th
e operation. It typically contains progress information and common metadata such
as create time. Some services might not provide such metadata. Any method that
returns a long-running operation should document the metadata type, if any.", | 983 ], |
887 "type": "object" | 984 "enumDescriptions": [ |
888 } | 985 "The job state is unknown.", |
889 }, | 986 "The job is pending; it has been submitted, but is not y
et running.", |
890 "type": "object" | 987 "Job has been received by the service and completed init
ial setup; it will shortly be submitted to the cluster.", |
891 }, | 988 "The job is running on the cluster.", |
892 "OperationStatus": { | 989 "A CancelJob request has been received, but is pending."
, |
| 990 "Transient in-flight resources have been canceled, and t
he request to cancel the running job has been issued to the cluster.", |
| 991 "The job cancelation was successful.", |
| 992 "The job has completed successfully.", |
| 993 "The job has completed, but encountered an error.", |
| 994 "Job attempt has failed. The detail field contains failu
re details for this attempt.Applies to restartable jobs only." |
| 995 ], |
| 996 "type": "string" |
| 997 }, |
| 998 "details": { |
| 999 "description": "Optional Job state details, such as an error
description if the state is <code>ERROR</code>.", |
| 1000 "type": "string" |
| 1001 } |
| 1002 }, |
| 1003 "type": "object" |
| 1004 }, |
| 1005 "DiskConfiguration": { |
| 1006 "description": "Specifies the configuration of disk options for a gr
oup of VM instances.", |
| 1007 "id": "DiskConfiguration", |
| 1008 "properties": { |
| 1009 "numLocalSsds": { |
| 1010 "description": "Optional Number of attached SSDs, from 0 to
4 (default is 0). If SSDs are not attached, the boot disk is used to store runti
me logs and HDFS data. If one or more SSDs are attached, this runtime bulk data
is spread across them, and the boot disk contains only basic configuration and i
nstalled binaries.", |
| 1011 "format": "int32", |
| 1012 "type": "integer" |
| 1013 }, |
| 1014 "bootDiskSizeGb": { |
| 1015 "description": "Optional Size in GB of the boot disk (defaul
t is 500GB).", |
| 1016 "format": "int32", |
| 1017 "type": "integer" |
| 1018 } |
| 1019 }, |
| 1020 "type": "object" |
| 1021 }, |
| 1022 "ClusterOperationStatus": { |
893 "description": "The status of the operation.", | 1023 "description": "The status of the operation.", |
894 "id": "OperationStatus", | 1024 "id": "ClusterOperationStatus", |
895 "properties": { | 1025 "properties": { |
896 "stateStartTime": { | |
897 "description": "The time this state was entered.", | |
898 "format": "google-datetime", | |
899 "type": "string" | |
900 }, | |
901 "state": { | 1026 "state": { |
902 "description": "A message containing the operation state.", | 1027 "description": "Output-only A message containing the operati
on state.", |
903 "enum": [ | 1028 "enum": [ |
904 "UNKNOWN", | 1029 "UNKNOWN", |
905 "PENDING", | 1030 "PENDING", |
906 "RUNNING", | 1031 "RUNNING", |
907 "DONE" | 1032 "DONE" |
908 ], | 1033 ], |
909 "enumDescriptions": [ | 1034 "enumDescriptions": [ |
910 "Unused.", | 1035 "Unused.", |
911 "The operation has been created.", | 1036 "The operation has been created.", |
912 "The operation is running.", | 1037 "The operation is running.", |
913 "The operation is done; either cancelled or completed." | 1038 "The operation is done; either cancelled or completed." |
914 ], | 1039 ], |
915 "type": "string" | 1040 "type": "string" |
916 }, | 1041 }, |
917 "details": { | 1042 "details": { |
918 "description": "A message containing any operation metadata
details.", | 1043 "description": "Output-onlyA message containing any operatio
n metadata details.", |
919 "type": "string" | 1044 "type": "string" |
920 }, | 1045 }, |
921 "innerState": { | 1046 "innerState": { |
922 "description": "A message containing the detailed operation
state.", | 1047 "description": "Output-only A message containing the detaile
d operation state.", |
923 "type": "string" | 1048 "type": "string" |
924 } | 1049 }, |
925 }, | 1050 "stateStartTime": { |
926 "type": "object" | 1051 "description": "Output-only The time this state was entered.
", |
927 }, | 1052 "format": "google-datetime", |
928 "JobReference": { | 1053 "type": "string" |
929 "description": "Encapsulates the full scoping used to reference a jo
b.", | 1054 } |
930 "id": "JobReference", | 1055 }, |
931 "properties": { | 1056 "type": "object" |
932 "projectId": { | 1057 }, |
933 "description": "Required The ID of the Google Cloud Platform
project that the job belongs to.", | 1058 "YarnApplication": { |
934 "type": "string" | 1059 "description": "A YARN application created by a job. Application inf
ormation is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.Applicatio
nReportProto</code>.", |
935 }, | 1060 "id": "YarnApplication", |
936 "jobId": { | 1061 "properties": { |
937 "description": "Required The job ID, which must be unique wi
thin the project. The job ID is generated by the server upon job submission or p
rovided by the user as a means to perform retries without creating duplicate job
s. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_),
or hyphens (-). The maximum length is 100 characters.", | 1062 "state": { |
938 "type": "string" | 1063 "description": "Required The application state.", |
939 } | 1064 "enum": [ |
940 }, | 1065 "STATE_UNSPECIFIED", |
941 "type": "object" | 1066 "NEW", |
942 }, | 1067 "NEW_SAVING", |
943 "SubmitJobRequest": { | 1068 "SUBMITTED", |
944 "description": "A request to submit a job.", | 1069 "ACCEPTED", |
945 "id": "SubmitJobRequest", | 1070 "RUNNING", |
946 "properties": { | 1071 "FINISHED", |
947 "job": { | 1072 "FAILED", |
948 "$ref": "Job", | 1073 "KILLED" |
949 "description": "Required The job resource." | 1074 ], |
950 } | 1075 "enumDescriptions": [ |
951 }, | 1076 "Status is unspecified.", |
952 "type": "object" | 1077 "Status is NEW.", |
953 }, | 1078 "Status is NEW_SAVING.", |
954 "Status": { | 1079 "Status is SUBMITTED.", |
955 "description": "The Status type defines a logical error model that i
s suitable for different programming environments, including REST APIs and RPC A
PIs. It is used by gRPC (https://github.com/grpc). The error model is designed t
o be:\nSimple to use and understand for most users\nFlexible enough to meet unex
pected needsOverviewThe Status message contains three pieces of data: error code
, error message, and error details. The error code should be an enum value of go
ogle.rpc.Code, but it may accept additional error codes if needed. The error mes
sage should be a developer-facing English message that helps developers understa
nd and resolve the error. If a localized user-facing error message is needed, pu
t the localized message in the error details or localize it in the client. The o
ptional error details may contain arbitrary information about the error. There i
s a predefined set of error detail types in the package google.rpc which can be
used for common error conditions.Language mappingThe Status message is the logic
al representation of the error model, but it is not necessarily the actual wire
format. When the Status message is exposed in different client libraries and dif
ferent wire protocols, it can be mapped differently. For example, it will likely
be mapped to some exceptions in Java, but more likely mapped to some error code
s in C.Other usesThe error model and the Status message can be used in a variety
of environments, either with or without APIs, to provide a consistent developer
experience across different environments.Example uses of this error model inclu
de:\nPartial errors. If a service needs to return partial errors to the client,
it may embed the Status in the normal response to indicate the partial errors.\n
Workflow errors. A typical workflow has multiple steps. Each step may have a Sta
tus message for error reporting purpose.\nBatch operations. If a client uses bat
ch request and batch response, the Status message should be used directly inside
batch response, one for each error sub-response.\nAsynchronous operations. If a
n API call embeds asynchronous operation results in its response, the status of
those operations should be represented directly using the Status message.\nLoggi
ng. If some API errors are stored in logs, the message Status could be used dire
ctly after any stripping needed for security/privacy reasons.", | 1080 "Status is ACCEPTED.", |
956 "id": "Status", | 1081 "Status is RUNNING.", |
957 "properties": { | 1082 "Status is FINISHED.", |
958 "message": { | 1083 "Status is FAILED.", |
959 "description": "A developer-facing error message, which shou
ld be in English. Any user-facing error message should be localized and sent in
the google.rpc.Status.details field, or localized by the client.", | 1084 "Status is KILLED." |
960 "type": "string" | 1085 ], |
961 }, | 1086 "type": "string" |
962 "details": { | 1087 }, |
963 "description": "A list of messages that carry the error deta
ils. There will be a common set of message types for APIs to use.", | 1088 "name": { |
964 "items": { | 1089 "description": "Required The application name.", |
965 "additionalProperties": { | 1090 "type": "string" |
966 "description": "Properties of the object. Contains f
ield @type with type URL.", | 1091 }, |
967 "type": "any" | 1092 "trackingUrl": { |
968 }, | 1093 "description": "Optional The HTTP URL of the ApplicationMast
er, HistoryServer, or TimelineServer that provides application-specific informat
ion. The URL uses the internal hostname, and requires a proxy server for resolut
ion and, possibly, access.", |
969 "type": "object" | 1094 "type": "string" |
970 }, | 1095 }, |
971 "type": "array" | 1096 "progress": { |
972 }, | 1097 "description": "Required The numerical progress of the appli
cation, from 1 to 100.", |
973 "code": { | 1098 "format": "float", |
974 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", | 1099 "type": "number" |
975 "format": "int32", | 1100 } |
976 "type": "integer" | 1101 }, |
977 } | 1102 "type": "object" |
978 }, | 1103 }, |
979 "type": "object" | 1104 "QueryList": { |
980 }, | 1105 "description": "A list of queries to run on a cluster.", |
981 "JobScheduling": { | 1106 "id": "QueryList", |
982 "description": "Job scheduling options.Beta Feature: These options a
re available for testing purposes only. They may be changed before final release
.", | 1107 "properties": { |
983 "id": "JobScheduling", | 1108 "queries": { |
984 "properties": { | 1109 "description": "Required The queries to execute. You do not
need to terminate a query with a semicolon. Multiple queries can be specified in
one string by separating each with a semicolon. Here is an example of an Cloud
Dataproc API snippet that uses a QueryList to specify a HiveJob:\n\"hiveJob\": {
\n \"queryList\": {\n \"queries\": [\n \"query1\",\n \"query2\",\n
\"query3;query4\",\n ]\n }\n}\n", |
985 "maxFailuresPerHour": { | 1110 "items": { |
986 "description": "Optional Maximum number of times per hour a
driver may be restarted as a result of driver terminating with non-zero code bef
ore job is reported failed.A job may be reported as thrashing if driver exits wi
th non-zero code 4 times within 10 minute window.Maximum value is 10.", | 1111 "type": "string" |
987 "format": "int32", | 1112 }, |
988 "type": "integer" | 1113 "type": "array" |
989 } | 1114 } |
990 }, | 1115 }, |
991 "type": "object" | 1116 "type": "object" |
992 }, | 1117 }, |
993 "NodeInitializationAction": { | 1118 "HadoopJob": { |
994 "description": "Specifies an executable to run on a fully configured
node and a timeout period for executable completion.", | 1119 "description": "A Cloud Dataproc job for running Hadoop MapReduce jo
bs on YARN.", |
995 "id": "NodeInitializationAction", | 1120 "id": "HadoopJob", |
996 "properties": { | 1121 "properties": { |
997 "executionTimeout": { | 1122 "mainClass": { |
998 "description": "Optional Amount of time executable has to co
mplete. Default is 10 minutes. Cluster creation fails with an explanatory error
message (the name of the executable that caused the error and the exceeded timeo
ut period) if the executable is not completed at end of the timeout period.", | 1123 "description": "The name of the driver's main class. The jar
file containing the class must be in the default CLASSPATH or specified in jar_
file_uris.", |
999 "format": "google-duration", | 1124 "type": "string" |
1000 "type": "string" | 1125 }, |
1001 }, | 1126 "archiveUris": { |
1002 "executableFile": { | 1127 "description": "Optional HCFS URIs of archives to be extract
ed in the working directory of Hadoop drivers and tasks. Supported file types: .
jar, .tar, .tar.gz, .tgz, or .zip.", |
1003 "description": "Required Google Cloud Storage URI of executa
ble file.", | 1128 "items": { |
1004 "type": "string" | 1129 "type": "string" |
1005 } | 1130 }, |
1006 }, | 1131 "type": "array" |
1007 "type": "object" | 1132 }, |
1008 }, | 1133 "mainJarFileUri": { |
1009 "ListJobsResponse": { | 1134 "description": "The Hadoop Compatible Filesystem (HCFS) URI
of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics
-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcou
nt.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'", |
1010 "description": "A list of jobs in a project.", | 1135 "type": "string" |
1011 "id": "ListJobsResponse", | |
1012 "properties": { | |
1013 "jobs": { | |
1014 "description": "Output-only Jobs list.", | |
1015 "items": { | |
1016 "$ref": "Job" | |
1017 }, | |
1018 "type": "array" | |
1019 }, | |
1020 "nextPageToken": { | |
1021 "description": "Optional This token is included in the respo
nse if there are more results to fetch. To fetch additional results, provide thi
s value as the page_token in a subsequent <code>ListJobsRequest</code>.", | |
1022 "type": "string" | |
1023 } | |
1024 }, | |
1025 "type": "object" | |
1026 }, | |
1027 "CancelJobRequest": { | |
1028 "description": "A request to cancel a job.", | |
1029 "id": "CancelJobRequest", | |
1030 "properties": {}, | |
1031 "type": "object" | |
1032 }, | |
1033 "SparkSqlJob": { | |
1034 "description": "A Cloud Dataproc job for running Spark SQL queries."
, | |
1035 "id": "SparkSqlJob", | |
1036 "properties": { | |
1037 "queryFileUri": { | |
1038 "description": "The HCFS URI of the script that contains SQL
queries.", | |
1039 "type": "string" | |
1040 }, | |
1041 "queryList": { | |
1042 "$ref": "QueryList", | |
1043 "description": "A list of queries." | |
1044 }, | |
1045 "scriptVariables": { | |
1046 "additionalProperties": { | |
1047 "type": "string" | |
1048 }, | |
1049 "description": "Optional Mapping of query variable names to
values (equivalent to the Spark SQL command: SET name=\"value\";).", | |
1050 "type": "object" | |
1051 }, | 1136 }, |
1052 "jarFileUris": { | 1137 "jarFileUris": { |
1053 "description": "Optional HCFS URIs of jar files to be added
to the Spark CLASSPATH.", | 1138 "description": "Optional Jar file URIs to add to the CLASSPA
THs of the Hadoop driver and tasks.", |
1054 "items": { | 1139 "items": { |
1055 "type": "string" | 1140 "type": "string" |
1056 }, | 1141 }, |
1057 "type": "array" | 1142 "type": "array" |
1058 }, | 1143 }, |
1059 "loggingConfiguration": { | 1144 "loggingConfiguration": { |
1060 "$ref": "LoggingConfiguration", | 1145 "$ref": "LoggingConfiguration", |
1061 "description": "Optional The runtime log configuration for j
ob execution." | 1146 "description": "Optional The runtime log configuration for j
ob execution." |
1062 }, | 1147 }, |
1063 "properties": { | 1148 "properties": { |
1064 "additionalProperties": { | 1149 "additionalProperties": { |
1065 "type": "string" | 1150 "type": "string" |
1066 }, | 1151 }, |
1067 "description": "Optional A mapping of property names to valu
es, used to configure Spark SQL's SparkConf. Properties that conflict with value
s set by the Cloud Dataproc API may be overwritten.", | 1152 "description": "Optional A mapping of property names to valu
es, used to configure Hadoop. Properties that conflict with values set by the Cl
oud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/c
onf/*-site and classes in user code.", |
1068 "type": "object" | |
1069 } | |
1070 }, | |
1071 "type": "object" | |
1072 }, | |
1073 "Cluster": { | |
1074 "description": "Describes the identifying information, configuration
, and status of a cluster of Google Compute Engine instances.", | |
1075 "id": "Cluster", | |
1076 "properties": { | |
1077 "configuration": { | |
1078 "$ref": "ClusterConfiguration", | |
1079 "description": "Required The cluster configuration. Note tha
t Cloud Dataproc may set default values, and values may change when clusters are
updated." | |
1080 }, | |
1081 "labels": { | |
1082 "additionalProperties": { | |
1083 "type": "string" | |
1084 }, | |
1085 "description": "Optional The labels to associate with this c
luster.Label keys must be between 1 and 63 characters long, and must conform to
the following PCRE regular expression: \\p{Ll}\\p{Lo}{0,62}Label values must be
between 1 and 63 characters long, and must conform to the following PCRE regular
expression: \\p{Ll}\\p{Lo}\\p{N}_-{0,63}No more than 64 labels can be associate
d with a given cluster.", | |
1086 "type": "object" | 1153 "type": "object" |
1087 }, | 1154 }, |
1088 "metrics": { | 1155 "args": { |
1089 "$ref": "ClusterMetrics", | 1156 "description": "Optional The arguments to pass to the driver
. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as jo
b properties, since a collision may occur that causes an incorrect job submissio
n.", |
1090 "description": "Contains cluster daemon metrics such as HDFS
and YARN stats." | |
1091 }, | |
1092 "status": { | |
1093 "$ref": "ClusterStatus", | |
1094 "description": "Output-only Cluster status." | |
1095 }, | |
1096 "statusHistory": { | |
1097 "description": "Output-only Previous cluster statuses.", | |
1098 "items": { | 1157 "items": { |
1099 "$ref": "ClusterStatus" | 1158 "type": "string" |
1100 }, | 1159 }, |
1101 "type": "array" | 1160 "type": "array" |
1102 }, | 1161 }, |
1103 "clusterName": { | 1162 "fileUris": { |
1104 "description": "Required The cluster name. Cluster names wit
hin a project must be unique. Names from deleted clusters can be reused.", | 1163 "description": "Optional HCFS URIs of files to be copied to
the working directory of Hadoop drivers and distributed tasks. Useful for naivel
y parallel tasks.", |
1105 "type": "string" | |
1106 }, | |
1107 "clusterUuid": { | |
1108 "description": "Output-only A cluster UUID (Unique Universal
Identifier). Cloud Dataproc generates this value when it creates the cluster.", | |
1109 "type": "string" | |
1110 }, | |
1111 "projectId": { | |
1112 "description": "Required The Google Cloud Platform project I
D that the cluster belongs to.", | |
1113 "type": "string" | |
1114 } | |
1115 }, | |
1116 "type": "object" | |
1117 }, | |
1118 "ListOperationsResponse": { | |
1119 "description": "The response message for Operations.ListOperations."
, | |
1120 "id": "ListOperationsResponse", | |
1121 "properties": { | |
1122 "nextPageToken": { | |
1123 "description": "The standard List next-page token.", | |
1124 "type": "string" | |
1125 }, | |
1126 "operations": { | |
1127 "description": "A list of operations that matches the specif
ied filter in the request.", | |
1128 "items": { | 1164 "items": { |
1129 "$ref": "Operation" | 1165 "type": "string" |
1130 }, | 1166 }, |
1131 "type": "array" | 1167 "type": "array" |
1132 } | 1168 } |
1133 }, | 1169 }, |
1134 "type": "object" | 1170 "type": "object" |
1135 }, | 1171 }, |
1136 "OperationMetadata": { | 1172 "DiagnoseClusterRequest": { |
| 1173 "description": "A request to collect cluster diagnostic information.
", |
| 1174 "id": "DiagnoseClusterRequest", |
| 1175 "properties": {}, |
| 1176 "type": "object" |
| 1177 }, |
| 1178 "ClusterOperationMetadata": { |
1137 "description": "Metadata describing the operation.", | 1179 "description": "Metadata describing the operation.", |
1138 "id": "OperationMetadata", | 1180 "id": "ClusterOperationMetadata", |
1139 "properties": { | 1181 "properties": { |
| 1182 "statusHistory": { |
| 1183 "description": "Output-only The previous operation status.", |
| 1184 "items": { |
| 1185 "$ref": "ClusterOperationStatus" |
| 1186 }, |
| 1187 "type": "array" |
| 1188 }, |
| 1189 "clusterName": { |
| 1190 "description": "Output-only Name of the cluster for the oper
ation.", |
| 1191 "type": "string" |
| 1192 }, |
| 1193 "clusterUuid": { |
| 1194 "description": "Output-only Cluster UUID for the operation."
, |
| 1195 "type": "string" |
| 1196 }, |
1140 "operationType": { | 1197 "operationType": { |
1141 "description": "Output-only The operation type.", | 1198 "description": "Output-only The operation type.", |
1142 "type": "string" | 1199 "type": "string" |
1143 }, | 1200 }, |
1144 "description": { | 1201 "description": { |
1145 "description": "Output-only Short description of operation."
, | 1202 "description": "Output-only Short description of operation."
, |
1146 "type": "string" | 1203 "type": "string" |
1147 }, | 1204 }, |
1148 "warnings": { | 1205 "warnings": { |
1149 "description": "Output-only Errors encountered during operat
ion execution.", | 1206 "description": "Output-only Errors encountered during operat
ion execution.", |
1150 "items": { | 1207 "items": { |
1151 "type": "string" | 1208 "type": "string" |
1152 }, | 1209 }, |
1153 "type": "array" | 1210 "type": "array" |
1154 }, | 1211 }, |
| 1212 "labels": { |
| 1213 "additionalProperties": { |
| 1214 "type": "string" |
| 1215 }, |
| 1216 "description": "Output-only Labels associated with the opera
tion", |
| 1217 "type": "object" |
| 1218 }, |
1155 "status": { | 1219 "status": { |
1156 "$ref": "OperationStatus", | 1220 "$ref": "ClusterOperationStatus", |
1157 "description": "Output-only Current operation status." | 1221 "description": "Output-only Current operation status." |
| 1222 } |
| 1223 }, |
| 1224 "type": "object" |
| 1225 }, |
| 1226 "HiveJob": { |
| 1227 "description": "A Cloud Dataproc job for running Hive queries on YAR
N.", |
| 1228 "id": "HiveJob", |
| 1229 "properties": { |
| 1230 "properties": { |
| 1231 "additionalProperties": { |
| 1232 "type": "string" |
| 1233 }, |
| 1234 "description": "Optional A mapping of property names and val
ues, used to configure Hive. Properties that conflict with values set by the Clo
ud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/co
nf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.", |
| 1235 "type": "object" |
1158 }, | 1236 }, |
1159 "statusHistory": { | 1237 "continueOnFailure": { |
1160 "description": "Output-only Previous operation status.", | 1238 "description": "Optional Whether to continue executing queri
es if a query fails. The default value is false. Setting to true can be useful w
hen executing independent parallel queries.", |
| 1239 "type": "boolean" |
| 1240 }, |
| 1241 "queryList": { |
| 1242 "$ref": "QueryList", |
| 1243 "description": "A list of queries." |
| 1244 }, |
| 1245 "queryFileUri": { |
| 1246 "description": "The HCFS URI of the script that contains Hiv
e queries.", |
| 1247 "type": "string" |
| 1248 }, |
| 1249 "jarFileUris": { |
| 1250 "description": "Optional HCFS URIs of jar files to add to th
e CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive
SerDes and UDFs.", |
1161 "items": { | 1251 "items": { |
1162 "$ref": "OperationStatus" | 1252 "type": "string" |
1163 }, | 1253 }, |
1164 "type": "array" | 1254 "type": "array" |
1165 }, | 1255 }, |
1166 "clusterName": { | 1256 "scriptVariables": { |
1167 "description": "Name of the cluster for the operation.", | 1257 "additionalProperties": { |
1168 "type": "string" | 1258 "type": "string" |
1169 }, | 1259 }, |
1170 "clusterUuid": { | 1260 "description": "Optional Mapping of query variable names to
values (equivalent to the Hive command: SET name=\"value\";).", |
1171 "description": "Cluster UUId for the operation.", | 1261 "type": "object" |
| 1262 } |
| 1263 }, |
| 1264 "type": "object" |
| 1265 }, |
| 1266 "Empty": { |
| 1267 "description": "A generic empty message that you can re-use to avoid
defining duplicated empty messages in your APIs. A typical example is to use it
as the request or the response type of an API method. For instance:\nservice Fo
o {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe J
SON representation for Empty is empty JSON object {}.", |
| 1268 "id": "Empty", |
| 1269 "properties": {}, |
| 1270 "type": "object" |
| 1271 }, |
| 1272 "DiagnoseClusterResults": { |
| 1273 "description": "The location of diagnostic output.", |
| 1274 "id": "DiagnoseClusterResults", |
| 1275 "properties": { |
| 1276 "outputUri": { |
| 1277 "description": "Output-only The Google Cloud Storage URI of
the diagnostic output. The output report is a plain text file with a summary of
collected diagnostics.", |
1172 "type": "string" | 1278 "type": "string" |
1173 } | 1279 } |
1174 }, | 1280 }, |
1175 "type": "object" | 1281 "type": "object" |
1176 }, | 1282 }, |
1177 "JobPlacement": { | 1283 "SoftwareConfiguration": { |
1178 "description": "Cloud Dataproc job configuration.", | 1284 "description": "Specifies the selection and configuration of softwar
e inside the cluster.", |
1179 "id": "JobPlacement", | 1285 "id": "SoftwareConfiguration", |
1180 "properties": { | 1286 "properties": { |
1181 "clusterName": { | 1287 "properties": { |
1182 "description": "Required The name of the cluster where the j
ob will be submitted.", | 1288 "additionalProperties": { |
1183 "type": "string" | 1289 "type": "string" |
| 1290 }, |
| 1291 "description": "Optional The properties to set on daemon con
figuration files.Property keys are specified in \"prefix:property\" format, such
as \"core:fs.defaultFS\". The following are supported prefixes and their mappin
gs: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn
- yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defau
lts.conf", |
| 1292 "type": "object" |
1184 }, | 1293 }, |
1185 "clusterUuid": { | 1294 "imageVersion": { |
1186 "description": "Output-only A cluster UUID generated by the
Dataproc service when the job is submitted.", | 1295 "description": "Optional The version of software inside the
cluster. It must match the regular expression [0-9]+\\.[0-9]+. If unspecified, i
t defaults to the latest version (see Cloud Dataproc Versioning).", |
1187 "type": "string" | 1296 "type": "string" |
1188 } | 1297 } |
1189 }, | 1298 }, |
1190 "type": "object" | 1299 "type": "object" |
1191 }, | 1300 }, |
1192 "ClusterStatus": { | 1301 "PySparkJob": { |
1193 "description": "The status of a cluster and its instances.", | 1302 "description": "A Cloud Dataproc job for running PySpark application
s on YARN.", |
1194 "id": "ClusterStatus", | 1303 "id": "PySparkJob", |
1195 "properties": { | 1304 "properties": { |
1196 "state": { | 1305 "properties": { |
1197 "description": "The cluster's state.", | |
1198 "enum": [ | |
1199 "UNKNOWN", | |
1200 "CREATING", | |
1201 "RUNNING", | |
1202 "ERROR", | |
1203 "DELETING", | |
1204 "UPDATING" | |
1205 ], | |
1206 "enumDescriptions": [ | |
1207 "The cluster state is unknown.", | |
1208 "The cluster is being created and set up. It is not read
y for use.", | |
1209 "The cluster is currently running and healthy. It is rea
dy for use.", | |
1210 "The cluster encountered an error. It is not ready for u
se.", | |
1211 "The cluster is being deleted. It cannot be used.", | |
1212 "The cluster is being updated. It continues to accept an
d process jobs." | |
1213 ], | |
1214 "type": "string" | |
1215 }, | |
1216 "stateStartTime": { | |
1217 "description": "Time when this state was entered.", | |
1218 "format": "google-datetime", | |
1219 "type": "string" | |
1220 }, | |
1221 "detail": { | |
1222 "description": "Optional details of cluster's state.", | |
1223 "type": "string" | |
1224 } | |
1225 }, | |
1226 "type": "object" | |
1227 }, | |
1228 "PigJob": { | |
1229 "description": "A Cloud Dataproc job for running Pig queries on YARN
.", | |
1230 "id": "PigJob", | |
1231 "properties": { | |
1232 "continueOnFailure": { | |
1233 "description": "Optional Whether to continue executing queri
es if a query fails. The default value is false. Setting to true can be useful w
hen executing independent parallel queries.", | |
1234 "type": "boolean" | |
1235 }, | |
1236 "queryFileUri": { | |
1237 "description": "The HCFS URI of the script that contains the
Pig queries.", | |
1238 "type": "string" | |
1239 }, | |
1240 "queryList": { | |
1241 "$ref": "QueryList", | |
1242 "description": "A list of queries." | |
1243 }, | |
1244 "scriptVariables": { | |
1245 "additionalProperties": { | 1306 "additionalProperties": { |
1246 "type": "string" | 1307 "type": "string" |
1247 }, | 1308 }, |
1248 "description": "Optional Mapping of query variable names to
values (equivalent to the Pig command: name=[value]).", | 1309 "description": "Optional A mapping of property names to valu
es, used to configure PySpark. Properties that conflict with values set by the C
loud Dataproc API may be overwritten. Can include properties set in /etc/spark/c
onf/spark-defaults.conf and classes in user code.", |
1249 "type": "object" | 1310 "type": "object" |
1250 }, | 1311 }, |
1251 "jarFileUris": { | 1312 "args": { |
1252 "description": "Optional HCFS URIs of jar files to add to th
e CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig U
DFs.", | 1313 "description": "Optional The arguments to pass to the driver
. Do not include arguments, such as --conf, that can be set as job properties, s
ince a collision may occur that causes an incorrect job submission.", |
1253 "items": { | 1314 "items": { |
1254 "type": "string" | 1315 "type": "string" |
1255 }, | 1316 }, |
| 1317 "type": "array" |
| 1318 }, |
| 1319 "fileUris": { |
| 1320 "description": "Optional HCFS URIs of files to be copied to
the working directory of Python drivers and distributed tasks. Useful for naivel
y parallel tasks.", |
| 1321 "items": { |
| 1322 "type": "string" |
| 1323 }, |
| 1324 "type": "array" |
| 1325 }, |
| 1326 "pythonFileUris": { |
| 1327 "description": "Optional HCFS file URIs of Python files to p
ass to the PySpark framework. Supported file types: .py, .egg, and .zip.", |
| 1328 "items": { |
| 1329 "type": "string" |
| 1330 }, |
| 1331 "type": "array" |
| 1332 }, |
| 1333 "mainPythonFileUri": { |
| 1334 "description": "Required The Hadoop Compatible Filesystem (H
CFS) URI of the main Python file to use as the driver. Must be a .py file.", |
| 1335 "type": "string" |
| 1336 }, |
| 1337 "archiveUris": { |
| 1338 "description": "Optional HCFS URIs of archives to be extract
ed in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.", |
| 1339 "items": { |
| 1340 "type": "string" |
| 1341 }, |
| 1342 "type": "array" |
| 1343 }, |
| 1344 "jarFileUris": { |
| 1345 "description": "Optional HCFS URIs of jar files to add to th
e CLASSPATHs of the Python driver and tasks.", |
| 1346 "items": { |
| 1347 "type": "string" |
| 1348 }, |
1256 "type": "array" | 1349 "type": "array" |
1257 }, | 1350 }, |
1258 "loggingConfiguration": { | 1351 "loggingConfiguration": { |
1259 "$ref": "LoggingConfiguration", | 1352 "$ref": "LoggingConfiguration", |
1260 "description": "Optional The runtime log configuration for j
ob execution." | 1353 "description": "Optional The runtime log configuration for j
ob execution." |
1261 }, | 1354 } |
1262 "properties": { | 1355 }, |
1263 "additionalProperties": { | 1356 "type": "object" |
1264 "type": "string" | 1357 }, |
1265 }, | 1358 "ClusterMetrics": { |
1266 "description": "Optional A mapping of property names to valu
es, used to configure Pig. Properties that conflict with values set by the Cloud
Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf
/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.", | 1359 "description": "Contains cluster daemon metrics, such as HDFS and YA
RN stats.", |
1267 "type": "object" | 1360 "id": "ClusterMetrics", |
1268 } | 1361 "properties": { |
1269 }, | 1362 "yarnMetrics": { |
1270 "type": "object" | 1363 "additionalProperties": { |
1271 }, | 1364 "format": "int64", |
1272 "AcceleratorConfiguration": { | 1365 "type": "string" |
1273 "description": "Specifies the type and number of accelerator cards a
ttached to the instances of an instance group (see GPUs on Compute Engine).", | 1366 }, |
1274 "id": "AcceleratorConfiguration", | 1367 "description": "The YARN metrics.", |
1275 "properties": { | 1368 "type": "object" |
1276 "acceleratorTypeUri": { | 1369 }, |
1277 "description": "Full or partial URI of the accelerator type
resource to expose to this instance. See Google Compute Engine AcceleratorTypes(
/compute/docs/reference/beta/acceleratorTypes)", | 1370 "hdfsMetrics": { |
1278 "type": "string" | 1371 "additionalProperties": { |
1279 }, | 1372 "format": "int64", |
1280 "acceleratorCount": { | 1373 "type": "string" |
1281 "description": "The number of the accelerator cards of this
type exposed to this instance.", | 1374 }, |
| 1375 "description": "The HDFS metrics.", |
| 1376 "type": "object" |
| 1377 } |
| 1378 }, |
| 1379 "type": "object" |
| 1380 }, |
| 1381 "ClusterConfiguration": { |
| 1382 "description": "The cluster configuration.", |
| 1383 "id": "ClusterConfiguration", |
| 1384 "properties": { |
| 1385 "initializationActions": { |
| 1386 "description": "Optional Commands to execute on each node af
ter configuration is completed. By default, executables are run on master and al
l worker nodes. You can test a node's <code>role</code> metadata to run an execu
table on a master or worker node, as shown below:\nROLE=$(/usr/share/google/get_
metadata_value attributes/role)\nif [[ \"${ROLE}\" == 'Master' ]]; then\n ... m
aster specific actions ...\nelse\n ... worker specific actions ...\nfi\n", |
| 1387 "items": { |
| 1388 "$ref": "NodeInitializationAction" |
| 1389 }, |
| 1390 "type": "array" |
| 1391 }, |
| 1392 "workerConfiguration": { |
| 1393 "$ref": "InstanceGroupConfiguration", |
| 1394 "description": "Optional The Google Compute Engine configura
tion settings for worker instances in a cluster." |
| 1395 }, |
| 1396 "gceClusterConfiguration": { |
| 1397 "$ref": "GceClusterConfiguration", |
| 1398 "description": "Required The shared Google Compute Engine co
nfiguration settings for all instances in a cluster." |
| 1399 }, |
| 1400 "softwareConfiguration": { |
| 1401 "$ref": "SoftwareConfiguration", |
| 1402 "description": "Optional The configuration settings for soft
ware inside the cluster." |
| 1403 }, |
| 1404 "configurationBucket": { |
| 1405 "description": "Optional A Google Cloud Storage staging buck
et used for sharing generated SSH keys and configuration. If you do not specify
a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage loc
ation (US, ASIA, or EU) for your cluster's staging bucket according to the Googl
e Compute Engine zone where your cluster is deployed, and then it will create an
d manage this project-level, per-location bucket for you.", |
| 1406 "type": "string" |
| 1407 }, |
| 1408 "masterConfiguration": { |
| 1409 "$ref": "InstanceGroupConfiguration", |
| 1410 "description": "Optional The Google Compute Engine configura
tion settings for the master instance in a cluster." |
| 1411 }, |
| 1412 "secondaryWorkerConfiguration": { |
| 1413 "$ref": "InstanceGroupConfiguration", |
| 1414 "description": "Optional The Google Compute Engine configura
tion settings for additional worker instances in a cluster." |
| 1415 } |
| 1416 }, |
| 1417 "type": "object" |
| 1418 }, |
| 1419 "LoggingConfiguration": { |
| 1420 "description": "The runtime logging configuration of the job.", |
| 1421 "id": "LoggingConfiguration", |
| 1422 "properties": { |
| 1423 "driverLogLevels": { |
| 1424 "additionalProperties": { |
| 1425 "enum": [ |
| 1426 "LEVEL_UNSPECIFIED", |
| 1427 "ALL", |
| 1428 "TRACE", |
| 1429 "DEBUG", |
| 1430 "INFO", |
| 1431 "WARN", |
| 1432 "ERROR", |
| 1433 "FATAL", |
| 1434 "OFF" |
| 1435 ], |
| 1436 "type": "string" |
| 1437 }, |
| 1438 "description": "The per-package log levels for the driver. T
his may include \"root\" package name to configure rootLogger. Examples: 'com.g
oogle = FATAL', 'root = INFO', 'org.apache = DEBUG'", |
| 1439 "type": "object" |
| 1440 } |
| 1441 }, |
| 1442 "type": "object" |
| 1443 }, |
| 1444 "InstanceGroupConfiguration": { |
| 1445 "description": "The configuration settings for Google Compute Engine
resources in an instance group, such as a master or worker group.", |
| 1446 "id": "InstanceGroupConfiguration", |
| 1447 "properties": { |
| 1448 "diskConfiguration": { |
| 1449 "$ref": "DiskConfiguration", |
| 1450 "description": "Disk option configuration settings." |
| 1451 }, |
| 1452 "machineTypeUri": { |
| 1453 "description": "The Google Compute Engine machine type used
for cluster instances. Example: https://www.googleapis.com/compute/v1/projects/[
project_id]/zones/us-east1-a/machineTypes/n1-standard-2.", |
| 1454 "type": "string" |
| 1455 }, |
| 1456 "imageUri": { |
| 1457 "description": "Output-only The Google Compute Engine image
resource used for cluster instances. Inferred from SoftwareConfiguration.image_v
ersion.", |
| 1458 "type": "string" |
| 1459 }, |
| 1460 "isPreemptible": { |
| 1461 "description": "Specifies that this instance group contains
Preemptible Instances.", |
| 1462 "type": "boolean" |
| 1463 }, |
| 1464 "instanceNames": { |
| 1465 "description": "The list of instance names. Dataproc derives
the names from cluster_name, num_instances, and the instance group if not set b
y user (recommended practice is to let Dataproc derive the name).", |
| 1466 "items": { |
| 1467 "type": "string" |
| 1468 }, |
| 1469 "type": "array" |
| 1470 }, |
| 1471 "managedGroupConfiguration": { |
| 1472 "$ref": "ManagedGroupConfiguration", |
| 1473 "description": "Output-only The configuration for Google Com
pute Engine Instance Group Manager that manages this group. This is only used fo
r preemptible instance groups." |
| 1474 }, |
| 1475 "accelerators": { |
| 1476 "description": "Optional The Google Compute Engine accelerat
or configuration for these instances.", |
| 1477 "items": { |
| 1478 "$ref": "AcceleratorConfiguration" |
| 1479 }, |
| 1480 "type": "array" |
| 1481 }, |
| 1482 "numInstances": { |
| 1483 "description": "The number of VM instances in the instance g
roup. For master instance groups, must be set to 1.", |
1282 "format": "int32", | 1484 "format": "int32", |
1283 "type": "integer" | 1485 "type": "integer" |
1284 } | 1486 } |
1285 }, | 1487 }, |
1286 "type": "object" | 1488 "type": "object" |
1287 }, | 1489 }, |
1288 "ListClustersResponse": { | 1490 "GceClusterConfiguration": { |
1289 "description": "The list of all clusters in a project.", | 1491 "description": "Common configuration settings for resources of Googl
e Compute Engine cluster instances, applicable to all instances in the cluster."
, |
1290 "id": "ListClustersResponse", | 1492 "id": "GceClusterConfiguration", |
1291 "properties": { | 1493 "properties": { |
1292 "clusters": { | 1494 "networkUri": { |
1293 "description": "Output-only The clusters in the project.", | 1495 "description": "The Google Compute Engine network to be used
for machine communications. Cannot be specified with subnetwork_uri. If neither
network_uri nor subnetwork_uri is specified, the \"default\" network of the pro
ject is used, if it exists. Cannot be a \"Custom Subnet Network\" (see https://c
loud.google.com/compute/docs/subnetworks for more information). Example: https:/
/www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default.", |
1294 "items": { | 1496 "type": "string" |
1295 "$ref": "Cluster" | 1497 }, |
1296 }, | 1498 "zoneUri": { |
1297 "type": "array" | 1499 "description": "Required The zone where the Google Compute E
ngine cluster will be located. Example: https://www.googleapis.com/compute/v1/pr
ojects/[project_id]/zones/[zone].", |
1298 }, | 1500 "type": "string" |
1299 "nextPageToken": { | 1501 }, |
1300 "description": "The standard List next-page token.", | 1502 "metadata": { |
1301 "type": "string" | 1503 "additionalProperties": { |
1302 } | 1504 "type": "string" |
1303 }, | 1505 }, |
1304 "type": "object" | 1506 "description": "The Google Compute Engine metadata entries t
o add to all instances.", |
1305 }, | 1507 "type": "object" |
1306 "ManagedGroupConfiguration": { | 1508 }, |
1307 "description": "Specifies the resources used to actively manage an i
nstance group.", | 1509 "internalIpOnly": { |
1308 "id": "ManagedGroupConfiguration", | 1510 "description": "If true, all instances in the cluser will on
ly have internal IP addresses. By default, clusters are not restricted to intern
al IP addresses, and will have ephemeral external IP addresses assigned to each
instance. This restriction can only be enabled for subnetwork enabled networks,
and all off-cluster dependencies must be configured to be accessible without ext
ernal IP addresses.", |
1309 "properties": { | |
1310 "instanceGroupManagerName": { | |
1311 "description": "Output-only The name of the Instance Group M
anager for this group.", | |
1312 "type": "string" | |
1313 }, | |
1314 "instanceTemplateName": { | |
1315 "description": "Output-only The name of the Instance Templat
e used for the Managed Instance Group.", | |
1316 "type": "string" | |
1317 } | |
1318 }, | |
1319 "type": "object" | |
1320 }, | |
1321 "Job": { | |
1322 "description": "A Cloud Dataproc job resource.", | |
1323 "id": "Job", | |
1324 "properties": { | |
1325 "hadoopJob": { | |
1326 "$ref": "HadoopJob", | |
1327 "description": "Job is a Hadoop job." | |
1328 }, | |
1329 "placement": { | |
1330 "$ref": "JobPlacement", | |
1331 "description": "Required Job information, including how, whe
n, and where to run the job." | |
1332 }, | |
1333 "status": { | |
1334 "$ref": "JobStatus", | |
1335 "description": "Output-only The job status. Additional appli
cation-specific status information may be contained in the <code>type_job</code>
and <code>yarn_applications</code> fields." | |
1336 }, | |
1337 "driverControlFilesUri": { | |
1338 "description": "Output-only If present, the location of misc
ellaneous control files which may be used as part of job setup and handling. If
not present, control files may be placed in the same location as driver_output_u
ri.", | |
1339 "type": "string" | |
1340 }, | |
1341 "submittedBy": { | |
1342 "description": "Output-only The email address of the user su
bmitting the job. For jobs submitted on the cluster, the address is <code>userna
me@hostname</code>.", | |
1343 "type": "string" | |
1344 }, | |
1345 "scheduling": { | |
1346 "$ref": "JobScheduling", | |
1347 "description": "Optional Job scheduling configuration." | |
1348 }, | |
1349 "pigJob": { | |
1350 "$ref": "PigJob", | |
1351 "description": "Job is a Pig job." | |
1352 }, | |
1353 "hiveJob": { | |
1354 "$ref": "HiveJob", | |
1355 "description": "Job is a Hive job." | |
1356 }, | |
1357 "labels": { | |
1358 "additionalProperties": { | |
1359 "type": "string" | |
1360 }, | |
1361 "description": "Optional The labels to associate with this j
ob.Label keys must be between 1 and 63 characters long, and must conform to the
following regular expression: \\p{Ll}\\p{Lo}{0,62}Label values must be between 1
and 63 characters long, and must conform to the following regular expression: \
\p{Ll}\\p{Lo}\\p{N}_-{0,63}No more than 64 labels can be associated with a given
job.", | |
1362 "type": "object" | |
1363 }, | |
1364 "driverOutputResourceUri": { | |
1365 "description": "Output-only A URI pointing to the location o
f the stdout of the job's driver program.", | |
1366 "type": "string" | |
1367 }, | |
1368 "sparkSqlJob": { | |
1369 "$ref": "SparkSqlJob", | |
1370 "description": "Job is a SparkSql job." | |
1371 }, | |
1372 "sparkJob": { | |
1373 "$ref": "SparkJob", | |
1374 "description": "Job is a Spark job." | |
1375 }, | |
1376 "statusHistory": { | |
1377 "description": "Output-only The previous job status.", | |
1378 "items": { | |
1379 "$ref": "JobStatus" | |
1380 }, | |
1381 "type": "array" | |
1382 }, | |
1383 "yarnApplications": { | |
1384 "description": "Output-only The collection of YARN applicati
ons spun up by this job.", | |
1385 "items": { | |
1386 "$ref": "YarnApplication" | |
1387 }, | |
1388 "type": "array" | |
1389 }, | |
1390 "pysparkJob": { | |
1391 "$ref": "PySparkJob", | |
1392 "description": "Job is a Pyspark job." | |
1393 }, | |
1394 "reference": { | |
1395 "$ref": "JobReference", | |
1396 "description": "Optional The fully qualified reference to th
e job, which can be used to obtain the equivalent REST path of the job resource.
If this property is not specified when a job is created, the server generates a
<code>job_id</code>." | |
1397 }, | |
1398 "interactive": { | |
1399 "description": "Optional If set to true, the driver's stdin
will be kept open and driver_input_uri will be set to provide a path at which ad
ditional input can be sent to the driver.", | |
1400 "type": "boolean" | 1511 "type": "boolean" |
1401 }, | 1512 }, |
1402 "driverInputResourceUri": { | 1513 "serviceAccountScopes": { |
1403 "description": "Output-only A URI pointing to the location o
f the stdin of the job's driver program, only set if the job is interactive.", | 1514 "description": "The URIs of service account scopes to be inc
luded in Google Compute Engine instances. The following base set of scopes is al
ways included: - https://www.googleapis.com/auth/cloud.useraccounts.readonly - h
ttps://www.googleapis.com/auth/devstorage.read_write - https://www.googleapis.co
m/auth/logging.write If no scopes are specfied, the following defaults are also
provided: - https://www.googleapis.com/auth/bigquery - https://www.googleapis.co
m/auth/bigtable.admin.table - https://www.googleapis.com/auth/bigtable.data - ht
tps://www.googleapis.com/auth/devstorage.full_control", |
1404 "type": "string" | 1515 "items": { |
1405 } | 1516 "type": "string" |
1406 }, | 1517 }, |
1407 "type": "object" | 1518 "type": "array" |
1408 }, | 1519 }, |
1409 "SparkJob": { | 1520 "tags": { |
1410 "description": "A Cloud Dataproc job for running Spark applications
on YARN.", | 1521 "description": "The Google Compute Engine tags to add to all
instances.", |
1411 "id": "SparkJob", | 1522 "items": { |
1412 "properties": { | 1523 "type": "string" |
1413 "mainClass": { | 1524 }, |
1414 "description": "The name of the driver's main class. The jar
file that contains the class must be in the default CLASSPATH or specified in j
ar_file_uris.", | 1525 "type": "array" |
1415 "type": "string" | 1526 }, |
1416 }, | 1527 "serviceAccount": { |
1417 "archiveUris": { | 1528 "description": "Optional The service account of the instance
s. Defaults to the default Google Compute Engine service account. Custom service
accounts need permissions equivalent to the folloing IAM roles:\nroles/logging.
logWriter\nroles/storage.objectAdmin(see https://cloud.google.com/compute/docs/a
ccess/service-accounts#custom_service_accounts for more information). Example: [
account_id]@[project_id].iam.gserviceaccount.com", |
1418 "description": "Optional HCFS URIs of archives to be extract
ed in the working directory of Spark drivers and tasks. Supported file types: .j
ar, .tar, .tar.gz, .tgz, and .zip.", | 1529 "type": "string" |
1419 "items": { | 1530 }, |
1420 "type": "string" | 1531 "subnetworkUri": { |
1421 }, | 1532 "description": "The Google Compute Engine subnetwork to be u
sed for machine communications. Cannot be specified with network_uri. Example: h
ttps://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0
.", |
1422 "type": "array" | 1533 "type": "string" |
1423 }, | 1534 } |
1424 "mainJarFileUri": { | 1535 }, |
1425 "description": "The Hadoop Compatible Filesystem (HCFS) URI
of the jar file that contains the main class.", | 1536 "type": "object" |
1426 "type": "string" | 1537 }, |
1427 }, | 1538 "CancelOperationRequest": { |
1428 "jarFileUris": { | 1539 "description": "The request message for Operations.CancelOperation."
, |
1429 "description": "Optional HCFS URIs of jar files to add to th
e CLASSPATHs of the Spark driver and tasks.", | 1540 "id": "CancelOperationRequest", |
1430 "items": { | 1541 "properties": {}, |
1431 "type": "string" | 1542 "type": "object" |
1432 }, | 1543 }, |
1433 "type": "array" | 1544 "DiagnoseClusterOutputLocation": { |
1434 }, | 1545 "description": "The location of diagnostic output.", |
1435 "loggingConfiguration": { | 1546 "id": "DiagnoseClusterOutputLocation", |
1436 "$ref": "LoggingConfiguration", | 1547 "properties": { |
1437 "description": "Optional The runtime log configuration for j
ob execution." | 1548 "outputUri": { |
1438 }, | 1549 "description": "Output-only The Google Cloud Storage URI of
the diagnostic output. This is a plain text file with a summary of collected dia
gnostics.", |
1439 "properties": { | 1550 "type": "string" |
1440 "additionalProperties": { | 1551 } |
1441 "type": "string" | 1552 }, |
1442 }, | 1553 "type": "object" |
1443 "description": "Optional A mapping of property names to valu
es, used to configure Spark. Properties that conflict with values set by the Clo
ud Dataproc API may be overwritten. Can include properties set in /etc/spark/con
f/spark-defaults.conf and classes in user code.", | 1554 }, |
1444 "type": "object" | 1555 "Operation": { |
1445 }, | 1556 "description": "This resource represents a long-running operation th
at is the result of a network API call.", |
1446 "args": { | 1557 "id": "Operation", |
1447 "description": "Optional The arguments to pass to the driver
. Do not include arguments, such as --conf, that can be set as job properties, s
ince a collision may occur that causes an incorrect job submission.", | 1558 "properties": { |
1448 "items": { | 1559 "response": { |
1449 "type": "string" | 1560 "additionalProperties": { |
1450 }, | 1561 "description": "Properties of the object. Contains field
@type with type URL.", |
1451 "type": "array" | 1562 "type": "any" |
1452 }, | 1563 }, |
1453 "fileUris": { | 1564 "description": "The normal response of the operation in case
of success. If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty. If the original method is standard Get/Cr
eate/Update, the response should be the resource. For other methods, the respons
e should have the type XxxResponse, where Xxx is the original method name. For e
xample, if the original method name is TakeSnapshot(), the inferred response typ
e is TakeSnapshotResponse.", |
1454 "description": "Optional HCFS URIs of files to be copied to
the working directory of Spark drivers and distributed tasks. Useful for naively
parallel tasks.", | 1565 "type": "object" |
1455 "items": { | 1566 }, |
1456 "type": "string" | 1567 "name": { |
1457 }, | 1568 "description": "The server-assigned name, which is only uniq
ue within the same service that originally returns it. If you use the default HT
TP mapping, the name should have the format of operations/some/unique/name.", |
1458 "type": "array" | 1569 "type": "string" |
1459 } | 1570 }, |
1460 }, | 1571 "error": { |
1461 "type": "object" | 1572 "$ref": "Status", |
1462 }, | 1573 "description": "The error result of the operation in case of
failure or cancellation." |
1463 "DiskConfiguration": { | 1574 }, |
1464 "description": "Specifies the configuration of disk options for a gr
oup of VM instances.", | 1575 "metadata": { |
1465 "id": "DiskConfiguration", | 1576 "additionalProperties": { |
1466 "properties": { | 1577 "description": "Properties of the object. Contains field
@type with type URL.", |
1467 "bootDiskSizeGb": { | 1578 "type": "any" |
1468 "description": "Optional Size in GB of the boot disk (defaul
t is 500GB).", | 1579 }, |
1469 "format": "int32", | 1580 "description": "Service-specific metadata associated with th
e operation. It typically contains progress information and common metadata such
as create time. Some services might not provide such metadata. Any method that
returns a long-running operation should document the metadata type, if any.", |
1470 "type": "integer" | 1581 "type": "object" |
1471 }, | 1582 }, |
1472 "numLocalSsds": { | 1583 "done": { |
1473 "description": "Optional Number of attached SSDs, from 0 to
4 (default is 0). If SSDs are not attached, the boot disk is used to store runti
me logs and HDFS data. If one or more SSDs are attached, this runtime bulk data
is spread across them, and the boot disk contains only basic configuration and i
nstalled binaries.", | 1584 "description": "If the value is false, it means the operatio
n is still in progress. If true, the operation is completed, and either error or
response is available.", |
1474 "format": "int32", | 1585 "type": "boolean" |
1475 "type": "integer" | 1586 } |
1476 } | 1587 }, |
1477 }, | 1588 "type": "object" |
1478 "type": "object" | 1589 }, |
1479 }, | 1590 "OperationStatus": { |
1480 "JobStatus": { | 1591 "description": "The status of the operation.", |
1481 "description": "Cloud Dataproc job status.", | 1592 "id": "OperationStatus", |
1482 "id": "JobStatus", | |
1483 "properties": { | 1593 "properties": { |
1484 "state": { | 1594 "state": { |
1485 "description": "Required A state message specifying the over
all job state.", | 1595 "description": "A message containing the operation state.", |
1486 "enum": [ | |
1487 "STATE_UNSPECIFIED", | |
1488 "PENDING", | |
1489 "SETUP_DONE", | |
1490 "RUNNING", | |
1491 "CANCEL_PENDING", | |
1492 "CANCEL_STARTED", | |
1493 "CANCELLED", | |
1494 "DONE", | |
1495 "ERROR", | |
1496 "ATTEMPT_FAILURE" | |
1497 ], | |
1498 "enumDescriptions": [ | |
1499 "The job state is unknown.", | |
1500 "The job is pending; it has been submitted, but is not y
et running.", | |
1501 "Job has been received by the service and completed init
ial setup; it will shortly be submitted to the cluster.", | |
1502 "The job is running on the cluster.", | |
1503 "A CancelJob request has been received, but is pending."
, | |
1504 "Transient in-flight resources have been canceled, and t
he request to cancel the running job has been issued to the cluster.", | |
1505 "The job cancelation was successful.", | |
1506 "The job has completed successfully.", | |
1507 "The job has completed, but encountered an error.", | |
1508 "Job attempt has failed. The detail field contains failu
re details for this attempt.Applies to restartable jobs only." | |
1509 ], | |
1510 "type": "string" | |
1511 }, | |
1512 "details": { | |
1513 "description": "Optional Job state details, such as an error
description if the state is <code>ERROR</code>.", | |
1514 "type": "string" | |
1515 }, | |
1516 "stateStartTime": { | |
1517 "description": "Output-only The time when this state was ent
ered.", | |
1518 "format": "google-datetime", | |
1519 "type": "string" | |
1520 } | |
1521 }, | |
1522 "type": "object" | |
1523 }, | |
1524 "ClusterOperationStatus": { | |
1525 "description": "The status of the operation.", | |
1526 "id": "ClusterOperationStatus", | |
1527 "properties": { | |
1528 "state": { | |
1529 "description": "Output-only A message containing the operati
on state.", | |
1530 "enum": [ | 1596 "enum": [ |
1531 "UNKNOWN", | 1597 "UNKNOWN", |
1532 "PENDING", | 1598 "PENDING", |
1533 "RUNNING", | 1599 "RUNNING", |
1534 "DONE" | 1600 "DONE" |
1535 ], | 1601 ], |
1536 "enumDescriptions": [ | 1602 "enumDescriptions": [ |
1537 "Unused.", | 1603 "Unused.", |
1538 "The operation has been created.", | 1604 "The operation has been created.", |
1539 "The operation is running.", | 1605 "The operation is running.", |
1540 "The operation is done; either cancelled or completed." | 1606 "The operation is done; either cancelled or completed." |
1541 ], | 1607 ], |
1542 "type": "string" | 1608 "type": "string" |
1543 }, | 1609 }, |
1544 "details": { | 1610 "details": { |
1545 "description": "Output-onlyA message containing any operatio
n metadata details.", | 1611 "description": "A message containing any operation metadata
details.", |
1546 "type": "string" | 1612 "type": "string" |
1547 }, | 1613 }, |
1548 "innerState": { | 1614 "innerState": { |
1549 "description": "Output-only A message containing the detaile
d operation state.", | 1615 "description": "A message containing the detailed operation
state.", |
1550 "type": "string" | 1616 "type": "string" |
1551 }, | 1617 }, |
1552 "stateStartTime": { | 1618 "stateStartTime": { |
1553 "description": "Output-only The time this state was entered.
", | 1619 "description": "The time this state was entered.", |
1554 "format": "google-datetime", | 1620 "format": "google-datetime", |
1555 "type": "string" | 1621 "type": "string" |
1556 } | 1622 } |
1557 }, | 1623 }, |
1558 "type": "object" | 1624 "type": "object" |
1559 }, | 1625 }, |
1560 "HadoopJob": { | 1626 "JobReference": { |
1561 "description": "A Cloud Dataproc job for running Hadoop MapReduce jo
bs on YARN.", | 1627 "description": "Encapsulates the full scoping used to reference a jo
b.", |
1562 "id": "HadoopJob", | 1628 "id": "JobReference", |
1563 "properties": { | 1629 "properties": { |
| 1630 "projectId": { |
| 1631 "description": "Required The ID of the Google Cloud Platform
project that the job belongs to.", |
| 1632 "type": "string" |
| 1633 }, |
| 1634 "jobId": { |
| 1635 "description": "Required The job ID, which must be unique wi
thin the project. The job ID is generated by the server upon job submission or p
rovided by the user as a means to perform retries without creating duplicate job
s. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_),
or hyphens (-). The maximum length is 100 characters.", |
| 1636 "type": "string" |
| 1637 } |
| 1638 }, |
| 1639 "type": "object" |
| 1640 }, |
| 1641 "SubmitJobRequest": { |
| 1642 "description": "A request to submit a job.", |
| 1643 "id": "SubmitJobRequest", |
| 1644 "properties": { |
| 1645 "job": { |
| 1646 "$ref": "Job", |
| 1647 "description": "Required The job resource." |
| 1648 } |
| 1649 }, |
| 1650 "type": "object" |
| 1651 }, |
| 1652 "Status": { |
| 1653 "description": "The Status type defines a logical error model that i
s suitable for different programming environments, including REST APIs and RPC A
PIs. It is used by gRPC (https://github.com/grpc). The error model is designed t
o be:\nSimple to use and understand for most users\nFlexible enough to meet unex
pected needsOverviewThe Status message contains three pieces of data: error code
, error message, and error details. The error code should be an enum value of go
ogle.rpc.Code, but it may accept additional error codes if needed. The error mes
sage should be a developer-facing English message that helps developers understa
nd and resolve the error. If a localized user-facing error message is needed, pu
t the localized message in the error details or localize it in the client. The o
ptional error details may contain arbitrary information about the error. There i
s a predefined set of error detail types in the package google.rpc which can be
used for common error conditions.Language mappingThe Status message is the logic
al representation of the error model, but it is not necessarily the actual wire
format. When the Status message is exposed in different client libraries and dif
ferent wire protocols, it can be mapped differently. For example, it will likely
be mapped to some exceptions in Java, but more likely mapped to some error code
s in C.Other usesThe error model and the Status message can be used in a variety
of environments, either with or without APIs, to provide a consistent developer
experience across different environments.Example uses of this error model inclu
de:\nPartial errors. If a service needs to return partial errors to the client,
it may embed the Status in the normal response to indicate the partial errors.\n
Workflow errors. A typical workflow has multiple steps. Each step may have a Sta
tus message for error reporting purpose.\nBatch operations. If a client uses bat
ch request and batch response, the Status message should be used directly inside
batch response, one for each error sub-response.\nAsynchronous operations. If a
n API call embeds asynchronous operation results in its response, the status of
those operations should be represented directly using the Status message.\nLoggi
ng. If some API errors are stored in logs, the message Status could be used dire
ctly after any stripping needed for security/privacy reasons.", |
| 1654 "id": "Status", |
| 1655 "properties": { |
| 1656 "message": { |
| 1657 "description": "A developer-facing error message, which shou
ld be in English. Any user-facing error message should be localized and sent in
the google.rpc.Status.details field, or localized by the client.", |
| 1658 "type": "string" |
| 1659 }, |
| 1660 "details": { |
| 1661 "description": "A list of messages that carry the error deta
ils. There will be a common set of message types for APIs to use.", |
| 1662 "items": { |
| 1663 "additionalProperties": { |
| 1664 "description": "Properties of the object. Contains f
ield @type with type URL.", |
| 1665 "type": "any" |
| 1666 }, |
| 1667 "type": "object" |
| 1668 }, |
| 1669 "type": "array" |
| 1670 }, |
| 1671 "code": { |
| 1672 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", |
| 1673 "format": "int32", |
| 1674 "type": "integer" |
| 1675 } |
| 1676 }, |
| 1677 "type": "object" |
| 1678 }, |
| 1679 "JobScheduling": { |
| 1680 "description": "Job scheduling options.Beta Feature: These options a
re available for testing purposes only. They may be changed before final release
.", |
| 1681 "id": "JobScheduling", |
| 1682 "properties": { |
| 1683 "maxFailuresPerHour": { |
| 1684 "description": "Optional Maximum number of times per hour a
driver may be restarted as a result of driver terminating with non-zero code bef
ore job is reported failed.A job may be reported as thrashing if driver exits wi
th non-zero code 4 times within 10 minute window.Maximum value is 10.", |
| 1685 "format": "int32", |
| 1686 "type": "integer" |
| 1687 } |
| 1688 }, |
| 1689 "type": "object" |
| 1690 }, |
| 1691 "NodeInitializationAction": { |
| 1692 "description": "Specifies an executable to run on a fully configured
node and a timeout period for executable completion.", |
| 1693 "id": "NodeInitializationAction", |
| 1694 "properties": { |
| 1695 "executableFile": { |
| 1696 "description": "Required Google Cloud Storage URI of executa
ble file.", |
| 1697 "type": "string" |
| 1698 }, |
| 1699 "executionTimeout": { |
| 1700 "description": "Optional Amount of time executable has to co
mplete. Default is 10 minutes. Cluster creation fails with an explanatory error
message (the name of the executable that caused the error and the exceeded timeo
ut period) if the executable is not completed at end of the timeout period.", |
| 1701 "format": "google-duration", |
| 1702 "type": "string" |
| 1703 } |
| 1704 }, |
| 1705 "type": "object" |
| 1706 }, |
| 1707 "ListJobsResponse": { |
| 1708 "description": "A list of jobs in a project.", |
| 1709 "id": "ListJobsResponse", |
| 1710 "properties": { |
| 1711 "jobs": { |
| 1712 "description": "Output-only Jobs list.", |
| 1713 "items": { |
| 1714 "$ref": "Job" |
| 1715 }, |
| 1716 "type": "array" |
| 1717 }, |
| 1718 "nextPageToken": { |
| 1719 "description": "Optional This token is included in the respo
nse if there are more results to fetch. To fetch additional results, provide thi
s value as the page_token in a subsequent <code>ListJobsRequest</code>.", |
| 1720 "type": "string" |
| 1721 } |
| 1722 }, |
| 1723 "type": "object" |
| 1724 }, |
| 1725 "CancelJobRequest": { |
| 1726 "description": "A request to cancel a job.", |
| 1727 "id": "CancelJobRequest", |
| 1728 "properties": {}, |
| 1729 "type": "object" |
| 1730 }, |
| 1731 "SparkSqlJob": { |
| 1732 "description": "A Cloud Dataproc job for running Spark SQL queries."
, |
| 1733 "id": "SparkSqlJob", |
| 1734 "properties": { |
| 1735 "properties": { |
| 1736 "additionalProperties": { |
| 1737 "type": "string" |
| 1738 }, |
| 1739 "description": "Optional A mapping of property names to valu
es, used to configure Spark SQL's SparkConf. Properties that conflict with value
s set by the Cloud Dataproc API may be overwritten.", |
| 1740 "type": "object" |
| 1741 }, |
| 1742 "queryFileUri": { |
| 1743 "description": "The HCFS URI of the script that contains SQL
queries.", |
| 1744 "type": "string" |
| 1745 }, |
| 1746 "queryList": { |
| 1747 "$ref": "QueryList", |
| 1748 "description": "A list of queries." |
| 1749 }, |
| 1750 "scriptVariables": { |
| 1751 "additionalProperties": { |
| 1752 "type": "string" |
| 1753 }, |
| 1754 "description": "Optional Mapping of query variable names to
values (equivalent to the Spark SQL command: SET name=\"value\";).", |
| 1755 "type": "object" |
| 1756 }, |
1564 "jarFileUris": { | 1757 "jarFileUris": { |
1565 "description": "Optional Jar file URIs to add to the CLASSPA
THs of the Hadoop driver and tasks.", | 1758 "description": "Optional HCFS URIs of jar files to be added
to the Spark CLASSPATH.", |
1566 "items": { | 1759 "items": { |
1567 "type": "string" | 1760 "type": "string" |
1568 }, | 1761 }, |
1569 "type": "array" | 1762 "type": "array" |
1570 }, | 1763 }, |
1571 "loggingConfiguration": { | 1764 "loggingConfiguration": { |
1572 "$ref": "LoggingConfiguration", | 1765 "$ref": "LoggingConfiguration", |
1573 "description": "Optional The runtime log configuration for j
ob execution." | 1766 "description": "Optional The runtime log configuration for j
ob execution." |
1574 }, | 1767 } |
1575 "properties": { | 1768 }, |
| 1769 "type": "object" |
| 1770 }, |
| 1771 "Cluster": { |
| 1772 "description": "Describes the identifying information, configuration
, and status of a cluster of Google Compute Engine instances.", |
| 1773 "id": "Cluster", |
| 1774 "properties": { |
| 1775 "configuration": { |
| 1776 "$ref": "ClusterConfiguration", |
| 1777 "description": "Required The cluster configuration. Note tha
t Cloud Dataproc may set default values, and values may change when clusters are
updated." |
| 1778 }, |
| 1779 "labels": { |
1576 "additionalProperties": { | 1780 "additionalProperties": { |
1577 "type": "string" | 1781 "type": "string" |
1578 }, | 1782 }, |
1579 "description": "Optional A mapping of property names to valu
es, used to configure Hadoop. Properties that conflict with values set by the Cl
oud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/c
onf/*-site and classes in user code.", | 1783 "description": "Optional The labels to associate with this c
luster.Label keys must be between 1 and 63 characters long, and must conform to
the following PCRE regular expression: \\p{Ll}\\p{Lo}{0,62}Label values must be
between 1 and 63 characters long, and must conform to the following PCRE regular
expression: \\p{Ll}\\p{Lo}\\p{N}_-{0,63}No more than 64 labels can be associate
d with a given cluster.", |
1580 "type": "object" | 1784 "type": "object" |
1581 }, | 1785 }, |
1582 "args": { | 1786 "metrics": { |
1583 "description": "Optional The arguments to pass to the driver
. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as jo
b properties, since a collision may occur that causes an incorrect job submissio
n.", | 1787 "$ref": "ClusterMetrics", |
1584 "items": { | 1788 "description": "Contains cluster daemon metrics such as HDFS
and YARN stats." |
1585 "type": "string" | 1789 }, |
1586 }, | 1790 "status": { |
1587 "type": "array" | 1791 "$ref": "ClusterStatus", |
1588 }, | 1792 "description": "Output-only Cluster status." |
1589 "fileUris": { | 1793 }, |
1590 "description": "Optional HCFS URIs of files to be copied to
the working directory of Hadoop drivers and distributed tasks. Useful for naivel
y parallel tasks.", | 1794 "statusHistory": { |
1591 "items": { | 1795 "description": "Output-only Previous cluster statuses.", |
1592 "type": "string" | 1796 "items": { |
1593 }, | 1797 "$ref": "ClusterStatus" |
1594 "type": "array" | 1798 }, |
1595 }, | 1799 "type": "array" |
1596 "mainClass": { | 1800 }, |
1597 "description": "The name of the driver's main class. The jar
file containing the class must be in the default CLASSPATH or specified in jar_
file_uris.", | 1801 "clusterName": { |
1598 "type": "string" | 1802 "description": "Required The cluster name. Cluster names wit
hin a project must be unique. Names from deleted clusters can be reused.", |
1599 }, | 1803 "type": "string" |
1600 "archiveUris": { | 1804 }, |
1601 "description": "Optional HCFS URIs of archives to be extract
ed in the working directory of Hadoop drivers and tasks. Supported file types: .
jar, .tar, .tar.gz, .tgz, or .zip.", | 1805 "clusterUuid": { |
1602 "items": { | 1806 "description": "Output-only A cluster UUID (Unique Universal
Identifier). Cloud Dataproc generates this value when it creates the cluster.", |
1603 "type": "string" | 1807 "type": "string" |
1604 }, | 1808 }, |
1605 "type": "array" | 1809 "projectId": { |
1606 }, | 1810 "description": "Required The Google Cloud Platform project I
D that the cluster belongs to.", |
1607 "mainJarFileUri": { | 1811 "type": "string" |
1608 "description": "The Hadoop Compatible Filesystem (HCFS) URI
of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics
-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcou
nt.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'", | 1812 } |
1609 "type": "string" | 1813 }, |
1610 } | 1814 "type": "object" |
1611 }, | 1815 }, |
1612 "type": "object" | 1816 "ListOperationsResponse": { |
1613 }, | 1817 "description": "The response message for Operations.ListOperations."
, |
1614 "QueryList": { | 1818 "id": "ListOperationsResponse", |
1615 "description": "A list of queries to run on a cluster.", | 1819 "properties": { |
1616 "id": "QueryList", | 1820 "nextPageToken": { |
1617 "properties": { | 1821 "description": "The standard List next-page token.", |
1618 "queries": { | 1822 "type": "string" |
1619 "description": "Required The queries to execute. You do not
need to terminate a query with a semicolon. Multiple queries can be specified in
one string by separating each with a semicolon. Here is an example of an Cloud
Dataproc API snippet that uses a QueryList to specify a HiveJob:\n\"hiveJob\": {
\n \"queryList\": {\n \"queries\": [\n \"query1\",\n \"query2\",\n
\"query3;query4\",\n ]\n }\n}\n", | 1823 }, |
1620 "items": { | 1824 "operations": { |
1621 "type": "string" | 1825 "description": "A list of operations that matches the specif
ied filter in the request.", |
1622 }, | 1826 "items": { |
1623 "type": "array" | 1827 "$ref": "Operation" |
1624 } | 1828 }, |
1625 }, | 1829 "type": "array" |
1626 "type": "object" | 1830 } |
1627 }, | 1831 }, |
1628 "YarnApplication": { | 1832 "type": "object" |
1629 "description": "A YARN application created by a job. Application inf
ormation is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.Applicatio
nReportProto</code>.", | 1833 }, |
1630 "id": "YarnApplication", | 1834 "OperationMetadata": { |
1631 "properties": { | |
1632 "state": { | |
1633 "description": "Required The application state.", | |
1634 "enum": [ | |
1635 "STATE_UNSPECIFIED", | |
1636 "NEW", | |
1637 "NEW_SAVING", | |
1638 "SUBMITTED", | |
1639 "ACCEPTED", | |
1640 "RUNNING", | |
1641 "FINISHED", | |
1642 "FAILED", | |
1643 "KILLED" | |
1644 ], | |
1645 "enumDescriptions": [ | |
1646 "Status is unspecified.", | |
1647 "Status is NEW.", | |
1648 "Status is NEW_SAVING.", | |
1649 "Status is SUBMITTED.", | |
1650 "Status is ACCEPTED.", | |
1651 "Status is RUNNING.", | |
1652 "Status is FINISHED.", | |
1653 "Status is FAILED.", | |
1654 "Status is KILLED." | |
1655 ], | |
1656 "type": "string" | |
1657 }, | |
1658 "name": { | |
1659 "description": "Required The application name.", | |
1660 "type": "string" | |
1661 }, | |
1662 "trackingUrl": { | |
1663 "description": "Optional The HTTP URL of the ApplicationMast
er, HistoryServer, or TimelineServer that provides application-specific informat
ion. The URL uses the internal hostname, and requires a proxy server for resolut
ion and, possibly, access.", | |
1664 "type": "string" | |
1665 }, | |
1666 "progress": { | |
1667 "description": "Required The numerical progress of the appli
cation, from 1 to 100.", | |
1668 "format": "float", | |
1669 "type": "number" | |
1670 } | |
1671 }, | |
1672 "type": "object" | |
1673 }, | |
1674 "DiagnoseClusterRequest": { | |
1675 "description": "A request to collect cluster diagnostic information.
", | |
1676 "id": "DiagnoseClusterRequest", | |
1677 "properties": {}, | |
1678 "type": "object" | |
1679 }, | |
1680 "ClusterOperationMetadata": { | |
1681 "description": "Metadata describing the operation.", | 1835 "description": "Metadata describing the operation.", |
1682 "id": "ClusterOperationMetadata", | 1836 "id": "OperationMetadata", |
1683 "properties": { | 1837 "properties": { |
1684 "operationType": { | 1838 "operationType": { |
1685 "description": "Output-only The operation type.", | 1839 "description": "Output-only The operation type.", |
1686 "type": "string" | 1840 "type": "string" |
1687 }, | 1841 }, |
1688 "description": { | 1842 "description": { |
1689 "description": "Output-only Short description of operation."
, | 1843 "description": "Output-only Short description of operation."
, |
1690 "type": "string" | 1844 "type": "string" |
1691 }, | 1845 }, |
1692 "warnings": { | 1846 "warnings": { |
1693 "description": "Output-only Errors encountered during operat
ion execution.", | 1847 "description": "Output-only Errors encountered during operat
ion execution.", |
1694 "items": { | 1848 "items": { |
1695 "type": "string" | 1849 "type": "string" |
1696 }, | 1850 }, |
1697 "type": "array" | 1851 "type": "array" |
1698 }, | 1852 }, |
1699 "labels": { | |
1700 "additionalProperties": { | |
1701 "type": "string" | |
1702 }, | |
1703 "description": "Output-only Labels associated with the opera
tion", | |
1704 "type": "object" | |
1705 }, | |
1706 "status": { | 1853 "status": { |
1707 "$ref": "ClusterOperationStatus", | 1854 "$ref": "OperationStatus", |
1708 "description": "Output-only Current operation status." | 1855 "description": "Output-only Current operation status." |
1709 }, | 1856 }, |
1710 "statusHistory": { | 1857 "statusHistory": { |
1711 "description": "Output-only The previous operation status.", | 1858 "description": "Output-only Previous operation status.", |
1712 "items": { | 1859 "items": { |
1713 "$ref": "ClusterOperationStatus" | 1860 "$ref": "OperationStatus" |
1714 }, | 1861 }, |
1715 "type": "array" | 1862 "type": "array" |
| 1863 }, |
| 1864 "clusterName": { |
| 1865 "description": "Name of the cluster for the operation.", |
| 1866 "type": "string" |
1716 }, | 1867 }, |
1717 "clusterUuid": { | 1868 "clusterUuid": { |
1718 "description": "Output-only Cluster UUID for the operation."
, | 1869 "description": "Cluster UUId for the operation.", |
1719 "type": "string" | 1870 "type": "string" |
1720 }, | 1871 } |
| 1872 }, |
| 1873 "type": "object" |
| 1874 }, |
| 1875 "JobPlacement": { |
| 1876 "description": "Cloud Dataproc job configuration.", |
| 1877 "id": "JobPlacement", |
| 1878 "properties": { |
1721 "clusterName": { | 1879 "clusterName": { |
1722 "description": "Output-only Name of the cluster for the oper
ation.", | 1880 "description": "Required The name of the cluster where the j
ob will be submitted.", |
1723 "type": "string" | 1881 "type": "string" |
1724 } | 1882 }, |
1725 }, | 1883 "clusterUuid": { |
1726 "type": "object" | 1884 "description": "Output-only A cluster UUID generated by the
Dataproc service when the job is submitted.", |
1727 }, | 1885 "type": "string" |
1728 "HiveJob": { | 1886 } |
1729 "description": "A Cloud Dataproc job for running Hive queries on YAR
N.", | 1887 }, |
1730 "id": "HiveJob", | 1888 "type": "object" |
1731 "properties": { | |
1732 "continueOnFailure": { | |
1733 "description": "Optional Whether to continue executing queri
es if a query fails. The default value is false. Setting to true can be useful w
hen executing independent parallel queries.", | |
1734 "type": "boolean" | |
1735 }, | |
1736 "queryList": { | |
1737 "$ref": "QueryList", | |
1738 "description": "A list of queries." | |
1739 }, | |
1740 "queryFileUri": { | |
1741 "description": "The HCFS URI of the script that contains Hiv
e queries.", | |
1742 "type": "string" | |
1743 }, | |
1744 "scriptVariables": { | |
1745 "additionalProperties": { | |
1746 "type": "string" | |
1747 }, | |
1748 "description": "Optional Mapping of query variable names to
values (equivalent to the Hive command: SET name=\"value\";).", | |
1749 "type": "object" | |
1750 }, | |
1751 "jarFileUris": { | |
1752 "description": "Optional HCFS URIs of jar files to add to th
e CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive
SerDes and UDFs.", | |
1753 "items": { | |
1754 "type": "string" | |
1755 }, | |
1756 "type": "array" | |
1757 }, | |
1758 "properties": { | |
1759 "additionalProperties": { | |
1760 "type": "string" | |
1761 }, | |
1762 "description": "Optional A mapping of property names and val
ues, used to configure Hive. Properties that conflict with values set by the Clo
ud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/co
nf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.", | |
1763 "type": "object" | |
1764 } | |
1765 }, | |
1766 "type": "object" | |
1767 }, | |
1768 "Empty": { | |
1769 "description": "A generic empty message that you can re-use to avoid
defining duplicated empty messages in your APIs. A typical example is to use it
as the request or the response type of an API method. For instance:\nservice Fo
o {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe J
SON representation for Empty is empty JSON object {}.", | |
1770 "id": "Empty", | |
1771 "properties": {}, | |
1772 "type": "object" | |
1773 }, | |
1774 "DiagnoseClusterResults": { | |
1775 "description": "The location of diagnostic output.", | |
1776 "id": "DiagnoseClusterResults", | |
1777 "properties": { | |
1778 "outputUri": { | |
1779 "description": "Output-only The Google Cloud Storage URI of
the diagnostic output. The output report is a plain text file with a summary of
collected diagnostics.", | |
1780 "type": "string" | |
1781 } | |
1782 }, | |
1783 "type": "object" | |
1784 }, | |
1785 "SoftwareConfiguration": { | |
1786 "description": "Specifies the selection and configuration of softwar
e inside the cluster.", | |
1787 "id": "SoftwareConfiguration", | |
1788 "properties": { | |
1789 "imageVersion": { | |
1790 "description": "Optional The version of software inside the
cluster. It must match the regular expression [0-9]+\\.[0-9]+. If unspecified, i
t defaults to the latest version (see Cloud Dataproc Versioning).", | |
1791 "type": "string" | |
1792 }, | |
1793 "properties": { | |
1794 "additionalProperties": { | |
1795 "type": "string" | |
1796 }, | |
1797 "description": "Optional The properties to set on daemon con
figuration files.Property keys are specified in \"prefix:property\" format, such
as \"core:fs.defaultFS\". The following are supported prefixes and their mappin
gs: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn
- yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defau
lts.conf", | |
1798 "type": "object" | |
1799 } | |
1800 }, | |
1801 "type": "object" | |
1802 }, | |
1803 "PySparkJob": { | |
1804 "description": "A Cloud Dataproc job for running PySpark application
s on YARN.", | |
1805 "id": "PySparkJob", | |
1806 "properties": { | |
1807 "jarFileUris": { | |
1808 "description": "Optional HCFS URIs of jar files to add to th
e CLASSPATHs of the Python driver and tasks.", | |
1809 "items": { | |
1810 "type": "string" | |
1811 }, | |
1812 "type": "array" | |
1813 }, | |
1814 "loggingConfiguration": { | |
1815 "$ref": "LoggingConfiguration", | |
1816 "description": "Optional The runtime log configuration for j
ob execution." | |
1817 }, | |
1818 "properties": { | |
1819 "additionalProperties": { | |
1820 "type": "string" | |
1821 }, | |
1822 "description": "Optional A mapping of property names to valu
es, used to configure PySpark. Properties that conflict with values set by the C
loud Dataproc API may be overwritten. Can include properties set in /etc/spark/c
onf/spark-defaults.conf and classes in user code.", | |
1823 "type": "object" | |
1824 }, | |
1825 "args": { | |
1826 "description": "Optional The arguments to pass to the driver
. Do not include arguments, such as --conf, that can be set as job properties, s
ince a collision may occur that causes an incorrect job submission.", | |
1827 "items": { | |
1828 "type": "string" | |
1829 }, | |
1830 "type": "array" | |
1831 }, | |
1832 "fileUris": { | |
1833 "description": "Optional HCFS URIs of files to be copied to
the working directory of Python drivers and distributed tasks. Useful for naivel
y parallel tasks.", | |
1834 "items": { | |
1835 "type": "string" | |
1836 }, | |
1837 "type": "array" | |
1838 }, | |
1839 "pythonFileUris": { | |
1840 "description": "Optional HCFS file URIs of Python files to p
ass to the PySpark framework. Supported file types: .py, .egg, and .zip.", | |
1841 "items": { | |
1842 "type": "string" | |
1843 }, | |
1844 "type": "array" | |
1845 }, | |
1846 "mainPythonFileUri": { | |
1847 "description": "Required The Hadoop Compatible Filesystem (H
CFS) URI of the main Python file to use as the driver. Must be a .py file.", | |
1848 "type": "string" | |
1849 }, | |
1850 "archiveUris": { | |
1851 "description": "Optional HCFS URIs of archives to be extract
ed in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.", | |
1852 "items": { | |
1853 "type": "string" | |
1854 }, | |
1855 "type": "array" | |
1856 } | |
1857 }, | |
1858 "type": "object" | |
1859 } | 1889 } |
1860 }, | 1890 }, |
1861 "servicePath": "", | 1891 "servicePath": "", |
1862 "title": "Google Cloud Dataproc API", | 1892 "title": "Google Cloud Dataproc API", |
1863 "version": "v1beta1" | 1893 "version": "v1beta1" |
1864 } | 1894 } |
OLD | NEW |