Blame - docs/dyn/dataproc_v1.projects.regions.jobs.html - platform/external/python/google-api-python-client

2016-02-19 16:02:29 -0800

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

78

<code><a href="#cancel">cancel(projectId, region, jobId, body=None, x__xgafv=None)</a></code></p>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

79

<p class="firstline">Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list (https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs/list) or regions/{region}/jobs.get (https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs/get).</p>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

80

81

<code><a href="#delete">delete(projectId, region, jobId, x__xgafv=None)</a></code></p>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

82

<p class="firstline">Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.</p>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

83

84

<code><a href="#get">get(projectId, region, jobId, x__xgafv=None)</a></code></p>

85

<p class="firstline">Gets the resource representation for a job in a project.</p>

86

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

87

<code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>

88

<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>

89

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

90

<code><a href="#list">list(projectId, region, clusterName=None, filter=None, jobStateMatcher=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

91

<p class="firstline">Lists regions/{region}/jobs in a project.</p>

92

93

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

94

<p class="firstline">Retrieves the next page of results.</p>

95

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

96

<code><a href="#patch">patch(projectId, region, jobId, body=None, updateMask=None, x__xgafv=None)</a></code></p>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

97

<p class="firstline">Updates a job in a project.</p>

98

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

99

<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>

100

<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

101

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

102

<code><a href="#submit">submit(projectId, region, body=None, x__xgafv=None)</a></code></p>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

103

<p class="firstline">Submits a job to a cluster.</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

104

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

105

<code><a href="#submitAsOperation">submitAsOperation(projectId, region, body=None, x__xgafv=None)</a></code></p>

106

<p class="firstline">Submits job to a cluster.</p>

107

108

<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

109

<p class="firstline">Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

110

<h3>Method Details</h3>

111

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

112

<code class="details" id="cancel">cancel(projectId, region, jobId, body=None, x__xgafv=None)</code>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

113

<pre>Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list (https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs/list) or regions/{region}/jobs.get (https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs/get).

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

114

115

Args:

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

116

projectId: string, Required. The ID of the Google Cloud Platform project that the job belongs to. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

117

region: string, Required. The Dataproc region in which to handle the request. (required)

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

118

jobId: string, Required. The job ID. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

119

body: object, The request body.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

120

The object takes the form of:

121

122

{ # A request to cancel a job.

123

}

124

125

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

126

Allowed values

127

1 - v1 error format

128

2 - v2 error format

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

129

130

Returns:

131

An object of the form:

132

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

133

{ # A Dataproc job resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

134

"driverControlFilesUri": "A String", # Output only. If present, the location of miscellaneous 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.

135

"prestoJob": { # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. # Optional. Job is a Presto job.

136

"outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats

137

"continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.

138

"queryList": { # A list of queries to run on a cluster. # A list of queries.

139

"queries": [ # 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:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

146

# ]

147

# }

148

# }

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

149

"A String",

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

150

],

151

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

152

"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.

153

"clientTags": [ # Optional. Presto client tags to attach to this query

154

"A String",

155

],

156

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

157

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"properties": { # Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI

162

"a_key": "A String",

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

163

},

164

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

165

"scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.

166

"maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.

167

},

168

"pigJob": { # A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Optional. Job is a Pig job.

169

"continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.

170

"queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.

171

"queryList": { # A list of queries to run on a cluster. # A list of queries.

172

"queries": [ # 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:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.

186

"A String",

187

],

188

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).

189

"a_key": "A String",

190

},

191

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

192

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the 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.

"a_key": "A String",

},

},

"jobUuid": "A String", # Output only. A UUID that uniquely identifies a job within the project over time. This is in contrast to a user-settable reference.job_id that may be reused over time.

201

"hiveJob": { # A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Optional. Job is a Hive job.

202

"continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.

203

"queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.

204

"queryList": { # A list of queries to run on a cluster. # A list of queries.

205

"queries": [ # 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:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.

219

"A String",

220

],

221

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).

222

"a_key": "A String",

223

},

224

"properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.

"a_key": "A String",

},

},

"labels": { # Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.

229

"a_key": "A String",

230

},

231

"done": True or False, # Output only. Indicates whether the job is completed. If the value is false, the job is still in progress. If true, the job is completed, and status.state field will indicate if it was successful, failed, or cancelled.

232

"driverOutputResourceUri": "A String", # Output only. A URI pointing to the location of the stdout of the job's driver program.

233

"sparkSqlJob": { # A Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Optional. Job is a SparkSql job.

234

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).

235

"a_key": "A String",

236

},

237

"jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.

238

"A String",

239

],

240

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

241

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.

246

"a_key": "A String",

247

},

248

"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.

249

"queryList": { # A list of queries to run on a cluster. # A list of queries.

250

"queries": [ # 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:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

},

"sparkJob": { # A Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Optional. Job is a Spark job.

265

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

266

"A String",

267

],

268

"mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.

269

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.

270

"A String",

271

],

272

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

273

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

278

"a_key": "A String",

279

},

280

"args": [ # Optional. The arguments to pass to the driver. 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.

281

"A String",

282

],

283

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.

284

"A String",

285

],

286

"mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.

287

},

288

"statusHistory": [ # Output only. The previous job status.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

289

{ # Dataproc job status.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

290

"state": "A String", # Output only. A state message specifying the overall job state.

291

"details": "A String", # Optional. Output only. Job state details, such as an error description if the state is <code>ERROR</code>.

292

"stateStartTime": "A String", # Output only. The time when this state was entered.

293

"substate": "A String", # Output only. Additional state information, which includes status reported by the agent.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

294

},

295

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

296

"yarnApplications": [ # Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

297

{ # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.Beta Feature: This report is available for testing purposes only. It may be changed before final release.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

298

"progress": 3.14, # Required. The numerical progress of the application, from 1 to 100.

299

"state": "A String", # Required. The application state.

300

"name": "A String", # Required. The application name.

301

"trackingUrl": "A String", # Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

302

},

303

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

304

"pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Optional. Job is a PySpark job.

305

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.

306

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

307

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

308

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

309

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

310

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

311

},

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

312

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

313

"properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

314

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

315

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

316

"args": [ # Optional. The arguments to pass to the driver. 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.

317

"A String",

318

],

319

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.

320

"A String",

321

],

322

"pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.

323

"A String",

324

],

325

"mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.

326

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.

327

"A String",

328

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

329

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

330

"sparkRJob": { # A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Optional. Job is a SparkR job.

331

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

332

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

333

"a_key": "A String",

334

},

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

335

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

336

"properties": { # Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

337

"a_key": "A String",

338

},

339

"mainRFileUri": "A String", # Required. The HCFS URI of the main R file to use as the driver. Must be a .R file.

340

"args": [ # Optional. The arguments to pass to the driver. 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.

341

"A String",

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

342

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

343

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of R drivers and distributed tasks. Useful for naively parallel tasks.

344

"A String",

345

],

346

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

"A String",

],

},

"reference": { # Encapsulates the full scoping used to reference a job. # Optional. The fully qualified reference to the 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>.

351

"projectId": "A String", # Required. The ID of the Google Cloud Platform project that the job belongs to.

352

"jobId": "A String", # Optional. The job ID, which must be unique within the project.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.If not specified by the caller, the job ID will be provided by the server.

353

},

354

"hadoopJob": { # A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Optional. Job is a Hadoop job.

355

"mainClass": "A String", # 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.

356

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.

357

"A String",

358

],

359

"mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'

360

"jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.

361

"A String",

362

],

363

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

364

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

365

"a_key": "A String",

366

},

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

367

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

368

"properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.

369

"a_key": "A String",

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

370

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

371

"args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.

372

"A String",

373

],

374

"fileUris": [ # Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.

"A String",

],

},

"placement": { # Dataproc job config. # Required. Job information, including how, when, and where to run the job.

379

"clusterName": "A String", # Required. The name of the cluster where the job will be submitted.

380

"clusterUuid": "A String", # Output only. A cluster UUID generated by the Dataproc service when the job is submitted.

381

},

382

"status": { # Dataproc job status. # Output only. The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields.

383

"state": "A String", # Output only. A state message specifying the overall job state.

384

"details": "A String", # Optional. Output only. Job state details, such as an error description if the state is <code>ERROR</code>.

385

"stateStartTime": "A String", # Output only. The time when this state was entered.

386

"substate": "A String", # Output only. Additional state information, which includes status reported by the agent.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

},

}</pre>

</div>

<code class="details" id="delete">delete(projectId, region, jobId, x__xgafv=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

393

<pre>Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

394

395

Args:

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

396

projectId: string, Required. The ID of the Google Cloud Platform project that the job belongs to. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

397

region: string, Required. The Dataproc region in which to handle the request. (required)

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

398

jobId: string, Required. The job ID. (required)

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

399

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

400

Allowed values

401

1 - v1 error format

402

2 - v2 error format

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

403

404

Returns:

405

An object of the form:

406

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

407

{ # 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:

408

# service Foo {

409

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

410

# }

411

# The JSON representation for Empty is empty JSON object {}.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(projectId, region, jobId, x__xgafv=None)</code>

417

<pre>Gets the resource representation for a job in a project.

418

419

Args:

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

420

projectId: string, Required. The ID of the Google Cloud Platform project that the job belongs to. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

421

region: string, Required. The Dataproc region in which to handle the request. (required)

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

422

jobId: string, Required. The job ID. (required)

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

423

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

424

Allowed values

425

1 - v1 error format

426

2 - v2 error format

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

427

428

Returns:

429

An object of the form:

430

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

431

{ # A Dataproc job resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

432

"driverControlFilesUri": "A String", # Output only. If present, the location of miscellaneous 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.

433

"prestoJob": { # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. # Optional. Job is a Presto job.

434

"outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats

435

"continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.

436

"queryList": { # A list of queries to run on a cluster. # A list of queries.

437

"queries": [ # 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:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

444

# ]

445

# }

446

# }

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

447

"A String",

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

448

],

449

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

450

"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.

451

"clientTags": [ # Optional. Presto client tags to attach to this query

452

"A String",

453

],

454

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

455

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"properties": { # Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI

460

"a_key": "A String",

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

461

},

462

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

463

"scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.

464

"maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.

465

},

466

"pigJob": { # A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Optional. Job is a Pig job.

467

"continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.

468

"queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.

469

"queryList": { # A list of queries to run on a cluster. # A list of queries.

470

"queries": [ # 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:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.

484

"A String",

485

],

486

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).

487

"a_key": "A String",

488

},

489

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

490

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the 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.

"a_key": "A String",

},

},

"jobUuid": "A String", # Output only. A UUID that uniquely identifies a job within the project over time. This is in contrast to a user-settable reference.job_id that may be reused over time.

499

"hiveJob": { # A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Optional. Job is a Hive job.

500

"continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.

501

"queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.

502

"queryList": { # A list of queries to run on a cluster. # A list of queries.

503

"queries": [ # 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:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.

517

"A String",

518

],

519

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).

520

"a_key": "A String",

521

},

522

"properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.

"a_key": "A String",

},

},

"labels": { # Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.

527

"a_key": "A String",

528

},

529

"done": True or False, # Output only. Indicates whether the job is completed. If the value is false, the job is still in progress. If true, the job is completed, and status.state field will indicate if it was successful, failed, or cancelled.

530

"driverOutputResourceUri": "A String", # Output only. A URI pointing to the location of the stdout of the job's driver program.

531

"sparkSqlJob": { # A Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Optional. Job is a SparkSql job.

532

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).

533

"a_key": "A String",

534

},

535

"jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.

536

"A String",

537

],

538

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

539

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.

544

"a_key": "A String",

545

},

546

"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.

547

"queryList": { # A list of queries to run on a cluster. # A list of queries.

548

"queries": [ # 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:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

},

"sparkJob": { # A Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Optional. Job is a Spark job.

563

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

564

"A String",

565

],

566

"mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.

567

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.

568

"A String",

569

],

570

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

571

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

576

"a_key": "A String",

577

},

578

"args": [ # Optional. The arguments to pass to the driver. 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.

579

"A String",

580

],

581

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.

582

"A String",

583

],

584

"mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.

585

},

586

"statusHistory": [ # Output only. The previous job status.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

587

{ # Dataproc job status.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

588

"state": "A String", # Output only. A state message specifying the overall job state.

589

"details": "A String", # Optional. Output only. Job state details, such as an error description if the state is <code>ERROR</code>.

590

"stateStartTime": "A String", # Output only. The time when this state was entered.

591

"substate": "A String", # Output only. Additional state information, which includes status reported by the agent.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

592

},

593

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

594

"yarnApplications": [ # Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

595

{ # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.Beta Feature: This report is available for testing purposes only. It may be changed before final release.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

596

"progress": 3.14, # Required. The numerical progress of the application, from 1 to 100.

597

"state": "A String", # Required. The application state.

598

"name": "A String", # Required. The application name.

599

"trackingUrl": "A String", # Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

600

},

601

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

602

"pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Optional. Job is a PySpark job.

603

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.

604

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

605

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

606

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

607

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

608

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

609

},

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

610

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

611

"properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

612

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

613

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

614

"args": [ # Optional. The arguments to pass to the driver. 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.

615

"A String",

616

],

617

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.

618

"A String",

619

],

620

"pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.

621

"A String",

622

],

623

"mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.

624

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.

625

"A String",

626

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

627

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

628

"sparkRJob": { # A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Optional. Job is a SparkR job.

629

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

630

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

631

"a_key": "A String",

632

},

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

633

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

634

"properties": { # Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

635

"a_key": "A String",

636

},

637

"mainRFileUri": "A String", # Required. The HCFS URI of the main R file to use as the driver. Must be a .R file.

638

"args": [ # Optional. The arguments to pass to the driver. 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.

639

"A String",

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

640

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

641

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of R drivers and distributed tasks. Useful for naively parallel tasks.

642

"A String",

643

],

644

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

"A String",

],

},

"reference": { # Encapsulates the full scoping used to reference a job. # Optional. The fully qualified reference to the 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>.

649

"projectId": "A String", # Required. The ID of the Google Cloud Platform project that the job belongs to.

650

"jobId": "A String", # Optional. The job ID, which must be unique within the project.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.If not specified by the caller, the job ID will be provided by the server.

651

},

652

"hadoopJob": { # A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Optional. Job is a Hadoop job.

653

"mainClass": "A String", # 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.

654

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.

655

"A String",

656

],

657

"mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'

658

"jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.

659

"A String",

660

],

661

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

662

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

663

"a_key": "A String",

664

},

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

665

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

666

"properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.

667

"a_key": "A String",

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

668

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

669

"args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.

670

"A String",

671

],

672

"fileUris": [ # Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.

"A String",

],

},

"placement": { # Dataproc job config. # Required. Job information, including how, when, and where to run the job.

677

"clusterName": "A String", # Required. The name of the cluster where the job will be submitted.

678

"clusterUuid": "A String", # Output only. A cluster UUID generated by the Dataproc service when the job is submitted.

679

},

680

"status": { # Dataproc job status. # Output only. The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields.

681

"state": "A String", # Output only. A state message specifying the overall job state.

682

"details": "A String", # Optional. Output only. Job state details, such as an error description if the state is <code>ERROR</code>.

683

"stateStartTime": "A String", # Output only. The time when this state was entered.

684

"substate": "A String", # Output only. Additional state information, which includes status reported by the agent.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

},

}</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

690

<code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code>

691

<pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

692

693

Args:

694

resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required)

695

body: object, The request body.

696

The object takes the form of:

697

698

{ # Request message for GetIamPolicy method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

699

"options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy. This field is only used by Cloud IAM.

700

"requestedPolicyVersion": 42, # Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

701

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

702

}

703

704

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

711

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

712

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.Optionally, a binding can specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both.JSON example:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

713

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

714

# "bindings": [

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

715

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

716

# "role": "roles/resourcemanager.organizationAdmin",

717

# "members": [

718

# "user:mike@example.com",

719

# "group:admins@example.com",

720

# "domain:google.com",

721

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

722

# ]

723

# },

724

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

725

# "role": "roles/resourcemanager.organizationViewer",

726

# "members": ["user:eve@example.com"],

727

# "condition": {

728

# "title": "expirable access",

729

# "description": "Does not grant access after Sep 2020",

730

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

731

# }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

732

# }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

733

# ],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

734

# "etag": "BwWWja0YfJA=",

735

# "version": 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

736

# }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

737

# YAML example:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

738

# bindings:

739

# - members:

740

# - user:mike@example.com

741

# - group:admins@example.com

742

# - domain:google.com

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

743

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

744

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

745

# - members:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

746

# - user:eve@example.com

747

# role: roles/resourcemanager.organizationViewer

748

# condition:

749

# title: expirable access

750

# description: Does not grant access after Sep 2020

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

751

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

752

# - etag: BwWWja0YfJA=

753

# - version: 3

754

# For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

755

"bindings": [ # Associates a list of members to a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one member.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

756

{ # Associates members with a role.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

757

"role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.

758

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.

759

# title: "Summary size limit"

760

# description: "Determines if a summary is less than 100 chars"

761

# expression: "document.summary.size() < 100"

762

# Example (Equality):

763

# title: "Requestor is owner"

764

# description: "Determines if requestor is the document owner"

765

# expression: "document.owner == request.auth.claims.email"

766

# Example (Logic):

767

# title: "Public documents"

768

# description: "Determine whether the document should be publicly visible"

769

# expression: "document.type != 'private' && document.type != 'internal'"

770

# Example (Data Manipulation):

771

# title: "Notification string"

772

# description: "Create a notification string with a timestamp."

773

# expression: "'New message received at ' + string(document.create_time)"

774

# The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

775

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

776

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

777

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

778

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

779

},

780

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

781

# allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.

782

# allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

783

# user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com .

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

784

# serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.

785

# group:{emailid}: An email address that represents a Google group. For example, admins@example.com.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

786

# deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding.

787

# deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding.

788

# deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

789

# domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

790

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

791

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

792

},

793

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

794

"etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.

795

"version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

796

# Getting a policy that includes a conditional role binding

797

# Adding a conditional role binding to a policy

798

# Changing a conditional role binding in a policy

799

# Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

804

<code class="details" id="list">list(projectId, region, clusterName=None, filter=None, jobStateMatcher=None, pageToken=None, pageSize=None, x__xgafv=None)</code>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

805

<pre>Lists regions/{region}/jobs in a project.

806

807

Args:

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

808

projectId: string, Required. The ID of the Google Cloud Platform project that the job belongs to. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

809

region: string, Required. The Dataproc region in which to handle the request. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

810

clusterName: string, Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.

811

filter: string, Optional. A filter constraining 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.state can be either ACTIVE or NON_ACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND labels.env = staging AND labels.starred = *

812

jobStateMatcher: string, Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs).If filter is provided, jobStateMatcher will be ignored.

813

pageToken: string, Optional. The page token, returned by a previous call, to request the next page of results.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

814

pageSize: integer, Optional. The number of results to return in each response.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

815

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

816

Allowed values

817

1 - v1 error format

818

2 - v2 error format

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

819

820

Returns:

821

An object of the form:

822

823

{ # A list of jobs in a project.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

824

"jobs": [ # Output only. Jobs list.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

825

{ # A Dataproc job resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

826

"driverControlFilesUri": "A String", # Output only. If present, the location of miscellaneous 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.

827

"prestoJob": { # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. # Optional. Job is a Presto job.

828

"outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats

829

"continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.

830

"queryList": { # A list of queries to run on a cluster. # A list of queries.

831

"queries": [ # 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:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

838

# ]

839

# }

840

# }

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

841

"A String",

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

842

],

843

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

844

"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.

845

"clientTags": [ # Optional. Presto client tags to attach to this query

846

"A String",

847

],

848

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

849

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"properties": { # Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI

854

"a_key": "A String",

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

855

},

856

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

857

"scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.

858

"maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.

859

},

860

"pigJob": { # A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Optional. Job is a Pig job.

861

"continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.

862

"queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.

863

"queryList": { # A list of queries to run on a cluster. # A list of queries.

864

"queries": [ # 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:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.

878

"A String",

879

],

880

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).

881

"a_key": "A String",

882

},

883

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

884

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the 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.

"a_key": "A String",

},

},

"jobUuid": "A String", # Output only. A UUID that uniquely identifies a job within the project over time. This is in contrast to a user-settable reference.job_id that may be reused over time.

893

"hiveJob": { # A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Optional. Job is a Hive job.

894

"continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.

895

"queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.

896

"queryList": { # A list of queries to run on a cluster. # A list of queries.

897

"queries": [ # 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:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.

911

"A String",

912

],

913

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).

914

"a_key": "A String",

915

},

916

"properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.

"a_key": "A String",

},

},

"labels": { # Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.

921

"a_key": "A String",

922

},

923

"done": True or False, # Output only. Indicates whether the job is completed. If the value is false, the job is still in progress. If true, the job is completed, and status.state field will indicate if it was successful, failed, or cancelled.

924

"driverOutputResourceUri": "A String", # Output only. A URI pointing to the location of the stdout of the job's driver program.

925

"sparkSqlJob": { # A Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Optional. Job is a SparkSql job.

926

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).

927

"a_key": "A String",

928

},

929

"jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.

930

"A String",

931

],

932

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

933

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.

938

"a_key": "A String",

939

},

940

"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.

941

"queryList": { # A list of queries to run on a cluster. # A list of queries.

942

"queries": [ # 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:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

},

"sparkJob": { # A Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Optional. Job is a Spark job.

957

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

958

"A String",

959

],

960

"mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.

961

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.

962

"A String",

963

],

964

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

965

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

970

"a_key": "A String",

971

},

972

"args": [ # Optional. The arguments to pass to the driver. 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.

973

"A String",

974

],

975

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.

976

"A String",

977

],

978

"mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.

979

},

980

"statusHistory": [ # Output only. The previous job status.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

981

{ # Dataproc job status.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

982

"state": "A String", # Output only. A state message specifying the overall job state.

983

"details": "A String", # Optional. Output only. Job state details, such as an error description if the state is <code>ERROR</code>.

984

"stateStartTime": "A String", # Output only. The time when this state was entered.

985

"substate": "A String", # Output only. Additional state information, which includes status reported by the agent.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

986

},

987

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

988

"yarnApplications": [ # Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

989

{ # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.Beta Feature: This report is available for testing purposes only. It may be changed before final release.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

990

"progress": 3.14, # Required. The numerical progress of the application, from 1 to 100.

991

"state": "A String", # Required. The application state.

992

"name": "A String", # Required. The application name.

993

"trackingUrl": "A String", # Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

994

},

995

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

996

"pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Optional. Job is a PySpark job.

997

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.

998

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

999

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1000

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

1001

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

1002

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1003

},

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1004

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1005

"properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

1006

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1007

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1008

"args": [ # Optional. The arguments to pass to the driver. 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.

1009

"A String",

1010

],

1011

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.

1012

"A String",

1013

],

1014

"pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.

1015

"A String",

1016

],

1017

"mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.

1018

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.

1019

"A String",

1020

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1021

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1022

"sparkRJob": { # A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Optional. Job is a SparkR job.

1023

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

1024

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

1025

"a_key": "A String",

1026

},

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1027

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1028

"properties": { # Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

1029

"a_key": "A String",

1030

},

1031

"mainRFileUri": "A String", # Required. The HCFS URI of the main R file to use as the driver. Must be a .R file.

1032

"args": [ # Optional. The arguments to pass to the driver. 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.

1033

"A String",

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1034

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1035

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of R drivers and distributed tasks. Useful for naively parallel tasks.

1036

"A String",

1037

],

1038

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

"A String",

],

},

"reference": { # Encapsulates the full scoping used to reference a job. # Optional. The fully qualified reference to the 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>.

1043

"projectId": "A String", # Required. The ID of the Google Cloud Platform project that the job belongs to.

1044

"jobId": "A String", # Optional. The job ID, which must be unique within the project.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.If not specified by the caller, the job ID will be provided by the server.

1045

},

1046

"hadoopJob": { # A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Optional. Job is a Hadoop job.

1047

"mainClass": "A String", # 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.

1048

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.

1049

"A String",

1050

],

1051

"mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'

1052

"jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.

1053

"A String",

1054

],

1055

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

1056

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

1057

"a_key": "A String",

1058

},

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1059

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1060

"properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.

1061

"a_key": "A String",

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1062

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1063

"args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.

1064

"A String",

1065

],

1066

"fileUris": [ # Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.

"A String",

],

},

"placement": { # Dataproc job config. # Required. Job information, including how, when, and where to run the job.

1071

"clusterName": "A String", # Required. The name of the cluster where the job will be submitted.

1072

"clusterUuid": "A String", # Output only. A cluster UUID generated by the Dataproc service when the job is submitted.

1073

},

1074

"status": { # Dataproc job status. # Output only. The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields.

1075

"state": "A String", # Output only. A state message specifying the overall job state.

1076

"details": "A String", # Optional. Output only. Job state details, such as an error description if the state is <code>ERROR</code>.

1077

"stateStartTime": "A String", # Output only. The time when this state was entered.

1078

"substate": "A String", # Output only. Additional state information, which includes status reported by the agent.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1079

},

1080

},

1081

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1082

"nextPageToken": "A String", # Optional. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent <code>ListJobsRequest</code>.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

1088

<pre>Retrieves the next page of results.

1089

1090

Args:

1091

previous_request: The request for the previous page. (required)

1092

previous_response: The response from the request for the previous page. (required)

1093

1094

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1095

A request object that you can call 'execute()' on to request the next

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1096

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1101

<code class="details" id="patch">patch(projectId, region, jobId, body=None, updateMask=None, x__xgafv=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1102

<pre>Updates a job in a project.

1103

1104

Args:

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1105

projectId: string, Required. The ID of the Google Cloud Platform project that the job belongs to. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1106

region: string, Required. The Dataproc region in which to handle the request. (required)

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1107

jobId: string, Required. The job ID. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1108

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1109

The object takes the form of:

1110

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1111

{ # A Dataproc job resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1112

"driverControlFilesUri": "A String", # Output only. If present, the location of miscellaneous 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.

1113

"prestoJob": { # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. # Optional. Job is a Presto job.

1114

"outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats

1115

"continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.

1116

"queryList": { # A list of queries to run on a cluster. # A list of queries.

1117

"queries": [ # 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:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1124

# ]

1125

# }

1126

# }

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1127

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1128

],

1129

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1130

"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.

1131

"clientTags": [ # Optional. Presto client tags to attach to this query

1132

"A String",

1133

],

1134

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

1135

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"properties": { # Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI

1140

"a_key": "A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1141

},

1142

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1143

"scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.

1144

"maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.

1145

},

1146

"pigJob": { # A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Optional. Job is a Pig job.

1147

"continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.

1148

"queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.

1149

"queryList": { # A list of queries to run on a cluster. # A list of queries.

1150

"queries": [ # 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:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.

1164

"A String",

1165

],

1166

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).

1167

"a_key": "A String",

1168

},

1169

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

1170

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the 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.

"a_key": "A String",

},

},

"jobUuid": "A String", # Output only. A UUID that uniquely identifies a job within the project over time. This is in contrast to a user-settable reference.job_id that may be reused over time.

1179

"hiveJob": { # A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Optional. Job is a Hive job.

1180

"continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.

1181

"queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.

1182

"queryList": { # A list of queries to run on a cluster. # A list of queries.

1183

"queries": [ # 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:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.

1197

"A String",

1198

],

1199

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).

1200

"a_key": "A String",

1201

},

1202

"properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.

"a_key": "A String",

},

},

"labels": { # Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.

1207

"a_key": "A String",

1208

},

1209

"done": True or False, # Output only. Indicates whether the job is completed. If the value is false, the job is still in progress. If true, the job is completed, and status.state field will indicate if it was successful, failed, or cancelled.

1210

"driverOutputResourceUri": "A String", # Output only. A URI pointing to the location of the stdout of the job's driver program.

1211

"sparkSqlJob": { # A Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Optional. Job is a SparkSql job.

1212

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).

1213

"a_key": "A String",

1214

},

1215

"jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.

1216

"A String",

1217

],

1218

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

1219

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.

1224

"a_key": "A String",

1225

},

1226

"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.

1227

"queryList": { # A list of queries to run on a cluster. # A list of queries.

1228

"queries": [ # 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:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

},

"sparkJob": { # A Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Optional. Job is a Spark job.

1243

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

1244

"A String",

1245

],

1246

"mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.

1247

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.

1248

"A String",

1249

],

1250

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

1251

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

1256

"a_key": "A String",

1257

},

1258

"args": [ # Optional. The arguments to pass to the driver. 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.

1259

"A String",

1260

],

1261

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.

1262

"A String",

1263

],

1264

"mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.

1265

},

1266

"statusHistory": [ # Output only. The previous job status.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1267

{ # Dataproc job status.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1268

"state": "A String", # Output only. A state message specifying the overall job state.

1269

"details": "A String", # Optional. Output only. Job state details, such as an error description if the state is <code>ERROR</code>.

1270

"stateStartTime": "A String", # Output only. The time when this state was entered.

1271

"substate": "A String", # Output only. Additional state information, which includes status reported by the agent.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1272

},

1273

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1274

"yarnApplications": [ # Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1275

{ # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.Beta Feature: This report is available for testing purposes only. It may be changed before final release.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1276

"progress": 3.14, # Required. The numerical progress of the application, from 1 to 100.

1277

"state": "A String", # Required. The application state.

1278

"name": "A String", # Required. The application name.

1279

"trackingUrl": "A String", # Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1280

},

1281

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1282

"pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Optional. Job is a PySpark job.

1283

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.

1284

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1285

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1286

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

1287

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

1288

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1289

},

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1290

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1291

"properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

1292

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1293

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1294

"args": [ # Optional. The arguments to pass to the driver. 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.

1295

"A String",

1296

],

1297

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.

1298

"A String",

1299

],

1300

"pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.

1301

"A String",

1302

],

1303

"mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.

1304

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.

1305

"A String",

1306

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1307

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1308

"sparkRJob": { # A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Optional. Job is a SparkR job.

1309

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

1310

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

1311

"a_key": "A String",

1312

},

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1313

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1314

"properties": { # Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

1315

"a_key": "A String",

1316

},

1317

"mainRFileUri": "A String", # Required. The HCFS URI of the main R file to use as the driver. Must be a .R file.

1318

"args": [ # Optional. The arguments to pass to the driver. 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.

1319

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1320

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1321

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of R drivers and distributed tasks. Useful for naively parallel tasks.

1322

"A String",

1323

],

1324

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

"A String",

],

},

"reference": { # Encapsulates the full scoping used to reference a job. # Optional. The fully qualified reference to the 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>.

1329

"projectId": "A String", # Required. The ID of the Google Cloud Platform project that the job belongs to.

1330

"jobId": "A String", # Optional. The job ID, which must be unique within the project.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.If not specified by the caller, the job ID will be provided by the server.

1331

},

1332

"hadoopJob": { # A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Optional. Job is a Hadoop job.

1333

"mainClass": "A String", # 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.

1334

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.

1335

"A String",

1336

],

1337

"mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'

1338

"jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.

1339

"A String",

1340

],

1341

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

1342

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

1343

"a_key": "A String",

1344

},

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1345

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1346

"properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.

1347

"a_key": "A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1348

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1349

"args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.

1350

"A String",

1351

],

1352

"fileUris": [ # Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.

"A String",

],

},

"placement": { # Dataproc job config. # Required. Job information, including how, when, and where to run the job.

1357

"clusterName": "A String", # Required. The name of the cluster where the job will be submitted.

1358

"clusterUuid": "A String", # Output only. A cluster UUID generated by the Dataproc service when the job is submitted.

1359

},

1360

"status": { # Dataproc job status. # Output only. The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields.

1361

"state": "A String", # Output only. A state message specifying the overall job state.

1362

"details": "A String", # Optional. Output only. Job state details, such as an error description if the state is <code>ERROR</code>.

1363

"stateStartTime": "A String", # Output only. The time when this state was entered.

1364

"substate": "A String", # Output only. Additional state information, which includes status reported by the agent.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

},

}

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1368

updateMask: string, 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 specified as <code>labels</code>, and the PATCH request body would specify the new value. <strong>Note:</strong> Currently, <code>labels</code> is the only field that can be updated.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1369

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1376

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1377

{ # A Dataproc job resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1378

"driverControlFilesUri": "A String", # Output only. If present, the location of miscellaneous 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.

1379

"prestoJob": { # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. # Optional. Job is a Presto job.

1380

"outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats

1381

"continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.

1382

"queryList": { # A list of queries to run on a cluster. # A list of queries.

1383

"queries": [ # 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:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1390

# ]

1391

# }

1392

# }

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1393

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1394

],

1395

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1396

"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.

1397

"clientTags": [ # Optional. Presto client tags to attach to this query

1398

"A String",

1399

],

1400

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

1401

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"properties": { # Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI

1406

"a_key": "A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1407

},

1408

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1409

"scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.

1410

"maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.

1411

},

1412

"pigJob": { # A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Optional. Job is a Pig job.

1413

"continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.

1414

"queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.

1415

"queryList": { # A list of queries to run on a cluster. # A list of queries.

1416

"queries": [ # 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:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.

1430

"A String",

1431

],

1432

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).

1433

"a_key": "A String",

1434

},

1435

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

1436

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the 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.

"a_key": "A String",

},

},

"jobUuid": "A String", # Output only. A UUID that uniquely identifies a job within the project over time. This is in contrast to a user-settable reference.job_id that may be reused over time.

1445

"hiveJob": { # A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Optional. Job is a Hive job.

1446

"continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.

1447

"queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.

1448

"queryList": { # A list of queries to run on a cluster. # A list of queries.

1449

"queries": [ # 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:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.

1463

"A String",

1464

],

1465

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).

1466

"a_key": "A String",

1467

},

1468

"properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.

"a_key": "A String",

},

},

"labels": { # Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.

1473

"a_key": "A String",

1474

},

1475

"done": True or False, # Output only. Indicates whether the job is completed. If the value is false, the job is still in progress. If true, the job is completed, and status.state field will indicate if it was successful, failed, or cancelled.

1476

"driverOutputResourceUri": "A String", # Output only. A URI pointing to the location of the stdout of the job's driver program.

1477

"sparkSqlJob": { # A Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Optional. Job is a SparkSql job.

1478

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).

1479

"a_key": "A String",

1480

},

1481

"jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.

1482

"A String",

1483

],

1484

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

1485

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.

1490

"a_key": "A String",

1491

},

1492

"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.

1493

"queryList": { # A list of queries to run on a cluster. # A list of queries.

1494

"queries": [ # 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:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

},

"sparkJob": { # A Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Optional. Job is a Spark job.

1509

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

1510

"A String",

1511

],

1512

"mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.

1513

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.

1514

"A String",

1515

],

1516

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

1517

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

1522

"a_key": "A String",

1523

},

1524

"args": [ # Optional. The arguments to pass to the driver. 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.

1525

"A String",

1526

],

1527

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.

1528

"A String",

1529

],

1530

"mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.

1531

},

1532

"statusHistory": [ # Output only. The previous job status.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1533

{ # Dataproc job status.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1534

"state": "A String", # Output only. A state message specifying the overall job state.

1535

"details": "A String", # Optional. Output only. Job state details, such as an error description if the state is <code>ERROR</code>.

1536

"stateStartTime": "A String", # Output only. The time when this state was entered.

1537

"substate": "A String", # Output only. Additional state information, which includes status reported by the agent.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1538

},

1539

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1540

"yarnApplications": [ # Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1541

{ # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.Beta Feature: This report is available for testing purposes only. It may be changed before final release.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1542

"progress": 3.14, # Required. The numerical progress of the application, from 1 to 100.

1543

"state": "A String", # Required. The application state.

1544

"name": "A String", # Required. The application name.

1545

"trackingUrl": "A String", # Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1546

},

1547

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1548

"pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Optional. Job is a PySpark job.

1549

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.

1550

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1551

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1552

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

1553

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

1554

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1555

},

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1556

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1557

"properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

1558

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1559

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1560

"args": [ # Optional. The arguments to pass to the driver. 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.

1561

"A String",

1562

],

1563

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.

1564

"A String",

1565

],

1566

"pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.

1567

"A String",

1568

],

1569

"mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.

1570

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.

1571

"A String",

1572

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1573

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1574

"sparkRJob": { # A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Optional. Job is a SparkR job.

1575

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

1576

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

1577

"a_key": "A String",

1578

},

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1579

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1580

"properties": { # Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

1581

"a_key": "A String",

1582

},

1583

"mainRFileUri": "A String", # Required. The HCFS URI of the main R file to use as the driver. Must be a .R file.

1584

"args": [ # Optional. The arguments to pass to the driver. 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.

1585

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1586

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1587

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of R drivers and distributed tasks. Useful for naively parallel tasks.

1588

"A String",

1589

],

1590

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

"A String",

],

},

"reference": { # Encapsulates the full scoping used to reference a job. # Optional. The fully qualified reference to the 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>.

1595

"projectId": "A String", # Required. The ID of the Google Cloud Platform project that the job belongs to.

1596

"jobId": "A String", # Optional. The job ID, which must be unique within the project.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.If not specified by the caller, the job ID will be provided by the server.

1597

},

1598

"hadoopJob": { # A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Optional. Job is a Hadoop job.

1599

"mainClass": "A String", # 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.

1600

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.

1601

"A String",

1602

],

1603

"mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'

1604

"jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.

1605

"A String",

1606

],

1607

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

1608

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

1609

"a_key": "A String",

1610

},

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1611

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1612

"properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.

1613

"a_key": "A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1614

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1615

"args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.

1616

"A String",

1617

],

1618

"fileUris": [ # Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.

"A String",

],

},

"placement": { # Dataproc job config. # Required. Job information, including how, when, and where to run the job.

1623

"clusterName": "A String", # Required. The name of the cluster where the job will be submitted.

1624

"clusterUuid": "A String", # Output only. A cluster UUID generated by the Dataproc service when the job is submitted.

1625

},

1626

"status": { # Dataproc job status. # Output only. The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields.

1627

"state": "A String", # Output only. A state message specifying the overall job state.

1628

"details": "A String", # Optional. Output only. Job state details, such as an error description if the state is <code>ERROR</code>.

1629

"stateStartTime": "A String", # Output only. The time when this state was entered.

1630

"substate": "A String", # Output only. Additional state information, which includes status reported by the agent.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

},

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1636

<code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>

1637

<pre>Sets the access control policy on the specified resource. Replaces any existing policy.Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1638

1639

Args:

1640

resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1641

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1642

The object takes the form of:

1643

1644

{ # Request message for SetIamPolicy method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1645

"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.Optionally, a binding can specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both.JSON example: # REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1646

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1647

# "bindings": [

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1648

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1649

# "role": "roles/resourcemanager.organizationAdmin",

1650

# "members": [

1651

# "user:mike@example.com",

1652

# "group:admins@example.com",

1653

# "domain:google.com",

1654

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1655

# ]

1656

# },

1657

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1658

# "role": "roles/resourcemanager.organizationViewer",

1659

# "members": ["user:eve@example.com"],

1660

# "condition": {

1661

# "title": "expirable access",

1662

# "description": "Does not grant access after Sep 2020",

1663

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1664

# }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1665

# }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1666

# ],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1667

# "etag": "BwWWja0YfJA=",

1668

# "version": 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1669

# }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1670

# YAML example:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1671

# bindings:

1672

# - members:

1673

# - user:mike@example.com

1674

# - group:admins@example.com

1675

# - domain:google.com

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1676

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

1677

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1678

# - members:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1679

# - user:eve@example.com

1680

# role: roles/resourcemanager.organizationViewer

1681

# condition:

1682

# title: expirable access

1683

# description: Does not grant access after Sep 2020

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1684

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1685

# - etag: BwWWja0YfJA=

1686

# - version: 3

1687

# For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1688

"bindings": [ # Associates a list of members to a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one member.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1689

{ # Associates members with a role.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1690

"role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.

1691

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.

1692

# title: "Summary size limit"

1693

# description: "Determines if a summary is less than 100 chars"

1694

# expression: "document.summary.size() < 100"

1695

# Example (Equality):

1696

# title: "Requestor is owner"

1697

# description: "Determines if requestor is the document owner"

1698

# expression: "document.owner == request.auth.claims.email"

1699

# Example (Logic):

1700

# title: "Public documents"

1701

# description: "Determine whether the document should be publicly visible"

1702

# expression: "document.type != 'private' && document.type != 'internal'"

1703

# Example (Data Manipulation):

1704

# title: "Notification string"

1705

# description: "Create a notification string with a timestamp."

1706

# expression: "'New message received at ' + string(document.create_time)"

1707

# The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

1708

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

1709

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

1710

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

1711

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

1712

},

1713

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1714

# allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.

1715

# allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1716

# user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com .

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1717

# serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.

1718

# group:{emailid}: An email address that represents a Google group. For example, admins@example.com.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1719

# deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding.

1720

# deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding.

1721

# deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1722

# domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1723

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1724

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1725

},

1726

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1727

"etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.

1728

"version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1729

# Getting a policy that includes a conditional role binding

1730

# Adding a conditional role binding to a policy

1731

# Changing a conditional role binding in a policy

1732

# Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1743

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1744

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.Optionally, a binding can specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both.JSON example:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1745

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1746

# "bindings": [

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1747

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1748

# "role": "roles/resourcemanager.organizationAdmin",

1749

# "members": [

1750

# "user:mike@example.com",

1751

# "group:admins@example.com",

1752

# "domain:google.com",

1753

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1754

# ]

1755

# },

1756

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1757

# "role": "roles/resourcemanager.organizationViewer",

1758

# "members": ["user:eve@example.com"],

1759

# "condition": {

1760

# "title": "expirable access",

1761

# "description": "Does not grant access after Sep 2020",

1762

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1763

# }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1764

# }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1765

# ],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1766

# "etag": "BwWWja0YfJA=",

1767

# "version": 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1768

# }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1769

# YAML example:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1770

# bindings:

1771

# - members:

1772

# - user:mike@example.com

1773

# - group:admins@example.com

1774

# - domain:google.com

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1775

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

1776

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1777

# - members:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1778

# - user:eve@example.com

1779

# role: roles/resourcemanager.organizationViewer

1780

# condition:

1781

# title: expirable access

1782

# description: Does not grant access after Sep 2020

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1783

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1784

# - etag: BwWWja0YfJA=

1785

# - version: 3

1786

# For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1787

"bindings": [ # Associates a list of members to a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one member.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1788

{ # Associates members with a role.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1789

"role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.

1790

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.

1791

# title: "Summary size limit"

1792

# description: "Determines if a summary is less than 100 chars"

1793

# expression: "document.summary.size() < 100"

1794

# Example (Equality):

1795

# title: "Requestor is owner"

1796

# description: "Determines if requestor is the document owner"

1797

# expression: "document.owner == request.auth.claims.email"

1798

# Example (Logic):

1799

# title: "Public documents"

1800

# description: "Determine whether the document should be publicly visible"

1801

# expression: "document.type != 'private' && document.type != 'internal'"

1802

# Example (Data Manipulation):

1803

# title: "Notification string"

1804

# description: "Create a notification string with a timestamp."

1805

# expression: "'New message received at ' + string(document.create_time)"

1806

# The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

1807

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

1808

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

1809

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

1810

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

1811

},

1812

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1813

# allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.

1814

# allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1815

# user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com .

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1816

# serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.

1817

# group:{emailid}: An email address that represents a Google group. For example, admins@example.com.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1818

# deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding.

1819

# deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding.

1820

# deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1821

# domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1822

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1823

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1824

},

1825

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1826

"etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.

1827

"version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1828

# Getting a policy that includes a conditional role binding

1829

# Adding a conditional role binding to a policy

1830

# Changing a conditional role binding in a policy

1831

# Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1836

<code class="details" id="submit">submit(projectId, region, body=None, x__xgafv=None)</code>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1837

<pre>Submits a job to a cluster.

1838

1839

Args:

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1840

projectId: string, Required. The ID of the Google Cloud Platform project that the job belongs to. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1841

region: string, Required. The Dataproc region in which to handle the request. (required)

1842

body: object, The request body.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1843

The object takes the form of:

1844

1845

{ # A request to submit a job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1846

"job": { # A Dataproc job resource. # Required. The job resource.

1847

"driverControlFilesUri": "A String", # Output only. If present, the location of miscellaneous 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.

1848

"prestoJob": { # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. # Optional. Job is a Presto job.

1849

"outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats

1850

"continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.

1851

"queryList": { # A list of queries to run on a cluster. # A list of queries.

1852

"queries": [ # 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:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1859

# ]

1860

# }

1861

# }

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1862

"A String",

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1863

],

1864

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1865

"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.

1866

"clientTags": [ # Optional. Presto client tags to attach to this query

1867

"A String",

1868

],

1869

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

1870

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"properties": { # Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI

1875

"a_key": "A String",

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1876

},

1877

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1878

"scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.

1879

"maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.

1880

},

1881

"pigJob": { # A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Optional. Job is a Pig job.

1882

"continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.

1883

"queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.

1884

"queryList": { # A list of queries to run on a cluster. # A list of queries.

1885

"queries": [ # 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:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.

1899

"A String",

1900

],

1901

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).

1902

"a_key": "A String",

1903

},

1904

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

1905

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the 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.

"a_key": "A String",

},

},

"jobUuid": "A String", # Output only. A UUID that uniquely identifies a job within the project over time. This is in contrast to a user-settable reference.job_id that may be reused over time.

1914

"hiveJob": { # A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Optional. Job is a Hive job.

1915

"continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.

1916

"queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.

1917

"queryList": { # A list of queries to run on a cluster. # A list of queries.

1918

"queries": [ # 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:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.

1932

"A String",

1933

],

1934

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).

1935

"a_key": "A String",

1936

},

1937

"properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.

"a_key": "A String",

},

},

"labels": { # Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.

1942

"a_key": "A String",

1943

},

1944

"done": True or False, # Output only. Indicates whether the job is completed. If the value is false, the job is still in progress. If true, the job is completed, and status.state field will indicate if it was successful, failed, or cancelled.

1945

"driverOutputResourceUri": "A String", # Output only. A URI pointing to the location of the stdout of the job's driver program.

1946

"sparkSqlJob": { # A Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Optional. Job is a SparkSql job.

1947

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).

1948

"a_key": "A String",

1949

},

1950

"jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.

1951

"A String",

1952

],

1953

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

1954

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.

1959

"a_key": "A String",

1960

},

1961

"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.

1962

"queryList": { # A list of queries to run on a cluster. # A list of queries.

1963

"queries": [ # 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:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

},

"sparkJob": { # A Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Optional. Job is a Spark job.

1978

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

1979

"A String",

1980

],

1981

"mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.

1982

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.

1983

"A String",

1984

],

1985

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

1986

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

1991

"a_key": "A String",

1992

},

1993

"args": [ # Optional. The arguments to pass to the driver. 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.

1994

"A String",

1995

],

1996

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.

1997

"A String",

1998

],

1999

"mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.

2000

},

2001

"statusHistory": [ # Output only. The previous job status.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2002

{ # Dataproc job status.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2003

"state": "A String", # Output only. A state message specifying the overall job state.

2004

"details": "A String", # Optional. Output only. Job state details, such as an error description if the state is <code>ERROR</code>.

2005

"stateStartTime": "A String", # Output only. The time when this state was entered.

2006

"substate": "A String", # Output only. Additional state information, which includes status reported by the agent.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2007

},

2008

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2009

"yarnApplications": [ # Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2010

{ # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.Beta Feature: This report is available for testing purposes only. It may be changed before final release.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2011

"progress": 3.14, # Required. The numerical progress of the application, from 1 to 100.

2012

"state": "A String", # Required. The application state.

2013

"name": "A String", # Required. The application name.

2014

"trackingUrl": "A String", # Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2015

},

2016

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2017

"pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Optional. Job is a PySpark job.

2018

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.

2019

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2020

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2021

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

2022

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

2023

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2024

},

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2025

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2026

"properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

2027

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2028

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2029

"args": [ # Optional. The arguments to pass to the driver. 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.

2030

"A String",

2031

],

2032

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.

2033

"A String",

2034

],

2035

"pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.

2036

"A String",

2037

],

2038

"mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.

2039

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.

2040

"A String",

2041

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2042

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2043

"sparkRJob": { # A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Optional. Job is a SparkR job.

2044

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

2045

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

2046

"a_key": "A String",

2047

},

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2048

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2049

"properties": { # Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

2050

"a_key": "A String",

2051

},

2052

"mainRFileUri": "A String", # Required. The HCFS URI of the main R file to use as the driver. Must be a .R file.

2053

"args": [ # Optional. The arguments to pass to the driver. 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.

2054

"A String",

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2055

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2056

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of R drivers and distributed tasks. Useful for naively parallel tasks.

2057

"A String",

2058

],

2059

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

"A String",

],

},

"reference": { # Encapsulates the full scoping used to reference a job. # Optional. The fully qualified reference to the 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>.

2064

"projectId": "A String", # Required. The ID of the Google Cloud Platform project that the job belongs to.

2065

"jobId": "A String", # Optional. The job ID, which must be unique within the project.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.If not specified by the caller, the job ID will be provided by the server.

2066

},

2067

"hadoopJob": { # A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Optional. Job is a Hadoop job.

2068

"mainClass": "A String", # 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.

2069

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.

2070

"A String",

2071

],

2072

"mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'

2073

"jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.

2074

"A String",

2075

],

2076

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

2077

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

2078

"a_key": "A String",

2079

},

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2080

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2081

"properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.

2082

"a_key": "A String",

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2083

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2084

"args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.

2085

"A String",

2086

],

2087

"fileUris": [ # Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.

"A String",

],

},

"placement": { # Dataproc job config. # Required. Job information, including how, when, and where to run the job.

2092

"clusterName": "A String", # Required. The name of the cluster where the job will be submitted.

2093

"clusterUuid": "A String", # Output only. A cluster UUID generated by the Dataproc service when the job is submitted.

2094

},

2095

"status": { # Dataproc job status. # Output only. The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields.

2096

"state": "A String", # Output only. A state message specifying the overall job state.

2097

"details": "A String", # Optional. Output only. Job state details, such as an error description if the state is <code>ERROR</code>.

2098

"stateStartTime": "A String", # Output only. The time when this state was entered.

2099

"substate": "A String", # Output only. Additional state information, which includes status reported by the agent.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2100

},

2101

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2102

"requestId": "A String", # Optional. A unique id used to identify the request. If the server receives two SubmitJobRequest requests with the same id, then the second request will be ignored and the first Job created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2103

}

2104

2105

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2106

Allowed values

2107

1 - v1 error format

2108

2 - v2 error format

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2109

2110

Returns:

2111

An object of the form:

2112

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2113

{ # A Dataproc job resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2114

"driverControlFilesUri": "A String", # Output only. If present, the location of miscellaneous 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.

2115

"prestoJob": { # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. # Optional. Job is a Presto job.

2116

"outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats

2117

"continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.

2118

"queryList": { # A list of queries to run on a cluster. # A list of queries.

2119

"queries": [ # 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:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2126

# ]

2127

# }

2128

# }

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2129

"A String",

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2130

],

2131

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2132

"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.

2133

"clientTags": [ # Optional. Presto client tags to attach to this query

2134

"A String",

2135

],

2136

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

2137

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"properties": { # Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI

2142

"a_key": "A String",

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2143

},

2144

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2145

"scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.

2146

"maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.

2147

},

2148

"pigJob": { # A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Optional. Job is a Pig job.

2149

"continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.

2150

"queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.

2151

"queryList": { # A list of queries to run on a cluster. # A list of queries.

2152

"queries": [ # 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:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.

2166

"A String",

2167

],

2168

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).

2169

"a_key": "A String",

2170

},

2171

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

2172

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the 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.

"a_key": "A String",

},

},

"jobUuid": "A String", # Output only. A UUID that uniquely identifies a job within the project over time. This is in contrast to a user-settable reference.job_id that may be reused over time.

2181

"hiveJob": { # A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Optional. Job is a Hive job.

2182

"continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.

2183

"queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.

2184

"queryList": { # A list of queries to run on a cluster. # A list of queries.

2185

"queries": [ # 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:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.

2199

"A String",

2200

],

2201

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).

2202

"a_key": "A String",

2203

},

2204

"properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.

"a_key": "A String",

},

},

"labels": { # Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.

2209

"a_key": "A String",

2210

},

2211

"done": True or False, # Output only. Indicates whether the job is completed. If the value is false, the job is still in progress. If true, the job is completed, and status.state field will indicate if it was successful, failed, or cancelled.

2212

"driverOutputResourceUri": "A String", # Output only. A URI pointing to the location of the stdout of the job's driver program.

2213

"sparkSqlJob": { # A Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Optional. Job is a SparkSql job.

2214

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).

2215

"a_key": "A String",

2216

},

2217

"jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.

2218

"A String",

2219

],

2220

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

2221

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.

2226

"a_key": "A String",

2227

},

2228

"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.

2229

"queryList": { # A list of queries to run on a cluster. # A list of queries.

2230

"queries": [ # 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:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

},

"sparkJob": { # A Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Optional. Job is a Spark job.

2245

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

2246

"A String",

2247

],

2248

"mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.

2249

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.

2250

"A String",

2251

],

2252

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

2253

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

2258

"a_key": "A String",

2259

},

2260

"args": [ # Optional. The arguments to pass to the driver. 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.

2261

"A String",

2262

],

2263

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.

2264

"A String",

2265

],

2266

"mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.

2267

},

2268

"statusHistory": [ # Output only. The previous job status.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2269

{ # Dataproc job status.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2270

"state": "A String", # Output only. A state message specifying the overall job state.

2271

"details": "A String", # Optional. Output only. Job state details, such as an error description if the state is <code>ERROR</code>.

2272

"stateStartTime": "A String", # Output only. The time when this state was entered.

2273

"substate": "A String", # Output only. Additional state information, which includes status reported by the agent.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2274

},

2275

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2276

"yarnApplications": [ # Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2277

{ # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.Beta Feature: This report is available for testing purposes only. It may be changed before final release.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2278

"progress": 3.14, # Required. The numerical progress of the application, from 1 to 100.

2279

"state": "A String", # Required. The application state.

2280

"name": "A String", # Required. The application name.

2281

"trackingUrl": "A String", # Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2282

},

2283

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2284

"pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Optional. Job is a PySpark job.

2285

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.

2286

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2287

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2288

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

2289

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

2290

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2291

},

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

2292

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2293

"properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

2294

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2295

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2296

"args": [ # Optional. The arguments to pass to the driver. 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.

2297

"A String",

2298

],

2299

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.

2300

"A String",

2301

],

2302

"pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.

2303

"A String",

2304

],

2305

"mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.

2306

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.

2307

"A String",

2308

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2309

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2310

"sparkRJob": { # A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Optional. Job is a SparkR job.

2311

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

2312

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

2313

"a_key": "A String",

2314

},

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2315

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2316

"properties": { # Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

2317

"a_key": "A String",

2318

},

2319

"mainRFileUri": "A String", # Required. The HCFS URI of the main R file to use as the driver. Must be a .R file.

2320

"args": [ # Optional. The arguments to pass to the driver. 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.

2321

"A String",

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2322

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2323

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of R drivers and distributed tasks. Useful for naively parallel tasks.

2324

"A String",

2325

],

2326

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

"A String",

],

},

"reference": { # Encapsulates the full scoping used to reference a job. # Optional. The fully qualified reference to the 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>.

2331

"projectId": "A String", # Required. The ID of the Google Cloud Platform project that the job belongs to.

2332

"jobId": "A String", # Optional. The job ID, which must be unique within the project.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.If not specified by the caller, the job ID will be provided by the server.

2333

},

2334

"hadoopJob": { # A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Optional. Job is a Hadoop job.

2335

"mainClass": "A String", # 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.

2336

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.

2337

"A String",

2338

],

2339

"mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'

2340

"jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.

2341

"A String",

2342

],

2343

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

2344

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

2345

"a_key": "A String",

2346

},

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2347

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2348

"properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.

2349

"a_key": "A String",

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2350

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2351

"args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.

2352

"A String",

2353

],

2354

"fileUris": [ # Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.

"A String",

],

},

"placement": { # Dataproc job config. # Required. Job information, including how, when, and where to run the job.

2359

"clusterName": "A String", # Required. The name of the cluster where the job will be submitted.

2360

"clusterUuid": "A String", # Output only. A cluster UUID generated by the Dataproc service when the job is submitted.

2361

},

2362

"status": { # Dataproc job status. # Output only. The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields.

2363

"state": "A String", # Output only. A state message specifying the overall job state.

2364

"details": "A String", # Optional. Output only. Job state details, such as an error description if the state is <code>ERROR</code>.

2365

"stateStartTime": "A String", # Output only. The time when this state was entered.

2366

"substate": "A String", # Output only. Additional state information, which includes status reported by the agent.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

},

}</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2371

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2372

<code class="details" id="submitAsOperation">submitAsOperation(projectId, region, body=None, x__xgafv=None)</code>

2373

<pre>Submits job to a cluster.

2374

2375

Args:

2376

projectId: string, Required. The ID of the Google Cloud Platform project that the job belongs to. (required)

2377

region: string, Required. The Dataproc region in which to handle the request. (required)

2378

body: object, The request body.

2379

The object takes the form of:

2380

2381

{ # A request to submit a job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2382

"job": { # A Dataproc job resource. # Required. The job resource.

2383

"driverControlFilesUri": "A String", # Output only. If present, the location of miscellaneous 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.

2384

"prestoJob": { # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. # Optional. Job is a Presto job.

2385

"outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats

2386

"continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.

2387

"queryList": { # A list of queries to run on a cluster. # A list of queries.

2388

"queries": [ # 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:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2395

# ]

2396

# }

2397

# }

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2398

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2399

],

2400

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2401

"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.

2402

"clientTags": [ # Optional. Presto client tags to attach to this query

2403

"A String",

2404

],

2405

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

2406

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"properties": { # Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI

2411

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2412

},

2413

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2414

"scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.

2415

"maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.

2416

},

2417

"pigJob": { # A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Optional. Job is a Pig job.

2418

"continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.

2419

"queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.

2420

"queryList": { # A list of queries to run on a cluster. # A list of queries.

2421

"queries": [ # 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:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.

2435

"A String",

2436

],

2437

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).

2438

"a_key": "A String",

2439

},

2440

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

2441

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the 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.

"a_key": "A String",

},

},

"jobUuid": "A String", # Output only. A UUID that uniquely identifies a job within the project over time. This is in contrast to a user-settable reference.job_id that may be reused over time.

2450

"hiveJob": { # A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Optional. Job is a Hive job.

2451

"continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.

2452

"queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.

2453

"queryList": { # A list of queries to run on a cluster. # A list of queries.

2454

"queries": [ # 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:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.

2468

"A String",

2469

],

2470

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).

2471

"a_key": "A String",

2472

},

2473

"properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.

"a_key": "A String",

},

},

"labels": { # Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.

2478

"a_key": "A String",

2479

},

2480

"done": True or False, # Output only. Indicates whether the job is completed. If the value is false, the job is still in progress. If true, the job is completed, and status.state field will indicate if it was successful, failed, or cancelled.

2481

"driverOutputResourceUri": "A String", # Output only. A URI pointing to the location of the stdout of the job's driver program.

2482

"sparkSqlJob": { # A Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Optional. Job is a SparkSql job.

2483

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).

2484

"a_key": "A String",

2485

},

2486

"jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.

2487

"A String",

2488

],

2489

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

2490

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.

2495

"a_key": "A String",

2496

},

2497

"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.

2498

"queryList": { # A list of queries to run on a cluster. # A list of queries.

2499

"queries": [ # 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:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

},

"sparkJob": { # A Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Optional. Job is a Spark job.

2514

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

2515

"A String",

2516

],

2517

"mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.

2518

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.

2519

"A String",

2520

],

2521

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

2522

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

2527

"a_key": "A String",

2528

},

2529

"args": [ # Optional. The arguments to pass to the driver. 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.

2530

"A String",

2531

],

2532

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.

2533

"A String",

2534

],

2535

"mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.

2536

},

2537

"statusHistory": [ # Output only. The previous job status.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2538

{ # Dataproc job status.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2539

"state": "A String", # Output only. A state message specifying the overall job state.

2540

"details": "A String", # Optional. Output only. Job state details, such as an error description if the state is <code>ERROR</code>.

2541

"stateStartTime": "A String", # Output only. The time when this state was entered.

2542

"substate": "A String", # Output only. Additional state information, which includes status reported by the agent.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2543

},

2544

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2545

"yarnApplications": [ # Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2546

{ # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.Beta Feature: This report is available for testing purposes only. It may be changed before final release.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2547

"progress": 3.14, # Required. The numerical progress of the application, from 1 to 100.

2548

"state": "A String", # Required. The application state.

2549

"name": "A String", # Required. The application name.

2550

"trackingUrl": "A String", # Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2551

},

2552

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2553

"pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Optional. Job is a PySpark job.

2554

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.

2555

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2556

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2557

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

2558

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

2559

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2560

},

2561

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2562

"properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

2563

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2564

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2565

"args": [ # Optional. The arguments to pass to the driver. 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.

2566

"A String",

2567

],

2568

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.

2569

"A String",

2570

],

2571

"pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.

2572

"A String",

2573

],

2574

"mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.

2575

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.

2576

"A String",

2577

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2578

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2579

"sparkRJob": { # A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Optional. Job is a SparkR job.

2580

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

2581

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

2582

"a_key": "A String",

2583

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2584

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2585

"properties": { # Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

2586

"a_key": "A String",

2587

},

2588

"mainRFileUri": "A String", # Required. The HCFS URI of the main R file to use as the driver. Must be a .R file.

2589

"args": [ # Optional. The arguments to pass to the driver. 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.

2590

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2591

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2592

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of R drivers and distributed tasks. Useful for naively parallel tasks.

2593

"A String",

2594

],

2595

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

"A String",

],

},

"reference": { # Encapsulates the full scoping used to reference a job. # Optional. The fully qualified reference to the 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>.

2600

"projectId": "A String", # Required. The ID of the Google Cloud Platform project that the job belongs to.

2601

"jobId": "A String", # Optional. The job ID, which must be unique within the project.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.If not specified by the caller, the job ID will be provided by the server.

2602

},

2603

"hadoopJob": { # A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Optional. Job is a Hadoop job.

2604

"mainClass": "A String", # 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.

2605

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.

2606

"A String",

2607

],

2608

"mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'

2609

"jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.

2610

"A String",

2611

],

2612

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

2613

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

2614

"a_key": "A String",

2615

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2616

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2617

"properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.

2618

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2619

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2620

"args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.

2621

"A String",

2622

],

2623

"fileUris": [ # Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.

"A String",

],

},

"placement": { # Dataproc job config. # Required. Job information, including how, when, and where to run the job.

2628

"clusterName": "A String", # Required. The name of the cluster where the job will be submitted.

2629

"clusterUuid": "A String", # Output only. A cluster UUID generated by the Dataproc service when the job is submitted.

2630

},

2631

"status": { # Dataproc job status. # Output only. The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields.

2632

"state": "A String", # Output only. A state message specifying the overall job state.

2633

"details": "A String", # Optional. Output only. Job state details, such as an error description if the state is <code>ERROR</code>.

2634

"stateStartTime": "A String", # Output only. The time when this state was entered.

2635

"substate": "A String", # Output only. Additional state information, which includes status reported by the agent.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2636

},

2637

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2638

"requestId": "A String", # Optional. A unique id used to identify the request. If the server receives two SubmitJobRequest requests with the same id, then the second request will be ignored and the first Job created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2639

}

2640

2641

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2648

2649

{ # This resource represents a long-running operation that is the result of a network API call.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2650

"done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

2651

"response": { # 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/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

2652

"a_key": "", # Properties of the object. Contains field @type with type URL.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2653

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2654

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

2655

"error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

2656

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2657

"message": "A String", # A developer-facing error message, which should 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.

2658

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2659

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2660

"a_key": "", # Properties of the object. Contains field @type with type URL.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2661

},

2662

],

2663

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2664

"metadata": { # Service-specific metadata associated with the 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.

2665

"a_key": "", # Properties of the object. Contains field @type with type URL.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2666

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2672

<pre>Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2673

2674

Args:

2675

resource: string, REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2676

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2677

The object takes the form of:

2678

2679

{ # Request message for TestIamPermissions method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2680

"permissions": [ # The set of permissions to check for the resource. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview (https://cloud.google.com/iam/docs/overview#permissions).

2681

"A String",

Bu Sun Kim