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