1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="dataproc_v1beta2.html">Cloud Dataproc API</a> . <a href="dataproc_v1beta2.projects.html">projects</a> . <a href="dataproc_v1beta2.projects.regions.html">regions</a> . <a href="dataproc_v1beta2.projects.regions.jobs.html">jobs</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#cancel">cancel(projectId, region, jobId, body=None, x__xgafv=None)</a></code></p> 79<p class="firstline">Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(projectId, region, jobId, x__xgafv=None)</a></code></p> 82<p class="firstline">Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(projectId, region, jobId, x__xgafv=None)</a></code></p> 85<p class="firstline">Gets the resource representation for a job in a project.</p> 86<p class="toc_element"> 87 <code><a href="#getIamPolicy">getIamPolicy(resource, x__xgafv=None)</a></code></p> 88<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(projectId, region, pageSize=None, x__xgafv=None, jobStateMatcher=None, pageToken=None, clusterName=None, filter=None)</a></code></p> 91<p class="firstline">Lists regions/{region}/jobs in a project.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<p class="toc_element"> 96 <code><a href="#patch">patch(projectId, region, jobId, body, updateMask=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Updates a job in a project.</p> 98<p class="toc_element"> 99 <code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p> 100<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p> 101<p class="toc_element"> 102 <code><a href="#submit">submit(projectId, region, body, x__xgafv=None)</a></code></p> 103<p class="firstline">Submits a job to a cluster.</p> 104<p class="toc_element"> 105 <code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p> 106<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> 107<h3>Method Details</h3> 108<div class="method"> 109 <code class="details" id="cancel">cancel(projectId, region, jobId, body=None, x__xgafv=None)</code> 110 <pre>Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get. 111 112Args: 113 projectId: string, Required. The ID of the Google Cloud Platform project that the job belongs to. (required) 114 region: string, Required. The Cloud Dataproc region in which to handle the request. (required) 115 jobId: string, Required. The job ID. (required) 116 body: object, The request body. 117 The object takes the form of: 118 119{ # A request to cancel a job. 120 } 121 122 x__xgafv: string, V1 error format. 123 Allowed values 124 1 - v1 error format 125 2 - v2 error format 126 127Returns: 128 An object of the form: 129 130 { # A Cloud Dataproc job resource. 131 "status": { # Cloud Dataproc job status. # Output only. The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields. 132 "state": "A String", # Output only. A state message specifying the overall job state. 133 "stateStartTime": "A String", # Output only. The time when this state was entered. 134 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent. 135 "details": "A String", # Output only. Optional job state details, such as an error description if the state is <code>ERROR</code>. 136 }, 137 "hadoopJob": { # A Cloud 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). # Job is a Hadoop job. 138 "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. 139 "A String", 140 ], 141 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 142 "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' 143 "a_key": "A String", 144 }, 145 }, 146 "jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks. 147 "A String", 148 ], 149 "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. 150 "A String", 151 ], 152 "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. 153 "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. 154 "A String", 155 ], 156 "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' 157 "properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code. 158 "a_key": "A String", 159 }, 160 }, 161 "pigJob": { # A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Job is a Pig job. 162 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries. 163 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]). 164 "a_key": "A String", 165 }, 166 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 167 "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' 168 "a_key": "A String", 169 }, 170 }, 171 "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. 172 "A String", 173 ], 174 "queryList": { # A list of queries to run on a cluster. # A list of queries. 175 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: 176 # "hiveJob": { 177 # "queryList": { 178 # "queries": [ 179 # "query1", 180 # "query2", 181 # "query3;query4", 182 # ] 183 # } 184 # } 185 "A String", 186 ], 187 }, 188 "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. 189 "properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code. 190 "a_key": "A String", 191 }, 192 }, 193 "placement": { # Cloud Dataproc job config. # Required. Job information, including how, when, and where to run the job. 194 "clusterName": "A String", # Required. The name of the cluster where the job will be submitted. 195 "clusterUuid": "A String", # Output only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted. 196 }, 197 "sparkRJob": { # A Cloud Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Job is a SparkR job. 198 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 199 "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' 200 "a_key": "A String", 201 }, 202 }, 203 "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. 204 "A String", 205 ], 206 "mainRFileUri": "A String", # Required. The HCFS URI of the main R file to use as the driver. Must be a .R file. 207 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of R drivers and distributed tasks. Useful for naively parallel tasks. 208 "A String", 209 ], 210 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip. 211 "A String", 212 ], 213 "properties": { # Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. 214 "a_key": "A String", 215 }, 216 }, 217 "reference": { # Encapsulates the full scoping used to reference a job. # Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>. 218 "projectId": "A String", # Required. The ID of the Google Cloud Platform project that the job belongs to. 219 "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. 220 }, 221 "sparkSqlJob": { # A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Job is a SparkSql job. 222 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries. 223 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";). 224 "a_key": "A String", 225 }, 226 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 227 "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' 228 "a_key": "A String", 229 }, 230 }, 231 "jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH. 232 "A String", 233 ], 234 "queryList": { # A list of queries to run on a cluster. # A list of queries. 235 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: 236 # "hiveJob": { 237 # "queryList": { 238 # "queries": [ 239 # "query1", 240 # "query2", 241 # "query3;query4", 242 # ] 243 # } 244 # } 245 "A String", 246 ], 247 }, 248 "properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. 249 "a_key": "A String", 250 }, 251 }, 252 "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. 253 { # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.Beta Feature: This report is available for testing purposes only. It may be changed before final release. 254 "progress": 3.14, # Required. The numerical progress of the application, from 1 to 100. 255 "state": "A String", # Required. The application state. 256 "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. 257 "name": "A String", # Required. The application name. 258 }, 259 ], 260 "submittedBy": "A String", # Output only. The email address of the user submitting the job. For jobs submitted on the cluster, the address is <code>username@hostname</code>. 261 "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. 262 "pysparkJob": { # A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Job is a Pyspark job. 263 "mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file. 264 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks. 265 "A String", 266 ], 267 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 268 "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' 269 "a_key": "A String", 270 }, 271 }, 272 "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. 273 "A String", 274 ], 275 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks. 276 "A String", 277 ], 278 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip. 279 "A String", 280 ], 281 "pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip. 282 "A String", 283 ], 284 "properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. 285 "a_key": "A String", 286 }, 287 }, 288 "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. 289 "a_key": "A String", 290 }, 291 "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. 292 "sparkJob": { # A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Job is a Spark job. 293 "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. 294 "A String", 295 ], 296 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 297 "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' 298 "a_key": "A String", 299 }, 300 }, 301 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks. 302 "A String", 303 ], 304 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks. 305 "A String", 306 ], 307 "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. 308 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip. 309 "A String", 310 ], 311 "mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class. 312 "properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. 313 "a_key": "A String", 314 }, 315 }, 316 "driverOutputResourceUri": "A String", # Output only. A URI pointing to the location of the stdout of the job's driver program. 317 "prestoJob": { # A Cloud Dataproc job for running Presto (https://prestosql.io/) queries # Job is a Presto job 318 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries. 319 "outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats 320 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 321 "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' 322 "a_key": "A String", 323 }, 324 }, 325 "clientTags": [ # Optional. Presto client tags to attach to this query 326 "A String", 327 ], 328 "queryList": { # A list of queries to run on a cluster. # A list of queries. 329 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: 330 # "hiveJob": { 331 # "queryList": { 332 # "queries": [ 333 # "query1", 334 # "query2", 335 # "query3;query4", 336 # ] 337 # } 338 # } 339 "A String", 340 ], 341 }, 342 "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. 343 "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 344 "a_key": "A String", 345 }, 346 }, 347 "scheduling": { # Job scheduling options. # Optional. Job scheduling configuration. 348 "maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10. 349 }, 350 "statusHistory": [ # Output only. The previous job status. 351 { # Cloud Dataproc job status. 352 "state": "A String", # Output only. A state message specifying the overall job state. 353 "stateStartTime": "A String", # Output only. The time when this state was entered. 354 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent. 355 "details": "A String", # Output only. Optional job state details, such as an error description if the state is <code>ERROR</code>. 356 }, 357 ], 358 "hiveJob": { # A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Job is a Hive job. 359 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries. 360 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";). 361 "a_key": "A String", 362 }, 363 "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. 364 "A String", 365 ], 366 "queryList": { # A list of queries to run on a cluster. # A list of queries. 367 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: 368 # "hiveJob": { 369 # "queryList": { 370 # "queries": [ 371 # "query1", 372 # "query2", 373 # "query3;query4", 374 # ] 375 # } 376 # } 377 "A String", 378 ], 379 }, 380 "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. 381 "properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code. 382 "a_key": "A String", 383 }, 384 }, 385 }</pre> 386</div> 387 388<div class="method"> 389 <code class="details" id="delete">delete(projectId, region, jobId, x__xgafv=None)</code> 390 <pre>Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION. 391 392Args: 393 projectId: string, Required. The ID of the Google Cloud Platform project that the job belongs to. (required) 394 region: string, Required. The Cloud Dataproc region in which to handle the request. (required) 395 jobId: string, Required. The job ID. (required) 396 x__xgafv: string, V1 error format. 397 Allowed values 398 1 - v1 error format 399 2 - v2 error format 400 401Returns: 402 An object of the form: 403 404 { # 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: 405 # service Foo { 406 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 407 # } 408 # The JSON representation for Empty is empty JSON object {}. 409 }</pre> 410</div> 411 412<div class="method"> 413 <code class="details" id="get">get(projectId, region, jobId, x__xgafv=None)</code> 414 <pre>Gets the resource representation for a job in a project. 415 416Args: 417 projectId: string, Required. The ID of the Google Cloud Platform project that the job belongs to. (required) 418 region: string, Required. The Cloud Dataproc region in which to handle the request. (required) 419 jobId: string, Required. The job ID. (required) 420 x__xgafv: string, V1 error format. 421 Allowed values 422 1 - v1 error format 423 2 - v2 error format 424 425Returns: 426 An object of the form: 427 428 { # A Cloud Dataproc job resource. 429 "status": { # Cloud Dataproc job status. # Output only. The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields. 430 "state": "A String", # Output only. A state message specifying the overall job state. 431 "stateStartTime": "A String", # Output only. The time when this state was entered. 432 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent. 433 "details": "A String", # Output only. Optional job state details, such as an error description if the state is <code>ERROR</code>. 434 }, 435 "hadoopJob": { # A Cloud 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). # Job is a Hadoop job. 436 "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. 437 "A String", 438 ], 439 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 440 "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' 441 "a_key": "A String", 442 }, 443 }, 444 "jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks. 445 "A String", 446 ], 447 "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. 448 "A String", 449 ], 450 "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. 451 "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. 452 "A String", 453 ], 454 "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' 455 "properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code. 456 "a_key": "A String", 457 }, 458 }, 459 "pigJob": { # A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Job is a Pig job. 460 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries. 461 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]). 462 "a_key": "A String", 463 }, 464 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 465 "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' 466 "a_key": "A String", 467 }, 468 }, 469 "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. 470 "A String", 471 ], 472 "queryList": { # A list of queries to run on a cluster. # A list of queries. 473 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: 474 # "hiveJob": { 475 # "queryList": { 476 # "queries": [ 477 # "query1", 478 # "query2", 479 # "query3;query4", 480 # ] 481 # } 482 # } 483 "A String", 484 ], 485 }, 486 "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. 487 "properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code. 488 "a_key": "A String", 489 }, 490 }, 491 "placement": { # Cloud Dataproc job config. # Required. Job information, including how, when, and where to run the job. 492 "clusterName": "A String", # Required. The name of the cluster where the job will be submitted. 493 "clusterUuid": "A String", # Output only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted. 494 }, 495 "sparkRJob": { # A Cloud Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Job is a SparkR job. 496 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 497 "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' 498 "a_key": "A String", 499 }, 500 }, 501 "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. 502 "A String", 503 ], 504 "mainRFileUri": "A String", # Required. The HCFS URI of the main R file to use as the driver. Must be a .R file. 505 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of R drivers and distributed tasks. Useful for naively parallel tasks. 506 "A String", 507 ], 508 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip. 509 "A String", 510 ], 511 "properties": { # Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. 512 "a_key": "A String", 513 }, 514 }, 515 "reference": { # Encapsulates the full scoping used to reference a job. # Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>. 516 "projectId": "A String", # Required. The ID of the Google Cloud Platform project that the job belongs to. 517 "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. 518 }, 519 "sparkSqlJob": { # A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Job is a SparkSql job. 520 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries. 521 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";). 522 "a_key": "A String", 523 }, 524 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 525 "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' 526 "a_key": "A String", 527 }, 528 }, 529 "jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH. 530 "A String", 531 ], 532 "queryList": { # A list of queries to run on a cluster. # A list of queries. 533 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: 534 # "hiveJob": { 535 # "queryList": { 536 # "queries": [ 537 # "query1", 538 # "query2", 539 # "query3;query4", 540 # ] 541 # } 542 # } 543 "A String", 544 ], 545 }, 546 "properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. 547 "a_key": "A String", 548 }, 549 }, 550 "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. 551 { # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.Beta Feature: This report is available for testing purposes only. It may be changed before final release. 552 "progress": 3.14, # Required. The numerical progress of the application, from 1 to 100. 553 "state": "A String", # Required. The application state. 554 "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. 555 "name": "A String", # Required. The application name. 556 }, 557 ], 558 "submittedBy": "A String", # Output only. The email address of the user submitting the job. For jobs submitted on the cluster, the address is <code>username@hostname</code>. 559 "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. 560 "pysparkJob": { # A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Job is a Pyspark job. 561 "mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file. 562 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks. 563 "A String", 564 ], 565 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 566 "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' 567 "a_key": "A String", 568 }, 569 }, 570 "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. 571 "A String", 572 ], 573 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks. 574 "A String", 575 ], 576 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip. 577 "A String", 578 ], 579 "pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip. 580 "A String", 581 ], 582 "properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. 583 "a_key": "A String", 584 }, 585 }, 586 "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. 587 "a_key": "A String", 588 }, 589 "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. 590 "sparkJob": { # A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Job is a Spark job. 591 "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. 592 "A String", 593 ], 594 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 595 "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' 596 "a_key": "A String", 597 }, 598 }, 599 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks. 600 "A String", 601 ], 602 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks. 603 "A String", 604 ], 605 "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. 606 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip. 607 "A String", 608 ], 609 "mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class. 610 "properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. 611 "a_key": "A String", 612 }, 613 }, 614 "driverOutputResourceUri": "A String", # Output only. A URI pointing to the location of the stdout of the job's driver program. 615 "prestoJob": { # A Cloud Dataproc job for running Presto (https://prestosql.io/) queries # Job is a Presto job 616 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries. 617 "outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats 618 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 619 "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' 620 "a_key": "A String", 621 }, 622 }, 623 "clientTags": [ # Optional. Presto client tags to attach to this query 624 "A String", 625 ], 626 "queryList": { # A list of queries to run on a cluster. # A list of queries. 627 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: 628 # "hiveJob": { 629 # "queryList": { 630 # "queries": [ 631 # "query1", 632 # "query2", 633 # "query3;query4", 634 # ] 635 # } 636 # } 637 "A String", 638 ], 639 }, 640 "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. 641 "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 642 "a_key": "A String", 643 }, 644 }, 645 "scheduling": { # Job scheduling options. # Optional. Job scheduling configuration. 646 "maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10. 647 }, 648 "statusHistory": [ # Output only. The previous job status. 649 { # Cloud Dataproc job status. 650 "state": "A String", # Output only. A state message specifying the overall job state. 651 "stateStartTime": "A String", # Output only. The time when this state was entered. 652 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent. 653 "details": "A String", # Output only. Optional job state details, such as an error description if the state is <code>ERROR</code>. 654 }, 655 ], 656 "hiveJob": { # A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Job is a Hive job. 657 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries. 658 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";). 659 "a_key": "A String", 660 }, 661 "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. 662 "A String", 663 ], 664 "queryList": { # A list of queries to run on a cluster. # A list of queries. 665 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: 666 # "hiveJob": { 667 # "queryList": { 668 # "queries": [ 669 # "query1", 670 # "query2", 671 # "query3;query4", 672 # ] 673 # } 674 # } 675 "A String", 676 ], 677 }, 678 "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. 679 "properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code. 680 "a_key": "A String", 681 }, 682 }, 683 }</pre> 684</div> 685 686<div class="method"> 687 <code class="details" id="getIamPolicy">getIamPolicy(resource, x__xgafv=None)</code> 688 <pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. 689 690Args: 691 resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required) 692 x__xgafv: string, V1 error format. 693 Allowed values 694 1 - v1 error format 695 2 - v2 error format 696 697Returns: 698 An object of the form: 699 700 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.A Policy consists of a list of bindings. A binding binds a list of members to a role, where the members can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM.JSON Example 701 # { 702 # "bindings": [ 703 # { 704 # "role": "roles/owner", 705 # "members": [ 706 # "user:mike@example.com", 707 # "group:admins@example.com", 708 # "domain:google.com", 709 # "serviceAccount:my-other-app@appspot.gserviceaccount.com" 710 # ] 711 # }, 712 # { 713 # "role": "roles/viewer", 714 # "members": ["user:sean@example.com"] 715 # } 716 # ] 717 # } 718 # YAML Example 719 # bindings: 720 # - members: 721 # - user:mike@example.com 722 # - group:admins@example.com 723 # - domain:google.com 724 # - serviceAccount:my-other-app@appspot.gserviceaccount.com 725 # role: roles/owner 726 # - members: 727 # - user:sean@example.com 728 # role: roles/viewer 729 # For a description of IAM and its features, see the IAM developer's guide (https://cloud.google.com/iam/docs). 730 "bindings": [ # Associates a list of members to a role. bindings with no members will result in an error. 731 { # Associates members with a role. 732 "role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner. 733 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values: 734 # allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. 735 # allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. 736 # user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com . 737 # serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com. 738 # group:{emailid}: An email address that represents a Google group. For example, admins@example.com. 739 # domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. 740 "A String", 741 ], 742 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. 743 # title: "User account presence" 744 # description: "Determines whether the request has a user account" 745 # expression: "size(request.user) > 0" 746 "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 747 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.The application context of the containing message determines which well-known feature set of CEL is supported. 748 "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 749 "title": "A String", # An 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. 750 }, 751 }, 752 ], 753 "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.If no etag is provided in the call to setIamPolicy, then the existing policy is overwritten blindly. 754 "version": 42, # Deprecated. 755 }</pre> 756</div> 757 758<div class="method"> 759 <code class="details" id="list">list(projectId, region, pageSize=None, x__xgafv=None, jobStateMatcher=None, pageToken=None, clusterName=None, filter=None)</code> 760 <pre>Lists regions/{region}/jobs in a project. 761 762Args: 763 projectId: string, Required. The ID of the Google Cloud Platform project that the job belongs to. (required) 764 region: string, Required. The Cloud Dataproc region in which to handle the request. (required) 765 pageSize: integer, Optional. The number of results to return in each response. 766 x__xgafv: string, V1 error format. 767 Allowed values 768 1 - v1 error format 769 2 - v2 error format 770 jobStateMatcher: string, Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs).If filter is provided, jobStateMatcher will be ignored. 771 pageToken: string, Optional. The page token, returned by a previous call, to request the next page of results. 772 clusterName: string, Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster. 773 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 = * 774 775Returns: 776 An object of the form: 777 778 { # A list of jobs in a project. 779 "nextPageToken": "A String", # Optional. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent <code>ListJobsRequest</code>. 780 "jobs": [ # Output only. Jobs list. 781 { # A Cloud Dataproc job resource. 782 "status": { # Cloud Dataproc job status. # Output only. The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields. 783 "state": "A String", # Output only. A state message specifying the overall job state. 784 "stateStartTime": "A String", # Output only. The time when this state was entered. 785 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent. 786 "details": "A String", # Output only. Optional job state details, such as an error description if the state is <code>ERROR</code>. 787 }, 788 "hadoopJob": { # A Cloud 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). # Job is a Hadoop job. 789 "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. 790 "A String", 791 ], 792 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 793 "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' 794 "a_key": "A String", 795 }, 796 }, 797 "jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks. 798 "A String", 799 ], 800 "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. 801 "A String", 802 ], 803 "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. 804 "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. 805 "A String", 806 ], 807 "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' 808 "properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code. 809 "a_key": "A String", 810 }, 811 }, 812 "pigJob": { # A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Job is a Pig job. 813 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries. 814 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]). 815 "a_key": "A String", 816 }, 817 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 818 "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' 819 "a_key": "A String", 820 }, 821 }, 822 "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. 823 "A String", 824 ], 825 "queryList": { # A list of queries to run on a cluster. # A list of queries. 826 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: 827 # "hiveJob": { 828 # "queryList": { 829 # "queries": [ 830 # "query1", 831 # "query2", 832 # "query3;query4", 833 # ] 834 # } 835 # } 836 "A String", 837 ], 838 }, 839 "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. 840 "properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code. 841 "a_key": "A String", 842 }, 843 }, 844 "placement": { # Cloud Dataproc job config. # Required. Job information, including how, when, and where to run the job. 845 "clusterName": "A String", # Required. The name of the cluster where the job will be submitted. 846 "clusterUuid": "A String", # Output only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted. 847 }, 848 "sparkRJob": { # A Cloud Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Job is a SparkR 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' 851 "a_key": "A String", 852 }, 853 }, 854 "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. 855 "A String", 856 ], 857 "mainRFileUri": "A String", # Required. The HCFS URI of the main R file to use as the driver. Must be a .R file. 858 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of R drivers and distributed tasks. Useful for naively parallel tasks. 859 "A String", 860 ], 861 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip. 862 "A String", 863 ], 864 "properties": { # Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. 865 "a_key": "A String", 866 }, 867 }, 868 "reference": { # Encapsulates the full scoping used to reference a job. # Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>. 869 "projectId": "A String", # Required. The ID of the Google Cloud Platform project that the job belongs to. 870 "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. 871 }, 872 "sparkSqlJob": { # A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Job is a SparkSql job. 873 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries. 874 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";). 875 "a_key": "A String", 876 }, 877 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 878 "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' 879 "a_key": "A String", 880 }, 881 }, 882 "jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH. 883 "A String", 884 ], 885 "queryList": { # A list of queries to run on a cluster. # A list of queries. 886 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: 887 # "hiveJob": { 888 # "queryList": { 889 # "queries": [ 890 # "query1", 891 # "query2", 892 # "query3;query4", 893 # ] 894 # } 895 # } 896 "A String", 897 ], 898 }, 899 "properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. 900 "a_key": "A String", 901 }, 902 }, 903 "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. 904 { # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.Beta Feature: This report is available for testing purposes only. It may be changed before final release. 905 "progress": 3.14, # Required. The numerical progress of the application, from 1 to 100. 906 "state": "A String", # Required. The application state. 907 "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. 908 "name": "A String", # Required. The application name. 909 }, 910 ], 911 "submittedBy": "A String", # Output only. The email address of the user submitting the job. For jobs submitted on the cluster, the address is <code>username@hostname</code>. 912 "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. 913 "pysparkJob": { # A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Job is a Pyspark job. 914 "mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file. 915 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks. 916 "A String", 917 ], 918 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 919 "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' 920 "a_key": "A String", 921 }, 922 }, 923 "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. 924 "A String", 925 ], 926 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks. 927 "A String", 928 ], 929 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip. 930 "A String", 931 ], 932 "pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip. 933 "A String", 934 ], 935 "properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. 936 "a_key": "A String", 937 }, 938 }, 939 "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. 940 "a_key": "A String", 941 }, 942 "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. 943 "sparkJob": { # A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Job is a Spark job. 944 "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. 945 "A String", 946 ], 947 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 948 "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' 949 "a_key": "A String", 950 }, 951 }, 952 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks. 953 "A String", 954 ], 955 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks. 956 "A String", 957 ], 958 "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. 959 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip. 960 "A String", 961 ], 962 "mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class. 963 "properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. 964 "a_key": "A String", 965 }, 966 }, 967 "driverOutputResourceUri": "A String", # Output only. A URI pointing to the location of the stdout of the job's driver program. 968 "prestoJob": { # A Cloud Dataproc job for running Presto (https://prestosql.io/) queries # Job is a Presto job 969 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries. 970 "outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats 971 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 972 "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' 973 "a_key": "A String", 974 }, 975 }, 976 "clientTags": [ # Optional. Presto client tags to attach to this query 977 "A String", 978 ], 979 "queryList": { # A list of queries to run on a cluster. # A list of queries. 980 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: 981 # "hiveJob": { 982 # "queryList": { 983 # "queries": [ 984 # "query1", 985 # "query2", 986 # "query3;query4", 987 # ] 988 # } 989 # } 990 "A String", 991 ], 992 }, 993 "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. 994 "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 995 "a_key": "A String", 996 }, 997 }, 998 "scheduling": { # Job scheduling options. # Optional. Job scheduling configuration. 999 "maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10. 1000 }, 1001 "statusHistory": [ # Output only. The previous job status. 1002 { # Cloud Dataproc job status. 1003 "state": "A String", # Output only. A state message specifying the overall job state. 1004 "stateStartTime": "A String", # Output only. The time when this state was entered. 1005 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent. 1006 "details": "A String", # Output only. Optional job state details, such as an error description if the state is <code>ERROR</code>. 1007 }, 1008 ], 1009 "hiveJob": { # A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Job is a Hive job. 1010 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries. 1011 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";). 1012 "a_key": "A String", 1013 }, 1014 "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. 1015 "A String", 1016 ], 1017 "queryList": { # A list of queries to run on a cluster. # A list of queries. 1018 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: 1019 # "hiveJob": { 1020 # "queryList": { 1021 # "queries": [ 1022 # "query1", 1023 # "query2", 1024 # "query3;query4", 1025 # ] 1026 # } 1027 # } 1028 "A String", 1029 ], 1030 }, 1031 "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. 1032 "properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code. 1033 "a_key": "A String", 1034 }, 1035 }, 1036 }, 1037 ], 1038 }</pre> 1039</div> 1040 1041<div class="method"> 1042 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 1043 <pre>Retrieves the next page of results. 1044 1045Args: 1046 previous_request: The request for the previous page. (required) 1047 previous_response: The response from the request for the previous page. (required) 1048 1049Returns: 1050 A request object that you can call 'execute()' on to request the next 1051 page. Returns None if there are no more items in the collection. 1052 </pre> 1053</div> 1054 1055<div class="method"> 1056 <code class="details" id="patch">patch(projectId, region, jobId, body, updateMask=None, x__xgafv=None)</code> 1057 <pre>Updates a job in a project. 1058 1059Args: 1060 projectId: string, Required. The ID of the Google Cloud Platform project that the job belongs to. (required) 1061 region: string, Required. The Cloud Dataproc region in which to handle the request. (required) 1062 jobId: string, Required. The job ID. (required) 1063 body: object, The request body. (required) 1064 The object takes the form of: 1065 1066{ # A Cloud Dataproc job resource. 1067 "status": { # Cloud Dataproc job status. # Output only. The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields. 1068 "state": "A String", # Output only. A state message specifying the overall job state. 1069 "stateStartTime": "A String", # Output only. The time when this state was entered. 1070 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent. 1071 "details": "A String", # Output only. Optional job state details, such as an error description if the state is <code>ERROR</code>. 1072 }, 1073 "hadoopJob": { # A Cloud 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). # Job is a Hadoop job. 1074 "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. 1075 "A String", 1076 ], 1077 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 1078 "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' 1079 "a_key": "A String", 1080 }, 1081 }, 1082 "jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks. 1083 "A String", 1084 ], 1085 "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. 1086 "A String", 1087 ], 1088 "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. 1089 "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. 1090 "A String", 1091 ], 1092 "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' 1093 "properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code. 1094 "a_key": "A String", 1095 }, 1096 }, 1097 "pigJob": { # A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Job is a Pig job. 1098 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries. 1099 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]). 1100 "a_key": "A String", 1101 }, 1102 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 1103 "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' 1104 "a_key": "A String", 1105 }, 1106 }, 1107 "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. 1108 "A String", 1109 ], 1110 "queryList": { # A list of queries to run on a cluster. # A list of queries. 1111 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: 1112 # "hiveJob": { 1113 # "queryList": { 1114 # "queries": [ 1115 # "query1", 1116 # "query2", 1117 # "query3;query4", 1118 # ] 1119 # } 1120 # } 1121 "A String", 1122 ], 1123 }, 1124 "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. 1125 "properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code. 1126 "a_key": "A String", 1127 }, 1128 }, 1129 "placement": { # Cloud Dataproc job config. # Required. Job information, including how, when, and where to run the job. 1130 "clusterName": "A String", # Required. The name of the cluster where the job will be submitted. 1131 "clusterUuid": "A String", # Output only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted. 1132 }, 1133 "sparkRJob": { # A Cloud Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Job is a SparkR job. 1134 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 1135 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG' 1136 "a_key": "A String", 1137 }, 1138 }, 1139 "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. 1140 "A String", 1141 ], 1142 "mainRFileUri": "A String", # Required. The HCFS URI of the main R file to use as the driver. Must be a .R file. 1143 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of R drivers and distributed tasks. Useful for naively parallel tasks. 1144 "A String", 1145 ], 1146 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip. 1147 "A String", 1148 ], 1149 "properties": { # Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. 1150 "a_key": "A String", 1151 }, 1152 }, 1153 "reference": { # Encapsulates the full scoping used to reference a job. # Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>. 1154 "projectId": "A String", # Required. The ID of the Google Cloud Platform project that the job belongs to. 1155 "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. 1156 }, 1157 "sparkSqlJob": { # A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Job is a SparkSql job. 1158 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries. 1159 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";). 1160 "a_key": "A String", 1161 }, 1162 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 1163 "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' 1164 "a_key": "A String", 1165 }, 1166 }, 1167 "jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH. 1168 "A String", 1169 ], 1170 "queryList": { # A list of queries to run on a cluster. # A list of queries. 1171 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: 1172 # "hiveJob": { 1173 # "queryList": { 1174 # "queries": [ 1175 # "query1", 1176 # "query2", 1177 # "query3;query4", 1178 # ] 1179 # } 1180 # } 1181 "A String", 1182 ], 1183 }, 1184 "properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. 1185 "a_key": "A String", 1186 }, 1187 }, 1188 "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. 1189 { # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.Beta Feature: This report is available for testing purposes only. It may be changed before final release. 1190 "progress": 3.14, # Required. The numerical progress of the application, from 1 to 100. 1191 "state": "A String", # Required. The application state. 1192 "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. 1193 "name": "A String", # Required. The application name. 1194 }, 1195 ], 1196 "submittedBy": "A String", # Output only. The email address of the user submitting the job. For jobs submitted on the cluster, the address is <code>username@hostname</code>. 1197 "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. 1198 "pysparkJob": { # A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Job is a Pyspark job. 1199 "mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file. 1200 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks. 1201 "A String", 1202 ], 1203 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 1204 "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' 1205 "a_key": "A String", 1206 }, 1207 }, 1208 "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. 1209 "A String", 1210 ], 1211 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks. 1212 "A String", 1213 ], 1214 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip. 1215 "A String", 1216 ], 1217 "pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip. 1218 "A String", 1219 ], 1220 "properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. 1221 "a_key": "A String", 1222 }, 1223 }, 1224 "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. 1225 "a_key": "A String", 1226 }, 1227 "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. 1228 "sparkJob": { # A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Job is a Spark job. 1229 "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. 1230 "A String", 1231 ], 1232 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 1233 "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' 1234 "a_key": "A String", 1235 }, 1236 }, 1237 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks. 1238 "A String", 1239 ], 1240 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks. 1241 "A String", 1242 ], 1243 "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. 1244 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip. 1245 "A String", 1246 ], 1247 "mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class. 1248 "properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. 1249 "a_key": "A String", 1250 }, 1251 }, 1252 "driverOutputResourceUri": "A String", # Output only. A URI pointing to the location of the stdout of the job's driver program. 1253 "prestoJob": { # A Cloud Dataproc job for running Presto (https://prestosql.io/) queries # Job is a Presto job 1254 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries. 1255 "outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats 1256 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 1257 "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' 1258 "a_key": "A String", 1259 }, 1260 }, 1261 "clientTags": [ # Optional. Presto client tags to attach to this query 1262 "A String", 1263 ], 1264 "queryList": { # A list of queries to run on a cluster. # A list of queries. 1265 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: 1266 # "hiveJob": { 1267 # "queryList": { 1268 # "queries": [ 1269 # "query1", 1270 # "query2", 1271 # "query3;query4", 1272 # ] 1273 # } 1274 # } 1275 "A String", 1276 ], 1277 }, 1278 "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. 1279 "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 1280 "a_key": "A String", 1281 }, 1282 }, 1283 "scheduling": { # Job scheduling options. # Optional. Job scheduling configuration. 1284 "maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10. 1285 }, 1286 "statusHistory": [ # Output only. The previous job status. 1287 { # Cloud Dataproc job status. 1288 "state": "A String", # Output only. A state message specifying the overall job state. 1289 "stateStartTime": "A String", # Output only. The time when this state was entered. 1290 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent. 1291 "details": "A String", # Output only. Optional job state details, such as an error description if the state is <code>ERROR</code>. 1292 }, 1293 ], 1294 "hiveJob": { # A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Job is a Hive job. 1295 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries. 1296 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";). 1297 "a_key": "A String", 1298 }, 1299 "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. 1300 "A String", 1301 ], 1302 "queryList": { # A list of queries to run on a cluster. # A list of queries. 1303 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: 1304 # "hiveJob": { 1305 # "queryList": { 1306 # "queries": [ 1307 # "query1", 1308 # "query2", 1309 # "query3;query4", 1310 # ] 1311 # } 1312 # } 1313 "A String", 1314 ], 1315 }, 1316 "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. 1317 "properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code. 1318 "a_key": "A String", 1319 }, 1320 }, 1321} 1322 1323 updateMask: string, Required. Specifies the path, relative to <code>Job</code>, of the field to update. For example, to update the labels of a Job the <code>update_mask</code> parameter would be specified as <code>labels</code>, and the PATCH request body would specify the new value. <strong>Note:</strong> Currently, <code>labels</code> is the only field that can be updated. 1324 x__xgafv: string, V1 error format. 1325 Allowed values 1326 1 - v1 error format 1327 2 - v2 error format 1328 1329Returns: 1330 An object of the form: 1331 1332 { # A Cloud Dataproc job resource. 1333 "status": { # Cloud Dataproc job status. # Output only. The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields. 1334 "state": "A String", # Output only. A state message specifying the overall job state. 1335 "stateStartTime": "A String", # Output only. The time when this state was entered. 1336 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent. 1337 "details": "A String", # Output only. Optional job state details, such as an error description if the state is <code>ERROR</code>. 1338 }, 1339 "hadoopJob": { # A Cloud 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). # Job is a Hadoop job. 1340 "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. 1341 "A String", 1342 ], 1343 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 1344 "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' 1345 "a_key": "A String", 1346 }, 1347 }, 1348 "jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks. 1349 "A String", 1350 ], 1351 "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. 1352 "A String", 1353 ], 1354 "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. 1355 "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. 1356 "A String", 1357 ], 1358 "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' 1359 "properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code. 1360 "a_key": "A String", 1361 }, 1362 }, 1363 "pigJob": { # A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Job is a Pig job. 1364 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries. 1365 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]). 1366 "a_key": "A String", 1367 }, 1368 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 1369 "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' 1370 "a_key": "A String", 1371 }, 1372 }, 1373 "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. 1374 "A String", 1375 ], 1376 "queryList": { # A list of queries to run on a cluster. # A list of queries. 1377 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: 1378 # "hiveJob": { 1379 # "queryList": { 1380 # "queries": [ 1381 # "query1", 1382 # "query2", 1383 # "query3;query4", 1384 # ] 1385 # } 1386 # } 1387 "A String", 1388 ], 1389 }, 1390 "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. 1391 "properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code. 1392 "a_key": "A String", 1393 }, 1394 }, 1395 "placement": { # Cloud Dataproc job config. # Required. Job information, including how, when, and where to run the job. 1396 "clusterName": "A String", # Required. The name of the cluster where the job will be submitted. 1397 "clusterUuid": "A String", # Output only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted. 1398 }, 1399 "sparkRJob": { # A Cloud Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Job is a SparkR job. 1400 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 1401 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG' 1402 "a_key": "A String", 1403 }, 1404 }, 1405 "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. 1406 "A String", 1407 ], 1408 "mainRFileUri": "A String", # Required. The HCFS URI of the main R file to use as the driver. Must be a .R file. 1409 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of R drivers and distributed tasks. Useful for naively parallel tasks. 1410 "A String", 1411 ], 1412 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip. 1413 "A String", 1414 ], 1415 "properties": { # Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. 1416 "a_key": "A String", 1417 }, 1418 }, 1419 "reference": { # Encapsulates the full scoping used to reference a job. # Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>. 1420 "projectId": "A String", # Required. The ID of the Google Cloud Platform project that the job belongs to. 1421 "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. 1422 }, 1423 "sparkSqlJob": { # A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Job is a SparkSql job. 1424 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries. 1425 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";). 1426 "a_key": "A String", 1427 }, 1428 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 1429 "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' 1430 "a_key": "A String", 1431 }, 1432 }, 1433 "jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH. 1434 "A String", 1435 ], 1436 "queryList": { # A list of queries to run on a cluster. # A list of queries. 1437 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: 1438 # "hiveJob": { 1439 # "queryList": { 1440 # "queries": [ 1441 # "query1", 1442 # "query2", 1443 # "query3;query4", 1444 # ] 1445 # } 1446 # } 1447 "A String", 1448 ], 1449 }, 1450 "properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. 1451 "a_key": "A String", 1452 }, 1453 }, 1454 "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. 1455 { # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.Beta Feature: This report is available for testing purposes only. It may be changed before final release. 1456 "progress": 3.14, # Required. The numerical progress of the application, from 1 to 100. 1457 "state": "A String", # Required. The application state. 1458 "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. 1459 "name": "A String", # Required. The application name. 1460 }, 1461 ], 1462 "submittedBy": "A String", # Output only. The email address of the user submitting the job. For jobs submitted on the cluster, the address is <code>username@hostname</code>. 1463 "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. 1464 "pysparkJob": { # A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Job is a Pyspark job. 1465 "mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file. 1466 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks. 1467 "A String", 1468 ], 1469 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 1470 "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' 1471 "a_key": "A String", 1472 }, 1473 }, 1474 "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. 1475 "A String", 1476 ], 1477 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks. 1478 "A String", 1479 ], 1480 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip. 1481 "A String", 1482 ], 1483 "pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip. 1484 "A String", 1485 ], 1486 "properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. 1487 "a_key": "A String", 1488 }, 1489 }, 1490 "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. 1491 "a_key": "A String", 1492 }, 1493 "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. 1494 "sparkJob": { # A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Job is a Spark job. 1495 "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. 1496 "A String", 1497 ], 1498 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 1499 "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' 1500 "a_key": "A String", 1501 }, 1502 }, 1503 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks. 1504 "A String", 1505 ], 1506 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks. 1507 "A String", 1508 ], 1509 "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. 1510 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip. 1511 "A String", 1512 ], 1513 "mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class. 1514 "properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. 1515 "a_key": "A String", 1516 }, 1517 }, 1518 "driverOutputResourceUri": "A String", # Output only. A URI pointing to the location of the stdout of the job's driver program. 1519 "prestoJob": { # A Cloud Dataproc job for running Presto (https://prestosql.io/) queries # Job is a Presto job 1520 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries. 1521 "outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats 1522 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 1523 "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' 1524 "a_key": "A String", 1525 }, 1526 }, 1527 "clientTags": [ # Optional. Presto client tags to attach to this query 1528 "A String", 1529 ], 1530 "queryList": { # A list of queries to run on a cluster. # A list of queries. 1531 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: 1532 # "hiveJob": { 1533 # "queryList": { 1534 # "queries": [ 1535 # "query1", 1536 # "query2", 1537 # "query3;query4", 1538 # ] 1539 # } 1540 # } 1541 "A String", 1542 ], 1543 }, 1544 "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. 1545 "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 1546 "a_key": "A String", 1547 }, 1548 }, 1549 "scheduling": { # Job scheduling options. # Optional. Job scheduling configuration. 1550 "maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10. 1551 }, 1552 "statusHistory": [ # Output only. The previous job status. 1553 { # Cloud Dataproc job status. 1554 "state": "A String", # Output only. A state message specifying the overall job state. 1555 "stateStartTime": "A String", # Output only. The time when this state was entered. 1556 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent. 1557 "details": "A String", # Output only. Optional job state details, such as an error description if the state is <code>ERROR</code>. 1558 }, 1559 ], 1560 "hiveJob": { # A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Job is a Hive job. 1561 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries. 1562 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";). 1563 "a_key": "A String", 1564 }, 1565 "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. 1566 "A String", 1567 ], 1568 "queryList": { # A list of queries to run on a cluster. # A list of queries. 1569 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: 1570 # "hiveJob": { 1571 # "queryList": { 1572 # "queries": [ 1573 # "query1", 1574 # "query2", 1575 # "query3;query4", 1576 # ] 1577 # } 1578 # } 1579 "A String", 1580 ], 1581 }, 1582 "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. 1583 "properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code. 1584 "a_key": "A String", 1585 }, 1586 }, 1587 }</pre> 1588</div> 1589 1590<div class="method"> 1591 <code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code> 1592 <pre>Sets the access control policy on the specified resource. Replaces any existing policy. 1593 1594Args: 1595 resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required) 1596 body: object, The request body. (required) 1597 The object takes the form of: 1598 1599{ # Request message for SetIamPolicy method. 1600 "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.A Policy consists of a list of bindings. A binding binds a list of members to a role, where the members can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM.JSON Example # REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. 1601 # { 1602 # "bindings": [ 1603 # { 1604 # "role": "roles/owner", 1605 # "members": [ 1606 # "user:mike@example.com", 1607 # "group:admins@example.com", 1608 # "domain:google.com", 1609 # "serviceAccount:my-other-app@appspot.gserviceaccount.com" 1610 # ] 1611 # }, 1612 # { 1613 # "role": "roles/viewer", 1614 # "members": ["user:sean@example.com"] 1615 # } 1616 # ] 1617 # } 1618 # YAML Example 1619 # bindings: 1620 # - members: 1621 # - user:mike@example.com 1622 # - group:admins@example.com 1623 # - domain:google.com 1624 # - serviceAccount:my-other-app@appspot.gserviceaccount.com 1625 # role: roles/owner 1626 # - members: 1627 # - user:sean@example.com 1628 # role: roles/viewer 1629 # For a description of IAM and its features, see the IAM developer's guide (https://cloud.google.com/iam/docs). 1630 "bindings": [ # Associates a list of members to a role. bindings with no members will result in an error. 1631 { # Associates members with a role. 1632 "role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner. 1633 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values: 1634 # allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. 1635 # allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. 1636 # user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com . 1637 # serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com. 1638 # group:{emailid}: An email address that represents a Google group. For example, admins@example.com. 1639 # domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. 1640 "A String", 1641 ], 1642 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. 1643 # title: "User account presence" 1644 # description: "Determines whether the request has a user account" 1645 # expression: "size(request.user) > 0" 1646 "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 1647 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.The application context of the containing message determines which well-known feature set of CEL is supported. 1648 "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 1649 "title": "A String", # An 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. 1650 }, 1651 }, 1652 ], 1653 "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.If no etag is provided in the call to setIamPolicy, then the existing policy is overwritten blindly. 1654 "version": 42, # Deprecated. 1655 }, 1656 } 1657 1658 x__xgafv: string, V1 error format. 1659 Allowed values 1660 1 - v1 error format 1661 2 - v2 error format 1662 1663Returns: 1664 An object of the form: 1665 1666 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.A Policy consists of a list of bindings. A binding binds a list of members to a role, where the members can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM.JSON Example 1667 # { 1668 # "bindings": [ 1669 # { 1670 # "role": "roles/owner", 1671 # "members": [ 1672 # "user:mike@example.com", 1673 # "group:admins@example.com", 1674 # "domain:google.com", 1675 # "serviceAccount:my-other-app@appspot.gserviceaccount.com" 1676 # ] 1677 # }, 1678 # { 1679 # "role": "roles/viewer", 1680 # "members": ["user:sean@example.com"] 1681 # } 1682 # ] 1683 # } 1684 # YAML Example 1685 # bindings: 1686 # - members: 1687 # - user:mike@example.com 1688 # - group:admins@example.com 1689 # - domain:google.com 1690 # - serviceAccount:my-other-app@appspot.gserviceaccount.com 1691 # role: roles/owner 1692 # - members: 1693 # - user:sean@example.com 1694 # role: roles/viewer 1695 # For a description of IAM and its features, see the IAM developer's guide (https://cloud.google.com/iam/docs). 1696 "bindings": [ # Associates a list of members to a role. bindings with no members will result in an error. 1697 { # Associates members with a role. 1698 "role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner. 1699 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values: 1700 # allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. 1701 # allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. 1702 # user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com . 1703 # serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com. 1704 # group:{emailid}: An email address that represents a Google group. For example, admins@example.com. 1705 # domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. 1706 "A String", 1707 ], 1708 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. 1709 # title: "User account presence" 1710 # description: "Determines whether the request has a user account" 1711 # expression: "size(request.user) > 0" 1712 "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 1713 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.The application context of the containing message determines which well-known feature set of CEL is supported. 1714 "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 1715 "title": "A String", # An 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. 1716 }, 1717 }, 1718 ], 1719 "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.If no etag is provided in the call to setIamPolicy, then the existing policy is overwritten blindly. 1720 "version": 42, # Deprecated. 1721 }</pre> 1722</div> 1723 1724<div class="method"> 1725 <code class="details" id="submit">submit(projectId, region, body, x__xgafv=None)</code> 1726 <pre>Submits a job to a cluster. 1727 1728Args: 1729 projectId: string, Required. The ID of the Google Cloud Platform project that the job belongs to. (required) 1730 region: string, Required. The Cloud Dataproc region in which to handle the request. (required) 1731 body: object, The request body. (required) 1732 The object takes the form of: 1733 1734{ # A request to submit a job. 1735 "job": { # A Cloud Dataproc job resource. # Required. The job resource. 1736 "status": { # Cloud Dataproc job status. # Output only. The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields. 1737 "state": "A String", # Output only. A state message specifying the overall job state. 1738 "stateStartTime": "A String", # Output only. The time when this state was entered. 1739 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent. 1740 "details": "A String", # Output only. Optional job state details, such as an error description if the state is <code>ERROR</code>. 1741 }, 1742 "hadoopJob": { # A Cloud 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). # Job is a Hadoop job. 1743 "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. 1744 "A String", 1745 ], 1746 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 1747 "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' 1748 "a_key": "A String", 1749 }, 1750 }, 1751 "jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks. 1752 "A String", 1753 ], 1754 "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. 1755 "A String", 1756 ], 1757 "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. 1758 "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. 1759 "A String", 1760 ], 1761 "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' 1762 "properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code. 1763 "a_key": "A String", 1764 }, 1765 }, 1766 "pigJob": { # A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Job is a Pig job. 1767 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries. 1768 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]). 1769 "a_key": "A String", 1770 }, 1771 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 1772 "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' 1773 "a_key": "A String", 1774 }, 1775 }, 1776 "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. 1777 "A String", 1778 ], 1779 "queryList": { # A list of queries to run on a cluster. # A list of queries. 1780 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: 1781 # "hiveJob": { 1782 # "queryList": { 1783 # "queries": [ 1784 # "query1", 1785 # "query2", 1786 # "query3;query4", 1787 # ] 1788 # } 1789 # } 1790 "A String", 1791 ], 1792 }, 1793 "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. 1794 "properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code. 1795 "a_key": "A String", 1796 }, 1797 }, 1798 "placement": { # Cloud Dataproc job config. # Required. Job information, including how, when, and where to run the job. 1799 "clusterName": "A String", # Required. The name of the cluster where the job will be submitted. 1800 "clusterUuid": "A String", # Output only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted. 1801 }, 1802 "sparkRJob": { # A Cloud Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Job is a SparkR job. 1803 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 1804 "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' 1805 "a_key": "A String", 1806 }, 1807 }, 1808 "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. 1809 "A String", 1810 ], 1811 "mainRFileUri": "A String", # Required. The HCFS URI of the main R file to use as the driver. Must be a .R file. 1812 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of R drivers and distributed tasks. Useful for naively parallel tasks. 1813 "A String", 1814 ], 1815 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip. 1816 "A String", 1817 ], 1818 "properties": { # Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. 1819 "a_key": "A String", 1820 }, 1821 }, 1822 "reference": { # Encapsulates the full scoping used to reference a job. # Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>. 1823 "projectId": "A String", # Required. The ID of the Google Cloud Platform project that the job belongs to. 1824 "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. 1825 }, 1826 "sparkSqlJob": { # A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Job is a SparkSql job. 1827 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries. 1828 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";). 1829 "a_key": "A String", 1830 }, 1831 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 1832 "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' 1833 "a_key": "A String", 1834 }, 1835 }, 1836 "jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH. 1837 "A String", 1838 ], 1839 "queryList": { # A list of queries to run on a cluster. # A list of queries. 1840 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: 1841 # "hiveJob": { 1842 # "queryList": { 1843 # "queries": [ 1844 # "query1", 1845 # "query2", 1846 # "query3;query4", 1847 # ] 1848 # } 1849 # } 1850 "A String", 1851 ], 1852 }, 1853 "properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. 1854 "a_key": "A String", 1855 }, 1856 }, 1857 "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. 1858 { # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.Beta Feature: This report is available for testing purposes only. It may be changed before final release. 1859 "progress": 3.14, # Required. The numerical progress of the application, from 1 to 100. 1860 "state": "A String", # Required. The application state. 1861 "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. 1862 "name": "A String", # Required. The application name. 1863 }, 1864 ], 1865 "submittedBy": "A String", # Output only. The email address of the user submitting the job. For jobs submitted on the cluster, the address is <code>username@hostname</code>. 1866 "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. 1867 "pysparkJob": { # A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Job is a Pyspark job. 1868 "mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file. 1869 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks. 1870 "A String", 1871 ], 1872 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 1873 "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' 1874 "a_key": "A String", 1875 }, 1876 }, 1877 "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. 1878 "A String", 1879 ], 1880 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks. 1881 "A String", 1882 ], 1883 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip. 1884 "A String", 1885 ], 1886 "pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip. 1887 "A String", 1888 ], 1889 "properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. 1890 "a_key": "A String", 1891 }, 1892 }, 1893 "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. 1894 "a_key": "A String", 1895 }, 1896 "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. 1897 "sparkJob": { # A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Job is a Spark job. 1898 "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. 1899 "A String", 1900 ], 1901 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 1902 "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' 1903 "a_key": "A String", 1904 }, 1905 }, 1906 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks. 1907 "A String", 1908 ], 1909 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks. 1910 "A String", 1911 ], 1912 "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. 1913 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip. 1914 "A String", 1915 ], 1916 "mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class. 1917 "properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. 1918 "a_key": "A String", 1919 }, 1920 }, 1921 "driverOutputResourceUri": "A String", # Output only. A URI pointing to the location of the stdout of the job's driver program. 1922 "prestoJob": { # A Cloud Dataproc job for running Presto (https://prestosql.io/) queries # Job is a Presto job 1923 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries. 1924 "outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats 1925 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 1926 "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' 1927 "a_key": "A String", 1928 }, 1929 }, 1930 "clientTags": [ # Optional. Presto client tags to attach to this query 1931 "A String", 1932 ], 1933 "queryList": { # A list of queries to run on a cluster. # A list of queries. 1934 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: 1935 # "hiveJob": { 1936 # "queryList": { 1937 # "queries": [ 1938 # "query1", 1939 # "query2", 1940 # "query3;query4", 1941 # ] 1942 # } 1943 # } 1944 "A String", 1945 ], 1946 }, 1947 "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. 1948 "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 1949 "a_key": "A String", 1950 }, 1951 }, 1952 "scheduling": { # Job scheduling options. # Optional. Job scheduling configuration. 1953 "maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10. 1954 }, 1955 "statusHistory": [ # Output only. The previous job status. 1956 { # Cloud Dataproc job status. 1957 "state": "A String", # Output only. A state message specifying the overall job state. 1958 "stateStartTime": "A String", # Output only. The time when this state was entered. 1959 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent. 1960 "details": "A String", # Output only. Optional job state details, such as an error description if the state is <code>ERROR</code>. 1961 }, 1962 ], 1963 "hiveJob": { # A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Job is a Hive job. 1964 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries. 1965 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";). 1966 "a_key": "A String", 1967 }, 1968 "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. 1969 "A String", 1970 ], 1971 "queryList": { # A list of queries to run on a cluster. # A list of queries. 1972 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: 1973 # "hiveJob": { 1974 # "queryList": { 1975 # "queries": [ 1976 # "query1", 1977 # "query2", 1978 # "query3;query4", 1979 # ] 1980 # } 1981 # } 1982 "A String", 1983 ], 1984 }, 1985 "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. 1986 "properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code. 1987 "a_key": "A String", 1988 }, 1989 }, 1990 }, 1991 "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. 1992 } 1993 1994 x__xgafv: string, V1 error format. 1995 Allowed values 1996 1 - v1 error format 1997 2 - v2 error format 1998 1999Returns: 2000 An object of the form: 2001 2002 { # A Cloud Dataproc job resource. 2003 "status": { # Cloud Dataproc job status. # Output only. The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields. 2004 "state": "A String", # Output only. A state message specifying the overall job state. 2005 "stateStartTime": "A String", # Output only. The time when this state was entered. 2006 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent. 2007 "details": "A String", # Output only. Optional job state details, such as an error description if the state is <code>ERROR</code>. 2008 }, 2009 "hadoopJob": { # A Cloud 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). # Job is a Hadoop job. 2010 "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. 2011 "A String", 2012 ], 2013 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 2014 "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' 2015 "a_key": "A String", 2016 }, 2017 }, 2018 "jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks. 2019 "A String", 2020 ], 2021 "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. 2022 "A String", 2023 ], 2024 "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. 2025 "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. 2026 "A String", 2027 ], 2028 "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' 2029 "properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code. 2030 "a_key": "A String", 2031 }, 2032 }, 2033 "pigJob": { # A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Job is a Pig job. 2034 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries. 2035 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]). 2036 "a_key": "A String", 2037 }, 2038 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 2039 "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' 2040 "a_key": "A String", 2041 }, 2042 }, 2043 "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. 2044 "A String", 2045 ], 2046 "queryList": { # A list of queries to run on a cluster. # A list of queries. 2047 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: 2048 # "hiveJob": { 2049 # "queryList": { 2050 # "queries": [ 2051 # "query1", 2052 # "query2", 2053 # "query3;query4", 2054 # ] 2055 # } 2056 # } 2057 "A String", 2058 ], 2059 }, 2060 "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. 2061 "properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code. 2062 "a_key": "A String", 2063 }, 2064 }, 2065 "placement": { # Cloud Dataproc job config. # Required. Job information, including how, when, and where to run the job. 2066 "clusterName": "A String", # Required. The name of the cluster where the job will be submitted. 2067 "clusterUuid": "A String", # Output only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted. 2068 }, 2069 "sparkRJob": { # A Cloud Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Job is a SparkR job. 2070 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 2071 "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' 2072 "a_key": "A String", 2073 }, 2074 }, 2075 "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. 2076 "A String", 2077 ], 2078 "mainRFileUri": "A String", # Required. The HCFS URI of the main R file to use as the driver. Must be a .R file. 2079 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of R drivers and distributed tasks. Useful for naively parallel tasks. 2080 "A String", 2081 ], 2082 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip. 2083 "A String", 2084 ], 2085 "properties": { # Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. 2086 "a_key": "A String", 2087 }, 2088 }, 2089 "reference": { # Encapsulates the full scoping used to reference a job. # Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>. 2090 "projectId": "A String", # Required. The ID of the Google Cloud Platform project that the job belongs to. 2091 "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. 2092 }, 2093 "sparkSqlJob": { # A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Job is a SparkSql job. 2094 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries. 2095 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";). 2096 "a_key": "A String", 2097 }, 2098 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 2099 "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' 2100 "a_key": "A String", 2101 }, 2102 }, 2103 "jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH. 2104 "A String", 2105 ], 2106 "queryList": { # A list of queries to run on a cluster. # A list of queries. 2107 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: 2108 # "hiveJob": { 2109 # "queryList": { 2110 # "queries": [ 2111 # "query1", 2112 # "query2", 2113 # "query3;query4", 2114 # ] 2115 # } 2116 # } 2117 "A String", 2118 ], 2119 }, 2120 "properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. 2121 "a_key": "A String", 2122 }, 2123 }, 2124 "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. 2125 { # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.Beta Feature: This report is available for testing purposes only. It may be changed before final release. 2126 "progress": 3.14, # Required. The numerical progress of the application, from 1 to 100. 2127 "state": "A String", # Required. The application state. 2128 "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. 2129 "name": "A String", # Required. The application name. 2130 }, 2131 ], 2132 "submittedBy": "A String", # Output only. The email address of the user submitting the job. For jobs submitted on the cluster, the address is <code>username@hostname</code>. 2133 "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. 2134 "pysparkJob": { # A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Job is a Pyspark job. 2135 "mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file. 2136 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks. 2137 "A String", 2138 ], 2139 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 2140 "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' 2141 "a_key": "A String", 2142 }, 2143 }, 2144 "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. 2145 "A String", 2146 ], 2147 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks. 2148 "A String", 2149 ], 2150 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip. 2151 "A String", 2152 ], 2153 "pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip. 2154 "A String", 2155 ], 2156 "properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. 2157 "a_key": "A String", 2158 }, 2159 }, 2160 "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. 2161 "a_key": "A String", 2162 }, 2163 "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. 2164 "sparkJob": { # A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Job is a Spark job. 2165 "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. 2166 "A String", 2167 ], 2168 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 2169 "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' 2170 "a_key": "A String", 2171 }, 2172 }, 2173 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks. 2174 "A String", 2175 ], 2176 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks. 2177 "A String", 2178 ], 2179 "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. 2180 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip. 2181 "A String", 2182 ], 2183 "mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class. 2184 "properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. 2185 "a_key": "A String", 2186 }, 2187 }, 2188 "driverOutputResourceUri": "A String", # Output only. A URI pointing to the location of the stdout of the job's driver program. 2189 "prestoJob": { # A Cloud Dataproc job for running Presto (https://prestosql.io/) queries # Job is a Presto job 2190 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries. 2191 "outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats 2192 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution. 2193 "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' 2194 "a_key": "A String", 2195 }, 2196 }, 2197 "clientTags": [ # Optional. Presto client tags to attach to this query 2198 "A String", 2199 ], 2200 "queryList": { # A list of queries to run on a cluster. # A list of queries. 2201 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: 2202 # "hiveJob": { 2203 # "queryList": { 2204 # "queries": [ 2205 # "query1", 2206 # "query2", 2207 # "query3;query4", 2208 # ] 2209 # } 2210 # } 2211 "A String", 2212 ], 2213 }, 2214 "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. 2215 "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 2216 "a_key": "A String", 2217 }, 2218 }, 2219 "scheduling": { # Job scheduling options. # Optional. Job scheduling configuration. 2220 "maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10. 2221 }, 2222 "statusHistory": [ # Output only. The previous job status. 2223 { # Cloud Dataproc job status. 2224 "state": "A String", # Output only. A state message specifying the overall job state. 2225 "stateStartTime": "A String", # Output only. The time when this state was entered. 2226 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent. 2227 "details": "A String", # Output only. Optional job state details, such as an error description if the state is <code>ERROR</code>. 2228 }, 2229 ], 2230 "hiveJob": { # A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Job is a Hive job. 2231 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries. 2232 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";). 2233 "a_key": "A String", 2234 }, 2235 "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. 2236 "A String", 2237 ], 2238 "queryList": { # A list of queries to run on a cluster. # A list of queries. 2239 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: 2240 # "hiveJob": { 2241 # "queryList": { 2242 # "queries": [ 2243 # "query1", 2244 # "query2", 2245 # "query3;query4", 2246 # ] 2247 # } 2248 # } 2249 "A String", 2250 ], 2251 }, 2252 "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. 2253 "properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code. 2254 "a_key": "A String", 2255 }, 2256 }, 2257 }</pre> 2258</div> 2259 2260<div class="method"> 2261 <code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code> 2262 <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. 2263 2264Args: 2265 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) 2266 body: object, The request body. (required) 2267 The object takes the form of: 2268 2269{ # Request message for TestIamPermissions method. 2270 "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). 2271 "A String", 2272 ], 2273 } 2274 2275 x__xgafv: string, V1 error format. 2276 Allowed values 2277 1 - v1 error format 2278 2 - v2 error format 2279 2280Returns: 2281 An object of the form: 2282 2283 { # Response message for TestIamPermissions method. 2284 "permissions": [ # A subset of TestPermissionsRequest.permissions that the caller is allowed. 2285 "A String", 2286 ], 2287 }</pre> 2288</div> 2289 2290</body></html>