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

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: discovery/googleapis/dataproc__v1.json

Issue 2936613002: Api-Roll 50: 2017-06-12 (Closed)
Patch Set: Created 3 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « discovery/googleapis/customsearch__v1.json ('k') | discovery/googleapis/datastore__v1.json » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 { 1 {
2 "auth": { 2 "auth": {
3 "oauth2": { 3 "oauth2": {
4 "scopes": { 4 "scopes": {
5 "https://www.googleapis.com/auth/cloud-platform": { 5 "https://www.googleapis.com/auth/cloud-platform": {
6 "description": "View and manage your data across Google Clou d Platform services" 6 "description": "View and manage your data across Google Clou d Platform services"
7 } 7 }
8 } 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:v1", 21 "id": "dataproc:v1",
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 "access_token": { 27 "alt": {
28 "description": "OAuth access token.", 28 "default": "json",
29 "description": "Data format for response.",
30 "enum": [
31 "json",
32 "media",
33 "proto"
34 ],
35 "enumDescriptions": [
36 "Responses with Content-Type of application/json",
37 "Media download with context-dependent Content-Type",
38 "Responses with Content-Type of application/x-protobuf"
39 ],
29 "location": "query", 40 "location": "query",
30 "type": "string" 41 "type": "string"
31 }, 42 },
32 "key": { 43 "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.", 44 "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", 45 "location": "query",
35 "type": "string" 46 "type": "string"
36 }, 47 },
48 "access_token": {
49 "description": "OAuth access token.",
50 "location": "query",
51 "type": "string"
52 },
37 "quotaUser": { 53 "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.", 54 "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", 55 "location": "query",
40 "type": "string" 56 "type": "string"
41 }, 57 },
42 "pp": { 58 "pp": {
43 "default": "true", 59 "default": "true",
44 "description": "Pretty-print response.", 60 "description": "Pretty-print response.",
45 "location": "query", 61 "location": "query",
46 "type": "boolean" 62 "type": "boolean"
47 }, 63 },
64 "bearer_token": {
65 "description": "OAuth bearer token.",
66 "location": "query",
67 "type": "string"
68 },
48 "oauth_token": { 69 "oauth_token": {
49 "description": "OAuth 2.0 token for the current user.", 70 "description": "OAuth 2.0 token for the current user.",
50 "location": "query", 71 "location": "query",
51 "type": "string" 72 "type": "string"
52 }, 73 },
53 "bearer_token": {
54 "description": "OAuth bearer token.",
55 "location": "query",
56 "type": "string"
57 },
58 "upload_protocol": { 74 "upload_protocol": {
59 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").", 75 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
60 "location": "query", 76 "location": "query",
61 "type": "string" 77 "type": "string"
62 }, 78 },
63 "prettyPrint": { 79 "prettyPrint": {
64 "default": "true", 80 "default": "true",
65 "description": "Returns response with indentations and line breaks." , 81 "description": "Returns response with indentations and line breaks." ,
66 "location": "query", 82 "location": "query",
67 "type": "boolean" 83 "type": "boolean"
(...skipping 18 matching lines...) Expand all
86 "v1 error format", 102 "v1 error format",
87 "v2 error format" 103 "v2 error format"
88 ], 104 ],
89 "location": "query", 105 "location": "query",
90 "type": "string" 106 "type": "string"
91 }, 107 },
92 "callback": { 108 "callback": {
93 "description": "JSONP", 109 "description": "JSONP",
94 "location": "query", 110 "location": "query",
95 "type": "string" 111 "type": "string"
96 },
97 "alt": {
98 "default": "json",
99 "description": "Data format for response.",
100 "enum": [
101 "json",
102 "media",
103 "proto"
104 ],
105 "enumDescriptions": [
106 "Responses with Content-Type of application/json",
107 "Media download with context-dependent Content-Type",
108 "Responses with Content-Type of application/x-protobuf"
109 ],
110 "location": "query",
111 "type": "string"
112 } 112 }
113 }, 113 },
114 "protocol": "rest", 114 "protocol": "rest",
115 "resources": { 115 "resources": {
116 "projects": { 116 "projects": {
117 "resources": { 117 "resources": {
118 "regions": { 118 "regions": {
119 "resources": { 119 "resources": {
120 "operations": {
121 "methods": {
122 "cancel": {
123 "description": "Starts asynchronous cancella tion on a long-running operation. The server makes a best effort to cancel the o peration, but success is not guaranteed. If the server doesn't support this meth od, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOper ation or other methods to check whether the cancellation succeeded or whether th e operation completed despite cancellation. On successful cancellation, the oper ation is not deleted; instead, it becomes an operation with an Operation.error v alue with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.",
124 "httpMethod": "POST",
125 "id": "dataproc.projects.regions.operations. cancel",
126 "parameterOrder": [
127 "name"
128 ],
129 "parameters": {
130 "name": {
131 "description": "The name of the oper ation resource to be cancelled.",
132 "location": "path",
133 "pattern": "^projects/[^/]+/regions/ [^/]+/operations/[^/]+$",
134 "required": true,
135 "type": "string"
136 }
137 },
138 "path": "v1/{+name}:cancel",
139 "response": {
140 "$ref": "Empty"
141 },
142 "scopes": [
143 "https://www.googleapis.com/auth/cloud-p latform"
144 ]
145 },
146 "delete": {
147 "description": "Deletes a long-running opera tion. This method indicates that the client is no longer interested in the opera tion result. It does not cancel the operation. If the server doesn't support thi s method, it returns google.rpc.Code.UNIMPLEMENTED.",
148 "httpMethod": "DELETE",
149 "id": "dataproc.projects.regions.operations. delete",
150 "parameterOrder": [
151 "name"
152 ],
153 "parameters": {
154 "name": {
155 "description": "The name of the oper ation resource to be deleted.",
156 "location": "path",
157 "pattern": "^projects/[^/]+/regions/ [^/]+/operations/[^/]+$",
158 "required": true,
159 "type": "string"
160 }
161 },
162 "path": "v1/{+name}",
163 "response": {
164 "$ref": "Empty"
165 },
166 "scopes": [
167 "https://www.googleapis.com/auth/cloud-p latform"
168 ]
169 },
170 "list": {
171 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding below allows API services to ove rride the binding to use different resource name schemes, such as users/*/operat ions.",
172 "httpMethod": "GET",
173 "id": "dataproc.projects.regions.operations. list",
174 "parameterOrder": [
175 "name"
176 ],
177 "parameters": {
178 "pageSize": {
179 "description": "The standard list pa ge size.",
180 "format": "int32",
181 "location": "query",
182 "type": "integer"
183 },
184 "filter": {
185 "description": "The standard list fi lter.",
186 "location": "query",
187 "type": "string"
188 },
189 "name": {
190 "description": "The name of the oper ation collection.",
191 "location": "path",
192 "pattern": "^projects/[^/]+/regions/ [^/]+/operations$",
193 "required": true,
194 "type": "string"
195 },
196 "pageToken": {
197 "description": "The standard list pa ge token.",
198 "location": "query",
199 "type": "string"
200 }
201 },
202 "path": "v1/{+name}",
203 "response": {
204 "$ref": "ListOperationsResponse"
205 },
206 "scopes": [
207 "https://www.googleapis.com/auth/cloud-p latform"
208 ]
209 },
210 "get": {
211 "description": "Gets the latest state of a l ong-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
212 "httpMethod": "GET",
213 "id": "dataproc.projects.regions.operations. get",
214 "parameterOrder": [
215 "name"
216 ],
217 "parameters": {
218 "name": {
219 "description": "The name of the oper ation resource.",
220 "location": "path",
221 "pattern": "^projects/[^/]+/regions/ [^/]+/operations/[^/]+$",
222 "required": true,
223 "type": "string"
224 }
225 },
226 "path": "v1/{+name}",
227 "response": {
228 "$ref": "Operation"
229 },
230 "scopes": [
231 "https://www.googleapis.com/auth/cloud-p latform"
232 ]
233 }
234 }
235 },
236 "jobs": { 120 "jobs": {
237 "methods": { 121 "methods": {
238 "submit": { 122 "submit": {
239 "description": "Submits a job to a cluster." , 123 "description": "Submits a job to a cluster." ,
240 "httpMethod": "POST", 124 "httpMethod": "POST",
241 "id": "dataproc.projects.regions.jobs.submit ", 125 "id": "dataproc.projects.regions.jobs.submit ",
242 "parameterOrder": [ 126 "parameterOrder": [
243 "projectId", 127 "projectId",
244 "region" 128 "region"
245 ], 129 ],
(...skipping 25 matching lines...) Expand all
271 "delete": { 155 "delete": {
272 "description": "Deletes the job from the pro ject. If the job is active, the delete fails, and the response returns FAILED_PR ECONDITION.", 156 "description": "Deletes the job from the pro ject. If the job is active, the delete fails, and the response returns FAILED_PR ECONDITION.",
273 "httpMethod": "DELETE", 157 "httpMethod": "DELETE",
274 "id": "dataproc.projects.regions.jobs.delete ", 158 "id": "dataproc.projects.regions.jobs.delete ",
275 "parameterOrder": [ 159 "parameterOrder": [
276 "projectId", 160 "projectId",
277 "region", 161 "region",
278 "jobId" 162 "jobId"
279 ], 163 ],
280 "parameters": { 164 "parameters": {
165 "jobId": {
166 "description": "Required. The job ID .",
167 "location": "path",
168 "required": true,
169 "type": "string"
170 },
281 "projectId": { 171 "projectId": {
282 "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", 172 "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
283 "location": "path", 173 "location": "path",
284 "required": true, 174 "required": true,
285 "type": "string" 175 "type": "string"
286 },
287 "jobId": {
288 "description": "Required. The job ID .",
289 "location": "path",
290 "required": true,
291 "type": "string"
292 }, 176 },
293 "region": { 177 "region": {
294 "description": "Required. The Cloud Dataproc region in which to handle the request.", 178 "description": "Required. The Cloud Dataproc region in which to handle the request.",
295 "location": "path", 179 "location": "path",
296 "required": true, 180 "required": true,
297 "type": "string" 181 "type": "string"
298 } 182 }
299 }, 183 },
300 "path": "v1/projects/{projectId}/regions/{re gion}/jobs/{jobId}", 184 "path": "v1/projects/{projectId}/regions/{re gion}/jobs/{jobId}",
301 "response": { 185 "response": {
302 "$ref": "Empty" 186 "$ref": "Empty"
303 }, 187 },
304 "scopes": [ 188 "scopes": [
305 "https://www.googleapis.com/auth/cloud-p latform" 189 "https://www.googleapis.com/auth/cloud-p latform"
306 ] 190 ]
307 }, 191 },
308 "list": { 192 "list": {
309 "description": "Lists regions/{region}/jobs in a project.", 193 "description": "Lists regions/{region}/jobs in a project.",
310 "httpMethod": "GET", 194 "httpMethod": "GET",
311 "id": "dataproc.projects.regions.jobs.list", 195 "id": "dataproc.projects.regions.jobs.list",
312 "parameterOrder": [ 196 "parameterOrder": [
313 "projectId", 197 "projectId",
314 "region" 198 "region"
315 ], 199 ],
316 "parameters": { 200 "parameters": {
317 "projectId": {
318 "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
319 "location": "path",
320 "required": true,
321 "type": "string"
322 },
323 "filter": { 201 "filter": {
324 "description": "Optional. A filter c onstraining the jobs to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is status.state or labels. [KEY], and [KEY] is a label key. value can be * to match all values. status.stat e can be either ACTIVE or INACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example fil ter:status.state = ACTIVE AND labels.env = staging AND labels.starred = *", 202 "description": "Optional. A filter c onstraining the jobs to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is status.state or labels. [KEY], and [KEY] is a label key. value can be * to match all values. status.stat e can be either ACTIVE or INACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example fil ter:status.state = ACTIVE AND labels.env = staging AND labels.starred = *",
325 "location": "query", 203 "location": "query",
326 "type": "string" 204 "type": "string"
327 }, 205 },
328 "jobStateMatcher": { 206 "jobStateMatcher": {
329 "description": "Optional. Specifies enumerated categories of jobs to list (default = match ALL jobs).", 207 "description": "Optional. Specifies enumerated categories of jobs to list (default = match ALL jobs).",
330 "enum": [ 208 "enum": [
331 "ALL", 209 "ALL",
332 "ACTIVE", 210 "ACTIVE",
(...skipping 16 matching lines...) Expand all
349 "region": { 227 "region": {
350 "description": "Required. The Cloud Dataproc region in which to handle the request.", 228 "description": "Required. The Cloud Dataproc region in which to handle the request.",
351 "location": "path", 229 "location": "path",
352 "required": true, 230 "required": true,
353 "type": "string" 231 "type": "string"
354 }, 232 },
355 "clusterName": { 233 "clusterName": {
356 "description": "Optional. If set, th e returned jobs list includes only jobs that were submitted to the named cluster .", 234 "description": "Optional. If set, th e returned jobs list includes only jobs that were submitted to the named cluster .",
357 "location": "query", 235 "location": "query",
358 "type": "string" 236 "type": "string"
237 },
238 "projectId": {
239 "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
240 "location": "path",
241 "required": true,
242 "type": "string"
359 } 243 }
360 }, 244 },
361 "path": "v1/projects/{projectId}/regions/{re gion}/jobs", 245 "path": "v1/projects/{projectId}/regions/{re gion}/jobs",
362 "response": { 246 "response": {
363 "$ref": "ListJobsResponse" 247 "$ref": "ListJobsResponse"
364 }, 248 },
365 "scopes": [ 249 "scopes": [
366 "https://www.googleapis.com/auth/cloud-p latform" 250 "https://www.googleapis.com/auth/cloud-p latform"
367 ] 251 ]
368 }, 252 },
369 "cancel": { 253 "cancel": {
370 "description": "Starts a job cancellation re quest. To access the job resource after cancellation, call regions/{region}/jobs .list or regions/{region}/jobs.get.", 254 "description": "Starts a job cancellation re quest. To access the job resource after cancellation, call regions/{region}/jobs .list or regions/{region}/jobs.get.",
371 "httpMethod": "POST", 255 "httpMethod": "POST",
372 "id": "dataproc.projects.regions.jobs.cancel ", 256 "id": "dataproc.projects.regions.jobs.cancel ",
373 "parameterOrder": [ 257 "parameterOrder": [
374 "projectId", 258 "projectId",
375 "region", 259 "region",
376 "jobId" 260 "jobId"
377 ], 261 ],
378 "parameters": { 262 "parameters": {
379 "region": { 263 "region": {
380 "description": "Required. The Cloud Dataproc region in which to handle the request.", 264 "description": "Required. The Cloud Dataproc region in which to handle the request.",
381 "location": "path", 265 "location": "path",
382 "required": true, 266 "required": true,
383 "type": "string" 267 "type": "string"
384 }, 268 },
269 "jobId": {
270 "description": "Required. The job ID .",
271 "location": "path",
272 "required": true,
273 "type": "string"
274 },
385 "projectId": { 275 "projectId": {
386 "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", 276 "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
387 "location": "path", 277 "location": "path",
388 "required": true, 278 "required": true,
389 "type": "string" 279 "type": "string"
390 },
391 "jobId": {
392 "description": "Required. The job ID .",
393 "location": "path",
394 "required": true,
395 "type": "string"
396 } 280 }
397 }, 281 },
398 "path": "v1/projects/{projectId}/regions/{re gion}/jobs/{jobId}:cancel", 282 "path": "v1/projects/{projectId}/regions/{re gion}/jobs/{jobId}:cancel",
399 "request": { 283 "request": {
400 "$ref": "CancelJobRequest" 284 "$ref": "CancelJobRequest"
401 }, 285 },
402 "response": { 286 "response": {
403 "$ref": "Job" 287 "$ref": "Job"
404 }, 288 },
405 "scopes": [ 289 "scopes": [
406 "https://www.googleapis.com/auth/cloud-p latform" 290 "https://www.googleapis.com/auth/cloud-p latform"
407 ] 291 ]
408 }, 292 },
409 "get": { 293 "patch": {
410 "description": "Gets the resource representa tion for a job in a project.", 294 "description": "Updates a job in a project." ,
411 "httpMethod": "GET", 295 "httpMethod": "PATCH",
412 "id": "dataproc.projects.regions.jobs.get", 296 "id": "dataproc.projects.regions.jobs.patch" ,
413 "parameterOrder": [ 297 "parameterOrder": [
414 "projectId", 298 "projectId",
415 "region", 299 "region",
416 "jobId" 300 "jobId"
417 ], 301 ],
418 "parameters": { 302 "parameters": {
419 "projectId": { 303 "updateMask": {
420 "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", 304 "description": "Required. Specifies the path, relative to <code>Job</code>, of the field to update. For example, to update the labels of a Job the <code>update_mask</code> parameter would be speci fied as <code>labels</code>, and the PATCH request body would specify the new va lue. <strong>Note:</strong> Currently, <code>labels</code> is the only field tha t can be updated.",
305 "format": "google-fieldmask",
306 "location": "query",
307 "type": "string"
308 },
309 "region": {
310 "description": "Required. The Cloud Dataproc region in which to handle the request.",
421 "location": "path", 311 "location": "path",
422 "required": true, 312 "required": true,
423 "type": "string" 313 "type": "string"
424 }, 314 },
425 "jobId": { 315 "jobId": {
426 "description": "Required. The job ID .", 316 "description": "Required. The job ID .",
427 "location": "path", 317 "location": "path",
428 "required": true, 318 "required": true,
429 "type": "string" 319 "type": "string"
430 }, 320 },
431 "region": { 321 "projectId": {
432 "description": "Required. The Cloud Dataproc region in which to handle the request.", 322 "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
433 "location": "path", 323 "location": "path",
434 "required": true, 324 "required": true,
435 "type": "string" 325 "type": "string"
436 } 326 }
437 }, 327 },
438 "path": "v1/projects/{projectId}/regions/{re gion}/jobs/{jobId}", 328 "path": "v1/projects/{projectId}/regions/{re gion}/jobs/{jobId}",
329 "request": {
330 "$ref": "Job"
331 },
439 "response": { 332 "response": {
440 "$ref": "Job" 333 "$ref": "Job"
441 }, 334 },
442 "scopes": [ 335 "scopes": [
443 "https://www.googleapis.com/auth/cloud-p latform" 336 "https://www.googleapis.com/auth/cloud-p latform"
444 ] 337 ]
445 }, 338 },
446 "patch": { 339 "get": {
447 "description": "Updates a job in a project." , 340 "description": "Gets the resource representa tion for a job in a project.",
448 "httpMethod": "PATCH", 341 "httpMethod": "GET",
449 "id": "dataproc.projects.regions.jobs.patch" , 342 "id": "dataproc.projects.regions.jobs.get",
450 "parameterOrder": [ 343 "parameterOrder": [
451 "projectId", 344 "projectId",
452 "region", 345 "region",
453 "jobId" 346 "jobId"
454 ], 347 ],
455 "parameters": { 348 "parameters": {
456 "region": { 349 "jobId": {
457 "description": "Required. The Cloud Dataproc region in which to handle the request.", 350 "description": "Required. The job ID .",
458 "location": "path", 351 "location": "path",
459 "required": true, 352 "required": true,
460 "type": "string" 353 "type": "string"
461 }, 354 },
462 "updateMask": {
463 "description": "Required. Specifies the path, relative to <code>Job</code>, of the field to update. For example, to update the labels of a Job the <code>update_mask</code> parameter would be speci fied as <code>labels</code>, and the PATCH request body would specify the new va lue. <strong>Note:</strong> Currently, <code>labels</code> is the only field tha t can be updated.",
464 "format": "google-fieldmask",
465 "location": "query",
466 "type": "string"
467 },
468 "projectId": { 355 "projectId": {
469 "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", 356 "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
470 "location": "path", 357 "location": "path",
471 "required": true, 358 "required": true,
472 "type": "string" 359 "type": "string"
473 }, 360 },
474 "jobId": { 361 "region": {
475 "description": "Required. The job ID .", 362 "description": "Required. The Cloud Dataproc region in which to handle the request.",
476 "location": "path", 363 "location": "path",
477 "required": true, 364 "required": true,
478 "type": "string" 365 "type": "string"
479 } 366 }
480 }, 367 },
481 "path": "v1/projects/{projectId}/regions/{re gion}/jobs/{jobId}", 368 "path": "v1/projects/{projectId}/regions/{re gion}/jobs/{jobId}",
482 "request": {
483 "$ref": "Job"
484 },
485 "response": { 369 "response": {
486 "$ref": "Job" 370 "$ref": "Job"
487 }, 371 },
488 "scopes": [ 372 "scopes": [
489 "https://www.googleapis.com/auth/cloud-p latform" 373 "https://www.googleapis.com/auth/cloud-p latform"
490 ] 374 ]
491 } 375 }
492 } 376 }
493 }, 377 },
494 "clusters": { 378 "clusters": {
495 "methods": { 379 "methods": {
496 "list": { 380 "diagnose": {
497 "description": "Lists all regions/{region}/c lusters in a project.", 381 "description": "Gets cluster diagnostic info rmation. After the operation completes, the Operation.response field contains Di agnoseClusterOutputLocation.",
498 "httpMethod": "GET", 382 "httpMethod": "POST",
499 "id": "dataproc.projects.regions.clusters.li st", 383 "id": "dataproc.projects.regions.clusters.di agnose",
500 "parameterOrder": [ 384 "parameterOrder": [
501 "projectId", 385 "projectId",
502 "region" 386 "region",
387 "clusterName"
503 ], 388 ],
504 "parameters": { 389 "parameters": {
505 "pageToken": { 390 "clusterName": {
506 "description": "Optional. The standa rd List page token.", 391 "description": "Required. The cluste r name.",
507 "location": "query", 392 "location": "path",
393 "required": true,
508 "type": "string" 394 "type": "string"
509 }, 395 },
510 "pageSize": {
511 "description": "Optional. The standa rd List page size.",
512 "format": "int32",
513 "location": "query",
514 "type": "integer"
515 },
516 "projectId": { 396 "projectId": {
517 "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.", 397 "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
518 "location": "path", 398 "location": "path",
519 "required": true, 399 "required": true,
520 "type": "string" 400 "type": "string"
521 }, 401 },
522 "region": { 402 "region": {
523 "description": "Required. The Cloud Dataproc region in which to handle the request.", 403 "description": "Required. The Cloud Dataproc region in which to handle the request.",
524 "location": "path", 404 "location": "path",
525 "required": true, 405 "required": true,
526 "type": "string" 406 "type": "string"
407 }
408 },
409 "path": "v1/projects/{projectId}/regions/{re gion}/clusters/{clusterName}:diagnose",
410 "request": {
411 "$ref": "DiagnoseClusterRequest"
412 },
413 "response": {
414 "$ref": "Operation"
415 },
416 "scopes": [
417 "https://www.googleapis.com/auth/cloud-p latform"
418 ]
419 },
420 "delete": {
421 "description": "Deletes a cluster in a proje ct.",
422 "httpMethod": "DELETE",
423 "id": "dataproc.projects.regions.clusters.de lete",
424 "parameterOrder": [
425 "projectId",
426 "region",
427 "clusterName"
428 ],
429 "parameters": {
430 "clusterName": {
431 "description": "Required. The cluste r name.",
432 "location": "path",
433 "required": true,
434 "type": "string"
527 }, 435 },
436 "projectId": {
437 "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
438 "location": "path",
439 "required": true,
440 "type": "string"
441 },
442 "region": {
443 "description": "Required. The Cloud Dataproc region in which to handle the request.",
444 "location": "path",
445 "required": true,
446 "type": "string"
447 }
448 },
449 "path": "v1/projects/{projectId}/regions/{re gion}/clusters/{clusterName}",
450 "response": {
451 "$ref": "Operation"
452 },
453 "scopes": [
454 "https://www.googleapis.com/auth/cloud-p latform"
455 ]
456 },
457 "list": {
458 "description": "Lists all regions/{region}/c lusters in a project.",
459 "httpMethod": "GET",
460 "id": "dataproc.projects.regions.clusters.li st",
461 "parameterOrder": [
462 "projectId",
463 "region"
464 ],
465 "parameters": {
528 "filter": { 466 "filter": {
529 "description": "Optional. A filter c onstraining the clusters to list. Filters are case-sensitive and have the follow ing syntax:field = value AND field = value ...where field is one of status.state , clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to matc h all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATI NG, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the CREATING, UPDATIN G, and RUNNING states. INACTIVE contains the DELETING and ERROR states. clusterN ame is the name of the cluster provided at creation time. Only the logical AND o perator is supported; space-separated items are treated as having an implicit AN D operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *", 467 "description": "Optional. A filter c onstraining the clusters to list. Filters are case-sensitive and have the follow ing syntax:field = value AND field = value ...where field is one of status.state , clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to matc h all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATI NG, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the CREATING, UPDATIN G, and RUNNING states. INACTIVE contains the DELETING and ERROR states. clusterN ame is the name of the cluster provided at creation time. Only the logical AND o perator is supported; space-separated items are treated as having an implicit AN D operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *",
530 "location": "query", 468 "location": "query",
531 "type": "string" 469 "type": "string"
470 },
471 "region": {
472 "description": "Required. The Cloud Dataproc region in which to handle the request.",
473 "location": "path",
474 "required": true,
475 "type": "string"
476 },
477 "pageToken": {
478 "description": "Optional. The standa rd List page token.",
479 "location": "query",
480 "type": "string"
481 },
482 "pageSize": {
483 "description": "Optional. The standa rd List page size.",
484 "format": "int32",
485 "location": "query",
486 "type": "integer"
487 },
488 "projectId": {
489 "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
490 "location": "path",
491 "required": true,
492 "type": "string"
532 } 493 }
533 }, 494 },
534 "path": "v1/projects/{projectId}/regions/{re gion}/clusters", 495 "path": "v1/projects/{projectId}/regions/{re gion}/clusters",
535 "response": { 496 "response": {
536 "$ref": "ListClustersResponse" 497 "$ref": "ListClustersResponse"
537 }, 498 },
538 "scopes": [ 499 "scopes": [
539 "https://www.googleapis.com/auth/cloud-p latform" 500 "https://www.googleapis.com/auth/cloud-p latform"
540 ] 501 ]
541 }, 502 },
(...skipping 33 matching lines...) Expand 10 before | Expand all | Expand 10 after
575 "patch": { 536 "patch": {
576 "description": "Updates a cluster in a proje ct.", 537 "description": "Updates a cluster in a proje ct.",
577 "httpMethod": "PATCH", 538 "httpMethod": "PATCH",
578 "id": "dataproc.projects.regions.clusters.pa tch", 539 "id": "dataproc.projects.regions.clusters.pa tch",
579 "parameterOrder": [ 540 "parameterOrder": [
580 "projectId", 541 "projectId",
581 "region", 542 "region",
582 "clusterName" 543 "clusterName"
583 ], 544 ],
584 "parameters": { 545 "parameters": {
585 "projectId": { 546 "updateMask": {
586 "description": "Required. The ID of the Google Cloud Platform project the cluster belongs to.", 547 "description": "Required. Specifies the path, relative to Cluster, of the field to update. For example, to change th e number of workers in a cluster to 5, the update_mask parameter would be specif ied as config.worker_config.num_instances, and the PATCH request body would spec ify the new value, as follows:\n{\n \"config\":{\n \"workerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\nSimilarly, to change the number of preem ptible workers in a cluster to 5, the update_mask parameter would be config.seco ndary_worker_config.num_instances, and the PATCH request body would be set as fo llows:\n{\n \"config\":{\n \"secondaryWorkerConfig\":{\n \"numInstances \":\"5\"\n }\n }\n}\n<strong>Note:</strong> Currently, only the following fi elds can be updated:<table> <tbody> <tr> <td><strong>Mask</strong></td> <td> <strong>Purpose</strong></td> </tr> <tr> <td><strong><em>labels</em></strong> </td> <td>Update labels</td> </tr> <tr> <td><strong><em>config.worker_config .num_instances</em></strong></td> <td>Resize primary worker group</td> </tr> <tr> <td><strong><em>config.secondary_worker_config.num_instances</em></strong> </td> <td>Resize secondary worker group</td> </tr> </tbody> </table>",
587 "location": "path", 548 "format": "google-fieldmask",
588 "required": true, 549 "location": "query",
589 "type": "string" 550 "type": "string"
590 }, 551 },
591 "region": { 552 "region": {
592 "description": "Required. The Cloud Dataproc region in which to handle the request.", 553 "description": "Required. The Cloud Dataproc region in which to handle the request.",
593 "location": "path", 554 "location": "path",
594 "required": true, 555 "required": true,
595 "type": "string" 556 "type": "string"
596 }, 557 },
597 "updateMask": {
598 "description": "Required. Specifies the path, relative to Cluster, of the field to update. For example, to change th e number of workers in a cluster to 5, the update_mask parameter would be specif ied as config.worker_config.num_instances, and the PATCH request body would spec ify the new value, as follows:\n{\n \"config\":{\n \"workerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\nSimilarly, to change the number of preem ptible workers in a cluster to 5, the update_mask parameter would be config.seco ndary_worker_config.num_instances, and the PATCH request body would be set as fo llows:\n{\n \"config\":{\n \"secondaryWorkerConfig\":{\n \"numInstances \":\"5\"\n }\n }\n}\n<strong>Note:</strong> Currently, only the following fi elds can be updated:<table> <tbody> <tr> <td><strong>Mask</strong></td> <td> <strong>Purpose</strong></td> </tr> <tr> <td><strong><em>labels</em></strong> </td> <td>Update labels</td> </tr> <tr> <td><strong><em>config.worker_config .num_instances</em></strong></td> <td>Resize primary worker group</td> </tr> <tr> <td><strong><em>config.secondary_worker_config.num_instances</em></strong> </td> <td>Resize secondary worker group</td> </tr> </tbody> </table>",
599 "format": "google-fieldmask",
600 "location": "query",
601 "type": "string"
602 },
603 "clusterName": { 558 "clusterName": {
604 "description": "Required. The cluste r name.", 559 "description": "Required. The cluste r name.",
605 "location": "path", 560 "location": "path",
606 "required": true, 561 "required": true,
607 "type": "string" 562 "type": "string"
563 },
564 "projectId": {
565 "description": "Required. The ID of the Google Cloud Platform project the cluster belongs to.",
566 "location": "path",
567 "required": true,
568 "type": "string"
608 } 569 }
609 }, 570 },
610 "path": "v1/projects/{projectId}/regions/{re gion}/clusters/{clusterName}", 571 "path": "v1/projects/{projectId}/regions/{re gion}/clusters/{clusterName}",
611 "request": { 572 "request": {
612 "$ref": "Cluster" 573 "$ref": "Cluster"
613 }, 574 },
614 "response": { 575 "response": {
615 "$ref": "Operation" 576 "$ref": "Operation"
616 }, 577 },
617 "scopes": [ 578 "scopes": [
618 "https://www.googleapis.com/auth/cloud-p latform" 579 "https://www.googleapis.com/auth/cloud-p latform"
619 ] 580 ]
620 }, 581 },
621 "get": { 582 "get": {
622 "description": "Gets the resource representa tion for a cluster in a project.", 583 "description": "Gets the resource representa tion for a cluster in a project.",
623 "httpMethod": "GET", 584 "httpMethod": "GET",
624 "id": "dataproc.projects.regions.clusters.ge t", 585 "id": "dataproc.projects.regions.clusters.ge t",
625 "parameterOrder": [ 586 "parameterOrder": [
626 "projectId", 587 "projectId",
627 "region", 588 "region",
628 "clusterName" 589 "clusterName"
629 ], 590 ],
630 "parameters": { 591 "parameters": {
592 "region": {
593 "description": "Required. The Cloud Dataproc region in which to handle the request.",
594 "location": "path",
595 "required": true,
596 "type": "string"
597 },
631 "clusterName": { 598 "clusterName": {
632 "description": "Required. The cluste r name.", 599 "description": "Required. The cluste r name.",
633 "location": "path", 600 "location": "path",
634 "required": true, 601 "required": true,
635 "type": "string" 602 "type": "string"
636 }, 603 },
637 "projectId": { 604 "projectId": {
638 "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.", 605 "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
639 "location": "path", 606 "location": "path",
640 "required": true, 607 "required": true,
641 "type": "string" 608 "type": "string"
642 },
643 "region": {
644 "description": "Required. The Cloud Dataproc region in which to handle the request.",
645 "location": "path",
646 "required": true,
647 "type": "string"
648 } 609 }
649 }, 610 },
650 "path": "v1/projects/{projectId}/regions/{re gion}/clusters/{clusterName}", 611 "path": "v1/projects/{projectId}/regions/{re gion}/clusters/{clusterName}",
651 "response": { 612 "response": {
652 "$ref": "Cluster" 613 "$ref": "Cluster"
653 }, 614 },
654 "scopes": [ 615 "scopes": [
655 "https://www.googleapis.com/auth/cloud-p latform" 616 "https://www.googleapis.com/auth/cloud-p latform"
656 ] 617 ]
618 }
619 }
620 },
621 "operations": {
622 "methods": {
623 "cancel": {
624 "description": "Starts asynchronous cancella tion on a long-running operation. The server makes a best effort to cancel the o peration, but success is not guaranteed. If the server doesn't support this meth od, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOper ation or other methods to check whether the cancellation succeeded or whether th e operation completed despite cancellation. On successful cancellation, the oper ation is not deleted; instead, it becomes an operation with an Operation.error v alue with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.",
625 "httpMethod": "POST",
626 "id": "dataproc.projects.regions.operations. cancel",
627 "parameterOrder": [
628 "name"
629 ],
630 "parameters": {
631 "name": {
632 "description": "The name of the oper ation resource to be cancelled.",
633 "location": "path",
634 "pattern": "^projects/[^/]+/regions/ [^/]+/operations/[^/]+$",
635 "required": true,
636 "type": "string"
637 }
638 },
639 "path": "v1/{+name}:cancel",
640 "response": {
641 "$ref": "Empty"
642 },
643 "scopes": [
644 "https://www.googleapis.com/auth/cloud-p latform"
645 ]
657 }, 646 },
658 "diagnose": { 647 "delete": {
659 "description": "Gets cluster diagnostic info rmation. After the operation completes, the Operation.response field contains Di agnoseClusterOutputLocation.", 648 "description": "Deletes a long-running opera tion. This method indicates that the client is no longer interested in the opera tion result. It does not cancel the operation. If the server doesn't support thi s method, it returns google.rpc.Code.UNIMPLEMENTED.",
660 "httpMethod": "POST", 649 "httpMethod": "DELETE",
661 "id": "dataproc.projects.regions.clusters.di agnose", 650 "id": "dataproc.projects.regions.operations. delete",
662 "parameterOrder": [ 651 "parameterOrder": [
663 "projectId", 652 "name"
664 "region",
665 "clusterName"
666 ], 653 ],
667 "parameters": { 654 "parameters": {
668 "region": { 655 "name": {
669 "description": "Required. The Cloud Dataproc region in which to handle the request.", 656 "description": "The name of the oper ation resource to be deleted.",
670 "location": "path", 657 "location": "path",
671 "required": true, 658 "pattern": "^projects/[^/]+/regions/ [^/]+/operations/[^/]+$",
672 "type": "string"
673 },
674 "clusterName": {
675 "description": "Required. The cluste r name.",
676 "location": "path",
677 "required": true,
678 "type": "string"
679 },
680 "projectId": {
681 "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
682 "location": "path",
683 "required": true, 659 "required": true,
684 "type": "string" 660 "type": "string"
685 } 661 }
686 }, 662 },
687 "path": "v1/projects/{projectId}/regions/{re gion}/clusters/{clusterName}:diagnose", 663 "path": "v1/{+name}",
688 "request": { 664 "response": {
689 "$ref": "DiagnoseClusterRequest" 665 "$ref": "Empty"
690 }, 666 },
667 "scopes": [
668 "https://www.googleapis.com/auth/cloud-p latform"
669 ]
670 },
671 "get": {
672 "description": "Gets the latest state of a l ong-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
673 "httpMethod": "GET",
674 "id": "dataproc.projects.regions.operations. get",
675 "parameterOrder": [
676 "name"
677 ],
678 "parameters": {
679 "name": {
680 "description": "The name of the oper ation resource.",
681 "location": "path",
682 "pattern": "^projects/[^/]+/regions/ [^/]+/operations/[^/]+$",
683 "required": true,
684 "type": "string"
685 }
686 },
687 "path": "v1/{+name}",
691 "response": { 688 "response": {
692 "$ref": "Operation" 689 "$ref": "Operation"
693 }, 690 },
694 "scopes": [ 691 "scopes": [
695 "https://www.googleapis.com/auth/cloud-p latform" 692 "https://www.googleapis.com/auth/cloud-p latform"
696 ] 693 ]
697 }, 694 },
698 "delete": { 695 "list": {
699 "description": "Deletes a cluster in a proje ct.", 696 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=user s/*}/operations\" to their service configuration. For backwards compatibility, t he default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations coll ection id.",
700 "httpMethod": "DELETE", 697 "httpMethod": "GET",
701 "id": "dataproc.projects.regions.clusters.de lete", 698 "id": "dataproc.projects.regions.operations. list",
702 "parameterOrder": [ 699 "parameterOrder": [
703 "projectId", 700 "name"
704 "region",
705 "clusterName"
706 ], 701 ],
707 "parameters": { 702 "parameters": {
708 "region": { 703 "pageToken": {
709 "description": "Required. The Cloud Dataproc region in which to handle the request.", 704 "description": "The standard list pa ge token.",
705 "location": "query",
706 "type": "string"
707 },
708 "name": {
709 "description": "The name of the oper ation's parent resource.",
710 "location": "path", 710 "location": "path",
711 "pattern": "^projects/[^/]+/regions/ [^/]+/operations$",
711 "required": true, 712 "required": true,
712 "type": "string" 713 "type": "string"
713 }, 714 },
714 "clusterName": { 715 "pageSize": {
715 "description": "Required. The cluste r name.", 716 "description": "The standard list pa ge size.",
716 "location": "path", 717 "format": "int32",
717 "required": true, 718 "location": "query",
718 "type": "string" 719 "type": "integer"
719 }, 720 },
720 "projectId": { 721 "filter": {
721 "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.", 722 "description": "The standard list fi lter.",
722 "location": "path", 723 "location": "query",
723 "required": true,
724 "type": "string" 724 "type": "string"
725 } 725 }
726 }, 726 },
727 "path": "v1/projects/{projectId}/regions/{re gion}/clusters/{clusterName}", 727 "path": "v1/{+name}",
728 "response": { 728 "response": {
729 "$ref": "Operation" 729 "$ref": "ListOperationsResponse"
730 }, 730 },
731 "scopes": [ 731 "scopes": [
732 "https://www.googleapis.com/auth/cloud-p latform" 732 "https://www.googleapis.com/auth/cloud-p latform"
733 ] 733 ]
734 } 734 }
735 } 735 }
736 } 736 }
737 } 737 }
738 } 738 }
739 } 739 }
740 } 740 }
741 }, 741 },
742 "revision": "20170515", 742 "revision": "20170606",
743 "rootUrl": "https://dataproc.googleapis.com/", 743 "rootUrl": "https://dataproc.googleapis.com/",
744 "schemas": { 744 "schemas": {
745 "ListJobsResponse": { 745 "ListClustersResponse": {
746 "description": "A list of jobs in a project.", 746 "description": "The list of all clusters in a project.",
747 "id": "ListJobsResponse", 747 "id": "ListClustersResponse",
748 "properties": { 748 "properties": {
749 "nextPageToken": { 749 "nextPageToken": {
750 "description": "Optional. This token is included in the resp onse if there are more results to fetch. To fetch additional results, provide th is value as the page_token in a subsequent <code>ListJobsRequest</code>.", 750 "description": "Output-only. This token is included in the r esponse if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent ListClustersRequest.",
751 "type": "string" 751 "type": "string"
752 }, 752 },
753 "jobs": { 753 "clusters": {
754 "description": "Output-only. Jobs list.", 754 "description": "Output-only. The clusters in the project.",
755 "items": { 755 "items": {
756 "$ref": "Job" 756 "$ref": "Cluster"
757 }, 757 },
758 "type": "array" 758 "type": "array"
759 } 759 }
760 }, 760 },
761 "type": "object" 761 "type": "object"
762 }, 762 },
763 "NodeInitializationAction": { 763 "SparkJob": {
764 "description": "Specifies an executable to run on a fully configured node and a timeout period for executable completion.", 764 "description": "A Cloud Dataproc job for running Apache Spark (http: //spark.apache.org/) applications on YARN.",
765 "id": "NodeInitializationAction", 765 "id": "SparkJob",
766 "properties": { 766 "properties": {
767 "executableFile": { 767 "mainJarFileUri": {
768 "description": "Required. Google Cloud Storage URI of execut able file.", 768 "description": "The HCFS URI of the jar file that contains t he main class.",
769 "type": "string" 769 "type": "string"
770 }, 770 },
771 "executionTimeout": {
772 "description": "Optional. Amount of time executable has to c omplete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded time out period) if the executable is not completed at end of the timeout period.",
773 "format": "google-duration",
774 "type": "string"
775 }
776 },
777 "type": "object"
778 },
779 "CancelJobRequest": {
780 "description": "A request to cancel a job.",
781 "id": "CancelJobRequest",
782 "properties": {},
783 "type": "object"
784 },
785 "SparkSqlJob": {
786 "description": "A Cloud Dataproc job for running Apache Spark SQL (h ttp://spark.apache.org/sql/) queries.",
787 "id": "SparkSqlJob",
788 "properties": {
789 "queryList": {
790 "$ref": "QueryList",
791 "description": "A list of queries."
792 },
793 "queryFileUri": {
794 "description": "The HCFS URI of the script that contains SQL queries.",
795 "type": "string"
796 },
797 "scriptVariables": {
798 "additionalProperties": {
799 "type": "string"
800 },
801 "description": "Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name=\"value\";).",
802 "type": "object"
803 },
804 "jarFileUris": { 771 "jarFileUris": {
805 "description": "Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.", 772 "description": "Optional. HCFS URIs of jar files to add to t he CLASSPATHs of the Spark driver and tasks.",
806 "items": { 773 "items": {
807 "type": "string" 774 "type": "string"
808 }, 775 },
809 "type": "array" 776 "type": "array"
810 }, 777 },
811 "loggingConfig": { 778 "loggingConfig": {
812 "$ref": "LoggingConfig", 779 "$ref": "LoggingConfig",
813 "description": "Optional. The runtime log config for job exe cution." 780 "description": "Optional. The runtime log config for job exe cution."
814 }, 781 },
815 "properties": { 782 "properties": {
816 "additionalProperties": { 783 "additionalProperties": {
817 "type": "string" 784 "type": "string"
818 }, 785 },
819 "description": "Optional. A mapping of property names to val ues, used to configure Spark SQL's SparkConf. Properties that conflict with valu es set by the Cloud Dataproc API may be overwritten.", 786 "description": "Optional. A mapping of property names to val ues, used to configure Spark. Properties that conflict with values set by the Cl oud Dataproc API may be overwritten. Can include properties set in /etc/spark/co nf/spark-defaults.conf and classes in user code.",
820 "type": "object" 787 "type": "object"
821 } 788 },
822 }, 789 "args": {
823 "type": "object" 790 "description": "Optional. The arguments to pass to the drive r. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.",
824 }, 791 "items": {
825 "Cluster": { 792 "type": "string"
826 "description": "Describes the identifying information, config, and s tatus of a cluster of Google Compute Engine instances.", 793 },
827 "id": "Cluster", 794 "type": "array"
828 "properties": { 795 },
796 "fileUris": {
797 "description": "Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naivel y parallel tasks.",
798 "items": {
799 "type": "string"
800 },
801 "type": "array"
802 },
803 "mainClass": {
804 "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.",
805 "type": "string"
806 },
807 "archiveUris": {
808 "description": "Optional. HCFS URIs of archives to be extrac ted in the working directory of Spark drivers and tasks. Supported file types: . jar, .tar, .tar.gz, .tgz, and .zip.",
809 "items": {
810 "type": "string"
811 },
812 "type": "array"
813 }
814 },
815 "type": "object"
816 },
817 "Job": {
818 "description": "A Cloud Dataproc job resource.",
819 "id": "Job",
820 "properties": {
821 "hiveJob": {
822 "$ref": "HiveJob",
823 "description": "Job is a Hive job."
824 },
829 "labels": { 825 "labels": {
830 "additionalProperties": { 826 "additionalProperties": {
831 "type": "string" 827 "type": "string"
832 }, 828 },
833 "description": "Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 103 5 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if pre sent, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www .ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a clus ter.", 829 "description": "Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (h ttps://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present , must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.iet f.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.",
834 "type": "object" 830 "type": "object"
835 }, 831 },
836 "metrics": { 832 "driverOutputResourceUri": {
837 "$ref": "ClusterMetrics", 833 "description": "Output-only. A URI pointing to the location of the stdout of the job's driver program.",
838 "description": "Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only . It may be changed before final release." 834 "type": "string"
835 },
836 "sparkSqlJob": {
837 "$ref": "SparkSqlJob",
838 "description": "Job is a SparkSql job."
839 },
840 "sparkJob": {
841 "$ref": "SparkJob",
842 "description": "Job is a Spark job."
843 },
844 "statusHistory": {
845 "description": "Output-only. The previous job status.",
846 "items": {
847 "$ref": "JobStatus"
848 },
849 "type": "array"
850 },
851 "yarnApplications": {
852 "description": "Output-only. The collection of YARN applicat ions spun up by this job.Beta Feature: This report is available for testing purp oses only. It may be changed before final release.",
853 "items": {
854 "$ref": "YarnApplication"
855 },
856 "type": "array"
857 },
858 "pysparkJob": {
859 "$ref": "PySparkJob",
860 "description": "Job is a Pyspark job."
861 },
862 "reference": {
863 "$ref": "JobReference",
864 "description": "Optional. The fully qualified reference to t he 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>."
865 },
866 "hadoopJob": {
867 "$ref": "HadoopJob",
868 "description": "Job is a Hadoop job."
869 },
870 "placement": {
871 "$ref": "JobPlacement",
872 "description": "Required. Job information, including how, wh en, and where to run the job."
839 }, 873 },
840 "status": { 874 "status": {
841 "$ref": "ClusterStatus", 875 "$ref": "JobStatus",
842 "description": "Output-only. Cluster status." 876 "description": "Output-only. The job status. Additional appl ication-specific status information may be contained in the <code>type_job</code > and <code>yarn_applications</code> fields."
843 }, 877 },
844 "config": { 878 "driverControlFilesUri": {
845 "$ref": "ClusterConfig", 879 "description": "Output-only. If present, the location of mis cellaneous 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_ uri.",
846 "description": "Required. The cluster config. Note that Clou d Dataproc may set default values, and values may change when clusters are updat ed." 880 "type": "string"
847 }, 881 },
848 "statusHistory": { 882 "scheduling": {
849 "description": "Output-only. The previous cluster status.", 883 "$ref": "JobScheduling",
850 "items": { 884 "description": "Optional. Job scheduling configuration."
851 "$ref": "ClusterStatus" 885 },
852 }, 886 "pigJob": {
853 "type": "array" 887 "$ref": "PigJob",
854 }, 888 "description": "Job is a Pig job."
855 "clusterName": { 889 }
856 "description": "Required. The cluster name. Cluster names wi thin a project must be unique. Names of deleted clusters can be reused.", 890 },
857 "type": "string" 891 "type": "object"
858 }, 892 },
859 "clusterUuid": { 893 "JobStatus": {
860 "description": "Output-only. A cluster UUID (Unique Universa l Identifier). Cloud Dataproc generates this value when it creates the cluster." , 894 "description": "Cloud Dataproc job status.",
861 "type": "string" 895 "id": "JobStatus",
862 }, 896 "properties": {
863 "projectId": { 897 "details": {
864 "description": "Required. The Google Cloud Platform project ID that the cluster belongs to.", 898 "description": "Output-only. Optional job state details, suc h as an error description if the state is <code>ERROR</code>.",
865 "type": "string" 899 "type": "string"
866 } 900 },
867 }, 901 "state": {
868 "type": "object" 902 "description": "Output-only. A state message specifying the overall job state.",
869 }, 903 "enum": [
870 "ListOperationsResponse": { 904 "STATE_UNSPECIFIED",
871 "description": "The response message for Operations.ListOperations." , 905 "PENDING",
872 "id": "ListOperationsResponse", 906 "SETUP_DONE",
873 "properties": { 907 "RUNNING",
874 "nextPageToken": { 908 "CANCEL_PENDING",
875 "description": "The standard List next-page token.", 909 "CANCEL_STARTED",
876 "type": "string" 910 "CANCELLED",
877 }, 911 "DONE",
878 "operations": { 912 "ERROR",
879 "description": "A list of operations that matches the specif ied filter in the request.", 913 "ATTEMPT_FAILURE"
880 "items": { 914 ],
881 "$ref": "Operation" 915 "enumDescriptions": [
882 }, 916 "The job state is unknown.",
883 "type": "array" 917 "The job is pending; it has been submitted, but is not y et running.",
884 } 918 "Job has been received by the service and completed init ial setup; it will soon be submitted to the cluster.",
885 }, 919 "The job is running on the cluster.",
886 "type": "object" 920 "A CancelJob request has been received, but is pending." ,
887 }, 921 "Transient in-flight resources have been canceled, and t he request to cancel the running job has been issued to the cluster.",
888 "OperationMetadata": { 922 "The job cancellation was successful.",
889 "description": "Metadata describing the operation.", 923 "The job has completed successfully.",
890 "id": "OperationMetadata", 924 "The job has completed, but encountered an error.",
891 "properties": { 925 "Job attempt has failed. The detail field contains failu re details for this attempt.Applies to restartable jobs only."
892 "warnings": { 926 ],
893 "description": "Output-only Errors encountered during operat ion execution.", 927 "type": "string"
894 "items": { 928 },
895 "type": "string" 929 "substate": {
896 }, 930 "description": "Output-only. Additional state information, w hich includes status reported by the agent.",
897 "type": "array" 931 "enum": [
898 }, 932 "UNSPECIFIED",
899 "insertTime": { 933 "SUBMITTED",
900 "description": "The time that the operation was requested.", 934 "QUEUED",
935 "STALE_STATUS"
936 ],
937 "enumDescriptions": [
938 "",
939 "The Job is submitted to the agent.Applies to RUNNING st ate.",
940 "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.",
941 "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."
942 ],
943 "type": "string"
944 },
945 "stateStartTime": {
946 "description": "Output-only. The time when this state was en tered.",
901 "format": "google-datetime", 947 "format": "google-datetime",
902 "type": "string" 948 "type": "string"
903 }, 949 }
904 "statusHistory": { 950 },
905 "description": "Output-only Previous operation status.", 951 "type": "object"
906 "items": { 952 },
907 "$ref": "OperationStatus" 953 "ManagedGroupConfig": {
908 }, 954 "description": "Specifies the resources used to actively manage an i nstance group.",
909 "type": "array" 955 "id": "ManagedGroupConfig",
910 }, 956 "properties": {
911 "operationType": { 957 "instanceGroupManagerName": {
912 "description": "Output-only The operation type.", 958 "description": "Output-only. The name of the Instance Group Manager for this group.",
913 "type": "string" 959 "type": "string"
914 }, 960 },
915 "description": { 961 "instanceTemplateName": {
916 "description": "Output-only Short description of operation." , 962 "description": "Output-only. The name of the Instance Templa te used for the Managed Instance Group.",
917 "type": "string" 963 "type": "string"
918 }, 964 }
919 "status": { 965 },
920 "$ref": "OperationStatus", 966 "type": "object"
921 "description": "Output-only Current operation status." 967 },
968 "ClusterOperationStatus": {
969 "description": "The status of the operation.",
970 "id": "ClusterOperationStatus",
971 "properties": {
972 "stateStartTime": {
973 "description": "Output-only. The time this state was entered .",
974 "format": "google-datetime",
975 "type": "string"
976 },
977 "details": {
978 "description": "Output-only.A message containing any operati on metadata details.",
979 "type": "string"
922 }, 980 },
923 "state": { 981 "state": {
924 "description": "A message containing the operation state.", 982 "description": "Output-only. A message containing the operat ion state.",
925 "enum": [ 983 "enum": [
926 "UNKNOWN", 984 "UNKNOWN",
927 "PENDING", 985 "PENDING",
928 "RUNNING", 986 "RUNNING",
929 "DONE" 987 "DONE"
930 ], 988 ],
931 "enumDescriptions": [ 989 "enumDescriptions": [
932 "Unused.", 990 "Unused.",
933 "The operation has been created.", 991 "The operation has been created.",
934 "The operation is currently running.", 992 "The operation is running.",
935 "The operation is done, either cancelled or completed." 993 "The operation is done; either cancelled or completed."
936 ], 994 ],
937 "type": "string" 995 "type": "string"
938 }, 996 },
939 "details": {
940 "description": "A message containing any operation metadata details.",
941 "type": "string"
942 },
943 "clusterUuid": {
944 "description": "Cluster UUId for the operation.",
945 "type": "string"
946 },
947 "clusterName": {
948 "description": "Name of the cluster for the operation.",
949 "type": "string"
950 },
951 "innerState": { 997 "innerState": {
952 "description": "A message containing the detailed operation state.", 998 "description": "Output-only. A message containing the detail ed operation state.",
953 "type": "string"
954 },
955 "endTime": {
956 "description": "The time that the operation completed.",
957 "format": "google-datetime",
958 "type": "string"
959 },
960 "startTime": {
961 "description": "The time that the operation was started by t he server.",
962 "format": "google-datetime",
963 "type": "string" 999 "type": "string"
964 } 1000 }
965 }, 1001 },
966 "type": "object" 1002 "type": "object"
967 }, 1003 },
968 "JobPlacement": { 1004 "QueryList": {
969 "description": "Cloud Dataproc job config.", 1005 "description": "A list of queries to run on a cluster.",
970 "id": "JobPlacement", 1006 "id": "QueryList",
971 "properties": { 1007 "properties": {
972 "clusterName": { 1008 "queries": {
973 "description": "Required. The name of the cluster where the job will be submitted.", 1009 "description": "Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified i n 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",
974 "type": "string" 1010 "items": {
975 }, 1011 "type": "string"
976 "clusterUuid": { 1012 },
977 "description": "Output-only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted.", 1013 "type": "array"
978 "type": "string"
979 } 1014 }
980 }, 1015 },
981 "type": "object" 1016 "type": "object"
982 }, 1017 },
983 "SoftwareConfig": { 1018 "YarnApplication": {
984 "description": "Specifies the selection and config of software insid e the cluster.", 1019 "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>.Beta Feature: This report is available for testing purposes only. It may be changed before final release.",
985 "id": "SoftwareConfig", 1020 "id": "YarnApplication",
986 "properties": { 1021 "properties": {
987 "properties": { 1022 "state": {
988 "additionalProperties": { 1023 "description": "Required. The application state.",
989 "type": "string" 1024 "enum": [
990 }, 1025 "STATE_UNSPECIFIED",
991 "description": "Optional. The properties to set on daemon co nfig files.Property keys are specified in prefix:property format, such as core:f s.defaultFS. The following are supported prefixes and their mappings:\ncapacity- scheduler: capacity-scheduler.xml\ncore: core-site.xml\ndistcp: distcp-default.x ml\nhdfs: hdfs-site.xml\nhive: hive-site.xml\nmapred: mapred-site.xml\npig: pig. properties\nspark: spark-defaults.conf\nyarn: yarn-site.xml", 1026 "NEW",
992 "type": "object" 1027 "NEW_SAVING",
1028 "SUBMITTED",
1029 "ACCEPTED",
1030 "RUNNING",
1031 "FINISHED",
1032 "FAILED",
1033 "KILLED"
1034 ],
1035 "enumDescriptions": [
1036 "Status is unspecified.",
1037 "Status is NEW.",
1038 "Status is NEW_SAVING.",
1039 "Status is SUBMITTED.",
1040 "Status is ACCEPTED.",
1041 "Status is RUNNING.",
1042 "Status is FINISHED.",
1043 "Status is FAILED.",
1044 "Status is KILLED."
1045 ],
1046 "type": "string"
993 }, 1047 },
994 "imageVersion": { 1048 "name": {
995 "description": "Optional. The version of software inside the cluster. It must match the regular expression [0-9]+\\.[0-9]+. If unspecified, it defaults to the latest version (see Cloud Dataproc Versioning).", 1049 "description": "Required. The application name.",
996 "type": "string" 1050 "type": "string"
1051 },
1052 "trackingUrl": {
1053 "description": "Optional. The HTTP URL of the ApplicationMas ter, HistoryServer, or TimelineServer that provides application-specific informa tion. The URL uses the internal hostname, and requires a proxy server for resolu tion and, possibly, access.",
1054 "type": "string"
1055 },
1056 "progress": {
1057 "description": "Required. The numerical progress of the appl ication, from 1 to 100.",
1058 "format": "float",
1059 "type": "number"
997 } 1060 }
998 }, 1061 },
999 "type": "object" 1062 "type": "object"
1000 }, 1063 },
1001 "ClusterStatus": { 1064 "HadoopJob": {
1002 "description": "The status of a cluster and its instances.", 1065 "description": "A Cloud Dataproc job for running Apache Hadoop MapRe duce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapr educe-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://ha doop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html).",
1003 "id": "ClusterStatus", 1066 "id": "HadoopJob",
1004 "properties": { 1067 "properties": {
1005 "stateStartTime": { 1068 "mainJarFileUri": {
1006 "description": "Output-only. Time when this state was entere d.", 1069 "description": "The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metric s-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/ hadoop-mapreduce/hadoop-mapreduce-examples.jar'",
1007 "format": "google-datetime",
1008 "type": "string" 1070 "type": "string"
1009 }, 1071 },
1010 "substate": {
1011 "description": "Output-only. Additional state information th at includes status reported by the agent.",
1012 "enum": [
1013 "UNSPECIFIED",
1014 "UNHEALTHY",
1015 "STALE_STATUS"
1016 ],
1017 "enumDescriptions": [
1018 "",
1019 "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.",
1020 "The agent-reported status is out of date (may occur if Cloud Dataproc loses communication with Agent).Applies to RUNNING state."
1021 ],
1022 "type": "string"
1023 },
1024 "detail": {
1025 "description": "Output-only. Optional details of cluster's s tate.",
1026 "type": "string"
1027 },
1028 "state": {
1029 "description": "Output-only. The cluster's state.",
1030 "enum": [
1031 "UNKNOWN",
1032 "CREATING",
1033 "RUNNING",
1034 "ERROR",
1035 "DELETING",
1036 "UPDATING"
1037 ],
1038 "enumDescriptions": [
1039 "The cluster state is unknown.",
1040 "The cluster is being created and set up. It is not read y for use.",
1041 "The cluster is currently running and healthy. It is rea dy for use.",
1042 "The cluster encountered an error. It is not ready for u se.",
1043 "The cluster is being deleted. It cannot be used.",
1044 "The cluster is being updated. It continues to accept an d process jobs."
1045 ],
1046 "type": "string"
1047 }
1048 },
1049 "type": "object"
1050 },
1051 "PigJob": {
1052 "description": "A Cloud Dataproc job for running Apache Pig (https:/ /pig.apache.org/) queries on YARN.",
1053 "id": "PigJob",
1054 "properties": {
1055 "scriptVariables": {
1056 "additionalProperties": {
1057 "type": "string"
1058 },
1059 "description": "Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).",
1060 "type": "object"
1061 },
1062 "jarFileUris": { 1072 "jarFileUris": {
1063 "description": "Optional. HCFS URIs of jar files to add to t he CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.", 1073 "description": "Optional. Jar file URIs to add to the CLASSP ATHs of the Hadoop driver and tasks.",
1064 "items": { 1074 "items": {
1065 "type": "string" 1075 "type": "string"
1066 }, 1076 },
1067 "type": "array" 1077 "type": "array"
1068 }, 1078 },
1069 "loggingConfig": { 1079 "loggingConfig": {
1070 "$ref": "LoggingConfig", 1080 "$ref": "LoggingConfig",
1071 "description": "Optional. The runtime log config for job exe cution." 1081 "description": "Optional. The runtime log config for job exe cution."
1072 }, 1082 },
1073 "properties": { 1083 "properties": {
1074 "additionalProperties": { 1084 "additionalProperties": {
1075 "type": "string" 1085 "type": "string"
1076 }, 1086 },
1077 "description": "Optional. A mapping of property names to val ues, used to configure Pig. Properties that conflict with values set by the Clou d Dataproc API may be overwritten. Can include properties set in /etc/hadoop/con f/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.", 1087 "description": "Optional. A mapping of property names to val ues, used to configure Hadoop. Properties that conflict with values set by the C loud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/ conf/*-site and classes in user code.",
1088 "type": "object"
1089 },
1090 "args": {
1091 "description": "Optional. The arguments to pass to the drive r. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as j ob properties, since a collision may occur that causes an incorrect job submissi on.",
1092 "items": {
1093 "type": "string"
1094 },
1095 "type": "array"
1096 },
1097 "fileUris": {
1098 "description": "Optional. HCFS (Hadoop Compatible Filesystem ) URIs of files to be copied to the working directory of Hadoop drivers and dist ributed tasks. Useful for naively parallel tasks.",
1099 "items": {
1100 "type": "string"
1101 },
1102 "type": "array"
1103 },
1104 "mainClass": {
1105 "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.",
1106 "type": "string"
1107 },
1108 "archiveUris": {
1109 "description": "Optional. HCFS URIs of archives to be extrac ted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.",
1110 "items": {
1111 "type": "string"
1112 },
1113 "type": "array"
1114 }
1115 },
1116 "type": "object"
1117 },
1118 "DiagnoseClusterRequest": {
1119 "description": "A request to collect cluster diagnostic information. ",
1120 "id": "DiagnoseClusterRequest",
1121 "properties": {},
1122 "type": "object"
1123 },
1124 "DiskConfig": {
1125 "description": "Specifies the config of disk options for a group of VM instances.",
1126 "id": "DiskConfig",
1127 "properties": {
1128 "bootDiskSizeGb": {
1129 "description": "Optional. Size in GB of the boot disk (defau lt is 500GB).",
1130 "format": "int32",
1131 "type": "integer"
1132 },
1133 "numLocalSsds": {
1134 "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 runt ime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) d ata. If one or more SSDs are attached, this runtime bulk data is spread across t hem, and the boot disk contains only basic config and installed binaries.",
1135 "format": "int32",
1136 "type": "integer"
1137 }
1138 },
1139 "type": "object"
1140 },
1141 "ClusterOperationMetadata": {
1142 "description": "Metadata describing the operation.",
1143 "id": "ClusterOperationMetadata",
1144 "properties": {
1145 "operationType": {
1146 "description": "Output-only. The operation type.",
1147 "type": "string"
1148 },
1149 "description": {
1150 "description": "Output-only. Short description of operation. ",
1151 "type": "string"
1152 },
1153 "warnings": {
1154 "description": "Output-only. Errors encountered during opera tion execution.",
1155 "items": {
1156 "type": "string"
1157 },
1158 "type": "array"
1159 },
1160 "labels": {
1161 "additionalProperties": {
1162 "type": "string"
1163 },
1164 "description": "Output-only. Labels associated with the oper ation",
1165 "type": "object"
1166 },
1167 "status": {
1168 "$ref": "ClusterOperationStatus",
1169 "description": "Output-only. Current operation status."
1170 },
1171 "statusHistory": {
1172 "description": "Output-only. The previous operation status." ,
1173 "items": {
1174 "$ref": "ClusterOperationStatus"
1175 },
1176 "type": "array"
1177 },
1178 "clusterName": {
1179 "description": "Output-only. Name of the cluster for the ope ration.",
1180 "type": "string"
1181 },
1182 "clusterUuid": {
1183 "description": "Output-only. Cluster UUID for the operation. ",
1184 "type": "string"
1185 }
1186 },
1187 "type": "object"
1188 },
1189 "HiveJob": {
1190 "description": "A Cloud Dataproc job for running Apache Hive (https: //hive.apache.org/) queries on YARN.",
1191 "id": "HiveJob",
1192 "properties": {
1193 "properties": {
1194 "additionalProperties": {
1195 "type": "string"
1196 },
1197 "description": "Optional. A mapping of property names and va lues, used to configure Hive. 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.xml, /etc/hive/conf/hive-site.xml, and classes in user code.",
1078 "type": "object" 1198 "type": "object"
1079 }, 1199 },
1080 "continueOnFailure": { 1200 "continueOnFailure": {
1081 "description": "Optional. Whether to continue executing quer ies if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.", 1201 "description": "Optional. Whether to continue executing quer ies if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.",
1082 "type": "boolean" 1202 "type": "boolean"
1083 }, 1203 },
1084 "queryList": { 1204 "queryList": {
1085 "$ref": "QueryList", 1205 "$ref": "QueryList",
1086 "description": "A list of queries." 1206 "description": "A list of queries."
1087 }, 1207 },
1088 "queryFileUri": { 1208 "queryFileUri": {
1089 "description": "The HCFS URI of the script that contains the Pig queries.", 1209 "description": "The HCFS URI of the script that contains Hiv e queries.",
1090 "type": "string" 1210 "type": "string"
1091 } 1211 },
1092 }, 1212 "jarFileUris": {
1093 "type": "object" 1213 "description": "Optional. HCFS URIs of jar files to add to t he CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hiv e SerDes and UDFs.",
1094 }, 1214 "items": {
1095 "ListClustersResponse": { 1215 "type": "string"
1096 "description": "The list of all clusters in a project.", 1216 },
1097 "id": "ListClustersResponse", 1217 "type": "array"
1098 "properties": { 1218 },
1099 "clusters": { 1219 "scriptVariables": {
1100 "description": "Output-only. The clusters in the project.", 1220 "additionalProperties": {
1101 "items": { 1221 "type": "string"
1102 "$ref": "Cluster" 1222 },
1103 }, 1223 "description": "Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name=\"value\";).",
1104 "type": "array" 1224 "type": "object"
1105 }, 1225 }
1106 "nextPageToken": { 1226 },
1107 "description": "Output-only. This token is included in the r esponse if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent ListClustersRequest.", 1227 "type": "object"
1108 "type": "string" 1228 },
1109 } 1229 "Empty": {
1110 }, 1230 "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 {}.",
1111 "type": "object" 1231 "id": "Empty",
1112 }, 1232 "properties": {},
1113 "Job": { 1233 "type": "object"
1114 "description": "A Cloud Dataproc job resource.", 1234 },
1115 "id": "Job", 1235 "DiagnoseClusterResults": {
1116 "properties": { 1236 "description": "The location of diagnostic output.",
1117 "reference": { 1237 "id": "DiagnoseClusterResults",
1118 "$ref": "JobReference", 1238 "properties": {
1119 "description": "Optional. The fully qualified reference to t he 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>." 1239 "outputUri": {
1120 }, 1240 "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.",
1121 "hadoopJob": { 1241 "type": "string"
1122 "$ref": "HadoopJob", 1242 }
1123 "description": "Job is a Hadoop job." 1243 },
1124 }, 1244 "type": "object"
1125 "status": { 1245 },
1126 "$ref": "JobStatus", 1246 "ClusterConfig": {
1127 "description": "Output-only. The job status. Additional appl ication-specific status information may be contained in the <code>type_job</code > and <code>yarn_applications</code> fields." 1247 "description": "The cluster config.",
1128 }, 1248 "id": "ClusterConfig",
1129 "placement": { 1249 "properties": {
1130 "$ref": "JobPlacement", 1250 "initializationActions": {
1131 "description": "Required. Job information, including how, wh en, and where to run the job." 1251 "description": "Optional. Commands to execute on each node a fter config is completed. By default, executables are run on master and all work er nodes. You can test a node's role metadata to run an executable on a master o r worker node, as shown below using curl (you can also use wget):\nROLE=$(curl - H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/ dataproc-role)\nif [[ \"${ROLE}\" == 'Master' ]]; then\n ... master specific ac tions ...\nelse\n ... worker specific actions ...\nfi\n",
1132 }, 1252 "items": {
1133 "driverControlFilesUri": { 1253 "$ref": "NodeInitializationAction"
1134 "description": "Output-only. If present, the location of mis cellaneous 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_ uri.", 1254 },
1135 "type": "string" 1255 "type": "array"
1136 }, 1256 },
1137 "scheduling": { 1257 "configBucket": {
1138 "$ref": "JobScheduling", 1258 "description": "Optional. A Google Cloud Storage staging buc ket used for sharing generated SSH keys and config. If you do not specify a stag ing bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Comp ute Engine zone where your cluster is deployed, and then it will create and mana ge this project-level, per-location bucket for you.",
1139 "description": "Optional. Job scheduling configuration." 1259 "type": "string"
1140 }, 1260 },
1141 "pigJob": { 1261 "workerConfig": {
1142 "$ref": "PigJob", 1262 "$ref": "InstanceGroupConfig",
1143 "description": "Job is a Pig job." 1263 "description": "Optional. The Google Compute Engine config s ettings for worker instances in a cluster."
1144 }, 1264 },
1145 "hiveJob": { 1265 "gceClusterConfig": {
1146 "$ref": "HiveJob", 1266 "$ref": "GceClusterConfig",
1147 "description": "Job is a Hive job." 1267 "description": "Required. The shared Google Compute Engine c onfig settings for all instances in a cluster."
1148 }, 1268 },
1149 "labels": { 1269 "softwareConfig": {
1150 "additionalProperties": { 1270 "$ref": "SoftwareConfig",
1151 "type": "string" 1271 "description": "Optional. The config settings for software i nside the cluster."
1152 }, 1272 },
1153 "description": "Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (h ttps://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present , must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.iet f.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.", 1273 "masterConfig": {
1154 "type": "object" 1274 "$ref": "InstanceGroupConfig",
1155 }, 1275 "description": "Optional. The Google Compute Engine config s ettings for the master instance in a cluster."
1156 "driverOutputResourceUri": { 1276 },
1157 "description": "Output-only. A URI pointing to the location of the stdout of the job's driver program.", 1277 "secondaryWorkerConfig": {
1158 "type": "string" 1278 "$ref": "InstanceGroupConfig",
1159 }, 1279 "description": "Optional. The Google Compute Engine config s ettings for additional worker instances in a cluster."
1160 "sparkSqlJob": { 1280 }
1161 "$ref": "SparkSqlJob", 1281 },
1162 "description": "Job is a SparkSql job." 1282 "type": "object"
1163 }, 1283 },
1164 "statusHistory": { 1284 "PySparkJob": {
1165 "description": "Output-only. The previous job status.", 1285 "description": "A Cloud Dataproc job for running Apache PySpark (htt ps://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN.",
1166 "items": { 1286 "id": "PySparkJob",
1167 "$ref": "JobStatus" 1287 "properties": {
1168 }, 1288 "pythonFileUris": {
1169 "type": "array" 1289 "description": "Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.",
1170 }, 1290 "items": {
1171 "sparkJob": { 1291 "type": "string"
1172 "$ref": "SparkJob", 1292 },
1173 "description": "Job is a Spark job." 1293 "type": "array"
1174 }, 1294 },
1175 "yarnApplications": { 1295 "mainPythonFileUri": {
1176 "description": "Output-only. The collection of YARN applicat ions spun up by this job.Beta Feature: This report is available for testing purp oses only. It may be changed before final release.", 1296 "description": "Required. The HCFS URI of the main Python fi le to use as the driver. Must be a .py file.",
1177 "items": {
1178 "$ref": "YarnApplication"
1179 },
1180 "type": "array"
1181 },
1182 "pysparkJob": {
1183 "$ref": "PySparkJob",
1184 "description": "Job is a Pyspark job."
1185 }
1186 },
1187 "type": "object"
1188 },
1189 "SparkJob": {
1190 "description": "A Cloud Dataproc job for running Apache Spark (http: //spark.apache.org/) applications on YARN.",
1191 "id": "SparkJob",
1192 "properties": {
1193 "mainClass": {
1194 "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.",
1195 "type": "string" 1297 "type": "string"
1196 }, 1298 },
1197 "archiveUris": { 1299 "archiveUris": {
1198 "description": "Optional. HCFS URIs of archives to be extrac ted in the working directory of Spark drivers and tasks. Supported file types: . jar, .tar, .tar.gz, .tgz, and .zip.", 1300 "description": "Optional. HCFS URIs of archives to be extrac ted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.",
1199 "items": { 1301 "items": {
1200 "type": "string" 1302 "type": "string"
1201 }, 1303 },
1202 "type": "array" 1304 "type": "array"
1203 },
1204 "mainJarFileUri": {
1205 "description": "The HCFS URI of the jar file that contains t he main class.",
1206 "type": "string"
1207 }, 1305 },
1208 "jarFileUris": { 1306 "jarFileUris": {
1209 "description": "Optional. HCFS URIs of jar files to add to t he CLASSPATHs of the Spark driver and tasks.", 1307 "description": "Optional. HCFS URIs of jar files to add to t he CLASSPATHs of the Python driver and tasks.",
1210 "items": { 1308 "items": {
1211 "type": "string" 1309 "type": "string"
1212 }, 1310 },
1213 "type": "array"
1214 },
1215 "loggingConfig": {
1216 "$ref": "LoggingConfig",
1217 "description": "Optional. The runtime log config for job exe cution."
1218 },
1219 "properties": {
1220 "additionalProperties": {
1221 "type": "string"
1222 },
1223 "description": "Optional. A mapping of property names to val ues, used to configure Spark. Properties that conflict with values set by the Cl oud Dataproc API may be overwritten. Can include properties set in /etc/spark/co nf/spark-defaults.conf and classes in user code.",
1224 "type": "object"
1225 },
1226 "args": {
1227 "description": "Optional. The arguments to pass to the drive r. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.",
1228 "items": {
1229 "type": "string"
1230 },
1231 "type": "array"
1232 },
1233 "fileUris": {
1234 "description": "Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naivel y parallel tasks.",
1235 "items": {
1236 "type": "string"
1237 },
1238 "type": "array"
1239 }
1240 },
1241 "type": "object"
1242 },
1243 "JobStatus": {
1244 "description": "Cloud Dataproc job status.",
1245 "id": "JobStatus",
1246 "properties": {
1247 "state": {
1248 "description": "Output-only. A state message specifying the overall job state.",
1249 "enum": [
1250 "STATE_UNSPECIFIED",
1251 "PENDING",
1252 "SETUP_DONE",
1253 "RUNNING",
1254 "CANCEL_PENDING",
1255 "CANCEL_STARTED",
1256 "CANCELLED",
1257 "DONE",
1258 "ERROR",
1259 "ATTEMPT_FAILURE"
1260 ],
1261 "enumDescriptions": [
1262 "The job state is unknown.",
1263 "The job is pending; it has been submitted, but is not y et running.",
1264 "Job has been received by the service and completed init ial setup; it will soon be submitted to the cluster.",
1265 "The job is running on the cluster.",
1266 "A CancelJob request has been received, but is pending." ,
1267 "Transient in-flight resources have been canceled, and t he request to cancel the running job has been issued to the cluster.",
1268 "The job cancellation was successful.",
1269 "The job has completed successfully.",
1270 "The job has completed, but encountered an error.",
1271 "Job attempt has failed. The detail field contains failu re details for this attempt.Applies to restartable jobs only."
1272 ],
1273 "type": "string"
1274 },
1275 "details": {
1276 "description": "Output-only. Optional job state details, suc h as an error description if the state is <code>ERROR</code>.",
1277 "type": "string"
1278 },
1279 "stateStartTime": {
1280 "description": "Output-only. The time when this state was en tered.",
1281 "format": "google-datetime",
1282 "type": "string"
1283 },
1284 "substate": {
1285 "description": "Output-only. Additional state information, w hich includes status reported by the agent.",
1286 "enum": [
1287 "UNSPECIFIED",
1288 "SUBMITTED",
1289 "QUEUED",
1290 "STALE_STATUS"
1291 ],
1292 "enumDescriptions": [
1293 "",
1294 "The Job is submitted to the agent.Applies to RUNNING st ate.",
1295 "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.",
1296 "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."
1297 ],
1298 "type": "string"
1299 }
1300 },
1301 "type": "object"
1302 },
1303 "ManagedGroupConfig": {
1304 "description": "Specifies the resources used to actively manage an i nstance group.",
1305 "id": "ManagedGroupConfig",
1306 "properties": {
1307 "instanceGroupManagerName": {
1308 "description": "Output-only. The name of the Instance Group Manager for this group.",
1309 "type": "string"
1310 },
1311 "instanceTemplateName": {
1312 "description": "Output-only. The name of the Instance Templa te used for the Managed Instance Group.",
1313 "type": "string"
1314 }
1315 },
1316 "type": "object"
1317 },
1318 "ClusterOperationStatus": {
1319 "description": "The status of the operation.",
1320 "id": "ClusterOperationStatus",
1321 "properties": {
1322 "innerState": {
1323 "description": "Output-only. A message containing the detail ed operation state.",
1324 "type": "string"
1325 },
1326 "stateStartTime": {
1327 "description": "Output-only. The time this state was entered .",
1328 "format": "google-datetime",
1329 "type": "string"
1330 },
1331 "state": {
1332 "description": "Output-only. A message containing the operat ion state.",
1333 "enum": [
1334 "UNKNOWN",
1335 "PENDING",
1336 "RUNNING",
1337 "DONE"
1338 ],
1339 "enumDescriptions": [
1340 "Unused.",
1341 "The operation has been created.",
1342 "The operation is running.",
1343 "The operation is done; either cancelled or completed."
1344 ],
1345 "type": "string"
1346 },
1347 "details": {
1348 "description": "Output-only.A message containing any operati on metadata details.",
1349 "type": "string"
1350 }
1351 },
1352 "type": "object"
1353 },
1354 "HadoopJob": {
1355 "description": "A Cloud Dataproc job for running Apache Hadoop MapRe duce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapr educe-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://ha doop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html).",
1356 "id": "HadoopJob",
1357 "properties": {
1358 "jarFileUris": {
1359 "description": "Optional. Jar file URIs to add to the CLASSP ATHs of the Hadoop driver and tasks.",
1360 "items": {
1361 "type": "string"
1362 },
1363 "type": "array" 1311 "type": "array"
1364 }, 1312 },
1365 "loggingConfig": { 1313 "loggingConfig": {
1366 "$ref": "LoggingConfig", 1314 "$ref": "LoggingConfig",
1367 "description": "Optional. The runtime log config for job exe cution." 1315 "description": "Optional. The runtime log config for job exe cution."
1368 }, 1316 },
1369 "properties": { 1317 "properties": {
1370 "additionalProperties": { 1318 "additionalProperties": {
1371 "type": "string" 1319 "type": "string"
1372 }, 1320 },
1373 "description": "Optional. A mapping of property names to val ues, used to configure Hadoop. Properties that conflict with values set by the C loud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/ conf/*-site and classes in user code.",
1374 "type": "object"
1375 },
1376 "args": {
1377 "description": "Optional. The arguments to pass to the drive r. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as j ob properties, since a collision may occur that causes an incorrect job submissi on.",
1378 "items": {
1379 "type": "string"
1380 },
1381 "type": "array"
1382 },
1383 "fileUris": {
1384 "description": "Optional. HCFS (Hadoop Compatible Filesystem ) URIs of files to be copied to the working directory of Hadoop drivers and dist ributed tasks. Useful for naively parallel tasks.",
1385 "items": {
1386 "type": "string"
1387 },
1388 "type": "array"
1389 },
1390 "mainClass": {
1391 "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.",
1392 "type": "string"
1393 },
1394 "archiveUris": {
1395 "description": "Optional. HCFS URIs of archives to be extrac ted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.",
1396 "items": {
1397 "type": "string"
1398 },
1399 "type": "array"
1400 },
1401 "mainJarFileUri": {
1402 "description": "The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metric s-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/ hadoop-mapreduce/hadoop-mapreduce-examples.jar'",
1403 "type": "string"
1404 }
1405 },
1406 "type": "object"
1407 },
1408 "QueryList": {
1409 "description": "A list of queries to run on a cluster.",
1410 "id": "QueryList",
1411 "properties": {
1412 "queries": {
1413 "description": "Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified i n 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",
1414 "items": {
1415 "type": "string"
1416 },
1417 "type": "array"
1418 }
1419 },
1420 "type": "object"
1421 },
1422 "YarnApplication": {
1423 "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>.Beta Feature: This report is available for testing purposes only. It may be changed before final release.",
1424 "id": "YarnApplication",
1425 "properties": {
1426 "state": {
1427 "description": "Required. The application state.",
1428 "enum": [
1429 "STATE_UNSPECIFIED",
1430 "NEW",
1431 "NEW_SAVING",
1432 "SUBMITTED",
1433 "ACCEPTED",
1434 "RUNNING",
1435 "FINISHED",
1436 "FAILED",
1437 "KILLED"
1438 ],
1439 "enumDescriptions": [
1440 "Status is unspecified.",
1441 "Status is NEW.",
1442 "Status is NEW_SAVING.",
1443 "Status is SUBMITTED.",
1444 "Status is ACCEPTED.",
1445 "Status is RUNNING.",
1446 "Status is FINISHED.",
1447 "Status is FAILED.",
1448 "Status is KILLED."
1449 ],
1450 "type": "string"
1451 },
1452 "name": {
1453 "description": "Required. The application name.",
1454 "type": "string"
1455 },
1456 "trackingUrl": {
1457 "description": "Optional. The HTTP URL of the ApplicationMas ter, HistoryServer, or TimelineServer that provides application-specific informa tion. The URL uses the internal hostname, and requires a proxy server for resolu tion and, possibly, access.",
1458 "type": "string"
1459 },
1460 "progress": {
1461 "description": "Required. The numerical progress of the appl ication, from 1 to 100.",
1462 "format": "float",
1463 "type": "number"
1464 }
1465 },
1466 "type": "object"
1467 },
1468 "DiagnoseClusterRequest": {
1469 "description": "A request to collect cluster diagnostic information. ",
1470 "id": "DiagnoseClusterRequest",
1471 "properties": {},
1472 "type": "object"
1473 },
1474 "DiskConfig": {
1475 "description": "Specifies the config of disk options for a group of VM instances.",
1476 "id": "DiskConfig",
1477 "properties": {
1478 "numLocalSsds": {
1479 "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 runt ime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) d ata. If one or more SSDs are attached, this runtime bulk data is spread across t hem, and the boot disk contains only basic config and installed binaries.",
1480 "format": "int32",
1481 "type": "integer"
1482 },
1483 "bootDiskSizeGb": {
1484 "description": "Optional. Size in GB of the boot disk (defau lt is 500GB).",
1485 "format": "int32",
1486 "type": "integer"
1487 }
1488 },
1489 "type": "object"
1490 },
1491 "ClusterOperationMetadata": {
1492 "description": "Metadata describing the operation.",
1493 "id": "ClusterOperationMetadata",
1494 "properties": {
1495 "labels": {
1496 "additionalProperties": {
1497 "type": "string"
1498 },
1499 "description": "Output-only. Labels associated with the oper ation",
1500 "type": "object"
1501 },
1502 "status": {
1503 "$ref": "ClusterOperationStatus",
1504 "description": "Output-only. Current operation status."
1505 },
1506 "statusHistory": {
1507 "description": "Output-only. The previous operation status." ,
1508 "items": {
1509 "$ref": "ClusterOperationStatus"
1510 },
1511 "type": "array"
1512 },
1513 "clusterUuid": {
1514 "description": "Output-only. Cluster UUID for the operation. ",
1515 "type": "string"
1516 },
1517 "clusterName": {
1518 "description": "Output-only. Name of the cluster for the ope ration.",
1519 "type": "string"
1520 },
1521 "operationType": {
1522 "description": "Output-only. The operation type.",
1523 "type": "string"
1524 },
1525 "description": {
1526 "description": "Output-only. Short description of operation. ",
1527 "type": "string"
1528 },
1529 "warnings": {
1530 "description": "Output-only. Errors encountered during opera tion execution.",
1531 "items": {
1532 "type": "string"
1533 },
1534 "type": "array"
1535 }
1536 },
1537 "type": "object"
1538 },
1539 "HiveJob": {
1540 "description": "A Cloud Dataproc job for running Apache Hive (https: //hive.apache.org/) queries on YARN.",
1541 "id": "HiveJob",
1542 "properties": {
1543 "continueOnFailure": {
1544 "description": "Optional. Whether to continue executing quer ies if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.",
1545 "type": "boolean"
1546 },
1547 "queryFileUri": {
1548 "description": "The HCFS URI of the script that contains Hiv e queries.",
1549 "type": "string"
1550 },
1551 "queryList": {
1552 "$ref": "QueryList",
1553 "description": "A list of queries."
1554 },
1555 "jarFileUris": {
1556 "description": "Optional. HCFS URIs of jar files to add to t he CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hiv e SerDes and UDFs.",
1557 "items": {
1558 "type": "string"
1559 },
1560 "type": "array"
1561 },
1562 "scriptVariables": {
1563 "additionalProperties": {
1564 "type": "string"
1565 },
1566 "description": "Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name=\"value\";).",
1567 "type": "object"
1568 },
1569 "properties": {
1570 "additionalProperties": {
1571 "type": "string"
1572 },
1573 "description": "Optional. A mapping of property names and va lues, used to configure Hive. 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.xml, /etc/hive/conf/hive-site.xml, and classes in user code.",
1574 "type": "object"
1575 }
1576 },
1577 "type": "object"
1578 },
1579 "Empty": {
1580 "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 {}.",
1581 "id": "Empty",
1582 "properties": {},
1583 "type": "object"
1584 },
1585 "DiagnoseClusterResults": {
1586 "description": "The location of diagnostic output.",
1587 "id": "DiagnoseClusterResults",
1588 "properties": {
1589 "outputUri": {
1590 "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.",
1591 "type": "string"
1592 }
1593 },
1594 "type": "object"
1595 },
1596 "ClusterConfig": {
1597 "description": "The cluster config.",
1598 "id": "ClusterConfig",
1599 "properties": {
1600 "masterConfig": {
1601 "$ref": "InstanceGroupConfig",
1602 "description": "Optional. The Google Compute Engine config s ettings for the master instance in a cluster."
1603 },
1604 "secondaryWorkerConfig": {
1605 "$ref": "InstanceGroupConfig",
1606 "description": "Optional. The Google Compute Engine config s ettings for additional worker instances in a cluster."
1607 },
1608 "initializationActions": {
1609 "description": "Optional. Commands to execute on each node a fter config is completed. By default, executables are run on master and all work er nodes. You can test a node's role metadata to run an executable on a master o r worker node, as shown below using curl (you can also use wget):\nROLE=$(curl - H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/ dataproc-role)\nif [[ \"${ROLE}\" == 'Master' ]]; then\n ... master specific ac tions ...\nelse\n ... worker specific actions ...\nfi\n",
1610 "items": {
1611 "$ref": "NodeInitializationAction"
1612 },
1613 "type": "array"
1614 },
1615 "configBucket": {
1616 "description": "Optional. A Google Cloud Storage staging buc ket used for sharing generated SSH keys and config. If you do not specify a stag ing bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Comp ute Engine zone where your cluster is deployed, and then it will create and mana ge this project-level, per-location bucket for you.",
1617 "type": "string"
1618 },
1619 "workerConfig": {
1620 "$ref": "InstanceGroupConfig",
1621 "description": "Optional. The Google Compute Engine config s ettings for worker instances in a cluster."
1622 },
1623 "gceClusterConfig": {
1624 "$ref": "GceClusterConfig",
1625 "description": "Required. The shared Google Compute Engine c onfig settings for all instances in a cluster."
1626 },
1627 "softwareConfig": {
1628 "$ref": "SoftwareConfig",
1629 "description": "Optional. The config settings for software i nside the cluster."
1630 }
1631 },
1632 "type": "object"
1633 },
1634 "PySparkJob": {
1635 "description": "A Cloud Dataproc job for running Apache PySpark (htt ps://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN.",
1636 "id": "PySparkJob",
1637 "properties": {
1638 "properties": {
1639 "additionalProperties": {
1640 "type": "string"
1641 },
1642 "description": "Optional. A mapping of property names to val ues, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/ conf/spark-defaults.conf and classes in user code.", 1321 "description": "Optional. A mapping of property names to val ues, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/ conf/spark-defaults.conf and classes in user code.",
1643 "type": "object" 1322 "type": "object"
1644 }, 1323 },
1645 "args": { 1324 "args": {
1646 "description": "Optional. The arguments to pass to the drive r. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.", 1325 "description": "Optional. The arguments to pass to the drive r. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.",
1647 "items": { 1326 "items": {
1648 "type": "string" 1327 "type": "string"
1649 }, 1328 },
1650 "type": "array" 1329 "type": "array"
1651 }, 1330 },
1652 "fileUris": { 1331 "fileUris": {
1653 "description": "Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naive ly parallel tasks.", 1332 "description": "Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naive ly parallel tasks.",
1654 "items": { 1333 "items": {
1655 "type": "string" 1334 "type": "string"
1656 }, 1335 },
1657 "type": "array" 1336 "type": "array"
1658 },
1659 "pythonFileUris": {
1660 "description": "Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.",
1661 "items": {
1662 "type": "string"
1663 },
1664 "type": "array"
1665 },
1666 "mainPythonFileUri": {
1667 "description": "Required. The HCFS URI of the main Python fi le to use as the driver. Must be a .py file.",
1668 "type": "string"
1669 },
1670 "archiveUris": {
1671 "description": "Optional. HCFS URIs of archives to be extrac ted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.",
1672 "items": {
1673 "type": "string"
1674 },
1675 "type": "array"
1676 },
1677 "jarFileUris": {
1678 "description": "Optional. HCFS URIs of jar files to add to t he CLASSPATHs of the Python driver and tasks.",
1679 "items": {
1680 "type": "string"
1681 },
1682 "type": "array"
1683 },
1684 "loggingConfig": {
1685 "$ref": "LoggingConfig",
1686 "description": "Optional. The runtime log config for job exe cution."
1687 } 1337 }
1688 }, 1338 },
1689 "type": "object" 1339 "type": "object"
1690 }, 1340 },
1691 "GceClusterConfig": { 1341 "GceClusterConfig": {
1692 "description": "Common config settings for resources of Google Compu te Engine cluster instances, applicable to all instances in the cluster.", 1342 "description": "Common config settings for resources of Google Compu te Engine cluster instances, applicable to all instances in the cluster.",
1693 "id": "GceClusterConfig", 1343 "id": "GceClusterConfig",
1694 "properties": { 1344 "properties": {
1345 "subnetworkUri": {
1346 "description": "Optional. The Google Compute Engine subnetwo rk to be used for machine communications. Cannot be specified with network_uri. Example: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us- east1/sub0.",
1347 "type": "string"
1348 },
1695 "networkUri": { 1349 "networkUri": {
1696 "description": "Optional. 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 project is used, if it exists. Cannot be a \"Custom Subnet Network\" (see Using Subnetworks for more information). Example: https://www.googleapis.com/co mpute/v1/projects/[project_id]/regions/global/default.", 1350 "description": "Optional. 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 project is used, if it exists. Cannot be a \"Custom Subnet Network\" (see Using Subnetworks for more information). Example: https://www.googleapis.com/co mpute/v1/projects/[project_id]/regions/global/default.",
1697 "type": "string" 1351 "type": "string"
1698 }, 1352 },
1699 "zoneUri": { 1353 "zoneUri": {
1700 "description": "Required. The zone where the Google Compute Engine cluster will be located. Example: https://www.googleapis.com/compute/v1/p rojects/[project_id]/zones/[zone].", 1354 "description": "Required. The zone where the Google Compute Engine cluster will be located. Example: https://www.googleapis.com/compute/v1/p rojects/[project_id]/zones/[zone].",
1701 "type": "string" 1355 "type": "string"
1702 }, 1356 },
1703 "internalIpOnly": { 1357 "internalIpOnly": {
1704 "description": "Optional. If true, all instances in the clus ter will only have internal IP addresses. By default, clusters are not restricte d to internal IP addresses, and will have ephemeral external IP addresses assign ed to each instance. This internal_ip_only restriction can only be enabled for s ubnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.", 1358 "description": "Optional. If true, all instances in the clus ter will only have internal IP addresses. By default, clusters are not restricte d to internal IP addresses, and will have ephemeral external IP addresses assign ed to each instance. This internal_ip_only restriction can only be enabled for s ubnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.",
(...skipping 16 matching lines...) Expand all
1721 "tags": { 1375 "tags": {
1722 "description": "The Google Compute Engine tags to add to all instances (see Tagging instances).", 1376 "description": "The Google Compute Engine tags to add to all instances (see Tagging instances).",
1723 "items": { 1377 "items": {
1724 "type": "string" 1378 "type": "string"
1725 }, 1379 },
1726 "type": "array" 1380 "type": "array"
1727 }, 1381 },
1728 "serviceAccount": { 1382 "serviceAccount": {
1729 "description": "Optional. The service account of the instanc es. Defaults to the default Google Compute Engine service account. Custom servic e accounts need permissions equivalent to the folloing IAM roles:\nroles/logging .logWriter\nroles/storage.objectAdmin(see https://cloud.google.com/compute/docs/ access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com", 1383 "description": "Optional. The service account of the instanc es. Defaults to the default Google Compute Engine service account. Custom servic e accounts need permissions equivalent to the folloing IAM roles:\nroles/logging .logWriter\nroles/storage.objectAdmin(see https://cloud.google.com/compute/docs/ access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com",
1730 "type": "string" 1384 "type": "string"
1731 },
1732 "subnetworkUri": {
1733 "description": "Optional. The Google Compute Engine subnetwo rk to be used for machine communications. Cannot be specified with network_uri. Example: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us- east1/sub0.",
1734 "type": "string"
1735 }
1736 },
1737 "type": "object"
1738 },
1739 "ClusterMetrics": {
1740 "description": "Contains cluster daemon metrics, such as HDFS and YA RN stats.Beta Feature: This report is available for testing purposes only. It ma y be changed before final release.",
1741 "id": "ClusterMetrics",
1742 "properties": {
1743 "yarnMetrics": {
1744 "additionalProperties": {
1745 "format": "int64",
1746 "type": "string"
1747 },
1748 "description": "The YARN metrics.",
1749 "type": "object"
1750 },
1751 "hdfsMetrics": {
1752 "additionalProperties": {
1753 "format": "int64",
1754 "type": "string"
1755 },
1756 "description": "The HDFS metrics.",
1757 "type": "object"
1758 } 1385 }
1759 }, 1386 },
1760 "type": "object" 1387 "type": "object"
1761 }, 1388 },
1762 "AcceleratorConfig": { 1389 "AcceleratorConfig": {
1763 "description": "Specifies the type and number of accelerator cards a ttached to the instances of an instance group (see GPUs on Compute Engine).", 1390 "description": "Specifies the type and number of accelerator cards a ttached to the instances of an instance group (see GPUs on Compute Engine).",
1764 "id": "AcceleratorConfig", 1391 "id": "AcceleratorConfig",
1765 "properties": { 1392 "properties": {
1766 "acceleratorTypeUri": { 1393 "acceleratorTypeUri": {
1767 "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)", 1394 "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)",
1768 "type": "string" 1395 "type": "string"
1769 }, 1396 },
1770 "acceleratorCount": { 1397 "acceleratorCount": {
1771 "description": "The number of the accelerator cards of this type exposed to this instance.", 1398 "description": "The number of the accelerator cards of this type exposed to this instance.",
1772 "format": "int32", 1399 "format": "int32",
1773 "type": "integer" 1400 "type": "integer"
1774 } 1401 }
1775 }, 1402 },
1776 "type": "object" 1403 "type": "object"
1777 }, 1404 },
1405 "ClusterMetrics": {
1406 "description": "Contains cluster daemon metrics, such as HDFS and YA RN stats.Beta Feature: This report is available for testing purposes only. It ma y be changed before final release.",
1407 "id": "ClusterMetrics",
1408 "properties": {
1409 "yarnMetrics": {
1410 "additionalProperties": {
1411 "format": "int64",
1412 "type": "string"
1413 },
1414 "description": "The YARN metrics.",
1415 "type": "object"
1416 },
1417 "hdfsMetrics": {
1418 "additionalProperties": {
1419 "format": "int64",
1420 "type": "string"
1421 },
1422 "description": "The HDFS metrics.",
1423 "type": "object"
1424 }
1425 },
1426 "type": "object"
1427 },
1778 "LoggingConfig": { 1428 "LoggingConfig": {
1779 "description": "The runtime logging config of the job.", 1429 "description": "The runtime logging config of the job.",
1780 "id": "LoggingConfig", 1430 "id": "LoggingConfig",
1781 "properties": { 1431 "properties": {
1782 "driverLogLevels": { 1432 "driverLogLevels": {
1783 "additionalProperties": { 1433 "additionalProperties": {
1784 "enum": [ 1434 "enum": [
1785 "LEVEL_UNSPECIFIED", 1435 "LEVEL_UNSPECIFIED",
1786 "ALL", 1436 "ALL",
1787 "TRACE", 1437 "TRACE",
1788 "DEBUG", 1438 "DEBUG",
1789 "INFO", 1439 "INFO",
1790 "WARN", 1440 "WARN",
1791 "ERROR", 1441 "ERROR",
1792 "FATAL", 1442 "FATAL",
1793 "OFF" 1443 "OFF"
1794 ], 1444 ],
1795 "type": "string" 1445 "type": "string"
1796 }, 1446 },
1797 "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'", 1447 "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'",
1798 "type": "object" 1448 "type": "object"
1799 } 1449 }
1800 }, 1450 },
1801 "type": "object" 1451 "type": "object"
1802 }, 1452 },
1803 "DiagnoseClusterOutputLocation": {
1804 "description": "The location where output from diagnostic command ca n be found.",
1805 "id": "DiagnoseClusterOutputLocation",
1806 "properties": {
1807 "outputUri": {
1808 "description": "Output-only The Google Cloud Storage URI of the diagnostic output. This will be a plain text file with summary of collected diagnostics.",
1809 "type": "string"
1810 }
1811 },
1812 "type": "object"
1813 },
1814 "Operation": { 1453 "Operation": {
1815 "description": "This resource represents a long-running operation th at is the result of a network API call.", 1454 "description": "This resource represents a long-running operation th at is the result of a network API call.",
1816 "id": "Operation", 1455 "id": "Operation",
1817 "properties": { 1456 "properties": {
1457 "response": {
1458 "additionalProperties": {
1459 "description": "Properties of the object. Contains field @type with type URL.",
1460 "type": "any"
1461 },
1462 "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.",
1463 "type": "object"
1464 },
1465 "name": {
1466 "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.",
1467 "type": "string"
1468 },
1469 "error": {
1470 "$ref": "Status",
1471 "description": "The error result of the operation in case of failure or cancellation."
1472 },
1473 "metadata": {
1474 "additionalProperties": {
1475 "description": "Properties of the object. Contains field @type with type URL.",
1476 "type": "any"
1477 },
1478 "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.",
1479 "type": "object"
1480 },
1818 "done": { 1481 "done": {
1819 "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.", 1482 "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.",
1820 "type": "boolean" 1483 "type": "boolean"
1821 },
1822 "response": {
1823 "additionalProperties": {
1824 "description": "Properties of the object. Contains field @type with type URL.",
1825 "type": "any"
1826 },
1827 "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.",
1828 "type": "object"
1829 },
1830 "name": {
1831 "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.",
1832 "type": "string"
1833 },
1834 "error": {
1835 "$ref": "Status",
1836 "description": "The error result of the operation in case of failure or cancellation."
1837 },
1838 "metadata": {
1839 "additionalProperties": {
1840 "description": "Properties of the object. Contains field @type with type URL.",
1841 "type": "any"
1842 },
1843 "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.",
1844 "type": "object"
1845 }
1846 },
1847 "type": "object"
1848 },
1849 "OperationStatus": {
1850 "description": "The status of the operation.",
1851 "id": "OperationStatus",
1852 "properties": {
1853 "stateStartTime": {
1854 "description": "The time this state was entered.",
1855 "format": "google-datetime",
1856 "type": "string"
1857 },
1858 "state": {
1859 "description": "A message containing the operation state.",
1860 "enum": [
1861 "UNKNOWN",
1862 "PENDING",
1863 "RUNNING",
1864 "DONE"
1865 ],
1866 "enumDescriptions": [
1867 "Unused.",
1868 "The operation has been created.",
1869 "The operation is running.",
1870 "The operation is done; either cancelled or completed."
1871 ],
1872 "type": "string"
1873 },
1874 "details": {
1875 "description": "A message containing any operation metadata details.",
1876 "type": "string"
1877 },
1878 "innerState": {
1879 "description": "A message containing the detailed operation state.",
1880 "type": "string"
1881 } 1484 }
1882 }, 1485 },
1883 "type": "object" 1486 "type": "object"
1884 }, 1487 },
1885 "JobReference": { 1488 "JobReference": {
1886 "description": "Encapsulates the full scoping used to reference a jo b.", 1489 "description": "Encapsulates the full scoping used to reference a jo b.",
1887 "id": "JobReference", 1490 "id": "JobReference",
1888 "properties": { 1491 "properties": {
1492 "jobId": {
1493 "description": "Optional. The job ID, which must be unique w ithin the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jo bs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.",
1494 "type": "string"
1495 },
1889 "projectId": { 1496 "projectId": {
1890 "description": "Required. The ID of the Google Cloud Platfor m project that the job belongs to.", 1497 "description": "Required. The ID of the Google Cloud Platfor m project that the job belongs to.",
1891 "type": "string" 1498 "type": "string"
1892 },
1893 "jobId": {
1894 "description": "Optional. The job ID, which must be unique w ithin the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jo bs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.",
1895 "type": "string"
1896 } 1499 }
1897 }, 1500 },
1898 "type": "object" 1501 "type": "object"
1899 }, 1502 },
1900 "SubmitJobRequest": { 1503 "SubmitJobRequest": {
1901 "description": "A request to submit a job.", 1504 "description": "A request to submit a job.",
1902 "id": "SubmitJobRequest", 1505 "id": "SubmitJobRequest",
1903 "properties": { 1506 "properties": {
1904 "job": { 1507 "job": {
1905 "$ref": "Job", 1508 "$ref": "Job",
1906 "description": "Required. The job resource." 1509 "description": "Required. The job resource."
1907 } 1510 }
1908 }, 1511 },
1909 "type": "object" 1512 "type": "object"
1910 }, 1513 },
1911 "Status": { 1514 "Status": {
1912 "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 that can be u sed for common error conditions.Language mappingThe Status message is the logica l representation of the error model, but it is not necessarily the actual wire f ormat. When the Status message is exposed in different client libraries and diff erent 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 codes 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 includ e:\nPartial errors. If a service needs to return partial errors to the client, i t may embed the Status in the normal response to indicate the partial errors.\nW orkflow errors. A typical workflow has multiple steps. Each step may have a Stat us message for error reporting.\nBatch operations. If a client uses batch reques t and batch response, the Status message should be used directly inside batch re sponse, one for each error sub-response.\nAsynchronous operations. If an API cal l embeds asynchronous operation results in its response, the status of those ope rations should be represented directly using the Status message.\nLogging. If so me API errors are stored in logs, the message Status could be used directly afte r any stripping needed for security/privacy reasons.", 1515 "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 that can be u sed for common error conditions.Language mappingThe Status message is the logica l representation of the error model, but it is not necessarily the actual wire f ormat. When the Status message is exposed in different client libraries and diff erent 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 codes 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 includ e:\nPartial errors. If a service needs to return partial errors to the client, i t may embed the Status in the normal response to indicate the partial errors.\nW orkflow errors. A typical workflow has multiple steps. Each step may have a Stat us message for error reporting.\nBatch operations. If a client uses batch reques t and batch response, the Status message should be used directly inside batch re sponse, one for each error sub-response.\nAsynchronous operations. If an API cal l embeds asynchronous operation results in its response, the status of those ope rations should be represented directly using the Status message.\nLogging. If so me API errors are stored in logs, the message Status could be used directly afte r any stripping needed for security/privacy reasons.",
1913 "id": "Status", 1516 "id": "Status",
1914 "properties": { 1517 "properties": {
1915 "code": {
1916 "description": "The status code, which should be an enum val ue of google.rpc.Code.",
1917 "format": "int32",
1918 "type": "integer"
1919 },
1920 "message": { 1518 "message": {
1921 "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.", 1519 "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.",
1922 "type": "string" 1520 "type": "string"
1923 }, 1521 },
1924 "details": { 1522 "details": {
1925 "description": "A list of messages that carry the error deta ils. There will be a common set of message types for APIs to use.", 1523 "description": "A list of messages that carry the error deta ils. There will be a common set of message types for APIs to use.",
1926 "items": { 1524 "items": {
1927 "additionalProperties": { 1525 "additionalProperties": {
1928 "description": "Properties of the object. Contains f ield @type with type URL.", 1526 "description": "Properties of the object. Contains f ield @type with type URL.",
1929 "type": "any" 1527 "type": "any"
1930 }, 1528 },
1931 "type": "object" 1529 "type": "object"
1932 }, 1530 },
1933 "type": "array" 1531 "type": "array"
1532 },
1533 "code": {
1534 "description": "The status code, which should be an enum val ue of google.rpc.Code.",
1535 "format": "int32",
1536 "type": "integer"
1934 } 1537 }
1935 }, 1538 },
1936 "type": "object" 1539 "type": "object"
1937 }, 1540 },
1938 "InstanceGroupConfig": { 1541 "InstanceGroupConfig": {
1939 "description": "Optional. The config settings for Google Compute Eng ine resources in an instance group, such as a master or worker group.", 1542 "description": "Optional. The config settings for Google Compute Eng ine resources in an instance group, such as a master or worker group.",
1940 "id": "InstanceGroupConfig", 1543 "id": "InstanceGroupConfig",
1941 "properties": { 1544 "properties": {
1942 "diskConfig": {
1943 "$ref": "DiskConfig",
1944 "description": "Optional. Disk option config settings."
1945 },
1946 "managedGroupConfig": {
1947 "$ref": "ManagedGroupConfig",
1948 "description": "Output-only. The config for Google Compute E ngine Instance Group Manager that manages this group. This is only used for pree mptible instance groups."
1949 },
1950 "isPreemptible": {
1951 "description": "Optional. Specifies that this instance group contains preemptible instances.",
1952 "type": "boolean"
1953 },
1954 "imageUri": {
1955 "description": "Output-only. The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version .",
1956 "type": "string"
1957 },
1958 "machineTypeUri": {
1959 "description": "Required. 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.",
1960 "type": "string"
1961 },
1962 "instanceNames": {
1963 "description": "Optional. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance gr oup if not set by user (recommended practice is to let Cloud Dataproc derive the name).",
1964 "items": {
1965 "type": "string"
1966 },
1967 "type": "array"
1968 },
1969 "accelerators": {
1970 "description": "Optional. The Google Compute Engine accelera tor configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.",
1971 "items": {
1972 "$ref": "AcceleratorConfig"
1973 },
1974 "type": "array"
1975 },
1976 "numInstances": { 1545 "numInstances": {
1977 "description": "Required. The number of VM instances in the instance group. For master instance groups, must be set to 1.", 1546 "description": "Required. The number of VM instances in the instance group. For master instance groups, must be set to 1.",
1978 "format": "int32", 1547 "format": "int32",
1979 "type": "integer" 1548 "type": "integer"
1549 },
1550 "diskConfig": {
1551 "$ref": "DiskConfig",
1552 "description": "Optional. Disk option config settings."
1553 },
1554 "managedGroupConfig": {
1555 "$ref": "ManagedGroupConfig",
1556 "description": "Output-only. The config for Google Compute E ngine Instance Group Manager that manages this group. This is only used for pree mptible instance groups."
1557 },
1558 "machineTypeUri": {
1559 "description": "Required. 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.",
1560 "type": "string"
1561 },
1562 "imageUri": {
1563 "description": "Output-only. The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version .",
1564 "type": "string"
1565 },
1566 "isPreemptible": {
1567 "description": "Optional. Specifies that this instance group contains preemptible instances.",
1568 "type": "boolean"
1569 },
1570 "instanceNames": {
1571 "description": "Optional. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance gr oup if not set by user (recommended practice is to let Cloud Dataproc derive the name).",
1572 "items": {
1573 "type": "string"
1574 },
1575 "type": "array"
1576 },
1577 "accelerators": {
1578 "description": "Optional. The Google Compute Engine accelera tor configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.",
1579 "items": {
1580 "$ref": "AcceleratorConfig"
1581 },
1582 "type": "array"
1980 } 1583 }
1981 }, 1584 },
1982 "type": "object" 1585 "type": "object"
1983 }, 1586 },
1984 "JobScheduling": { 1587 "JobScheduling": {
1985 "description": "Job scheduling options.Beta Feature: These options a re available for testing purposes only. They may be changed before final release .", 1588 "description": "Job scheduling options.Beta Feature: These options a re available for testing purposes only. They may be changed before final release .",
1986 "id": "JobScheduling", 1589 "id": "JobScheduling",
1987 "properties": { 1590 "properties": {
1988 "maxFailuresPerHour": { 1591 "maxFailuresPerHour": {
1989 "description": "Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code be fore job is reported failed.A job may be reported as thrashing if driver exits w ith non-zero code 4 times within 10 minute window.Maximum value is 10.", 1592 "description": "Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code be fore job is reported failed.A job may be reported as thrashing if driver exits w ith non-zero code 4 times within 10 minute window.Maximum value is 10.",
1990 "format": "int32", 1593 "format": "int32",
1991 "type": "integer" 1594 "type": "integer"
1992 } 1595 }
1993 }, 1596 },
1994 "type": "object" 1597 "type": "object"
1598 },
1599 "ListJobsResponse": {
1600 "description": "A list of jobs in a project.",
1601 "id": "ListJobsResponse",
1602 "properties": {
1603 "jobs": {
1604 "description": "Output-only. Jobs list.",
1605 "items": {
1606 "$ref": "Job"
1607 },
1608 "type": "array"
1609 },
1610 "nextPageToken": {
1611 "description": "Optional. This token is included in the resp onse if there are more results to fetch. To fetch additional results, provide th is value as the page_token in a subsequent <code>ListJobsRequest</code>.",
1612 "type": "string"
1613 }
1614 },
1615 "type": "object"
1616 },
1617 "NodeInitializationAction": {
1618 "description": "Specifies an executable to run on a fully configured node and a timeout period for executable completion.",
1619 "id": "NodeInitializationAction",
1620 "properties": {
1621 "executionTimeout": {
1622 "description": "Optional. Amount of time executable has to c omplete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded time out period) if the executable is not completed at end of the timeout period.",
1623 "format": "google-duration",
1624 "type": "string"
1625 },
1626 "executableFile": {
1627 "description": "Required. Google Cloud Storage URI of execut able file.",
1628 "type": "string"
1629 }
1630 },
1631 "type": "object"
1632 },
1633 "CancelJobRequest": {
1634 "description": "A request to cancel a job.",
1635 "id": "CancelJobRequest",
1636 "properties": {},
1637 "type": "object"
1638 },
1639 "SparkSqlJob": {
1640 "description": "A Cloud Dataproc job for running Apache Spark SQL (h ttp://spark.apache.org/sql/) queries.",
1641 "id": "SparkSqlJob",
1642 "properties": {
1643 "properties": {
1644 "additionalProperties": {
1645 "type": "string"
1646 },
1647 "description": "Optional. A mapping of property names to val ues, used to configure Spark SQL's SparkConf. Properties that conflict with valu es set by the Cloud Dataproc API may be overwritten.",
1648 "type": "object"
1649 },
1650 "queryList": {
1651 "$ref": "QueryList",
1652 "description": "A list of queries."
1653 },
1654 "queryFileUri": {
1655 "description": "The HCFS URI of the script that contains SQL queries.",
1656 "type": "string"
1657 },
1658 "scriptVariables": {
1659 "additionalProperties": {
1660 "type": "string"
1661 },
1662 "description": "Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name=\"value\";).",
1663 "type": "object"
1664 },
1665 "jarFileUris": {
1666 "description": "Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.",
1667 "items": {
1668 "type": "string"
1669 },
1670 "type": "array"
1671 },
1672 "loggingConfig": {
1673 "$ref": "LoggingConfig",
1674 "description": "Optional. The runtime log config for job exe cution."
1675 }
1676 },
1677 "type": "object"
1678 },
1679 "Cluster": {
1680 "description": "Describes the identifying information, config, and s tatus of a cluster of Google Compute Engine instances.",
1681 "id": "Cluster",
1682 "properties": {
1683 "labels": {
1684 "additionalProperties": {
1685 "type": "string"
1686 },
1687 "description": "Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 103 5 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if pre sent, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www .ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a clus ter.",
1688 "type": "object"
1689 },
1690 "metrics": {
1691 "$ref": "ClusterMetrics",
1692 "description": "Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only . It may be changed before final release."
1693 },
1694 "status": {
1695 "$ref": "ClusterStatus",
1696 "description": "Output-only. Cluster status."
1697 },
1698 "statusHistory": {
1699 "description": "Output-only. The previous cluster status.",
1700 "items": {
1701 "$ref": "ClusterStatus"
1702 },
1703 "type": "array"
1704 },
1705 "config": {
1706 "$ref": "ClusterConfig",
1707 "description": "Required. The cluster config. Note that Clou d Dataproc may set default values, and values may change when clusters are updat ed."
1708 },
1709 "clusterUuid": {
1710 "description": "Output-only. A cluster UUID (Unique Universa l Identifier). Cloud Dataproc generates this value when it creates the cluster." ,
1711 "type": "string"
1712 },
1713 "clusterName": {
1714 "description": "Required. The cluster name. Cluster names wi thin a project must be unique. Names of deleted clusters can be reused.",
1715 "type": "string"
1716 },
1717 "projectId": {
1718 "description": "Required. The Google Cloud Platform project ID that the cluster belongs to.",
1719 "type": "string"
1720 }
1721 },
1722 "type": "object"
1723 },
1724 "ListOperationsResponse": {
1725 "description": "The response message for Operations.ListOperations." ,
1726 "id": "ListOperationsResponse",
1727 "properties": {
1728 "nextPageToken": {
1729 "description": "The standard List next-page token.",
1730 "type": "string"
1731 },
1732 "operations": {
1733 "description": "A list of operations that matches the specif ied filter in the request.",
1734 "items": {
1735 "$ref": "Operation"
1736 },
1737 "type": "array"
1738 }
1739 },
1740 "type": "object"
1741 },
1742 "SoftwareConfig": {
1743 "description": "Specifies the selection and config of software insid e the cluster.",
1744 "id": "SoftwareConfig",
1745 "properties": {
1746 "imageVersion": {
1747 "description": "Optional. The version of software inside the cluster. It must match the regular expression [0-9]+\\.[0-9]+. If unspecified, it defaults to the latest version (see Cloud Dataproc Versioning).",
1748 "type": "string"
1749 },
1750 "properties": {
1751 "additionalProperties": {
1752 "type": "string"
1753 },
1754 "description": "Optional. The properties to set on daemon co nfig files.Property keys are specified in prefix:property format, such as core:f s.defaultFS. The following are supported prefixes and their mappings:\ncapacity- scheduler: capacity-scheduler.xml\ncore: core-site.xml\ndistcp: distcp-default.x ml\nhdfs: hdfs-site.xml\nhive: hive-site.xml\nmapred: mapred-site.xml\npig: pig. properties\nspark: spark-defaults.conf\nyarn: yarn-site.xml",
1755 "type": "object"
1756 }
1757 },
1758 "type": "object"
1759 },
1760 "JobPlacement": {
1761 "description": "Cloud Dataproc job config.",
1762 "id": "JobPlacement",
1763 "properties": {
1764 "clusterUuid": {
1765 "description": "Output-only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted.",
1766 "type": "string"
1767 },
1768 "clusterName": {
1769 "description": "Required. The name of the cluster where the job will be submitted.",
1770 "type": "string"
1771 }
1772 },
1773 "type": "object"
1774 },
1775 "PigJob": {
1776 "description": "A Cloud Dataproc job for running Apache Pig (https:/ /pig.apache.org/) queries on YARN.",
1777 "id": "PigJob",
1778 "properties": {
1779 "jarFileUris": {
1780 "description": "Optional. HCFS URIs of jar files to add to t he CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.",
1781 "items": {
1782 "type": "string"
1783 },
1784 "type": "array"
1785 },
1786 "scriptVariables": {
1787 "additionalProperties": {
1788 "type": "string"
1789 },
1790 "description": "Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).",
1791 "type": "object"
1792 },
1793 "loggingConfig": {
1794 "$ref": "LoggingConfig",
1795 "description": "Optional. The runtime log config for job exe cution."
1796 },
1797 "properties": {
1798 "additionalProperties": {
1799 "type": "string"
1800 },
1801 "description": "Optional. A mapping of property names to val ues, used to configure Pig. Properties that conflict with values set by the Clou d Dataproc API may be overwritten. Can include properties set in /etc/hadoop/con f/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.",
1802 "type": "object"
1803 },
1804 "continueOnFailure": {
1805 "description": "Optional. Whether to continue executing quer ies if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.",
1806 "type": "boolean"
1807 },
1808 "queryList": {
1809 "$ref": "QueryList",
1810 "description": "A list of queries."
1811 },
1812 "queryFileUri": {
1813 "description": "The HCFS URI of the script that contains the Pig queries.",
1814 "type": "string"
1815 }
1816 },
1817 "type": "object"
1818 },
1819 "ClusterStatus": {
1820 "description": "The status of a cluster and its instances.",
1821 "id": "ClusterStatus",
1822 "properties": {
1823 "substate": {
1824 "description": "Output-only. Additional state information th at includes status reported by the agent.",
1825 "enum": [
1826 "UNSPECIFIED",
1827 "UNHEALTHY",
1828 "STALE_STATUS"
1829 ],
1830 "enumDescriptions": [
1831 "",
1832 "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.",
1833 "The agent-reported status is out of date (may occur if Cloud Dataproc loses communication with Agent).Applies to RUNNING state."
1834 ],
1835 "type": "string"
1836 },
1837 "stateStartTime": {
1838 "description": "Output-only. Time when this state was entere d.",
1839 "format": "google-datetime",
1840 "type": "string"
1841 },
1842 "detail": {
1843 "description": "Output-only. Optional details of cluster's s tate.",
1844 "type": "string"
1845 },
1846 "state": {
1847 "description": "Output-only. The cluster's state.",
1848 "enum": [
1849 "UNKNOWN",
1850 "CREATING",
1851 "RUNNING",
1852 "ERROR",
1853 "DELETING",
1854 "UPDATING"
1855 ],
1856 "enumDescriptions": [
1857 "The cluster state is unknown.",
1858 "The cluster is being created and set up. It is not read y for use.",
1859 "The cluster is currently running and healthy. It is rea dy for use.",
1860 "The cluster encountered an error. It is not ready for u se.",
1861 "The cluster is being deleted. It cannot be used.",
1862 "The cluster is being updated. It continues to accept an d process jobs."
1863 ],
1864 "type": "string"
1865 }
1866 },
1867 "type": "object"
1995 } 1868 }
1996 }, 1869 },
1997 "servicePath": "", 1870 "servicePath": "",
1998 "title": "Google Cloud Dataproc API", 1871 "title": "Google Cloud Dataproc API",
1999 "version": "v1" 1872 "version": "v1"
2000 } 1873 }
OLDNEW
« no previous file with comments | « discovery/googleapis/customsearch__v1.json ('k') | discovery/googleapis/datastore__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698