discovery/googleapis_beta/dataproc__v1beta1.json - Issue 2987103002: Api-Roll 52: 2017-07-31

Side by Side Diff: discovery/googleapis_beta/dataproc__v1beta1.json

Issue 2987103002: Api-Roll 52: 2017-07-31 (Closed)

Patch Set: Created 3 years, 4 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:

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:v1beta1",

22 "kind": "discovery#restDescription",

23 "name": "dataproc",

24 "ownerDomain": "google.com",

25 "ownerName": "Google",

26 "parameters": {

27 "upload_protocol": {

28 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",

29 "location": "query",

30 "type": "string"

31 },

32 "prettyPrint": {

33 "default": "true",

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 "callback": {

49 "description": "JSONP",

50 "location": "query",

51 "type": "string"

52 },

53 "$.xgafv": {

54 "description": "V1 error format.",

55 "enum": [

56 "1",

57 "2"

58 ],

59 "enumDescriptions": [

60 "v1 error format",

61 "v2 error format"

62 ],

63 "location": "query",

64 "type": "string"

65 },

66 "alt": {

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 ],

79 "location": "query",

80 "type": "string"

81 },

82 "key": {

83 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.",

84 "location": "query",

85 "type": "string"

86 },

87 "access_token": {

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.",

94 "location": "query",

95 "type": "string"

96 },

97 "pp": {

98 "default": "true",

99 "description": "Pretty-print response.",

100 "location": "query",

101 "type": "boolean"

102 },

103 "oauth_token": {

104 "description": "OAuth 2.0 token for the current user.",

105 "location": "query",

106 "type": "string"

107 },

108 "bearer_token": {

109 "description": "OAuth bearer token.",

110 "location": "query",

111 "type": "string"

112 }

113 },

114 "protocol": "rest",

115 "resources": {

116 "operations": {

117 "methods": {

118 "list": {

119 "description": "Lists operations that match the specified fi lter in the request. If the server doesn't support this method, it returns UNIMP LEMENTED.NOTE: the name binding below allows API services to override the bindin g to use different resource name schemes, such as users/*/operations.",

120 "httpMethod": "GET",

121 "id": "dataproc.operations.list",

122 "parameterOrder": [

123 "name"

124 ],

125 "parameters": {

126 "filter": {

127 "description": "The standard list filter.",

128 "location": "query",

129 "type": "string"

130 },

131 "pageToken": {

132 "description": "The standard list page token.",

133 "location": "query",

134 "type": "string"

135 },

136 "name": {

137 "description": "The name of the operation's parent r esource.",

138 "location": "path",

139 "pattern": "^operations$",

140 "required": true,

141 "type": "string"

142 },

143 "pageSize": {

144 "description": "The standard list page size.",

145 "format": "int32",

146 "location": "query",

147 "type": "integer"

148 }

149 },

150 "path": "v1beta1/{+name}",

151 "response": {

152 "$ref": "ListOperationsResponse"

153 },

154 "scopes": [

155 "https://www.googleapis.com/auth/cloud-platform"

156 ]

157 },

158 "get": {

159 "description": "Gets the latest state of a long-running oper ation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",

160 "httpMethod": "GET",

161 "id": "dataproc.operations.get",

162 "parameterOrder": [

163 "name"

164 ],

165 "parameters": {

166 "name": {

167 "description": "The name of the operation resource." ,

168 "location": "path",

169 "pattern": "^operations/.+$",

170 "required": true,

171 "type": "string"

172 }

173 },

174 "path": "v1beta1/{+name}",

175 "response": {

176 "$ref": "Operation"

177 },

178 "scopes": [

179 "https://www.googleapis.com/auth/cloud-platform"

180 ]

181 },

182 "cancel": {

183 "description": "Starts asynchronous cancellation on a long-r unning operation. The server makes a best effort to cancel the operation, but su ccess is not guaranteed. If the server doesn't support this method, it returns g oogle.rpc.Code.UNIMPLEMENTED. Clients can use operations.get or other methods to check whether the cancellation succeeded or whether the operation completed des pite cancellation.",

184 "httpMethod": "POST",

185 "id": "dataproc.operations.cancel",

186 "parameterOrder": [

187 "name"

188 ],

189 "parameters": {

190 "name": {

191 "description": "The name of the operation resource t o be cancelled.",

192 "location": "path",

193 "pattern": "^operations/.+$",

194 "required": true,

195 "type": "string"

196 }

197 },

198 "path": "v1beta1/{+name}:cancel",

199 "request": {

200 "$ref": "CancelOperationRequest"

201 },

202 "response": {

203 "$ref": "Empty"

204 },

205 "scopes": [

206 "https://www.googleapis.com/auth/cloud-platform"

207 ]

208 },

209 "delete": {

210 "description": "Deletes a long-running operation. This metho d indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it ret urns google.rpc.Code.UNIMPLEMENTED.",

211 "httpMethod": "DELETE",

212 "id": "dataproc.operations.delete",

213 "parameterOrder": [

214 "name"

215 ],

216 "parameters": {

217 "name": {

218 "description": "The name of the operation resource t o be deleted.",

219 "location": "path",

220 "pattern": "^operations/.+$",

221 "required": true,

222 "type": "string"

223 }

224 },

225 "path": "v1beta1/{+name}",

226 "response": {

227 "$ref": "Empty"

228 },

229 "scopes": [

230 "https://www.googleapis.com/auth/cloud-platform"

231 ]

232 }

233 }

234 },

235 "projects": {

236 "resources": {

237 "clusters": {

238 "methods": {

239 "patch": {

240 "description": "Updates a cluster in a project.",

241 "httpMethod": "PATCH",

242 "id": "dataproc.projects.clusters.patch",

243 "parameterOrder": [

244 "projectId",

245 "clusterName"

246 ],

247 "parameters": {

248 "clusterName": {

249 "description": "Required The cluster name.",

250 "location": "path",

251 "required": true,

252 "type": "string"

253 },

254 "projectId": {

255 "description": "Required The ID of the Googl e Cloud Platform project the cluster belongs to.",

256 "location": "path",

257 "required": true,

258 "type": "string"

259 },

260 "updateMask": {

261 "description": "Required Specifies the path, relative to <code>Cluster</code>, of the field to update. For example, to chang e the number of workers in a cluster to 5, the <code>update_mask</code> paramete r would be specified as <code>configuration.worker_configuration.num_instances</ code>, and the PATCH request body would specify the new value, as follows:\n{\n \"configuration\":{\n \"workerConfiguration\":{\n \"numInstances\":\"5\ "\n }\n }\n}\nSimilarly, to change the number of preemptible workers in a cl uster to 5, the <code>update_mask</code> parameter would be <code>config.seconda ry_worker_config.num_instances</code>, and the PATCH request body would be set a s follows:\n{\n \"config\":{\n \"secondaryWorkerConfig\":{\n \"numInsta nces\":\"5\"\n }\n }\n}\n<strong>Note:</strong> Currently, <code>config.work er_config.num_instances</code> and <code>config.secondary_worker_config.num_inst ances</code> are the only fields that can be updated.",

262 "format": "google-fieldmask",

263 "location": "query",

264 "type": "string"

265 }

266 },

267 "path": "v1beta1/projects/{projectId}/clusters/{clus terName}",

268 "request": {

269 "$ref": "Cluster"

270 },

271 "response": {

272 "$ref": "Operation"

273 },

274 "scopes": [

275 "https://www.googleapis.com/auth/cloud-platform"

276 ]

277 },

278 "get": {

279 "description": "Gets the resource representation for a cluster in a project.",

280 "httpMethod": "GET",

281 "id": "dataproc.projects.clusters.get",

282 "parameterOrder": [

283 "projectId",

284 "clusterName"

285 ],

286 "parameters": {

287 "projectId": {

288 "description": "Required The ID of the Googl e Cloud Platform project that the cluster belongs to.",

289 "location": "path",

290 "required": true,

291 "type": "string"

292 },

293 "clusterName": {

294 "description": "Required The cluster name.",

295 "location": "path",

296 "required": true,

297 "type": "string"

298 }

299 },

300 "path": "v1beta1/projects/{projectId}/clusters/{clus terName}",

301 "response": {

302 "$ref": "Cluster"

303 },

304 "scopes": [

305 "https://www.googleapis.com/auth/cloud-platform"

306 ]

307 },

308 "diagnose": {

309 "description": "Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseCl usterOutputLocation.",

310 "httpMethod": "POST",

311 "id": "dataproc.projects.clusters.diagnose",

312 "parameterOrder": [

313 "projectId",

314 "clusterName"

315 ],

316 "parameters": {

317 "projectId": {

318 "description": "Required The ID of the Googl e Cloud Platform project that the cluster belongs to.",

319 "location": "path",

320 "required": true,

321 "type": "string"

322 },

323 "clusterName": {

324 "description": "Required The cluster name.",

325 "location": "path",

326 "required": true,

327 "type": "string"

328 }

329 },

330 "path": "v1beta1/projects/{projectId}/clusters/{clus terName}:diagnose",

331 "request": {

332 "$ref": "DiagnoseClusterRequest"

333 },

334 "response": {

335 "$ref": "Operation"

336 },

337 "scopes": [

338 "https://www.googleapis.com/auth/cloud-platform"

339 ]

340 },

341 "delete": {

342 "description": "Deletes a cluster in a project.",

343 "httpMethod": "DELETE",

344 "id": "dataproc.projects.clusters.delete",

345 "parameterOrder": [

346 "projectId",

347 "clusterName"

348 ],

349 "parameters": {

350 "clusterName": {

351 "description": "Required The cluster name.",

352 "location": "path",

353 "required": true,

354 "type": "string"

355 },

356 "projectId": {

357 "description": "Required The ID of the Googl e Cloud Platform project that the cluster belongs to.",

358 "location": "path",

359 "required": true,

360 "type": "string"

361 }

362 },

363 "path": "v1beta1/projects/{projectId}/clusters/{clus terName}",

364 "response": {

365 "$ref": "Operation"

366 },

367 "scopes": [

368 "https://www.googleapis.com/auth/cloud-platform"

369 ]

370 },

371 "list": {

372 "description": "Lists all clusters in a project.",

373 "httpMethod": "GET",

374 "id": "dataproc.projects.clusters.list",

375 "parameterOrder": [

376 "projectId"

377 ],

378 "parameters": {

379 "pageToken": {

380 "description": "The standard List page token .",

381 "location": "query",

382 "type": "string"

383 },

384 "pageSize": {

385 "description": "The standard List page size. ",

386 "format": "int32",

387 "location": "query",

388 "type": "integer"

389 },

390 "projectId": {

391 "description": "Required The ID of the Googl e Cloud Platform project that the cluster belongs to.",

392 "location": "path",

393 "required": true,

394 "type": "string"

395 },

396 "filter": {

397 "description": "Optional A filter constraini ng which clusters to list. Valid filters contain label terms such as: labels.key 1 = val1 AND (-labels.k2 = val2 OR labels.k3 = val3)",

398 "location": "query",

399 "type": "string"

400 }

401 },

402 "path": "v1beta1/projects/{projectId}/clusters",

403 "response": {

404 "$ref": "ListClustersResponse"

405 },

406 "scopes": [

407 "https://www.googleapis.com/auth/cloud-platform"

408 ]

409 },

410 "create": {

411 "description": "Creates a cluster in a project.",

412 "httpMethod": "POST",

413 "id": "dataproc.projects.clusters.create",

414 "parameterOrder": [

415 "projectId"

416 ],

417 "parameters": {

418 "projectId": {

419 "description": "Required The ID of the Googl e Cloud Platform project that the cluster belongs to.",

420 "location": "path",

421 "required": true,

422 "type": "string"

423 }

424 },

425 "path": "v1beta1/projects/{projectId}/clusters",

426 "request": {

427 "$ref": "Cluster"

428 },

429 "response": {

430 "$ref": "Operation"

431 },

432 "scopes": [

433 "https://www.googleapis.com/auth/cloud-platform"

434 ]

435 }

436 }

437 },

438 "jobs": {

439 "methods": {

440 "cancel": {

441 "description": "Starts a job cancellation request. T o access the job resource after cancellation, call jobs.list or jobs.get.",

442 "httpMethod": "POST",

443 "id": "dataproc.projects.jobs.cancel",

444 "parameterOrder": [

445 "projectId",

446 "jobId"

447 ],

448 "parameters": {

449 "jobId": {

450 "description": "Required The job ID.",

451 "location": "path",

452 "required": true,

453 "type": "string"

454 },

455 "projectId": {

456 "description": "Required The ID of the Googl e Cloud Platform project that the job belongs to.",

457 "location": "path",

458 "required": true,

459 "type": "string"

460 }

461 },

462 "path": "v1beta1/projects/{projectId}/jobs/{jobId}:c ancel",

463 "request": {

464 "$ref": "CancelJobRequest"

465 },

466 "response": {

467 "$ref": "Job"

468 },

469 "scopes": [

470 "https://www.googleapis.com/auth/cloud-platform"

471 ]

472 },

473 "get": {

474 "description": "Gets the resource representation for a job in a project.",

475 "httpMethod": "GET",

476 "id": "dataproc.projects.jobs.get",

477 "parameterOrder": [

478 "projectId",

479 "jobId"

480 ],

481 "parameters": {

482 "jobId": {

483 "description": "Required The job ID.",

484 "location": "path",

485 "required": true,

486 "type": "string"

487 },

488 "projectId": {

489 "description": "Required The ID of the Googl e Cloud Platform project that the job belongs to.",

490 "location": "path",

491 "required": true,

492 "type": "string"

493 }

494 },

495 "path": "v1beta1/projects/{projectId}/jobs/{jobId}",

496 "response": {

497 "$ref": "Job"

498 },

499 "scopes": [

500 "https://www.googleapis.com/auth/cloud-platform"

501 ]

502 },

503 "patch": {

504 "description": "Updates a job in a project.",

505 "httpMethod": "PATCH",

506 "id": "dataproc.projects.jobs.patch",

507 "parameterOrder": [

508 "projectId",

509 "jobId"

510 ],

511 "parameters": {

512 "updateMask": {

513 "description": "Required Specifies the path, relative to <code>Job</code>, of the field to update. For example, to update th e labels of a Job the <code>update_mask</code> parameter would be specified as < code>labels</code>, and the PATCH request body would specify the new value. <str ong>Note:</strong> Currently, <code>labels</code> is the only field that can be updated.",

514 "format": "google-fieldmask",

515 "location": "query",

516 "type": "string"

517 },

518 "jobId": {

519 "description": "Required The job ID.",

520 "location": "path",

521 "required": true,

522 "type": "string"

523 },

524 "projectId": {

525 "description": "Required The ID of the Googl e Cloud Platform project that the job belongs to.",

526 "location": "path",

527 "required": true,

528 "type": "string"

529 }

530 },

531 "path": "v1beta1/projects/{projectId}/jobs/{jobId}",

532 "request": {

533 "$ref": "Job"

534 },

535 "response": {

536 "$ref": "Job"

537 },

538 "scopes": [

539 "https://www.googleapis.com/auth/cloud-platform"

540 ]

541 },

542 "submit": {

543 "description": "Submits a job to a cluster.",

544 "httpMethod": "POST",

545 "id": "dataproc.projects.jobs.submit",

546 "parameterOrder": [

547 "projectId"

548 ],

549 "parameters": {

550 "projectId": {

551 "description": "Required The ID of the Googl e Cloud Platform project that the job belongs to.",

552 "location": "path",

553 "required": true,

554 "type": "string"

555 }

556 },

557 "path": "v1beta1/projects/{projectId}/jobs:submit",

558 "request": {

559 "$ref": "SubmitJobRequest"

560 },

561 "response": {

562 "$ref": "Job"

563 },

564 "scopes": [

565 "https://www.googleapis.com/auth/cloud-platform"

566 ]

567 },

568 "delete": {

569 "description": "Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITI ON.",

570 "httpMethod": "DELETE",

571 "id": "dataproc.projects.jobs.delete",

572 "parameterOrder": [

573 "projectId",

574 "jobId"

575 ],

576 "parameters": {

577 "jobId": {

578 "description": "Required The job ID.",

579 "location": "path",

580 "required": true,

581 "type": "string"

582 },

583 "projectId": {

584 "description": "Required The ID of the Googl e Cloud Platform project that the job belongs to.",

585 "location": "path",

586 "required": true,

587 "type": "string"

588 }

589 },

590 "path": "v1beta1/projects/{projectId}/jobs/{jobId}",

591 "response": {

592 "$ref": "Empty"

593 },

594 "scopes": [

595 "https://www.googleapis.com/auth/cloud-platform"

596 ]

597 },

598 "list": {

599 "description": "Lists jobs in a project.",

600 "httpMethod": "GET",

601 "id": "dataproc.projects.jobs.list",

602 "parameterOrder": [

603 "projectId"

604 ],

605 "parameters": {

606 "clusterName": {

607 "description": "Optional If set, the returne d jobs list includes only jobs that were submitted to the named cluster.",

608 "location": "query",

609 "type": "string"

610 },

611 "projectId": {

612 "description": "Required The ID of the Googl e Cloud Platform project that the job belongs to.",

613 "location": "path",

614 "required": true,

615 "type": "string"

616 },

617 "filter": {

618 "description": "Optional A filter constraini ng which jobs to list. Valid filters contain job state and label terms such as: labels.key1 = val1 AND (labels.k2 = val2 OR labels.k3 = val3)",

619 "location": "query",

620 "type": "string"

621 },

622 "jobStateMatcher": {

623 "description": "Optional Specifies enumerate d categories of jobs to list.",

624 "enum": [

625 "ALL",

626 "ACTIVE",

627 "NON_ACTIVE"

628 ],

629 "location": "query",

630 "type": "string"

631 },

632 "pageToken": {

633 "description": "Optional The page token, ret urned by a previous call, to request the next page of results.",

634 "location": "query",

635 "type": "string"

636 },

637 "pageSize": {

638 "description": "Optional The number of resul ts to return in each response.",

639 "format": "int32",

640 "location": "query",

641 "type": "integer"

642 }

643 },

644 "path": "v1beta1/projects/{projectId}/jobs",

645 "response": {

646 "$ref": "ListJobsResponse"

647 },

648 "scopes": [

649 "https://www.googleapis.com/auth/cloud-platform"

650 ]

651 }

652 }

653 }

654 }

655 }

656 },

657 "revision": "20170707",

658 "rootUrl": "https://dataproc.googleapis.com/",

659 "schemas": {

660 "ListClustersResponse": {

661 "description": "The list of all clusters in a project.",

662 "id": "ListClustersResponse",

663 "properties": {

664 "nextPageToken": {

665 "description": "The standard List next-page token.",

666 "type": "string"

667 },

668 "clusters": {

669 "description": "Output-only The clusters in the project.",

670 "items": {

671 "$ref": "Cluster"

672 },

673 "type": "array"

674 }

675 },

676 "type": "object"

677 },

678 "ManagedGroupConfiguration": {

679 "description": "Specifies the resources used to actively manage an i nstance group.",

680 "id": "ManagedGroupConfiguration",

681 "properties": {

682 "instanceGroupManagerName": {

683 "description": "Output-only The name of the Instance Group M anager for this group.",

684 "type": "string"

685 },

686 "instanceTemplateName": {

687 "description": "Output-only The name of the Instance Templat e used for the Managed Instance Group.",

688 "type": "string"

689 }

690 },

691 "type": "object"

692 },

693 "SparkJob": {

694 "description": "A Cloud Dataproc job for running Spark applications on YARN.",

695 "id": "SparkJob",

696 "properties": {

697 "mainClass": {

698 "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.",

699 "type": "string"

700 },

701 "archiveUris": {

702 "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.",

703 "items": {

704 "type": "string"

705 },

706 "type": "array"

707 },

708 "mainJarFileUri": {

709 "description": "The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.",

710 "type": "string"

711 },

712 "jarFileUris": {

713 "description": "Optional HCFS URIs of jar files to add to th e CLASSPATHs of the Spark driver and tasks.",

714 "items": {

715 "type": "string"

716 },

717 "type": "array"

718 },

719 "loggingConfiguration": {

720 "$ref": "LoggingConfiguration",

721 "description": "Optional The runtime log configuration for j ob execution."

722 },

723 "properties": {

724 "additionalProperties": {

725 "type": "string"

726 },

727 "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.",

728 "type": "object"

729 },

730 "args": {

731 "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.",

732 "items": {

733 "type": "string"

734 },

735 "type": "array"

736 },

737 "fileUris": {

738 "description": "Optional HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.",

739 "items": {

740 "type": "string"

741 },

742 "type": "array"

743 }

744 },

745 "type": "object"

746 },

747 "Job": {

748 "description": "A Cloud Dataproc job resource.",

749 "id": "Job",

750 "properties": {

751 "reference": {

752 "$ref": "JobReference",

753 "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>."

754 },

755 "interactive": {

756 "description": "Optional If set to true, the driver's stdin will be kept open and driver_input_uri will be set to provide a path at which ad ditional input can be sent to the driver.",

757 "type": "boolean"

758 },

759 "driverInputResourceUri": {

760 "description": "Output-only A URI pointing to the location o f the stdin of the job's driver program, only set if the job is interactive.",

761 "type": "string"

762 },

763 "hadoopJob": {

764 "$ref": "HadoopJob",

765 "description": "Job is a Hadoop job."

766 },

767 "placement": {

768 "$ref": "JobPlacement",

769 "description": "Required Job information, including how, whe n, and where to run the job."

770 },

771 "status": {

772 "$ref": "JobStatus",

773 "description": "Output-only The job status. Additional appli cation-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields."

774 },

775 "driverControlFilesUri": {

776 "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.",

777 "type": "string"

778 },

779 "submittedBy": {

780 "description": "Output-only The email address of the user su bmitting the job. For jobs submitted on the cluster, the address is <code>userna me@hostname</code>.",

781 "type": "string"

782 },

783 "scheduling": {

784 "$ref": "JobScheduling",

785 "description": "Optional Job scheduling configuration."

786 },

787 "pigJob": {

788 "$ref": "PigJob",

789 "description": "Job is a Pig job."

790 },

791 "hiveJob": {

792 "$ref": "HiveJob",

793 "description": "Job is a Hive job."

794 },

795 "labels": {

796 "additionalProperties": {

797 "type": "string"

798 },

799 "description": "Optional The labels to associate with this j ob.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \\p{Ll}\\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \ \p{Ll}\\p{Lo}\\p{N}_-{0,63}No more than 64 labels can be associated with a given job.",

800 "type": "object"

801 },

802 "driverOutputResourceUri": {

803 "description": "Output-only A URI pointing to the location o f the stdout of the job's driver program.",

804 "type": "string"

805 },

806 "sparkJob": {

807 "$ref": "SparkJob",

808 "description": "Job is a Spark job."

809 },

810 "statusHistory": {

811 "description": "Output-only The previous job status.",

812 "items": {

813 "$ref": "JobStatus"

814 },

815 "type": "array"

816 },

817 "sparkSqlJob": {

818 "$ref": "SparkSqlJob",

819 "description": "Job is a SparkSql job."

820 },

821 "yarnApplications": {

822 "description": "Output-only The collection of YARN applicati ons spun up by this job.",

823 "items": {

824 "$ref": "YarnApplication"

825 },

826 "type": "array"

827 },

828 "pysparkJob": {

829 "$ref": "PySparkJob",

830 "description": "Job is a Pyspark job."

831 }

832 },

833 "type": "object"

834 },

835 "JobStatus": {

836 "description": "Cloud Dataproc job status.",

837 "id": "JobStatus",

838 "properties": {

839 "substate": {

840 "description": "Output-only Additional state information, wh ich includes status reported by the agent.",

841 "enum": [

842 "UNSPECIFIED",

843 "SUBMITTED",

844 "QUEUED",

845 "STALE_STATUS"

846 ],

847 "enumDescriptions": [

848 "",

849 "The Job is submitted to the agent.Applies to RUNNING st ate.",

850 "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.",

851 "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."

852 ],

853 "type": "string"

854 },

855 "stateStartTime": {

856 "description": "Output-only The time when this state was ent ered.",

857 "format": "google-datetime",

858 "type": "string"

859 },

860 "details": {

861 "description": "Optional Job state details, such as an error description if the state is <code>ERROR</code>.",

862 "type": "string"

863 },

864 "state": {

865 "description": "Required A state message specifying the over all job state.",

866 "enum": [

867 "STATE_UNSPECIFIED",

868 "PENDING",

869 "SETUP_DONE",

870 "RUNNING",

871 "CANCEL_PENDING",

872 "CANCEL_STARTED",

873 "CANCELLED",

874 "DONE",

875 "ERROR",

876 "ATTEMPT_FAILURE"

877 ],

878 "enumDescriptions": [

879 "The job state is unknown.",

880 "The job is pending; it has been submitted, but is not y et running.",

881 "Job has been received by the service and completed init ial setup; it will shortly be submitted to the cluster.",

882 "The job is running on the cluster.",

883 "A CancelJob request has been received, but is pending." ,

884 "Transient in-flight resources have been canceled, and t he request to cancel the running job has been issued to the cluster.",

885 "The job cancelation was successful.",

886 "The job has completed successfully.",

887 "The job has completed, but encountered an error.",

888 "Job attempt has failed. The detail field contains failu re details for this attempt.Applies to restartable jobs only."

889 ],

890 "type": "string"

891 }

892 },

893 "type": "object"

894 },

895 "DiskConfiguration": {

896 "description": "Specifies the configuration of disk options for a gr oup of VM instances.",

897 "id": "DiskConfiguration",

898 "properties": {

899 "bootDiskSizeGb": {

900 "description": "Optional Size in GB of the boot disk (defaul t is 500GB).",

901 "format": "int32",

902 "type": "integer"

903 },

904 "numLocalSsds": {

905 "description": "Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runti me logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and i nstalled binaries.",

906 "format": "int32",

907 "type": "integer"

908 }

909 },

910 "type": "object"

911 },

912 "ClusterOperationStatus": {

913 "description": "The status of the operation.",

914 "id": "ClusterOperationStatus",

915 "properties": {

916 "innerState": {

917 "description": "Output-only. A message containing the detail ed operation state.",

918 "type": "string"

919 },

920 "stateStartTime": {

921 "description": "Output-only. The time this state was entered .",

922 "format": "google-datetime",

923 "type": "string"

924 },

925 "details": {

926 "description": "Output-only.A message containing any operati on metadata details.",

927 "type": "string"

928 },

929 "state": {

930 "description": "Output-only. A message containing the operat ion state.",

931 "enum": [

932 "UNKNOWN",

933 "PENDING",

934 "RUNNING",

935 "DONE"

936 ],

937 "enumDescriptions": [

938 "Unused.",

939 "The operation has been created.",

940 "The operation is running.",

941 "The operation is done; either cancelled or completed."

942 ],

943 "type": "string"

944 }

945 },

946 "type": "object"

947 },

948 "YarnApplication": {

949 "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>.",

950 "id": "YarnApplication",

951 "properties": {

952 "name": {

953 "description": "Required The application name.",

954 "type": "string"

955 },

956 "trackingUrl": {

957 "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.",

958 "type": "string"

959 },

960 "progress": {

961 "description": "Required The numerical progress of the appli cation, from 1 to 100.",

962 "format": "float",

963 "type": "number"

964 },

965 "state": {

966 "description": "Required The application state.",

967 "enum": [

968 "STATE_UNSPECIFIED",

969 "NEW",

970 "NEW_SAVING",

971 "SUBMITTED",

972 "ACCEPTED",

973 "RUNNING",

974 "FINISHED",

975 "FAILED",

976 "KILLED"

977 ],

978 "enumDescriptions": [

979 "Status is unspecified.",

980 "Status is NEW.",

981 "Status is NEW_SAVING.",

982 "Status is SUBMITTED.",

983 "Status is ACCEPTED.",

984 "Status is RUNNING.",

985 "Status is FINISHED.",

986 "Status is FAILED.",

987 "Status is KILLED."

988 ],

989 "type": "string"

990 }

991 },

992 "type": "object"

993 },

994 "QueryList": {

995 "description": "A list of queries to run on a cluster.",

996 "id": "QueryList",

997 "properties": {

998 "queries": {

999 "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",

1000 "items": {

1001 "type": "string"

1002 },

1003 "type": "array"

1004 }

1005 },

1006 "type": "object"

1007 },

1008 "HadoopJob": {

1009 "description": "A Cloud Dataproc job for running Hadoop MapReduce jo bs on YARN.",

1010 "id": "HadoopJob",

1011 "properties": {

1012 "args": {

1013 "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.",

1014 "items": {

1015 "type": "string"

1016 },

1017 "type": "array"

1018 },

1019 "fileUris": {

1020 "description": "Optional HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naivel y parallel tasks.",

1021 "items": {

1022 "type": "string"

1023 },

1024 "type": "array"

1025 },

1026 "mainClass": {

1027 "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.",

1028 "type": "string"

1029 },

1030 "archiveUris": {

1031 "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.",

1032 "items": {

1033 "type": "string"

1034 },

1035 "type": "array"

1036 },

1037 "mainJarFileUri": {

1038 "description": "The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics -binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcou nt.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'",

1039 "type": "string"

1040 },

1041 "jarFileUris": {

1042 "description": "Optional Jar file URIs to add to the CLASSPA THs of the Hadoop driver and tasks.",

1043 "items": {

1044 "type": "string"

1045 },

1046 "type": "array"

1047 },

1048 "loggingConfiguration": {

1049 "$ref": "LoggingConfiguration",

1050 "description": "Optional The runtime log configuration for j ob execution."

1051 },

1052 "properties": {

1053 "additionalProperties": {

1054 "type": "string"

1055 },

1056 "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.",

1057 "type": "object"

1058 }

1059 },

1060 "type": "object"

1061 },

1062 "DiagnoseClusterRequest": {

1063 "description": "A request to collect cluster diagnostic information. ",

1064 "id": "DiagnoseClusterRequest",

1065 "properties": {},

1066 "type": "object"

1067 },

1068 "ClusterOperationMetadata": {

1069 "description": "Metadata describing the operation.",

1070 "id": "ClusterOperationMetadata",

1071 "properties": {

1072 "statusHistory": {

1073 "description": "Output-only. The previous operation status." ,

1074 "items": {

1075 "$ref": "ClusterOperationStatus"

1076 },

1077 "type": "array"

1078 },

1079 "clusterName": {

1080 "description": "Output-only. Name of the cluster for the ope ration.",

1081 "type": "string"

1082 },

1083 "clusterUuid": {

1084 "description": "Output-only. Cluster UUID for the operation. ",

1085 "type": "string"

1086 },

1087 "operationType": {

1088 "description": "Output-only. The operation type.",

1089 "type": "string"

1090 },

1091 "description": {

1092 "description": "Output-only. Short description of operation. ",

1093 "type": "string"

1094 },

1095 "warnings": {

1096 "description": "Output-only. Errors encountered during opera tion execution.",

1097 "items": {

1098 "type": "string"

1099 },

1100 "type": "array"

1101 },

1102 "labels": {

1103 "additionalProperties": {

1104 "type": "string"

1105 },

1106 "description": "Output-only. Labels associated with the oper ation",

1107 "type": "object"

1108 },

1109 "status": {

1110 "$ref": "ClusterOperationStatus",

1111 "description": "Output-only. Current operation status."

1112 }

1113 },

1114 "type": "object"

1115 },

1116 "HiveJob": {

1117 "description": "A Cloud Dataproc job for running Hive queries on YAR N.",

1118 "id": "HiveJob",

1119 "properties": {

1120 "jarFileUris": {

1121 "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.",

1122 "items": {

1123 "type": "string"

1124 },

1125 "type": "array"

1126 },

1127 "scriptVariables": {

1128 "additionalProperties": {

1129 "type": "string"

1130 },

1131 "description": "Optional Mapping of query variable names to values (equivalent to the Hive command: SET name=\"value\";).",

1132 "type": "object"

1133 },

1134 "properties": {

1135 "additionalProperties": {

1136 "type": "string"

1137 },

1138 "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.",

1139 "type": "object"

1140 },

1141 "continueOnFailure": {

1142 "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.",

1143 "type": "boolean"

1144 },

1145 "queryFileUri": {

1146 "description": "The HCFS URI of the script that contains Hiv e queries.",

1147 "type": "string"

1148 },

1149 "queryList": {

1150 "$ref": "QueryList",

1151 "description": "A list of queries."

1152 }

1153 },

1154 "type": "object"

1155 },

1156 "Empty": {

1157 "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 {}.",

1158 "id": "Empty",

1159 "properties": {},

1160 "type": "object"

1161 },

1162 "DiagnoseClusterResults": {

1163 "description": "The location of diagnostic output.",

1164 "id": "DiagnoseClusterResults",

1165 "properties": {

1166 "outputUri": {

1167 "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.",

1168 "type": "string"

1169 }

1170 },

1171 "type": "object"

1172 },

1173 "SoftwareConfiguration": {

1174 "description": "Specifies the selection and configuration of softwar e inside the cluster.",

1175 "id": "SoftwareConfiguration",

1176 "properties": {

1177 "properties": {

1178 "additionalProperties": {

1179 "type": "string"

1180 },

1181 "description": "Optional The properties to set on daemon con figuration files.Property keys are specified in \"prefix:property\" format, such as \"core:fs.defaultFS\". The following are supported prefixes and their mappin gs: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defau lts.conf",

1182 "type": "object"

1183 },

1184 "imageVersion": {

1185 "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).",

1186 "type": "string"

1187 }

1188 },

1189 "type": "object"

1190 },

1191 "PySparkJob": {

1192 "description": "A Cloud Dataproc job for running PySpark application s on YARN.",

1193 "id": "PySparkJob",

1194 "properties": {

1195 "jarFileUris": {

1196 "description": "Optional HCFS URIs of jar files to add to th e CLASSPATHs of the Python driver and tasks.",

1197 "items": {

1198 "type": "string"

1199 },

1200 "type": "array"

1201 },

1202 "loggingConfiguration": {

1203 "$ref": "LoggingConfiguration",

1204 "description": "Optional The runtime log configuration for j ob execution."

1205 },

1206 "properties": {

1207 "additionalProperties": {

1208 "type": "string"

1209 },

1210 "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.",

1211 "type": "object"

1212 },

1213 "args": {

1214 "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.",

1215 "items": {

1216 "type": "string"

1217 },

1218 "type": "array"

1219 },

1220 "fileUris": {

1221 "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.",

1222 "items": {

1223 "type": "string"

1224 },

1225 "type": "array"

1226 },

1227 "pythonFileUris": {

1228 "description": "Optional HCFS file URIs of Python files to p ass to the PySpark framework. Supported file types: .py, .egg, and .zip.",

1229 "items": {

1230 "type": "string"

1231 },

1232 "type": "array"

1233 },

1234 "mainPythonFileUri": {

1235 "description": "Required The Hadoop Compatible Filesystem (H CFS) URI of the main Python file to use as the driver. Must be a .py file.",

1236 "type": "string"

1237 },

1238 "archiveUris": {

1239 "description": "Optional HCFS URIs of archives to be extract ed in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.",

1240 "items": {

1241 "type": "string"

1242 },

1243 "type": "array"

1244 }

1245 },

1246 "type": "object"

1247 },

1248 "ClusterMetrics": {

1249 "description": "Contains cluster daemon metrics, such as HDFS and YA RN stats.",

1250 "id": "ClusterMetrics",

1251 "properties": {

1252 "yarnMetrics": {

1253 "additionalProperties": {

1254 "format": "int64",

1255 "type": "string"

1256 },

1257 "description": "The YARN metrics.",

1258 "type": "object"

1259 },

1260 "hdfsMetrics": {

1261 "additionalProperties": {

1262 "format": "int64",

1263 "type": "string"

1264 },

1265 "description": "The HDFS metrics.",

1266 "type": "object"

1267 }

1268 },

1269 "type": "object"

1270 },

1271 "ClusterConfiguration": {

1272 "description": "The cluster configuration.",

1273 "id": "ClusterConfiguration",

1274 "properties": {

1275 "configurationBucket": {

1276 "description": "Optional A Google Cloud Storage staging buck et used for sharing generated SSH keys and configuration. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage loc ation (US, ASIA, or EU) for your cluster's staging bucket according to the Googl e Compute Engine zone where your cluster is deployed, and then it will create an d manage this project-level, per-location bucket for you.",

1277 "type": "string"

1278 },

1279 "masterConfiguration": {

1280 "$ref": "InstanceGroupConfiguration",

1281 "description": "Optional The Google Compute Engine configura tion settings for the master instance in a cluster."

1282 },

1283 "secondaryWorkerConfiguration": {

1284 "$ref": "InstanceGroupConfiguration",

1285 "description": "Optional The Google Compute Engine configura tion settings for additional worker instances in a cluster."

1286 },

1287 "workerConfiguration": {

1288 "$ref": "InstanceGroupConfiguration",

1289 "description": "Optional The Google Compute Engine configura tion settings for worker instances in a cluster."

1290 },

1291 "initializationActions": {

1292 "description": "Optional Commands to execute on each node af ter configuration is completed. By default, executables are run on master and al l worker nodes. You can test a node's <code>role</code> metadata to run an execu table on a master or worker node, as shown below:\nROLE=$(/usr/share/google/get_ metadata_value attributes/role)\nif [[ \"${ROLE}\" == 'Master' ]]; then\n ... m aster specific actions ...\nelse\n ... worker specific actions ...\nfi\n",

1293 "items": {

1294 "$ref": "NodeInitializationAction"

1295 },

1296 "type": "array"

1297 },

1298 "softwareConfiguration": {

1299 "$ref": "SoftwareConfiguration",

1300 "description": "Optional The configuration settings for soft ware inside the cluster."

1301 },

1302 "gceClusterConfiguration": {

1303 "$ref": "GceClusterConfiguration",

1304 "description": "Required The shared Google Compute Engine co nfiguration settings for all instances in a cluster."

1305 }

1306 },

1307 "type": "object"

1308 },

1309 "LoggingConfiguration": {

1310 "description": "The runtime logging configuration of the job.",

1311 "id": "LoggingConfiguration",

1312 "properties": {

1313 "driverLogLevels": {

1314 "additionalProperties": {

1315 "enum": [

1316 "LEVEL_UNSPECIFIED",

1317 "ALL",

1318 "TRACE",

1319 "DEBUG",

1320 "INFO",

1321 "WARN",

1322 "ERROR",

1323 "FATAL",

1324 "OFF"

1325 ],

1326 "type": "string"

1327 },

1328 "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'",

1329 "type": "object"

1330 }

1331 },

1332 "type": "object"

1333 },

1334 "InstanceGroupConfiguration": {

1335 "description": "The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group.",

1336 "id": "InstanceGroupConfiguration",

1337 "properties": {

1338 "isPreemptible": {

1339 "description": "Specifies that this instance group contains Preemptible Instances.",

1340 "type": "boolean"

1341 },

1342 "imageUri": {

1343 "description": "Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_v ersion.",

1344 "type": "string"

1345 },

1346 "machineTypeUri": {

1347 "description": "The Google Compute Engine machine type used for cluster instances. Example: https://www.googleapis.com/compute/v1/projects/[ project_id]/zones/us-east1-a/machineTypes/n1-standard-2.",

1348 "type": "string"

1349 },

1350 "instanceNames": {

1351 "description": "The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set b y user (recommended practice is to let Dataproc derive the name).",

1352 "items": {

1353 "type": "string"

1354 },

1355 "type": "array"

1356 },

1357 "managedGroupConfiguration": {

1358 "$ref": "ManagedGroupConfiguration",

1359 "description": "Output-only The configuration for Google Com pute Engine Instance Group Manager that manages this group. This is only used fo r preemptible instance groups."

1360 },

1361 "accelerators": {

1362 "description": "Optional The Google Compute Engine accelerat or configuration for these instances.",

1363 "items": {

1364 "$ref": "AcceleratorConfiguration"

1365 },

1366 "type": "array"

1367 },

1368 "numInstances": {

1369 "description": "The number of VM instances in the instance g roup. For master instance groups, must be set to 1.",

1370 "format": "int32",

1371 "type": "integer"

1372 },

1373 "diskConfiguration": {

1374 "$ref": "DiskConfiguration",

1375 "description": "Disk option configuration settings."

1376 }

1377 },

1378 "type": "object"

1379 },

1380 "GceClusterConfiguration": {

1381 "description": "Common configuration settings for resources of Googl e Compute Engine cluster instances, applicable to all instances in the cluster." ,

1382 "id": "GceClusterConfiguration",

1383 "properties": {

1384 "metadata": {

1385 "additionalProperties": {

1386 "type": "string"

1387 },

1388 "description": "The Google Compute Engine metadata entries t o add to all instances.",

1389 "type": "object"

1390 },

1391 "internalIpOnly": {

1392 "description": "If true, all instances in the cluser will on ly have internal IP addresses. By default, clusters are not restricted to intern al IP addresses, and will have ephemeral external IP addresses assigned to each instance. This restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without ext ernal IP addresses.",

1393 "type": "boolean"

1394 },

1395 "serviceAccountScopes": {

1396 "description": "The URIs of service account scopes to be inc luded in Google Compute Engine instances. The following base set of scopes is al ways included: - https://www.googleapis.com/auth/cloud.useraccounts.readonly - h ttps://www.googleapis.com/auth/devstorage.read_write - https://www.googleapis.co m/auth/logging.write If no scopes are specfied, the following defaults are also provided: - https://www.googleapis.com/auth/bigquery - https://www.googleapis.co m/auth/bigtable.admin.table - https://www.googleapis.com/auth/bigtable.data - ht tps://www.googleapis.com/auth/devstorage.full_control",

1397 "items": {

1398 "type": "string"

1399 },

1400 "type": "array"

1401 },

1402 "tags": {

1403 "description": "The Google Compute Engine tags to add to all instances.",

1404 "items": {

1405 "type": "string"

1406 },

1407 "type": "array"

1408 },

1409 "serviceAccount": {

1410 "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",

1411 "type": "string"

1412 },

1413 "subnetworkUri": {

1414 "description": "The Google Compute Engine subnetwork to be u sed for machine communications. Cannot be specified with network_uri. Example: h ttps://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0 .",

1415 "type": "string"

1416 },

1417 "networkUri": {

1418 "description": "The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the \"default\" network of the pro ject is used, if it exists. Cannot be a \"Custom Subnet Network\" (see https://c loud.google.com/compute/docs/subnetworks for more information). Example: https:/ /www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default.",

1419 "type": "string"

1420 },

1421 "zoneUri": {

1422 "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].",

1423 "type": "string"

1424 }

1425 },

1426 "type": "object"

1427 },

1428 "CancelOperationRequest": {

1429 "description": "The request message for Operations.CancelOperation." ,

1430 "id": "CancelOperationRequest",

1431 "properties": {},

1432 "type": "object"

1433 },

1434 "DiagnoseClusterOutputLocation": {

1435 "description": "The location of diagnostic output.",

1436 "id": "DiagnoseClusterOutputLocation",

1437 "properties": {

1438 "outputUri": {

1439 "description": "Output-only The Google Cloud Storage URI of the diagnostic output. This is a plain text file with a summary of collected dia gnostics.",

1440 "type": "string"

1441 }

1442 },

1443 "type": "object"

1444 },

1445 "Operation": {

1446 "description": "This resource represents a long-running operation th at is the result of a network API call.",

1447 "id": "Operation",

1448 "properties": {

1449 "done": {

1450 "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.",

1451 "type": "boolean"

1452 },

1453 "response": {

1454 "additionalProperties": {

1455 "description": "Properties of the object. Contains field @type with type URL.",

1456 "type": "any"

1457 },

1458 "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.",

1459 "type": "object"

1460 },

1461 "name": {

1462 "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.",

1463 "type": "string"

1464 },

1465 "error": {

1466 "$ref": "Status",

1467 "description": "The error result of the operation in case of failure or cancellation."

1468 },

1469 "metadata": {

1470 "additionalProperties": {

1471 "description": "Properties of the object. Contains field @type with type URL.",

1472 "type": "any"

1473 },

1474 "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.",

1475 "type": "object"

1476 }

1477 },

1478 "type": "object"

1479 },

1480 "OperationStatus": {

1481 "description": "The status of the operation.",

1482 "id": "OperationStatus",

1483 "properties": {

1484 "details": {

1485 "description": "A message containing any operation metadata details.",

1486 "type": "string"

1487 },

1488 "state": {

1489 "description": "A message containing the operation state.",

1490 "enum": [

1491 "UNKNOWN",

1492 "PENDING",

1493 "RUNNING",

1494 "DONE"

1495 ],

1496 "enumDescriptions": [

1497 "Unused.",

1498 "The operation has been created.",

1499 "The operation is running.",

1500 "The operation is done; either cancelled or completed."

1501 ],

1502 "type": "string"

1503 },

1504 "innerState": {

1505 "description": "A message containing the detailed operation state.",

1506 "type": "string"

1507 },

1508 "stateStartTime": {

1509 "description": "The time this state was entered.",

1510 "format": "google-datetime",

1511 "type": "string"

1512 }

1513 },

1514 "type": "object"

1515 },

1516 "JobReference": {

1517 "description": "Encapsulates the full scoping used to reference a jo b.",

1518 "id": "JobReference",

1519 "properties": {

1520 "jobId": {

1521 "description": "Required The job ID, which must be unique wi thin the project. The job ID is generated by the server upon job submission or p rovided by the user as a means to perform retries without creating duplicate job s. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.",

1522 "type": "string"

1523 },

1524 "projectId": {

1525 "description": "Required The ID of the Google Cloud Platform project that the job belongs to.",

1526 "type": "string"

1527 }

1528 },

1529 "type": "object"

1530 },

1531 "SubmitJobRequest": {

1532 "description": "A request to submit a job.",

1533 "id": "SubmitJobRequest",

1534 "properties": {

1535 "job": {

1536 "$ref": "Job",

1537 "description": "Required The job resource."

1538 }

1539 },

1540 "type": "object"

1541 },

1542 "Status": {

1543 "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.",

1544 "id": "Status",

1545 "properties": {

1546 "code": {

1547 "description": "The status code, which should be an enum val ue of google.rpc.Code.",

1548 "format": "int32",

1549 "type": "integer"

1550 },

1551 "message": {

1552 "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.",

1553 "type": "string"

1554 },

1555 "details": {

1556 "description": "A list of messages that carry the error deta ils. There will be a common set of message types for APIs to use.",

1557 "items": {

1558 "additionalProperties": {

1559 "description": "Properties of the object. Contains f ield @type with type URL.",

1560 "type": "any"

1561 },

1562 "type": "object"

1563 },

1564 "type": "array"

1565 }

1566 },

1567 "type": "object"

1568 },

1569 "JobScheduling": {

1570 "description": "Job scheduling options.Beta Feature: These options a re available for testing purposes only. They may be changed before final release .",

1571 "id": "JobScheduling",

1572 "properties": {

1573 "maxFailuresPerHour": {

1574 "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.",

1575 "format": "int32",

1576 "type": "integer"

1577 }

1578 },

1579 "type": "object"

1580 },

1581 "NodeInitializationAction": {

1582 "description": "Specifies an executable to run on a fully configured node and a timeout period for executable completion.",

1583 "id": "NodeInitializationAction",

1584 "properties": {

1585 "executionTimeout": {

1586 "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.",

1587 "format": "google-duration",

1588 "type": "string"

1589 },

1590 "executableFile": {

1591 "description": "Required Google Cloud Storage URI of executa ble file.",

1592 "type": "string"

1593 }

1594 },

1595 "type": "object"

1596 },

1597 "ListJobsResponse": {

1598 "description": "A list of jobs in a project.",

1599 "id": "ListJobsResponse",

1600 "properties": {

1601 "nextPageToken": {

1602 "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>.",

1603 "type": "string"

1604 },

1605 "jobs": {

1606 "description": "Output-only Jobs list.",

1607 "items": {

1608 "$ref": "Job"

1609 },

1610 "type": "array"

1611 }

1612 },

1613 "type": "object"

1614 },

1615 "CancelJobRequest": {

1616 "description": "A request to cancel a job.",

1617 "id": "CancelJobRequest",

1618 "properties": {},

1619 "type": "object"

1620 },

1621 "SparkSqlJob": {

1622 "description": "A Cloud Dataproc job for running Spark SQL queries." ,

1623 "id": "SparkSqlJob",

1624 "properties": {

1625 "queryFileUri": {

1626 "description": "The HCFS URI of the script that contains SQL queries.",

1627 "type": "string"

1628 },

1629 "queryList": {

1630 "$ref": "QueryList",

1631 "description": "A list of queries."

1632 },

1633 "scriptVariables": {

1634 "additionalProperties": {

1635 "type": "string"

1636 },

1637 "description": "Optional Mapping of query variable names to values (equivalent to the Spark SQL command: SET name=\"value\";).",

1638 "type": "object"

1639 },

1640 "jarFileUris": {

1641 "description": "Optional HCFS URIs of jar files to be added to the Spark CLASSPATH.",

1642 "items": {

1643 "type": "string"

1644 },

1645 "type": "array"

1646 },

1647 "loggingConfiguration": {

1648 "$ref": "LoggingConfiguration",

1649 "description": "Optional The runtime log configuration for j ob execution."

1650 },

1651 "properties": {

1652 "additionalProperties": {

1653 "type": "string"

1654 },

1655 "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.",

1656 "type": "object"

1657 }

1658 },

1659 "type": "object"

1660 },

1661 "Cluster": {

1662 "description": "Describes the identifying information, configuration , and status of a cluster of Google Compute Engine instances.",

1663 "id": "Cluster",

1664 "properties": {

1665 "statusHistory": {

1666 "description": "Output-only Previous cluster statuses.",

1667 "items": {

1668 "$ref": "ClusterStatus"

1669 },

1670 "type": "array"

1671 },

1672 "clusterUuid": {

1673 "description": "Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.",

1674 "type": "string"

1675 },

1676 "clusterName": {

1677 "description": "Required The cluster name. Cluster names wit hin a project must be unique. Names from deleted clusters can be reused.",

1678 "type": "string"

1679 },

1680 "projectId": {

1681 "description": "Required The Google Cloud Platform project I D that the cluster belongs to.",

1682 "type": "string"

1683 },

1684 "configuration": {

1685 "$ref": "ClusterConfiguration",

1686 "description": "Required The cluster configuration. Note tha t Cloud Dataproc may set default values, and values may change when clusters are updated."

1687 },

1688 "labels": {

1689 "additionalProperties": {

1690 "type": "string"

1691 },

1692 "description": "Optional The labels to associate with this c luster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}\\p{N}_-{0,63}No more than 64 labels can be associate d with a given cluster.",

1693 "type": "object"

1694 },

1695 "metrics": {

1696 "$ref": "ClusterMetrics",

1697 "description": "Contains cluster daemon metrics such as HDFS and YARN stats."

1698 },

1699 "status": {

1700 "$ref": "ClusterStatus",

1701 "description": "Output-only Cluster status."

1702 }

1703 },

1704 "type": "object"

1705 },

1706 "ListOperationsResponse": {

1707 "description": "The response message for Operations.ListOperations." ,

1708 "id": "ListOperationsResponse",

1709 "properties": {

1710 "operations": {

1711 "description": "A list of operations that matches the specif ied filter in the request.",

1712 "items": {

1713 "$ref": "Operation"

1714 },

1715 "type": "array"

1716 },

1717 "nextPageToken": {

1718 "description": "The standard List next-page token.",

1719 "type": "string"

1720 }

1721 },

1722 "type": "object"

1723 },

1724 "OperationMetadata": {

1725 "description": "Metadata describing the operation.",

1726 "id": "OperationMetadata",

1727 "properties": {

1728 "warnings": {

1729 "description": "Output-only Errors encountered during operat ion execution.",

1730 "items": {

1731 "type": "string"

1732 },

1733 "type": "array"

1734 },

1735 "status": {

1736 "$ref": "OperationStatus",

1737 "description": "Output-only Current operation status."

1738 },

1739 "statusHistory": {

1740 "description": "Output-only Previous operation status.",

1741 "items": {

1742 "$ref": "OperationStatus"

1743 },

1744 "type": "array"

1745 },

1746 "clusterUuid": {

1747 "description": "Cluster UUId for the operation.",

1748 "type": "string"

1749 },

1750 "clusterName": {

1751 "description": "Name of the cluster for the operation.",

1752 "type": "string"

1753 },

1754 "operationType": {

1755 "description": "Output-only The operation type.",

1756 "type": "string"

1757 },

1758 "description": {

1759 "description": "Output-only Short description of operation." ,

1760 "type": "string"

1761 }

1762 },

1763 "type": "object"

1764 },

1765 "JobPlacement": {

1766 "description": "Cloud Dataproc job configuration.",

1767 "id": "JobPlacement",

1768 "properties": {

1769 "clusterUuid": {

1770 "description": "Output-only A cluster UUID generated by the Dataproc service when the job is submitted.",

1771 "type": "string"

1772 },

1773 "clusterName": {

1774 "description": "Required The name of the cluster where the j ob will be submitted.",

1775 "type": "string"

1776 }

1777 },

1778 "type": "object"

1779 },

1780 "PigJob": {

1781 "description": "A Cloud Dataproc job for running Pig queries on YARN .",

1782 "id": "PigJob",

1783 "properties": {

1784 "jarFileUris": {

1785 "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.",

1786 "items": {

1787 "type": "string"

1788 },

1789 "type": "array"

1790 },

1791 "scriptVariables": {

1792 "additionalProperties": {

1793 "type": "string"

1794 },

1795 "description": "Optional Mapping of query variable names to values (equivalent to the Pig command: name=[value]).",

1796 "type": "object"

1797 },

1798 "loggingConfiguration": {

1799 "$ref": "LoggingConfiguration",

1800 "description": "Optional The runtime log configuration for j ob execution."

1801 },

1802 "properties": {

1803 "additionalProperties": {

1804 "type": "string"

1805 },

1806 "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.",

1807 "type": "object"

1808 },

1809 "continueOnFailure": {

1810 "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.",

1811 "type": "boolean"

1812 },

1813 "queryList": {

1814 "$ref": "QueryList",

1815 "description": "A list of queries."

1816 },

1817 "queryFileUri": {

1818 "description": "The HCFS URI of the script that contains the Pig queries.",

1819 "type": "string"

1820 }

1821 },

1822 "type": "object"

1823 },

1824 "ClusterStatus": {

1825 "description": "The status of a cluster and its instances.",

1826 "id": "ClusterStatus",

1827 "properties": {

1828 "substate": {

1829 "description": "Output-only Additional state information tha t includes status reported by the agent.",

1830 "enum": [

1831 "UNSPECIFIED",

1832 "UNHEALTHY",

1833 "STALE_STATUS"

1834 ],

1835 "enumDescriptions": [

1836 "",

1837 "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.",

1838 "The agent-reported status is out of date (may occur if Cloud Dataproc loses communication with Agent).Applies to RUNNING state."

1839 ],

1840 "type": "string"

1841 },

1842 "stateStartTime": {

1843 "description": "Time when this state was entered.",

1844 "format": "google-datetime",

1845 "type": "string"

1846 },

1847 "detail": {

1848 "description": "Optional details of cluster's state.",

1849 "type": "string"

1850 },

1851 "state": {

1852 "description": "The cluster's state.",

1853 "enum": [

1854 "UNKNOWN",

1855 "CREATING",

1856 "RUNNING",

1857 "ERROR",

1858 "DELETING",

1859 "UPDATING"

1860 ],

1861 "enumDescriptions": [

1862 "The cluster state is unknown.",

1863 "The cluster is being created and set up. It is not read y for use.",

1864 "The cluster is currently running and healthy. It is rea dy for use.",

1865 "The cluster encountered an error. It is not ready for u se.",

1866 "The cluster is being deleted. It cannot be used.",

1867 "The cluster is being updated. It continues to accept an d process jobs."

1868 ],

1869 "type": "string"

1870 }

1871 },

1872 "type": "object"

1873 },

1874 "AcceleratorConfiguration": {

1875 "description": "Specifies the type and number of accelerator cards a ttached to the instances of an instance group (see GPUs on Compute Engine).",

1876 "id": "AcceleratorConfiguration",

1877 "properties": {

1878 "acceleratorCount": {

1879 "description": "The number of the accelerator cards of this type exposed to this instance.",

1880 "format": "int32",

1881 "type": "integer"

1882 },

1883 "acceleratorTypeUri": {

1884 "description": "Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)",

1885 "type": "string"

1886 }

1887 },

1888 "type": "object"

1889 }

1890 },

1891 "servicePath": "",

1892 "title": "Google Cloud Dataproc API",

1893 "version": "v1beta1"

1894 }

OLD	NEW

« no previous file with comments | « discovery/googleapis_beta/dataflow__v1b3.json ('k') | discovery/googleapis_beta/dlp__v2beta1.json » ('j') | no next file with comments »