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

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

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

Powered by Google App Engine
This is Rietveld 408576698