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

Issues Search
    My Issues | Starred     Open | Closed | All

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

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

Powered by Google App Engine
This is Rietveld 408576698