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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

81

<code><a href="#close">close()</a></code></p>

82

<p class="firstline">Close httplib2 connections.</p>

83

Jon Wayne Parrott

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

[diff] [blame]

84

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

85

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

86

87

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

88

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

89

Bu Sun Kim

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

[diff] [blame]

90

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

91

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

92

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

93

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

Jon Wayne Parrott

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

[diff] [blame]

94

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

95

96

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

97

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

98

Dan O'Meara

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

[diff] [blame]

99

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

100

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

101

Dan O'Meara

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

[diff] [blame]

102

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

103

<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.</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="#submit">submit(projectId, region, body=None, x__xgafv=None)</a></code></p>

Jon Wayne Parrott

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

[diff] [blame]

106

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

Bu Sun Kim

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

[diff] [blame]

107

Dan O'Meara

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

[diff] [blame]

108

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

109

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

110

111

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

112

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

113

<h3>Method Details</h3>

114

Bu Sun Kim

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

[diff] [blame]

115

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

116

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

117

118

Args:

Sai Cheemalapati

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

[diff] [blame]

119

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]

120

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

Sai Cheemalapati

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

[diff] [blame]

121

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

Bu Sun Kim

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

[diff] [blame]

122

body: object, The request body.

Jon Wayne Parrott

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

[diff] [blame]

123

The object takes the form of:

124

125

{ # A request to cancel a job.

126

}

127

128

x__xgafv: string, V1 error format.

Sai Cheemalapati

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

[diff] [blame]

129

Allowed values

130

1 - v1 error format

131

2 - v2 error format

Jon Wayne Parrott

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

[diff] [blame]

132

133

Returns:

134

An object of the form:

135

Dan O'Meara

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

[diff] [blame]

136

{ # A Dataproc job resource.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

137

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

138

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

139

"a_key": "A String",

140

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

141

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

142

"A String",

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

143

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

144

"fileUris": [ # Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

145

"A String",

146

],

147

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

148

"A String",

149

],

150

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

151

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

152

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

},

},

},

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

158

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

159

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

160

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

},

},

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

165

"A String",

166

],

167

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

168

"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

169

"a_key": "A String",

170

},

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 end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }

"A String",

],

},

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

177

},

178

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

179

{ # Dataproc job status.

180

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

181

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

182

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

183

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

184

},

185

],

186

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

187

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

188

"a_key": "A String",

189

},

190

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

191

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

196

"a_key": "A String",

197

},

198

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

199

"queries": [ # Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }

"A String",

],

},

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

204

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

205

"A String",

206

],

207

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

208

},

209

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

210

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

211

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

212

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

213

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

214

},

215

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

216

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

217

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

218

"a_key": "A String",

219

},

220

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

221

"fileUris": [ # Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

222

"A String",

223

],

224

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

225

"A String",

226

],

227

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

228

"A String",

229

],

230

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

231

"A String",

232

],

233

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

234

"A String",

235

],

236

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

237

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

},

},

},

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

243

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

244

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

245

},

246

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

247

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

248

"a_key": "A String",

249

},

250

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

251

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

252

"A String",

253

],

254

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

255

"A String",

256

],

257

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

258

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

},

},

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

263

"A String",

264

],

265

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

266

"A String",

267

],

268

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

269

},

270

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

271

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

272

"a_key": "A String",

273

},

274

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

275

"queries": [ # Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }

"A String",

],

},

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

280

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

281

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

},

},

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

286

"a_key": "A String",

287

},

288

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

"A String",

],

},

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

293

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

294

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

295

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

},

},

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

300

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

301

"A String",

302

],

303

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

304

"A String",

305

],

306

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

307

"A String",

308

],

309

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

310

"a_key": "A String",

311

},

312

"fileUris": [ # Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

313

"A String",

314

],

315

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

316

},

317

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

318

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

319

"maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver exiting 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.

320

},

321

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

322

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

323

"projectId": "A String", # Optional. The ID of the Google Cloud Platform project that the job belongs to. If specified, must match the request project ID.

324

},

325

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

326

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

327

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

328

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

329

"a_key": "A String",

330

},

331

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

332

"a_key": "A String",

333

},

334

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

335

"A String",

336

],

337

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

338

"queries": [ # Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }

"A String",

],

},

},

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

344

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

345

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

346

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

347

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

348

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

349

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

350

},

351

],

352

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

"a_key": "A String",

},

}</pre>

</div>

<code class="details" id="close">close()</code>

360

<pre>Close httplib2 connections.</pre>

Jon Wayne Parrott

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

[diff] [blame]

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

365

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

366

367

Args:

Sai Cheemalapati

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

[diff] [blame]

368

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]

369

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

Sai Cheemalapati

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

[diff] [blame]

370

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

Jon Wayne Parrott

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

[diff] [blame]

371

x__xgafv: string, V1 error format.

Sai Cheemalapati

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

[diff] [blame]

372

Allowed values

373

1 - v1 error format

374

2 - v2 error format

Jon Wayne Parrott

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

[diff] [blame]

375

376

Returns:

377

An object of the form:

378

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

379

{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON 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>

385

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

386

387

Args:

Sai Cheemalapati

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

[diff] [blame]

388

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]

389

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

Sai Cheemalapati

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

[diff] [blame]

390

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

Jon Wayne Parrott

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

[diff] [blame]

391

x__xgafv: string, V1 error format.

Sai Cheemalapati

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

[diff] [blame]

392

Allowed values

393

1 - v1 error format

394

2 - v2 error format

Jon Wayne Parrott

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

[diff] [blame]

395

396

Returns:

397

An object of the form:

398

Dan O'Meara

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

[diff] [blame]

399

{ # A Dataproc job resource.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

400

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

401

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

402

"a_key": "A String",

403

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

404

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

405

"A String",

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

406

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

407

"fileUris": [ # Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

408

"A String",

409

],

410

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

411

"A String",

412

],

413

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

414

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

415

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

},

},

},

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

421

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

422

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

423

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

},

},

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

428

"A String",

429

],

430

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

431

"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

432

"a_key": "A String",

433

},

434

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

435

"queries": [ # Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }

"A String",

],

},

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

440

},

441

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

442

{ # Dataproc job status.

443

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

444

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

445

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

446

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

447

},

448

],

449

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

450

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

451

"a_key": "A String",

452

},

453

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

454

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

459

"a_key": "A String",

460

},

461

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

462

"queries": [ # Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }

"A String",

],

},

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

467

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

468

"A String",

469

],

470

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

471

},

472

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

473

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

474

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

475

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

476

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

477

},

478

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

479

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

480

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

481

"a_key": "A String",

482

},

483

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

484

"fileUris": [ # Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

485

"A String",

486

],

487

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

488

"A String",

489

],

490

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

491

"A String",

492

],

493

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

494

"A String",

495

],

496

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

497

"A String",

498

],

499

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

500

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

},

},

},

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

506

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

507

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

508

},

509

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

510

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

511

"a_key": "A String",

512

},

513

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

514

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

515

"A String",

516

],

517

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

518

"A String",

519

],

520

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

521

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

},

},

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

526

"A String",

527

],

528

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

529

"A String",

530

],

531

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

532

},

533

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

534

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

535

"a_key": "A String",

536

},

537

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

538

"queries": [ # Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }

"A String",

],

},

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

543

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

544

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

},

},

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

549

"a_key": "A String",

550

},

551

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

"A String",

],

},

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

556

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

557

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

558

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

},

},

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

563

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

564

"A String",

565

],

566

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

567

"A String",

568

],

569

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

570

"A String",

571

],

572

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

573

"a_key": "A String",

574

},

575

"fileUris": [ # Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

576

"A String",

577

],

578

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

579

},

580

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

581

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

582

"maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver exiting 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.

583

},

584

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

585

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

586

"projectId": "A String", # Optional. The ID of the Google Cloud Platform project that the job belongs to. If specified, must match the request project ID.

587

},

588

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

589

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

590

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

591

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

592

"a_key": "A String",

593

},

594

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

595

"a_key": "A String",

596

},

597

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

598

"A String",

599

],

600

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

601

"queries": [ # Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }

"A String",

],

},

},

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

607

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

608

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

609

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

610

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

611

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

612

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

613

},

614

],

615

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

616

"a_key": "A String",

617

},

618

}</pre>

Jon Wayne Parrott

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

622

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

623

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

624

625

Args:

626

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

627

body: object, The request body.

628

The object takes the form of:

629

630

{ # Request message for GetIamPolicy method.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

631

"options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy.

632

"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.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

Dan O'Meara

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

[diff] [blame]

633

},

Bu Sun Kim

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

[diff] [blame]

634

}

635

636

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

643

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

644

{ # 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.For some types of Google Cloud resources, a binding can also 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. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 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]

645

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

646

{ # Associates members with a role.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

647

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

648

"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): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

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

[diff] [blame]

649

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

650

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

651

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

652

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

Bu Sun Kim

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

[diff] [blame]

653

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

654

"bindingId": "A String", # A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.

655

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. 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. 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. 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. 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]

656

"A String",

Bu Sun Kim

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

[diff] [blame]

657

],

Bu Sun Kim

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

[diff] [blame]

658

},

659

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

660

"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: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy 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.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

661

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

666

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

Jon Wayne Parrott

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

[diff] [blame]

667

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

668

669

Args:

Sai Cheemalapati

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

[diff] [blame]

670

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]

671

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

672

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

673

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

Bu Sun Kim

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

[diff] [blame]

674

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

675

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

676

Allowed values

677

ALL - Match all jobs, regardless of state.

678

ACTIVE - Only match jobs in non-terminal states: PENDING, RUNNING, or CANCEL_PENDING.

679

NON_ACTIVE - Only match jobs in terminal states: CANCELLED, DONE, or ERROR.

680

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 = *

Jon Wayne Parrott

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

[diff] [blame]

681

x__xgafv: string, V1 error format.

Sai Cheemalapati

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

[diff] [blame]

682

Allowed values

683

1 - v1 error format

684

2 - v2 error format

Jon Wayne Parrott

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

[diff] [blame]

685

686

Returns:

687

An object of the form:

688

689

{ # A list of jobs in a project.

Bu Sun Kim

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

[diff] [blame]

690

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

Dan O'Meara

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

[diff] [blame]

691

{ # A Dataproc job resource.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

692

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

693

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

694

"a_key": "A String",

695

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

696

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

697

"A String",

698

],

699

"fileUris": [ # Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

700

"A String",

701

],

702

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

703

"A String",

704

],

705

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

706

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

707

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

708

"a_key": "A String",

709

},

710

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

711

},

712

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

713

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

714

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

715

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

716

"a_key": "A String",

717

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

718

},

719

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

720

"A String",

721

],

722

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

723

"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

724

"a_key": "A String",

725

},

726

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

727

"queries": [ # Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

728

"A String",

729

],

730

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

731

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

732

},

733

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

734

{ # Dataproc job status.

735

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

736

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

737

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

738

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

739

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

740

],

741

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

742

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

743

"a_key": "A String",

744

},

745

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

746

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

747

"a_key": "A String",

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

748

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

749

},

750

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

751

"a_key": "A String",

752

},

753

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

754

"queries": [ # Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

755

"A String",

756

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

757

},

758

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

759

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

760

"A String",

761

],

762

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

763

},

764

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

765

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

766

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

767

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

768

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

769

},

770

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

771

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

772

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

773

"a_key": "A String",

774

},

775

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

776

"fileUris": [ # Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

777

"A String",

778

],

779

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

780

"A String",

781

],

782

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

783

"A String",

784

],

785

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

786

"A String",

787

],

788

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

789

"A String",

790

],

791

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

792

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

793

"a_key": "A String",

794

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

795

},

796

},

797

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

798

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

799

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

800

},

801

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

802

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

803

"a_key": "A String",

804

},

805

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

806

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

807

"A String",

808

],

809

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

810

"A String",

811

],

812

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

813

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

814

"a_key": "A String",

815

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

816

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

817

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

818

"A String",

819

],

820

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

821

"A String",

822

],

823

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

824

},

825

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

826

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

827

"a_key": "A String",

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

828

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

829

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

830

"queries": [ # Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }

"A String",

],

},

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

835

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

836

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

837

"a_key": "A String",

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

838

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

839

},

840

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

841

"a_key": "A String",

842

},

843

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

844

"A String",

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

845

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

846

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

847

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

848

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

849

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

850

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

},

},

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

855

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

856

"A String",

857

],

858

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

859

"A String",

860

],

861

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

862

"A String",

863

],

864

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

865

"a_key": "A String",

866

},

867

"fileUris": [ # Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

868

"A String",

869

],

870

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

871

},

872

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

873

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

874

"maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver exiting 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.

875

},

876

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

877

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

878

"projectId": "A String", # Optional. The ID of the Google Cloud Platform project that the job belongs to. If specified, must match the request project ID.

879

},

880

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

881

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

882

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

883

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

884

"a_key": "A String",

885

},

886

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

887

"a_key": "A String",

888

},

889

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

890

"A String",

891

],

892

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

893

"queries": [ # Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }

"A String",

],

},

},

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

899

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

900

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

901

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

902

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

903

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

904

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

905

},

906

],

907

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

908

"a_key": "A String",

909

},

910

},

Jon Wayne Parrott

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

[diff] [blame]

911

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

912

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

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>

918

<pre>Retrieves the next page of results.

919

920

Args:

921

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

922

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

923

924

Returns:

Bu Sun Kim

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

[diff] [blame]

925

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]

926

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]

931

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

932

<pre>Updates a job in a project.

933

934

Args:

Sai Cheemalapati

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

[diff] [blame]

935

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]

936

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

Sai Cheemalapati

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

[diff] [blame]

937

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

Dan O'Meara

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

[diff] [blame]

938

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

939

The object takes the form of:

940

Dan O'Meara

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

[diff] [blame]

941

{ # A Dataproc job resource.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

942

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

943

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

944

"a_key": "A String",

945

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

946

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

947

"A String",

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

948

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

949

"fileUris": [ # Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

950

"A String",

951

],

952

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

953

"A String",

954

],

955

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

956

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

957

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

},

},

},

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

963

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

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

},

},

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

970

"A String",

971

],

972

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

973

"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

974

"a_key": "A String",

975

},

976

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

977

"queries": [ # Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }

"A String",

],

},

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

982

},

983

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

984

{ # Dataproc job status.

985

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

986

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

987

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

988

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

989

},

990

],

991

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

992

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

993

"a_key": "A String",

994

},

995

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

996

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

1001

"a_key": "A String",

1002

},

1003

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

1004

"queries": [ # Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }

"A String",

],

},

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

1009

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

1010

"A String",

1011

],

1012

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

1013

},

1014

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

1015

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

1016

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

1017

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

1018

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

1019

},

1020

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

1021

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

1022

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

1023

"a_key": "A String",

1024

},

1025

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

1026

"fileUris": [ # Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

1027

"A String",

1028

],

1029

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

1030

"A String",

1031

],

1032

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

1033

"A String",

1034

],

1035

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

1036

"A String",

1037

],

1038

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

1039

"A String",

1040

],

1041

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

1042

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

},

},

},

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

1048

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

1049

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

1050

},

1051

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

1052

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

1053

"a_key": "A String",

1054

},

1055

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

1056

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

1057

"A String",

1058

],

1059

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

1060

"A String",

1061

],

1062

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

1063

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

},

},

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

1068

"A String",

1069

],

1070

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

1071

"A String",

1072

],

1073

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

1074

},

1075

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

1076

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

1077

"a_key": "A String",

1078

},

1079

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

1080

"queries": [ # Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }

"A String",

],

},

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

1085

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

1086

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

},

},

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

1091

"a_key": "A String",

1092

},

1093

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

"A String",

],

},

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

1098

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

1099

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

1100

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

},

},

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

1105

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

1106

"A String",

1107

],

1108

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

1109

"A String",

1110

],

1111

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

1112

"A String",

1113

],

1114

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

1115

"a_key": "A String",

1116

},

1117

"fileUris": [ # Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

1118

"A String",

1119

],

1120

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

1121

},

1122

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

1123

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

1124

"maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver exiting 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.

1125

},

1126

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

1127

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

1128

"projectId": "A String", # Optional. The ID of the Google Cloud Platform project that the job belongs to. If specified, must match the request project ID.

1129

},

1130

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

1131

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

1132

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

1133

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

1134

"a_key": "A String",

1135

},

1136

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

1137

"a_key": "A String",

1138

},

1139

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

1140

"A String",

1141

],

1142

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

1143

"queries": [ # Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }

"A String",

],

},

},

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

1149

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

1150

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

1151

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

1152

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

1153

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

1154

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

1155

},

1156

],

1157

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

1158

"a_key": "A String",

1159

},

1160

}

Sai Cheemalapati

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

[diff] [blame]

1161

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1162

updateMask: string, Required. Specifies the path, relative to Job, of the field to update. For example, to update the labels of a Job the update_mask parameter would be specified as labels, and the PATCH request body would specify the new value. *Note:* Currently, labels is the only field that can be updated.

Sai Cheemalapati

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

[diff] [blame]

1163

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1170

Dan O'Meara

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

[diff] [blame]

1171

{ # A Dataproc job resource.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1172

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

1173

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1174

"a_key": "A String",

1175

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1176

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

1177

"A String",

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1178

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1179

"fileUris": [ # Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

1180

"A String",

1181

],

1182

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

1183

"A String",

1184

],

1185

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

1186

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

1187

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

},

},

},

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

1193

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

1194

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

1195

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

},

},

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

1200

"A String",

1201

],

1202

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

1203

"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

1204

"a_key": "A String",

1205

},

1206

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

1207

"queries": [ # Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }

"A String",

],

},

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

1212

},

1213

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

1214

{ # Dataproc job status.

1215

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

1216

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

1217

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

1218

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

1219

},

1220

],

1221

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

1222

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

1223

"a_key": "A String",

1224

},

1225

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

1226

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

1231

"a_key": "A String",

1232

},

1233

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

1234

"queries": [ # Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }

"A String",

],

},

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

1239

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

1240

"A String",

1241

],

1242

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

1243

},

1244

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

1245

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

1246

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

1247

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

1248

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

1249

},

1250

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

1251

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

1252

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

1253

"a_key": "A String",

1254

},

1255

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

1256

"fileUris": [ # Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

1257

"A String",

1258

],

1259

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

1260

"A String",

1261

],

1262

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

1263

"A String",

1264

],

1265

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

1266

"A String",

1267

],

1268

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

1269

"A String",

1270

],

1271

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

1272

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

},

},

},

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

1278

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

1279

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

1280

},

1281

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

1282

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

1283

"a_key": "A String",

1284

},

1285

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

1286

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

1287

"A String",

1288

],

1289

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

1290

"A String",

1291

],

1292

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

1293

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

},

},

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

1298

"A String",

1299

],

1300

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

1301

"A String",

1302

],

1303

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

1304

},

1305

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

1306

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

1307

"a_key": "A String",

1308

},

1309

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

1310

"queries": [ # Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }

"A String",

],

},

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

1315

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

1316

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

},

},

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

1321

"a_key": "A String",

1322

},

1323

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

"A String",

],

},

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

1328

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

1329

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

1330

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

},

},

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

1335

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

1336

"A String",

1337

],

1338

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

1339

"A String",

1340

],

1341

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

1342

"A String",

1343

],

1344

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

1345

"a_key": "A String",

1346

},

1347

"fileUris": [ # Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

1348

"A String",

1349

],

1350

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

1351

},

1352

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

1353

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

1354

"maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver exiting 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.

1355

},

1356

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

1357

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

1358

"projectId": "A String", # Optional. The ID of the Google Cloud Platform project that the job belongs to. If specified, must match the request project ID.

1359

},

1360

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

1361

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

1362

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

1363

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

1364

"a_key": "A String",

1365

},

1366

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

1367

"a_key": "A String",

1368

},

1369

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

1370

"A String",

1371

],

1372

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

1373

"queries": [ # Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }

"A String",

],

},

},

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

1379

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

1380

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

1381

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

1382

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

1383

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

1384

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

1385

},

1386

],

1387

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

1388

"a_key": "A String",

1389

},

1390

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

1394

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1395

<pre>Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Bu Sun Kim

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

[diff] [blame]

1396

1397

Args:

1398

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]

1399

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1400

The object takes the form of:

1401

1402

{ # Request message for SetIamPolicy method.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1403

"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.For some types of Google Cloud resources, a binding can also 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. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/). # 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

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

[diff] [blame]

1404

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

1405

{ # Associates members with a role.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1406

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

1407

"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): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

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

[diff] [blame]

1408

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1409

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

1410

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

1411

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

Bu Sun Kim

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

[diff] [blame]

1412

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1413

"bindingId": "A String", # A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.

1414

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. 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. 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. 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. 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]

1415

"A String",

Bu Sun Kim

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

[diff] [blame]

1416

],

Bu Sun Kim

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

[diff] [blame]

1417

},

1418

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1419

"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: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy 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.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

1420

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

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:

1431

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1432

{ # 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.For some types of Google Cloud resources, a binding can also 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. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 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]

1433

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

1434

{ # Associates members with a role.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1435

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

1436

"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): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

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

[diff] [blame]

1437

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1438

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

1439

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

1440

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

Bu Sun Kim

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

[diff] [blame]

1441

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1442

"bindingId": "A String", # A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.

1443

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. 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. 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. 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. 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]

1444

"A String",

Bu Sun Kim

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

[diff] [blame]

1445

],

Bu Sun Kim

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

[diff] [blame]

1446

},

1447

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1448

"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: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy 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.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

1449

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

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]

1454

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

1455

<pre>Submits a job to a cluster.

1456

1457

Args:

Sai Cheemalapati

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

[diff] [blame]

1458

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]

1459

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

1460

body: object, The request body.

Jon Wayne Parrott

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

[diff] [blame]

1461

The object takes the form of:

1462

1463

{ # A request to submit a job.

Bu Sun Kim

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

[diff] [blame]

1464

"job": { # A Dataproc job resource. # Required. The job resource.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1465

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

1466

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1467

"a_key": "A String",

1468

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1469

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

1470

"A String",

1471

],

1472

"fileUris": [ # Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

1473

"A String",

1474

],

1475

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

1476

"A String",

1477

],

1478

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

1479

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

1480

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1481

"a_key": "A String",

1482

},

1483

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1484

},

1485

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

1486

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

1487

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

1488

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1489

"a_key": "A String",

1490

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1491

},

1492

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

1493

"A String",

1494

],

1495

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

1496

"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

1497

"a_key": "A String",

1498

},

1499

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

1500

"queries": [ # Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1501

"A String",

1502

],

1503

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1504

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

1505

},

1506

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

1507

{ # Dataproc job status.

1508

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

1509

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

1510

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

1511

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1512

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1513

],

1514

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

1515

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

1516

"a_key": "A String",

1517

},

1518

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

1519

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

1520

"a_key": "A String",

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1521

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1522

},

1523

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

1524

"a_key": "A String",

1525

},

1526

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

1527

"queries": [ # Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1528

"A String",

1529

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1530

},

1531

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

1532

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

1533

"A String",

1534

],

1535

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

1536

},

1537

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

1538

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

1539

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

1540

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

1541

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

1542

},

1543

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

1544

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

1545

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

1546

"a_key": "A String",

1547

},

1548

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

1549

"fileUris": [ # Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

1550

"A String",

1551

],

1552

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

1553

"A String",

1554

],

1555

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

1556

"A String",

1557

],

1558

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

1559

"A String",

1560

],

1561

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

1562

"A String",

1563

],

1564

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

1565

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1566

"a_key": "A String",

1567

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1568

},

1569

},

1570

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

1571

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

1572

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

1573

},

1574

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

1575

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

1576

"a_key": "A String",

1577

},

1578

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

1579

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

1580

"A String",

1581

],

1582

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

1583

"A String",

1584

],

1585

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

1586

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1587

"a_key": "A String",

1588

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1589

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1590

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

1591

"A String",

1592

],

1593

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

1594

"A String",

1595

],

1596

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

1597

},

1598

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

1599

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

1600

"a_key": "A String",

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1601

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1602

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

1603

"queries": [ # Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }

"A String",

],

},

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

1608

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

1609

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

1610

"a_key": "A String",

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1611

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1612

},

1613

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

1614

"a_key": "A String",

1615

},

1616

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

1617

"A String",

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1618

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1619

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1620

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

1621

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

1622

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

1623

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

},

},

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

1628

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

1629

"A String",

1630

],

1631

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

1632

"A String",

1633

],

1634

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

1635

"A String",

1636

],

1637

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

1638

"a_key": "A String",

1639

},

1640

"fileUris": [ # Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

1641

"A String",

1642

],

1643

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

1644

},

1645

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

1646

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

1647

"maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver exiting 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.

1648

},

1649

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

1650

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

1651

"projectId": "A String", # Optional. The ID of the Google Cloud Platform project that the job belongs to. If specified, must match the request project ID.

1652

},

1653

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

1654

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

1655

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

1656

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

1657

"a_key": "A String",

1658

},

1659

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

1660

"a_key": "A String",

1661

},

1662

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

1663

"A String",

1664

],

1665

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

1666

"queries": [ # Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }

"A String",

],

},

},

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

1672

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

1673

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

1674

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

1675

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

1676

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

1677

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

1678

},

1679

],

1680

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

"a_key": "A String",

},

},

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

1685

}

1686

1687

x__xgafv: string, V1 error format.

Sai Cheemalapati

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

[diff] [blame]

1688

Allowed values

1689

1 - v1 error format

1690

2 - v2 error format

Jon Wayne Parrott

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

[diff] [blame]

1691

1692

Returns:

1693

An object of the form:

1694

Dan O'Meara

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

[diff] [blame]

1695

{ # A Dataproc job resource.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1696

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

1697

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1698

"a_key": "A String",

1699

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1700

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

1701

"A String",

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1702

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1703

"fileUris": [ # Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

1704

"A String",

1705

],

1706

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

1707

"A String",

1708

],

1709

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

1710

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

1711

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

},

},

},

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

1717

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

1718

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

1719

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

},

},

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

1724

"A String",

1725

],

1726

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

1727

"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

1728

"a_key": "A String",

1729

},

1730

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

1731

"queries": [ # Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }

"A String",

],

},

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

1736

},

1737

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

1738

{ # Dataproc job status.

1739

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

1740

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

1741

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

1742

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

1743

},

1744

],

1745

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

1746

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

1747

"a_key": "A String",

1748

},

1749

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

1750

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

1755

"a_key": "A String",

1756

},

1757

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

1758

"queries": [ # Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }

"A String",

],

},

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

1763

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

1764

"A String",

1765

],

1766

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

1767

},

1768

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

1769

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

1770

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

1771

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

1772

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

1773

},

1774

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

1775

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

1776

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

1777

"a_key": "A String",

1778

},

1779

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

1780

"fileUris": [ # Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

1781

"A String",

1782

],

1783

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

1784

"A String",

1785

],

1786

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

1787

"A String",

1788

],

1789

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

1790

"A String",

1791

],

1792

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

1793

"A String",

1794

],

1795

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

1796

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

},

},

},

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

1802

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

1803

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

1804

},

1805

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

1806

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

1807

"a_key": "A String",

1808

},

1809

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

1810

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

1811

"A String",

1812

],

1813

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

1814

"A String",

1815

],

1816

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

1817

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

},

},

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

1822

"A String",

1823

],

1824

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

1825

"A String",

1826

],

1827

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

1828

},

1829

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

1830

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

1831

"a_key": "A String",

1832

},

1833

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

1834

"queries": [ # Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }

"A String",

],

},

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

1839

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

1840

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

},

},

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

1845

"a_key": "A String",

1846

},

1847

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

"A String",

],

},

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

1852

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

1853

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

1854

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

},

},

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

1859

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

1860

"A String",

1861

],

1862

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

1863

"A String",

1864

],

1865

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

1866

"A String",

1867

],

1868

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

1869

"a_key": "A String",

1870

},

1871

"fileUris": [ # Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

1872

"A String",

1873

],

1874

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

1875

},

1876

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

1877

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

1878

"maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver exiting 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.

1879

},

1880

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

1881

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

1882

"projectId": "A String", # Optional. The ID of the Google Cloud Platform project that the job belongs to. If specified, must match the request project ID.

1883

},

1884

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

1885

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

1886

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

1887

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

1888

"a_key": "A String",

1889

},

1890

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

1891

"a_key": "A String",

1892

},

1893

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

1894

"A String",

1895

],

1896

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

1897

"queries": [ # Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }

"A String",

],

},

},

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

1903

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

1904

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

1905

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

1906

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

1907

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

1908

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

1909

},

1910

],

1911

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

1912

"a_key": "A String",

1913

},

1914

}</pre>

Jon Wayne Parrott

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

[diff] [blame]

1915

</div>

1916

Bu Sun Kim

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

[diff] [blame]

1917

Dan O'Meara

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

[diff] [blame]

1918

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

1919

<pre>Submits job to a cluster.

1920

1921

Args:

1922

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

1923

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

1924

body: object, The request body.

1925

The object takes the form of:

1926

1927

{ # A request to submit a job.

Bu Sun Kim

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

[diff] [blame]

1928

"job": { # A Dataproc job resource. # Required. The job resource.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1929

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

1930

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1931

"a_key": "A String",

1932

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1933

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

1934

"A String",

1935

],

1936

"fileUris": [ # Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

1937

"A String",

1938

],

1939

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

1940

"A String",

1941

],

1942

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

1943

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

1944

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1945

"a_key": "A String",

1946

},

1947

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1948

},

1949

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

1950

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

1951

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

1952

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1953

"a_key": "A String",

1954

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1955

},

1956

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

1957

"A String",

1958

],

1959

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

1960

"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

1961

"a_key": "A String",

1962

},

1963

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

1964

"queries": [ # Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1965

"A String",

1966

],

1967

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1968

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

1969

},

1970

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

1971

{ # Dataproc job status.

1972

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

1973

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

1974

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

1975

"substate": "A String", # Output only. Additional state information, which includes status reported by the agent.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1976

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1977

],

1978

"pigJob": { # A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Optional. Job is a Pig job.

1979

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).

1980

"a_key": "A String",

1981

},

1982

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

1983

"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'

1984

"a_key": "A String",

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1985

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1986

},

1987

"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.

1988

"a_key": "A String",

1989

},

1990

"queryList": { # A list of queries to run on a cluster. # A list of queries.

1991

"queries": [ # Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1992

"A String",

1993

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1994

},

1995

"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.

1996

"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.

1997

"A String",

1998

],

1999

"queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.

2000

},

2001

"status": { # Dataproc job status. # Output only. The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.

2002

"state": "A String", # Output only. A state message specifying the overall job state.

2003

"details": "A String", # Optional. Output only. Job state details, such as an error description if the state is ERROR.

2004

"stateStartTime": "A String", # Output only. The time when this state was entered.

2005

"substate": "A String", # Output only. Additional state information, which includes status reported by the agent.

2006

},

2007

"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.

2008

"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.

2009

"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.

2010

"a_key": "A String",

2011

},

2012

"mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.

2013

"fileUris": [ # Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

2014

"A String",

2015

],

2016

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

2017

"A String",

2018

],

2019

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.

2020

"A String",

2021

],

2022

"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.

2023

"A String",

2024

],

2025

"pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.

2026

"A String",

2027

],

2028

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

2029

"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'

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2030

"a_key": "A String",

2031

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2032

},

2033

},

2034

"placement": { # Dataproc job config. # Required. Job information, including how, when, and where to run the job.

2035

"clusterName": "A String", # Required. The name of the cluster where the job will be submitted.

2036

"clusterUuid": "A String", # Output only. A cluster UUID generated by the Dataproc service when the job is submitted.

2037

},

2038

"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.

2039

"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.

2040

"a_key": "A String",

2041

},

2042

"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'

2043

"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.

2044

"A String",

2045

],

2046

"jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.

2047

"A String",

2048

],

2049

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

2050

"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'

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2051

"a_key": "A String",

2052

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2053

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2054

"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.

2055

"A String",

2056

],

2057

"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.

2058

"A String",

2059

],

2060

"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.

2061

},

2062

"sparkSqlJob": { # A Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Optional. Job is a SparkSql job.

2063

"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.

2064

"a_key": "A String",

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2065

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2066

"queryList": { # A list of queries to run on a cluster. # A list of queries.

2067

"queries": [ # Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }

"A String",

],

},

"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.

2072

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

2073

"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'

2074

"a_key": "A String",

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2075

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2076

},

2077

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).

2078

"a_key": "A String",

2079

},

2080

"jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.

2081

"A String",

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2082

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2083

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2084

"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.

2085

"sparkJob": { # A Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Optional. Job is a Spark job.

2086

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

2087

"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",

},

},

"mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.

2092

"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.

2093

"A String",

2094

],

2095

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

2096

"A String",

2097

],

2098

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.

2099

"A String",

2100

],

2101

"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.

2102

"a_key": "A String",

2103

},

2104

"fileUris": [ # Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

2105

"A String",

2106

],

2107

"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.

2108

},

2109

"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.

2110

"scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.

2111

"maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver exiting 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.

2112

},

2113

"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 job_id.

2114

"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.

2115

"projectId": "A String", # Optional. The ID of the Google Cloud Platform project that the job belongs to. If specified, must match the request project ID.

2116

},

2117

"hiveJob": { # A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Optional. Job is a Hive job.

2118

"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.

2119

"queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.

2120

"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.

2121

"a_key": "A String",

2122

},

2123

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).

2124

"a_key": "A String",

2125

},

2126

"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.

2127

"A String",

2128

],

2129

"queryList": { # A list of queries to run on a cluster. # A list of queries.

2130

"queries": [ # Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }

"A String",

],

},

},

"driverOutputResourceUri": "A String", # Output only. A URI pointing to the location of the stdout of the job's driver program.

2136

"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.

2137

{ # A YARN application created by a job. Application information is a subset of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.Beta Feature: This report is available for testing purposes only. It may be changed before final release.

2138

"name": "A String", # Required. The application name.

2139

"state": "A String", # Required. The application state.

2140

"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.

2141

"progress": 3.14, # Required. The numerical progress of the application, from 1 to 100.

2142

},

2143

],

2144

"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.

"a_key": "A String",

},

},

"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]

2149

}

2150

2151

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2158

2159

{ # This resource represents a long-running operation that is the result of a network API call.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2160

"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.

2161

"a_key": "", # Properties of the object. Contains field @type with type URL.

2162

},

2163

"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.

2164

"a_key": "", # Properties of the object. Contains field @type with type URL.

2165

},

2166

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2167

"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.

2168

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

2169

{

2170

"a_key": "", # Properties of the object. Contains field @type with type URL.

2171

},

2172

],

2173

"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.

2174

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2175

},

2176

"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}.

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]

2182

<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]

2183

2184

Args:

2185

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]

2186

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2187

The object takes the form of:

2188

2189

{ # Request message for TestIamPermissions method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2190

"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).

2191

"A String",

Bu Sun Kim