1 <html><body> 2 <style> 3 4 body, 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 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, 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_v1beta1.html">Google Cloud Dataproc API</a> . <a href="dataproc_v1beta1.projects.html">projects</a> . <a href="dataproc_v1beta1.projects.jobs.html">jobs</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#cancel">cancel(projectId, jobId, body, x__xgafv=None)</a></code></p> 79 <p class="firstline">Starts a job cancellation request. To access the job resource after cancellation, call jobs.list or jobs.get.</p> 80 <p class="toc_element"> 81 <code><a href="#delete">delete(projectId, 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, 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="#list">list(projectId, pageSize=None, x__xgafv=None, jobStateMatcher=None, pageToken=None, clusterName=None, filter=None)</a></code></p> 88 <p class="firstline">Lists jobs in a project.</p> 89 <p class="toc_element"> 90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 91 <p class="firstline">Retrieves the next page of results.</p> 92 <p class="toc_element"> 93 <code><a href="#patch">patch(projectId, jobId, body, updateMask=None, x__xgafv=None)</a></code></p> 94 <p class="firstline">Updates a job in a project.</p> 95 <p class="toc_element"> 96 <code><a href="#submit">submit(projectId, body, x__xgafv=None)</a></code></p> 97 <p class="firstline">Submits a job to a cluster.</p> 98 <h3>Method Details</h3> 99 <div class="method"> 100 <code class="details" id="cancel">cancel(projectId, jobId, body, x__xgafv=None)</code> 101 <pre>Starts a job cancellation request. To access the job resource after cancellation, call jobs.list or jobs.get. 102 103 Args: 104 projectId: string, Required The ID of the Google Cloud Platform project that the job belongs to. (required) 105 jobId: string, Required The job ID. (required) 106 body: object, The request body. (required) 107 The object takes the form of: 108 109 { # A request to cancel a job. 110 } 111 112 x__xgafv: string, V1 error format. 113 Allowed values 114 1 - v1 error format 115 2 - v2 error format 116 117 Returns: 118 An object of the form: 119 120 { # A Cloud Dataproc job resource. 121 "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. 122 "state": "A String", # Required A state message specifying the overall job state. 123 "stateStartTime": "A String", # Output-only The time when this state was entered. 124 "substate": "A String", # Output-only Additional state information, which includes status reported by the agent. 125 "details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>. 126 }, 127 "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job. 128 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks. 129 "A String", 130 ], 131 "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. 132 "A String", 133 ], 134 "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks. 135 "A String", 136 ], 137 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 138 "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' 139 "a_key": "A String", 140 }, 141 }, 142 "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. 143 "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. 144 "A String", 145 ], 146 "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar' 147 "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. 148 "a_key": "A String", 149 }, 150 }, 151 "labels": { # Optional The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given job. 152 "a_key": "A String", 153 }, 154 "placement": { # Cloud Dataproc job configuration. # Required Job information, including how, when, and where to run the job. 155 "clusterName": "A String", # Required The name of the cluster where the job will be submitted. 156 "clusterUuid": "A String", # Output-only A cluster UUID generated by the Dataproc service when the job is submitted. 157 }, 158 "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>. 159 "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to. 160 "jobId": "A String", # Required The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters. 161 }, 162 "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job. 163 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries. 164 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";). 165 "a_key": "A String", 166 }, 167 "jarFileUris": [ # Optional HCFS URIs of jar files to be added to the Spark CLASSPATH. 168 "A String", 169 ], 170 "queryList": { # A list of queries to run on a cluster. # A list of queries. 171 "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: 172 # "hiveJob": { 173 # "queryList": { 174 # "queries": [ 175 # "query1", 176 # "query2", 177 # "query3;query4", 178 # ] 179 # } 180 # } 181 "A String", 182 ], 183 }, 184 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 185 "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' 186 "a_key": "A String", 187 }, 188 }, 189 "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. 190 "a_key": "A String", 191 }, 192 }, 193 "yarnApplications": [ # Output-only The collection of YARN applications spun up by this job. 194 { # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>. 195 "progress": 3.14, # Required The numerical progress of the application, from 1 to 100. 196 "state": "A String", # Required The application state. 197 "name": "A String", # Required The application name. 198 "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. 199 }, 200 ], 201 "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job. 202 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries. 203 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Pig command: name=[value]). 204 "a_key": "A String", 205 }, 206 "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. 207 "A String", 208 ], 209 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 210 "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' 211 "a_key": "A String", 212 }, 213 }, 214 "queryList": { # A list of queries to run on a cluster. # A list of queries. 215 "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: 216 # "hiveJob": { 217 # "queryList": { 218 # "queries": [ 219 # "query1", 220 # "query2", 221 # "query3;query4", 222 # ] 223 # } 224 # } 225 "A String", 226 ], 227 }, 228 "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. 229 "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. 230 "a_key": "A String", 231 }, 232 }, 233 "driverOutputResourceUri": "A String", # Output-only A URI pointing to the location of the stdout of the job's driver program. 234 "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job. 235 "mainPythonFileUri": "A String", # Required The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file. 236 "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. 237 "A String", 238 ], 239 "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks. 240 "A String", 241 ], 242 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 243 "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' 244 "a_key": "A String", 245 }, 246 }, 247 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks. 248 "A String", 249 ], 250 "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip. 251 "A String", 252 ], 253 "pythonFileUris": [ # Optional HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip. 254 "A String", 255 ], 256 "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. 257 "a_key": "A String", 258 }, 259 }, 260 "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. 261 "driverInputResourceUri": "A String", # Output-only A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive. 262 "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job. 263 "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. 264 "A String", 265 ], 266 "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks. 267 "A String", 268 ], 269 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 270 "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' 271 "a_key": "A String", 272 }, 273 }, 274 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks. 275 "A String", 276 ], 277 "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. 278 "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. 279 "A String", 280 ], 281 "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class. 282 "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. 283 "a_key": "A String", 284 }, 285 }, 286 "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>. 287 "scheduling": { # Job scheduling options.Beta Feature: These options are available for testing purposes only. They may be changed before final release. # Optional Job scheduling configuration. 288 "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. 289 }, 290 "statusHistory": [ # Output-only The previous job status. 291 { # Cloud Dataproc job status. 292 "state": "A String", # Required A state message specifying the overall job state. 293 "stateStartTime": "A String", # Output-only The time when this state was entered. 294 "substate": "A String", # Output-only Additional state information, which includes status reported by the agent. 295 "details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>. 296 }, 297 ], 298 "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job. 299 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries. 300 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Hive command: SET name="value";). 301 "a_key": "A String", 302 }, 303 "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. 304 "A String", 305 ], 306 "queryList": { # A list of queries to run on a cluster. # A list of queries. 307 "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: 308 # "hiveJob": { 309 # "queryList": { 310 # "queries": [ 311 # "query1", 312 # "query2", 313 # "query3;query4", 314 # ] 315 # } 316 # } 317 "A String", 318 ], 319 }, 320 "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. 321 "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. 322 "a_key": "A String", 323 }, 324 }, 325 "interactive": True or False, # Optional If set to true, the driver's stdin will be kept open and driver_input_uri will be set to provide a path at which additional input can be sent to the driver. 326 }</pre> 327 </div> 328 329 <div class="method"> 330 <code class="details" id="delete">delete(projectId, jobId, x__xgafv=None)</code> 331 <pre>Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION. 332 333 Args: 334 projectId: string, Required The ID of the Google Cloud Platform project that the job belongs to. (required) 335 jobId: string, Required The job ID. (required) 336 x__xgafv: string, V1 error format. 337 Allowed values 338 1 - v1 error format 339 2 - v2 error format 340 341 Returns: 342 An object of the form: 343 344 { # 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: 345 # service Foo { 346 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 347 # } 348 # The JSON representation for Empty is empty JSON object {}. 349 }</pre> 350 </div> 351 352 <div class="method"> 353 <code class="details" id="get">get(projectId, jobId, x__xgafv=None)</code> 354 <pre>Gets the resource representation for a job in a project. 355 356 Args: 357 projectId: string, Required The ID of the Google Cloud Platform project that the job belongs to. (required) 358 jobId: string, Required The job ID. (required) 359 x__xgafv: string, V1 error format. 360 Allowed values 361 1 - v1 error format 362 2 - v2 error format 363 364 Returns: 365 An object of the form: 366 367 { # A Cloud Dataproc job resource. 368 "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. 369 "state": "A String", # Required A state message specifying the overall job state. 370 "stateStartTime": "A String", # Output-only The time when this state was entered. 371 "substate": "A String", # Output-only Additional state information, which includes status reported by the agent. 372 "details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>. 373 }, 374 "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job. 375 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks. 376 "A String", 377 ], 378 "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. 379 "A String", 380 ], 381 "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks. 382 "A String", 383 ], 384 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 385 "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' 386 "a_key": "A String", 387 }, 388 }, 389 "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. 390 "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. 391 "A String", 392 ], 393 "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar' 394 "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. 395 "a_key": "A String", 396 }, 397 }, 398 "labels": { # Optional The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given job. 399 "a_key": "A String", 400 }, 401 "placement": { # Cloud Dataproc job configuration. # Required Job information, including how, when, and where to run the job. 402 "clusterName": "A String", # Required The name of the cluster where the job will be submitted. 403 "clusterUuid": "A String", # Output-only A cluster UUID generated by the Dataproc service when the job is submitted. 404 }, 405 "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>. 406 "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to. 407 "jobId": "A String", # Required The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters. 408 }, 409 "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job. 410 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries. 411 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";). 412 "a_key": "A String", 413 }, 414 "jarFileUris": [ # Optional HCFS URIs of jar files to be added to the Spark CLASSPATH. 415 "A String", 416 ], 417 "queryList": { # A list of queries to run on a cluster. # A list of queries. 418 "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: 419 # "hiveJob": { 420 # "queryList": { 421 # "queries": [ 422 # "query1", 423 # "query2", 424 # "query3;query4", 425 # ] 426 # } 427 # } 428 "A String", 429 ], 430 }, 431 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 432 "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' 433 "a_key": "A String", 434 }, 435 }, 436 "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. 437 "a_key": "A String", 438 }, 439 }, 440 "yarnApplications": [ # Output-only The collection of YARN applications spun up by this job. 441 { # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>. 442 "progress": 3.14, # Required The numerical progress of the application, from 1 to 100. 443 "state": "A String", # Required The application state. 444 "name": "A String", # Required The application name. 445 "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. 446 }, 447 ], 448 "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job. 449 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries. 450 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Pig command: name=[value]). 451 "a_key": "A String", 452 }, 453 "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. 454 "A String", 455 ], 456 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 457 "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' 458 "a_key": "A String", 459 }, 460 }, 461 "queryList": { # A list of queries to run on a cluster. # A list of queries. 462 "queries": [ # Required The queries to execute. You do not need to 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: 463 # "hiveJob": { 464 # "queryList": { 465 # "queries": [ 466 # "query1", 467 # "query2", 468 # "query3;query4", 469 # ] 470 # } 471 # } 472 "A String", 473 ], 474 }, 475 "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. 476 "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. 477 "a_key": "A String", 478 }, 479 }, 480 "driverOutputResourceUri": "A String", # Output-only A URI pointing to the location of the stdout of the job's driver program. 481 "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job. 482 "mainPythonFileUri": "A String", # Required The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file. 483 "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. 484 "A String", 485 ], 486 "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks. 487 "A String", 488 ], 489 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 490 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG' 491 "a_key": "A String", 492 }, 493 }, 494 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks. 495 "A String", 496 ], 497 "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip. 498 "A String", 499 ], 500 "pythonFileUris": [ # Optional HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip. 501 "A String", 502 ], 503 "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. 504 "a_key": "A String", 505 }, 506 }, 507 "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. 508 "driverInputResourceUri": "A String", # Output-only A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive. 509 "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job. 510 "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. 511 "A String", 512 ], 513 "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks. 514 "A String", 515 ], 516 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 517 "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' 518 "a_key": "A String", 519 }, 520 }, 521 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks. 522 "A String", 523 ], 524 "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. 525 "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. 526 "A String", 527 ], 528 "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class. 529 "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. 530 "a_key": "A String", 531 }, 532 }, 533 "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>. 534 "scheduling": { # Job scheduling options.Beta Feature: These options are available for testing purposes only. They may be changed before final release. # Optional Job scheduling configuration. 535 "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. 536 }, 537 "statusHistory": [ # Output-only The previous job status. 538 { # Cloud Dataproc job status. 539 "state": "A String", # Required A state message specifying the overall job state. 540 "stateStartTime": "A String", # Output-only The time when this state was entered. 541 "substate": "A String", # Output-only Additional state information, which includes status reported by the agent. 542 "details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>. 543 }, 544 ], 545 "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job. 546 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries. 547 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Hive command: SET name="value";). 548 "a_key": "A String", 549 }, 550 "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. 551 "A String", 552 ], 553 "queryList": { # A list of queries to run on a cluster. # A list of queries. 554 "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: 555 # "hiveJob": { 556 # "queryList": { 557 # "queries": [ 558 # "query1", 559 # "query2", 560 # "query3;query4", 561 # ] 562 # } 563 # } 564 "A String", 565 ], 566 }, 567 "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. 568 "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. 569 "a_key": "A String", 570 }, 571 }, 572 "interactive": True or False, # Optional If set to true, the driver's stdin will be kept open and driver_input_uri will be set to provide a path at which additional input can be sent to the driver. 573 }</pre> 574 </div> 575 576 <div class="method"> 577 <code class="details" id="list">list(projectId, pageSize=None, x__xgafv=None, jobStateMatcher=None, pageToken=None, clusterName=None, filter=None)</code> 578 <pre>Lists jobs in a project. 579 580 Args: 581 projectId: string, Required The ID of the Google Cloud Platform project that the job belongs to. (required) 582 pageSize: integer, Optional The number of results to return in each response. 583 x__xgafv: string, V1 error format. 584 Allowed values 585 1 - v1 error format 586 2 - v2 error format 587 jobStateMatcher: string, Optional Specifies enumerated categories of jobs to list. 588 pageToken: string, Optional The page token, returned by a previous call, to request the next page of results. 589 clusterName: string, Optional If set, the returned jobs list includes only jobs that were submitted to the named cluster. 590 filter: string, Optional A filter constraining which jobs to list. Valid filters contain job state and label terms such as: labels.key1 = val1 AND (labels.k2 = val2 OR labels.k3 = val3) 591 592 Returns: 593 An object of the form: 594 595 { # A list of jobs in a project. 596 "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>. 597 "jobs": [ # Output-only Jobs list. 598 { # A Cloud Dataproc job resource. 599 "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. 600 "state": "A String", # Required A state message specifying the overall job state. 601 "stateStartTime": "A String", # Output-only The time when this state was entered. 602 "substate": "A String", # Output-only Additional state information, which includes status reported by the agent. 603 "details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>. 604 }, 605 "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job. 606 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks. 607 "A String", 608 ], 609 "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. 610 "A String", 611 ], 612 "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks. 613 "A String", 614 ], 615 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 616 "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' 617 "a_key": "A String", 618 }, 619 }, 620 "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. 621 "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. 622 "A String", 623 ], 624 "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar' 625 "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. 626 "a_key": "A String", 627 }, 628 }, 629 "labels": { # Optional The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given job. 630 "a_key": "A String", 631 }, 632 "placement": { # Cloud Dataproc job configuration. # Required Job information, including how, when, and where to run the job. 633 "clusterName": "A String", # Required The name of the cluster where the job will be submitted. 634 "clusterUuid": "A String", # Output-only A cluster UUID generated by the Dataproc service when the job is submitted. 635 }, 636 "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>. 637 "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to. 638 "jobId": "A String", # Required The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters. 639 }, 640 "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job. 641 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries. 642 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";). 643 "a_key": "A String", 644 }, 645 "jarFileUris": [ # Optional HCFS URIs of jar files to be added to the Spark CLASSPATH. 646 "A String", 647 ], 648 "queryList": { # A list of queries to run on a cluster. # A list of queries. 649 "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: 650 # "hiveJob": { 651 # "queryList": { 652 # "queries": [ 653 # "query1", 654 # "query2", 655 # "query3;query4", 656 # ] 657 # } 658 # } 659 "A String", 660 ], 661 }, 662 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 663 "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' 664 "a_key": "A String", 665 }, 666 }, 667 "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. 668 "a_key": "A String", 669 }, 670 }, 671 "yarnApplications": [ # Output-only The collection of YARN applications spun up by this job. 672 { # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>. 673 "progress": 3.14, # Required The numerical progress of the application, from 1 to 100. 674 "state": "A String", # Required The application state. 675 "name": "A String", # Required The application name. 676 "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. 677 }, 678 ], 679 "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job. 680 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries. 681 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Pig command: name=[value]). 682 "a_key": "A String", 683 }, 684 "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. 685 "A String", 686 ], 687 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 688 "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' 689 "a_key": "A String", 690 }, 691 }, 692 "queryList": { # A list of queries to run on a cluster. # A list of queries. 693 "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: 694 # "hiveJob": { 695 # "queryList": { 696 # "queries": [ 697 # "query1", 698 # "query2", 699 # "query3;query4", 700 # ] 701 # } 702 # } 703 "A String", 704 ], 705 }, 706 "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. 707 "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. 708 "a_key": "A String", 709 }, 710 }, 711 "driverOutputResourceUri": "A String", # Output-only A URI pointing to the location of the stdout of the job's driver program. 712 "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job. 713 "mainPythonFileUri": "A String", # Required The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file. 714 "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. 715 "A String", 716 ], 717 "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks. 718 "A String", 719 ], 720 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 721 "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' 722 "a_key": "A String", 723 }, 724 }, 725 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks. 726 "A String", 727 ], 728 "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip. 729 "A String", 730 ], 731 "pythonFileUris": [ # Optional HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip. 732 "A String", 733 ], 734 "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. 735 "a_key": "A String", 736 }, 737 }, 738 "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. 739 "driverInputResourceUri": "A String", # Output-only A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive. 740 "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job. 741 "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. 742 "A String", 743 ], 744 "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks. 745 "A String", 746 ], 747 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 748 "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' 749 "a_key": "A String", 750 }, 751 }, 752 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks. 753 "A String", 754 ], 755 "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. 756 "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. 757 "A String", 758 ], 759 "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class. 760 "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. 761 "a_key": "A String", 762 }, 763 }, 764 "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>. 765 "scheduling": { # Job scheduling options.Beta Feature: These options are available for testing purposes only. They may be changed before final release. # Optional Job scheduling configuration. 766 "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. 767 }, 768 "statusHistory": [ # Output-only The previous job status. 769 { # Cloud Dataproc job status. 770 "state": "A String", # Required A state message specifying the overall job state. 771 "stateStartTime": "A String", # Output-only The time when this state was entered. 772 "substate": "A String", # Output-only Additional state information, which includes status reported by the agent. 773 "details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>. 774 }, 775 ], 776 "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job. 777 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries. 778 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Hive command: SET name="value";). 779 "a_key": "A String", 780 }, 781 "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. 782 "A String", 783 ], 784 "queryList": { # A list of queries to run on a cluster. # A list of queries. 785 "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: 786 # "hiveJob": { 787 # "queryList": { 788 # "queries": [ 789 # "query1", 790 # "query2", 791 # "query3;query4", 792 # ] 793 # } 794 # } 795 "A String", 796 ], 797 }, 798 "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. 799 "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. 800 "a_key": "A String", 801 }, 802 }, 803 "interactive": True or False, # Optional If set to true, the driver's stdin will be kept open and driver_input_uri will be set to provide a path at which additional input can be sent to the driver. 804 }, 805 ], 806 }</pre> 807 </div> 808 809 <div class="method"> 810 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 811 <pre>Retrieves the next page of results. 812 813 Args: 814 previous_request: The request for the previous page. (required) 815 previous_response: The response from the request for the previous page. (required) 816 817 Returns: 818 A request object that you can call 'execute()' on to request the next 819 page. Returns None if there are no more items in the collection. 820 </pre> 821 </div> 822 823 <div class="method"> 824 <code class="details" id="patch">patch(projectId, jobId, body, updateMask=None, x__xgafv=None)</code> 825 <pre>Updates a job in a project. 826 827 Args: 828 projectId: string, Required The ID of the Google Cloud Platform project that the job belongs to. (required) 829 jobId: string, Required The job ID. (required) 830 body: object, The request body. (required) 831 The object takes the form of: 832 833 { # A Cloud Dataproc job resource. 834 "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. 835 "state": "A String", # Required A state message specifying the overall job state. 836 "stateStartTime": "A String", # Output-only The time when this state was entered. 837 "substate": "A String", # Output-only Additional state information, which includes status reported by the agent. 838 "details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>. 839 }, 840 "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job. 841 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks. 842 "A String", 843 ], 844 "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. 845 "A String", 846 ], 847 "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks. 848 "A String", 849 ], 850 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 851 "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' 852 "a_key": "A String", 853 }, 854 }, 855 "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. 856 "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. 857 "A String", 858 ], 859 "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar' 860 "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. 861 "a_key": "A String", 862 }, 863 }, 864 "labels": { # Optional The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given job. 865 "a_key": "A String", 866 }, 867 "placement": { # Cloud Dataproc job configuration. # Required Job information, including how, when, and where to run the job. 868 "clusterName": "A String", # Required The name of the cluster where the job will be submitted. 869 "clusterUuid": "A String", # Output-only A cluster UUID generated by the Dataproc service when the job is submitted. 870 }, 871 "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>. 872 "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to. 873 "jobId": "A String", # Required The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters. 874 }, 875 "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job. 876 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries. 877 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";). 878 "a_key": "A String", 879 }, 880 "jarFileUris": [ # Optional HCFS URIs of jar files to be added to the Spark CLASSPATH. 881 "A String", 882 ], 883 "queryList": { # A list of queries to run on a cluster. # A list of queries. 884 "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: 885 # "hiveJob": { 886 # "queryList": { 887 # "queries": [ 888 # "query1", 889 # "query2", 890 # "query3;query4", 891 # ] 892 # } 893 # } 894 "A String", 895 ], 896 }, 897 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 898 "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' 899 "a_key": "A String", 900 }, 901 }, 902 "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. 903 "a_key": "A String", 904 }, 905 }, 906 "yarnApplications": [ # Output-only The collection of YARN applications spun up by this job. 907 { # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>. 908 "progress": 3.14, # Required The numerical progress of the application, from 1 to 100. 909 "state": "A String", # Required The application state. 910 "name": "A String", # Required The application name. 911 "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. 912 }, 913 ], 914 "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job. 915 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries. 916 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Pig command: name=[value]). 917 "a_key": "A String", 918 }, 919 "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. 920 "A String", 921 ], 922 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 923 "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' 924 "a_key": "A String", 925 }, 926 }, 927 "queryList": { # A list of queries to run on a cluster. # A list of queries. 928 "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: 929 # "hiveJob": { 930 # "queryList": { 931 # "queries": [ 932 # "query1", 933 # "query2", 934 # "query3;query4", 935 # ] 936 # } 937 # } 938 "A String", 939 ], 940 }, 941 "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. 942 "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. 943 "a_key": "A String", 944 }, 945 }, 946 "driverOutputResourceUri": "A String", # Output-only A URI pointing to the location of the stdout of the job's driver program. 947 "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job. 948 "mainPythonFileUri": "A String", # Required The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file. 949 "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. 950 "A String", 951 ], 952 "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks. 953 "A String", 954 ], 955 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 956 "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' 957 "a_key": "A String", 958 }, 959 }, 960 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks. 961 "A String", 962 ], 963 "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip. 964 "A String", 965 ], 966 "pythonFileUris": [ # Optional HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip. 967 "A String", 968 ], 969 "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. 970 "a_key": "A String", 971 }, 972 }, 973 "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. 974 "driverInputResourceUri": "A String", # Output-only A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive. 975 "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job. 976 "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. 977 "A String", 978 ], 979 "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks. 980 "A String", 981 ], 982 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 983 "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' 984 "a_key": "A String", 985 }, 986 }, 987 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks. 988 "A String", 989 ], 990 "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. 991 "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. 992 "A String", 993 ], 994 "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class. 995 "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. 996 "a_key": "A String", 997 }, 998 }, 999 "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>. 1000 "scheduling": { # Job scheduling options.Beta Feature: These options are available for testing purposes only. They may be changed before final release. # Optional Job scheduling configuration. 1001 "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. 1002 }, 1003 "statusHistory": [ # Output-only The previous job status. 1004 { # Cloud Dataproc job status. 1005 "state": "A String", # Required A state message specifying the overall job state. 1006 "stateStartTime": "A String", # Output-only The time when this state was entered. 1007 "substate": "A String", # Output-only Additional state information, which includes status reported by the agent. 1008 "details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>. 1009 }, 1010 ], 1011 "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job. 1012 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries. 1013 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Hive command: SET name="value";). 1014 "a_key": "A String", 1015 }, 1016 "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. 1017 "A String", 1018 ], 1019 "queryList": { # A list of queries to run on a cluster. # A list of queries. 1020 "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: 1021 # "hiveJob": { 1022 # "queryList": { 1023 # "queries": [ 1024 # "query1", 1025 # "query2", 1026 # "query3;query4", 1027 # ] 1028 # } 1029 # } 1030 "A String", 1031 ], 1032 }, 1033 "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. 1034 "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. 1035 "a_key": "A String", 1036 }, 1037 }, 1038 "interactive": True or False, # Optional If set to true, the driver's stdin will be kept open and driver_input_uri will be set to provide a path at which additional input can be sent to the driver. 1039 } 1040 1041 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. 1042 x__xgafv: string, V1 error format. 1043 Allowed values 1044 1 - v1 error format 1045 2 - v2 error format 1046 1047 Returns: 1048 An object of the form: 1049 1050 { # A Cloud Dataproc job resource. 1051 "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. 1052 "state": "A String", # Required A state message specifying the overall job state. 1053 "stateStartTime": "A String", # Output-only The time when this state was entered. 1054 "substate": "A String", # Output-only Additional state information, which includes status reported by the agent. 1055 "details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>. 1056 }, 1057 "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job. 1058 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks. 1059 "A String", 1060 ], 1061 "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. 1062 "A String", 1063 ], 1064 "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks. 1065 "A String", 1066 ], 1067 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 1068 "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' 1069 "a_key": "A String", 1070 }, 1071 }, 1072 "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. 1073 "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. 1074 "A String", 1075 ], 1076 "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar' 1077 "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. 1078 "a_key": "A String", 1079 }, 1080 }, 1081 "labels": { # Optional The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given job. 1082 "a_key": "A String", 1083 }, 1084 "placement": { # Cloud Dataproc job configuration. # Required Job information, including how, when, and where to run the job. 1085 "clusterName": "A String", # Required The name of the cluster where the job will be submitted. 1086 "clusterUuid": "A String", # Output-only A cluster UUID generated by the Dataproc service when the job is submitted. 1087 }, 1088 "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>. 1089 "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to. 1090 "jobId": "A String", # Required The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters. 1091 }, 1092 "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job. 1093 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries. 1094 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";). 1095 "a_key": "A String", 1096 }, 1097 "jarFileUris": [ # Optional HCFS URIs of jar files to be added to the Spark CLASSPATH. 1098 "A String", 1099 ], 1100 "queryList": { # A list of queries to run on a cluster. # A list of queries. 1101 "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: 1102 # "hiveJob": { 1103 # "queryList": { 1104 # "queries": [ 1105 # "query1", 1106 # "query2", 1107 # "query3;query4", 1108 # ] 1109 # } 1110 # } 1111 "A String", 1112 ], 1113 }, 1114 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 1115 "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' 1116 "a_key": "A String", 1117 }, 1118 }, 1119 "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. 1120 "a_key": "A String", 1121 }, 1122 }, 1123 "yarnApplications": [ # Output-only The collection of YARN applications spun up by this job. 1124 { # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>. 1125 "progress": 3.14, # Required The numerical progress of the application, from 1 to 100. 1126 "state": "A String", # Required The application state. 1127 "name": "A String", # Required The application name. 1128 "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. 1129 }, 1130 ], 1131 "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job. 1132 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries. 1133 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Pig command: name=[value]). 1134 "a_key": "A String", 1135 }, 1136 "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. 1137 "A String", 1138 ], 1139 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 1140 "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' 1141 "a_key": "A String", 1142 }, 1143 }, 1144 "queryList": { # A list of queries to run on a cluster. # A list of queries. 1145 "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: 1146 # "hiveJob": { 1147 # "queryList": { 1148 # "queries": [ 1149 # "query1", 1150 # "query2", 1151 # "query3;query4", 1152 # ] 1153 # } 1154 # } 1155 "A String", 1156 ], 1157 }, 1158 "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. 1159 "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. 1160 "a_key": "A String", 1161 }, 1162 }, 1163 "driverOutputResourceUri": "A String", # Output-only A URI pointing to the location of the stdout of the job's driver program. 1164 "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job. 1165 "mainPythonFileUri": "A String", # Required The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file. 1166 "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. 1167 "A String", 1168 ], 1169 "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks. 1170 "A String", 1171 ], 1172 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 1173 "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' 1174 "a_key": "A String", 1175 }, 1176 }, 1177 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks. 1178 "A String", 1179 ], 1180 "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip. 1181 "A String", 1182 ], 1183 "pythonFileUris": [ # Optional HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip. 1184 "A String", 1185 ], 1186 "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. 1187 "a_key": "A String", 1188 }, 1189 }, 1190 "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. 1191 "driverInputResourceUri": "A String", # Output-only A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive. 1192 "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job. 1193 "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. 1194 "A String", 1195 ], 1196 "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks. 1197 "A String", 1198 ], 1199 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 1200 "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' 1201 "a_key": "A String", 1202 }, 1203 }, 1204 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks. 1205 "A String", 1206 ], 1207 "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. 1208 "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. 1209 "A String", 1210 ], 1211 "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class. 1212 "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. 1213 "a_key": "A String", 1214 }, 1215 }, 1216 "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>. 1217 "scheduling": { # Job scheduling options.Beta Feature: These options are available for testing purposes only. They may be changed before final release. # Optional Job scheduling configuration. 1218 "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. 1219 }, 1220 "statusHistory": [ # Output-only The previous job status. 1221 { # Cloud Dataproc job status. 1222 "state": "A String", # Required A state message specifying the overall job state. 1223 "stateStartTime": "A String", # Output-only The time when this state was entered. 1224 "substate": "A String", # Output-only Additional state information, which includes status reported by the agent. 1225 "details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>. 1226 }, 1227 ], 1228 "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job. 1229 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries. 1230 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Hive command: SET name="value";). 1231 "a_key": "A String", 1232 }, 1233 "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. 1234 "A String", 1235 ], 1236 "queryList": { # A list of queries to run on a cluster. # A list of queries. 1237 "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: 1238 # "hiveJob": { 1239 # "queryList": { 1240 # "queries": [ 1241 # "query1", 1242 # "query2", 1243 # "query3;query4", 1244 # ] 1245 # } 1246 # } 1247 "A String", 1248 ], 1249 }, 1250 "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. 1251 "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. 1252 "a_key": "A String", 1253 }, 1254 }, 1255 "interactive": True or False, # Optional If set to true, the driver's stdin will be kept open and driver_input_uri will be set to provide a path at which additional input can be sent to the driver. 1256 }</pre> 1257 </div> 1258 1259 <div class="method"> 1260 <code class="details" id="submit">submit(projectId, body, x__xgafv=None)</code> 1261 <pre>Submits a job to a cluster. 1262 1263 Args: 1264 projectId: string, Required The ID of the Google Cloud Platform project that the job belongs to. (required) 1265 body: object, The request body. (required) 1266 The object takes the form of: 1267 1268 { # A request to submit a job. 1269 "job": { # A Cloud Dataproc job resource. # Required The job resource. 1270 "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. 1271 "state": "A String", # Required A state message specifying the overall job state. 1272 "stateStartTime": "A String", # Output-only The time when this state was entered. 1273 "substate": "A String", # Output-only Additional state information, which includes status reported by the agent. 1274 "details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>. 1275 }, 1276 "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job. 1277 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks. 1278 "A String", 1279 ], 1280 "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. 1281 "A String", 1282 ], 1283 "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks. 1284 "A String", 1285 ], 1286 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 1287 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG' 1288 "a_key": "A String", 1289 }, 1290 }, 1291 "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. 1292 "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. 1293 "A String", 1294 ], 1295 "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar' 1296 "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. 1297 "a_key": "A String", 1298 }, 1299 }, 1300 "labels": { # Optional The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given job. 1301 "a_key": "A String", 1302 }, 1303 "placement": { # Cloud Dataproc job configuration. # Required Job information, including how, when, and where to run the job. 1304 "clusterName": "A String", # Required The name of the cluster where the job will be submitted. 1305 "clusterUuid": "A String", # Output-only A cluster UUID generated by the Dataproc service when the job is submitted. 1306 }, 1307 "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>. 1308 "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to. 1309 "jobId": "A String", # Required The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters. 1310 }, 1311 "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job. 1312 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries. 1313 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";). 1314 "a_key": "A String", 1315 }, 1316 "jarFileUris": [ # Optional HCFS URIs of jar files to be added to the Spark CLASSPATH. 1317 "A String", 1318 ], 1319 "queryList": { # A list of queries to run on a cluster. # A list of queries. 1320 "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: 1321 # "hiveJob": { 1322 # "queryList": { 1323 # "queries": [ 1324 # "query1", 1325 # "query2", 1326 # "query3;query4", 1327 # ] 1328 # } 1329 # } 1330 "A String", 1331 ], 1332 }, 1333 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 1334 "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' 1335 "a_key": "A String", 1336 }, 1337 }, 1338 "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. 1339 "a_key": "A String", 1340 }, 1341 }, 1342 "yarnApplications": [ # Output-only The collection of YARN applications spun up by this job. 1343 { # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>. 1344 "progress": 3.14, # Required The numerical progress of the application, from 1 to 100. 1345 "state": "A String", # Required The application state. 1346 "name": "A String", # Required The application name. 1347 "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. 1348 }, 1349 ], 1350 "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job. 1351 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries. 1352 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Pig command: name=[value]). 1353 "a_key": "A String", 1354 }, 1355 "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. 1356 "A String", 1357 ], 1358 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 1359 "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' 1360 "a_key": "A String", 1361 }, 1362 }, 1363 "queryList": { # A list of queries to run on a cluster. # A list of queries. 1364 "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: 1365 # "hiveJob": { 1366 # "queryList": { 1367 # "queries": [ 1368 # "query1", 1369 # "query2", 1370 # "query3;query4", 1371 # ] 1372 # } 1373 # } 1374 "A String", 1375 ], 1376 }, 1377 "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. 1378 "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. 1379 "a_key": "A String", 1380 }, 1381 }, 1382 "driverOutputResourceUri": "A String", # Output-only A URI pointing to the location of the stdout of the job's driver program. 1383 "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job. 1384 "mainPythonFileUri": "A String", # Required The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file. 1385 "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. 1386 "A String", 1387 ], 1388 "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks. 1389 "A String", 1390 ], 1391 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 1392 "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' 1393 "a_key": "A String", 1394 }, 1395 }, 1396 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks. 1397 "A String", 1398 ], 1399 "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip. 1400 "A String", 1401 ], 1402 "pythonFileUris": [ # Optional HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip. 1403 "A String", 1404 ], 1405 "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. 1406 "a_key": "A String", 1407 }, 1408 }, 1409 "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. 1410 "driverInputResourceUri": "A String", # Output-only A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive. 1411 "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job. 1412 "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. 1413 "A String", 1414 ], 1415 "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks. 1416 "A String", 1417 ], 1418 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 1419 "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' 1420 "a_key": "A String", 1421 }, 1422 }, 1423 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks. 1424 "A String", 1425 ], 1426 "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. 1427 "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. 1428 "A String", 1429 ], 1430 "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class. 1431 "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. 1432 "a_key": "A String", 1433 }, 1434 }, 1435 "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>. 1436 "scheduling": { # Job scheduling options.Beta Feature: These options are available for testing purposes only. They may be changed before final release. # Optional Job scheduling configuration. 1437 "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. 1438 }, 1439 "statusHistory": [ # Output-only The previous job status. 1440 { # Cloud Dataproc job status. 1441 "state": "A String", # Required A state message specifying the overall job state. 1442 "stateStartTime": "A String", # Output-only The time when this state was entered. 1443 "substate": "A String", # Output-only Additional state information, which includes status reported by the agent. 1444 "details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>. 1445 }, 1446 ], 1447 "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job. 1448 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries. 1449 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Hive command: SET name="value";). 1450 "a_key": "A String", 1451 }, 1452 "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. 1453 "A String", 1454 ], 1455 "queryList": { # A list of queries to run on a cluster. # A list of queries. 1456 "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: 1457 # "hiveJob": { 1458 # "queryList": { 1459 # "queries": [ 1460 # "query1", 1461 # "query2", 1462 # "query3;query4", 1463 # ] 1464 # } 1465 # } 1466 "A String", 1467 ], 1468 }, 1469 "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. 1470 "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. 1471 "a_key": "A String", 1472 }, 1473 }, 1474 "interactive": True or False, # Optional If set to true, the driver's stdin will be kept open and driver_input_uri will be set to provide a path at which additional input can be sent to the driver. 1475 }, 1476 } 1477 1478 x__xgafv: string, V1 error format. 1479 Allowed values 1480 1 - v1 error format 1481 2 - v2 error format 1482 1483 Returns: 1484 An object of the form: 1485 1486 { # A Cloud Dataproc job resource. 1487 "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. 1488 "state": "A String", # Required A state message specifying the overall job state. 1489 "stateStartTime": "A String", # Output-only The time when this state was entered. 1490 "substate": "A String", # Output-only Additional state information, which includes status reported by the agent. 1491 "details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>. 1492 }, 1493 "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job. 1494 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks. 1495 "A String", 1496 ], 1497 "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. 1498 "A String", 1499 ], 1500 "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks. 1501 "A String", 1502 ], 1503 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 1504 "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' 1505 "a_key": "A String", 1506 }, 1507 }, 1508 "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. 1509 "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. 1510 "A String", 1511 ], 1512 "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar' 1513 "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. 1514 "a_key": "A String", 1515 }, 1516 }, 1517 "labels": { # Optional The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given job. 1518 "a_key": "A String", 1519 }, 1520 "placement": { # Cloud Dataproc job configuration. # Required Job information, including how, when, and where to run the job. 1521 "clusterName": "A String", # Required The name of the cluster where the job will be submitted. 1522 "clusterUuid": "A String", # Output-only A cluster UUID generated by the Dataproc service when the job is submitted. 1523 }, 1524 "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>. 1525 "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to. 1526 "jobId": "A String", # Required The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters. 1527 }, 1528 "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job. 1529 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries. 1530 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";). 1531 "a_key": "A String", 1532 }, 1533 "jarFileUris": [ # Optional HCFS URIs of jar files to be added to the Spark CLASSPATH. 1534 "A String", 1535 ], 1536 "queryList": { # A list of queries to run on a cluster. # A list of queries. 1537 "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: 1538 # "hiveJob": { 1539 # "queryList": { 1540 # "queries": [ 1541 # "query1", 1542 # "query2", 1543 # "query3;query4", 1544 # ] 1545 # } 1546 # } 1547 "A String", 1548 ], 1549 }, 1550 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 1551 "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' 1552 "a_key": "A String", 1553 }, 1554 }, 1555 "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. 1556 "a_key": "A String", 1557 }, 1558 }, 1559 "yarnApplications": [ # Output-only The collection of YARN applications spun up by this job. 1560 { # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>. 1561 "progress": 3.14, # Required The numerical progress of the application, from 1 to 100. 1562 "state": "A String", # Required The application state. 1563 "name": "A String", # Required The application name. 1564 "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. 1565 }, 1566 ], 1567 "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job. 1568 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries. 1569 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Pig command: name=[value]). 1570 "a_key": "A String", 1571 }, 1572 "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. 1573 "A String", 1574 ], 1575 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 1576 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG' 1577 "a_key": "A String", 1578 }, 1579 }, 1580 "queryList": { # A list of queries to run on a cluster. # A list of queries. 1581 "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: 1582 # "hiveJob": { 1583 # "queryList": { 1584 # "queries": [ 1585 # "query1", 1586 # "query2", 1587 # "query3;query4", 1588 # ] 1589 # } 1590 # } 1591 "A String", 1592 ], 1593 }, 1594 "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. 1595 "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. 1596 "a_key": "A String", 1597 }, 1598 }, 1599 "driverOutputResourceUri": "A String", # Output-only A URI pointing to the location of the stdout of the job's driver program. 1600 "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job. 1601 "mainPythonFileUri": "A String", # Required The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file. 1602 "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. 1603 "A String", 1604 ], 1605 "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks. 1606 "A String", 1607 ], 1608 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 1609 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG' 1610 "a_key": "A String", 1611 }, 1612 }, 1613 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks. 1614 "A String", 1615 ], 1616 "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip. 1617 "A String", 1618 ], 1619 "pythonFileUris": [ # Optional HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip. 1620 "A String", 1621 ], 1622 "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. 1623 "a_key": "A String", 1624 }, 1625 }, 1626 "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. 1627 "driverInputResourceUri": "A String", # Output-only A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive. 1628 "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job. 1629 "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. 1630 "A String", 1631 ], 1632 "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks. 1633 "A String", 1634 ], 1635 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution. 1636 "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' 1637 "a_key": "A String", 1638 }, 1639 }, 1640 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks. 1641 "A String", 1642 ], 1643 "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris. 1644 "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. 1645 "A String", 1646 ], 1647 "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class. 1648 "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. 1649 "a_key": "A String", 1650 }, 1651 }, 1652 "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>. 1653 "scheduling": { # Job scheduling options.Beta Feature: These options are available for testing purposes only. They may be changed before final release. # Optional Job scheduling configuration. 1654 "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. 1655 }, 1656 "statusHistory": [ # Output-only The previous job status. 1657 { # Cloud Dataproc job status. 1658 "state": "A String", # Required A state message specifying the overall job state. 1659 "stateStartTime": "A String", # Output-only The time when this state was entered. 1660 "substate": "A String", # Output-only Additional state information, which includes status reported by the agent. 1661 "details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>. 1662 }, 1663 ], 1664 "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job. 1665 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries. 1666 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Hive command: SET name="value";). 1667 "a_key": "A String", 1668 }, 1669 "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. 1670 "A String", 1671 ], 1672 "queryList": { # A list of queries to run on a cluster. # A list of queries. 1673 "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: 1674 # "hiveJob": { 1675 # "queryList": { 1676 # "queries": [ 1677 # "query1", 1678 # "query2", 1679 # "query3;query4", 1680 # ] 1681 # } 1682 # } 1683 "A String", 1684 ], 1685 }, 1686 "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. 1687 "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. 1688 "a_key": "A String", 1689 }, 1690 }, 1691 "interactive": True or False, # Optional If set to true, the driver's stdin will be kept open and driver_input_uri will be set to provide a path at which additional input can be sent to the driver. 1692 }</pre> 1693 </div> 1694 1695 </body></html>
