Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c30d2b5d4478b230246dcaaa9f1c533ca3304387 / . / docs / dyn / dataproc_v1alpha1.projects.regions.jobs.html
blob: 298b4ee393cba9cb32bbbe6b0726d420acdbd583 [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="dataproc_v1alpha1.html">Google Cloud Dataproc API</a> . <a href="dataproc_v1alpha1.projects.html">projects</a> . <a href="dataproc_v1alpha1.projects.regions.html">regions</a> . <a href="dataproc_v1alpha1.projects.regions.jobs.html">jobs</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#cancel">cancel(projectId, region, jobId, body, x__xgafv=None)</a></code></p>
79<p class="firstline">Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs:list or regions/{region}/jobs:get.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(projectId, region, jobId, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]82<p class="firstline">Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]83<p class="toc_element">
84 <code><a href="#get">get(projectId, region, jobId, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets the resource representation for a job in a project.</p>
86<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]87 <code><a href="#list">list(projectId, region, body, x__xgafv=None)</a></code></p>
88<p class="firstline">Lists regions/{region}/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, region, 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">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]96 <code><a href="#submit">submit(projectId, region, 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, region, jobId, body, x__xgafv=None)</code>
101 <pre>Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs:list or regions/{region}/jobs:get.
102
103Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]104 projectId: string, Required The ID of the Google Cloud Platform project that the job belongs to. (required)
105 region: string, Required The Dataproc region in which to handle the request. (required)
106 jobId: string, Required The job ID. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]107 body: object, The request body. (required)
108 The object takes the form of:
109
110{ # A request to cancel a job.
111 }
112
113 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]114 Allowed values
115 1 - v1 error format
116 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]117
118Returns:
119 An object of the form:
120
121 { # A Cloud Dataproc job resource.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]122 "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.
123 "stateStartTime": "A String", # Output-only The time when this state was entered.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]124 "startTime": "A String", # The time when the server started the job.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]125 "state": "A String", # Required A state message specifying the overall job state.
126 "details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
127 "insertTime": "A String", # The time of the job request.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]128 "endTime": "A String", # The time when the job completed.
129 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]130 "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
131 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]132 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]133 "a_key": "A String",
134 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]135 "jarFileUris": [ # Optional HCFS URIs of jar files to be added to the Spark CLASSPATH.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]136 "A String",
137 ],
138 "queryList": { # A list of queries to run on a cluster. # A list of queries.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]139 "queries": [ # Required The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
140 # "hiveJob": {
141 # "queryList": {
142 # "queries": [
143 # "query1",
144 # "query2",
145 # "query3;query4",
146 # ]
147 # }
148 # }
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]149 "A String",
150 ],
151 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]152 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
153 "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
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]154 "a_key": "A String",
155 },
156 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]157 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]158 "a_key": "A String",
159 },
160 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]161 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]162 "a_key": "A String",
163 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]164 "yarnApplications": [ # Output-only The collection of Yarn applications spun up by this job.
165 { # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.
166 "progress": 3.14, # Required The numerical progress of the application, from 1 to 100.
167 "state": "A String", # Required The application state.
168 "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.
169 "name": "A String", # Required The application name.
170 },
171 ],
172 "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>.
173 "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
174 "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 dashes (-). The maximum length is 100 characters.
175 },
176 "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
177 "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]178 "A String",
179 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]180 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]181 "A String",
182 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]183 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
184 "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
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]185 "a_key": "A String",
186 },
187 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]188 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
189 "A String",
190 ],
191 "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.
192 "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.
193 "A String",
194 ],
195 "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
196 "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.
197 "a_key": "A String",
198 },
199 },
200 "driverOutputUri": "A String", # Output-only A URI pointing to the location of the mixed stdout/stderr of the job's driver program&mdash;for example, <code>gs://sysbucket123/foo-cluster/jobid-123/driver/output</code>.
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 "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.
207 "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.
208 "A String",
209 ],
210 "queryList": { # A list of queries to run on a cluster. # A list of queries.
211 "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:
212 # "hiveJob": {
213 # "queryList": {
214 # "queries": [
215 # "query1",
216 # "query2",
217 # "query3;query4",
218 # ]
219 # }
220 # }
221 "A String",
222 ],
223 },
224 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
225 "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
226 "a_key": "A String",
227 },
228 },
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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]279 "A String",
280 ],
281 "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]283 "a_key": "A String",
284 },
285 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]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 "placement": { # Cloud Dataproc job configuration. # Required Job information, including how, when, and where to run the job.
291 "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
292 "clusterUuid": "A String", # Output-only A cluster UUID generated by the Dataproc service when the job is submitted.
293 },
294 "statusHistory": [ # Output-only The previous job status.
295 { # Cloud Dataproc job status.
296 "stateStartTime": "A String", # Output-only The time when this state was entered.
297 "startTime": "A String", # The time when the server started the job.
298 "state": "A String", # Required A state message specifying the overall job state.
299 "details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
300 "insertTime": "A String", # The time of the job request.
301 "endTime": "A String", # The time when the job completed.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]302 },
303 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]304 "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
305 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]306 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Hive command: 'SET name="value";').
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]307 "a_key": "A String",
308 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]309 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]310 "A String",
311 ],
312 "queryList": { # A list of queries to run on a cluster. # A list of queries.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]313 "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:
314 # "hiveJob": {
315 # "queryList": {
316 # "queries": [
317 # "query1",
318 # "query2",
319 # "query3;query4",
320 # ]
321 # }
322 # }
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]323 "A String",
324 ],
325 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]326 "continueOnFailure": True or False, # Optional Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
327 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]328 "a_key": "A String",
329 },
330 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]331 "interactive": True or False, # Optional If set to true, then 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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]332 }</pre>
333</div>
334
335<div class="method">
336 <code class="details" id="delete">delete(projectId, region, jobId, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]337 <pre>Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]338
339Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]340 projectId: string, Required The ID of the Google Cloud Platform project that the job belongs to. (required)
341 region: string, Required The Dataproc region in which to handle the request. (required)
342 jobId: string, Required The job ID. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]343 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]344 Allowed values
345 1 - v1 error format
346 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]347
348Returns:
349 An object of the form:
350
351 { # A Cloud Dataproc job resource.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]352 "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.
353 "stateStartTime": "A String", # Output-only The time when this state was entered.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]354 "startTime": "A String", # The time when the server started the job.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]355 "state": "A String", # Required A state message specifying the overall job state.
356 "details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
357 "insertTime": "A String", # The time of the job request.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]358 "endTime": "A String", # The time when the job completed.
359 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]360 "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
361 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]362 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]363 "a_key": "A String",
364 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]365 "jarFileUris": [ # Optional HCFS URIs of jar files to be added to the Spark CLASSPATH.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]366 "A String",
367 ],
368 "queryList": { # A list of queries to run on a cluster. # A list of queries.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]369 "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:
370 # "hiveJob": {
371 # "queryList": {
372 # "queries": [
373 # "query1",
374 # "query2",
375 # "query3;query4",
376 # ]
377 # }
378 # }
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]379 "A String",
380 ],
381 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]382 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
383 "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
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]384 "a_key": "A String",
385 },
386 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]387 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]388 "a_key": "A String",
389 },
390 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]391 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]392 "a_key": "A String",
393 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]394 "yarnApplications": [ # Output-only The collection of Yarn applications spun up by this job.
395 { # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.
396 "progress": 3.14, # Required The numerical progress of the application, from 1 to 100.
397 "state": "A String", # Required The application state.
398 "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.
399 "name": "A String", # Required The application name.
400 },
401 ],
402 "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>.
403 "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
404 "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 dashes (-). The maximum length is 100 characters.
405 },
406 "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
407 "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]408 "A String",
409 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]410 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]411 "A String",
412 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]413 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
414 "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
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]415 "a_key": "A String",
416 },
417 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]418 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
419 "A String",
420 ],
421 "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.
422 "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.
423 "A String",
424 ],
425 "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
426 "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.
427 "a_key": "A String",
428 },
429 },
430 "driverOutputUri": "A String", # Output-only A URI pointing to the location of the mixed stdout/stderr of the job's driver program&mdash;for example, <code>gs://sysbucket123/foo-cluster/jobid-123/driver/output</code>.
431 "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
432 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
433 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Pig command: "name=value").
434 "a_key": "A String",
435 },
436 "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.
437 "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.
438 "A String",
439 ],
440 "queryList": { # A list of queries to run on a cluster. # A list of queries.
441 "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:
442 # "hiveJob": {
443 # "queryList": {
444 # "queries": [
445 # "query1",
446 # "query2",
447 # "query3;query4",
448 # ]
449 # }
450 # }
451 "A String",
452 ],
453 },
454 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
455 "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
456 "a_key": "A String",
457 },
458 },
459 "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.
460 "a_key": "A String",
461 },
462 },
463 "driverOutputResourceUri": "A String", # Output-only A URI pointing to the location of the stdout of the job's driver program.
464 "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
465 "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.
466 "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.
467 "A String",
468 ],
469 "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
470 "A String",
471 ],
472 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
473 "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
474 "a_key": "A String",
475 },
476 },
477 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
478 "A String",
479 ],
480 "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
481 "A String",
482 ],
483 "pythonFileUris": [ # Optional HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
484 "A String",
485 ],
486 "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.
487 "a_key": "A String",
488 },
489 },
490 "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.
491 "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.
492 "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
493 "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
494 "A String",
495 ],
496 "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
497 "A String",
498 ],
499 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
500 "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
501 "a_key": "A String",
502 },
503 },
504 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]505 "A String",
506 ],
507 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]508 "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]509 "A String",
510 ],
511 "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]512 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]513 "a_key": "A String",
514 },
515 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]516 "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>.
517 "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.
518 "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.
519 },
520 "placement": { # Cloud Dataproc job configuration. # Required Job information, including how, when, and where to run the job.
521 "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
522 "clusterUuid": "A String", # Output-only A cluster UUID generated by the Dataproc service when the job is submitted.
523 },
524 "statusHistory": [ # Output-only The previous job status.
525 { # Cloud Dataproc job status.
526 "stateStartTime": "A String", # Output-only The time when this state was entered.
527 "startTime": "A String", # The time when the server started the job.
528 "state": "A String", # Required A state message specifying the overall job state.
529 "details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
530 "insertTime": "A String", # The time of the job request.
531 "endTime": "A String", # The time when the job completed.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]532 },
533 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]534 "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
535 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]536 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Hive command: 'SET name="value";').
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]537 "a_key": "A String",
538 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]539 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]540 "A String",
541 ],
542 "queryList": { # A list of queries to run on a cluster. # A list of queries.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]543 "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:
544 # "hiveJob": {
545 # "queryList": {
546 # "queries": [
547 # "query1",
548 # "query2",
549 # "query3;query4",
550 # ]
551 # }
552 # }
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]553 "A String",
554 ],
555 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]556 "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.
557 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]558 "a_key": "A String",
559 },
560 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]561 "interactive": True or False, # Optional If set to true, then 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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]562 }</pre>
563</div>
564
565<div class="method">
566 <code class="details" id="get">get(projectId, region, jobId, x__xgafv=None)</code>
567 <pre>Gets the resource representation for a job in a project.
568
569Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]570 projectId: string, Required The ID of the Google Cloud Platform project that the job belongs to. (required)
571 region: string, Required The Dataproc region in which to handle the request. (required)
572 jobId: string, Required The job ID. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]573 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]574 Allowed values
575 1 - v1 error format
576 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]577
578Returns:
579 An object of the form:
580
581 { # A Cloud Dataproc job resource.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]582 "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.
583 "stateStartTime": "A String", # Output-only The time when this state was entered.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]584 "startTime": "A String", # The time when the server started the job.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]585 "state": "A String", # Required A state message specifying the overall job state.
586 "details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
587 "insertTime": "A String", # The time of the job request.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]588 "endTime": "A String", # The time when the job completed.
589 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]590 "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
591 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]592 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]593 "a_key": "A String",
594 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]595 "jarFileUris": [ # Optional HCFS URIs of jar files to be added to the Spark CLASSPATH.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]596 "A String",
597 ],
598 "queryList": { # A list of queries to run on a cluster. # A list of queries.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]599 "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:
600 # "hiveJob": {
601 # "queryList": {
602 # "queries": [
603 # "query1",
604 # "query2",
605 # "query3;query4",
606 # ]
607 # }
608 # }
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]609 "A String",
610 ],
611 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]612 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
613 "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
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]614 "a_key": "A String",
615 },
616 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]617 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]618 "a_key": "A String",
619 },
620 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]621 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]622 "a_key": "A String",
623 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]624 "yarnApplications": [ # Output-only The collection of Yarn applications spun up by this job.
625 { # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.
626 "progress": 3.14, # Required The numerical progress of the application, from 1 to 100.
627 "state": "A String", # Required The application state.
628 "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.
629 "name": "A String", # Required The application name.
630 },
631 ],
632 "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>.
633 "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
634 "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 dashes (-). The maximum length is 100 characters.
635 },
636 "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
637 "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]638 "A String",
639 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]640 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]641 "A String",
642 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]643 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
644 "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
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]645 "a_key": "A String",
646 },
647 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]648 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
649 "A String",
650 ],
651 "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.
652 "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.
653 "A String",
654 ],
655 "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
656 "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.
657 "a_key": "A String",
658 },
659 },
660 "driverOutputUri": "A String", # Output-only A URI pointing to the location of the mixed stdout/stderr of the job's driver program&mdash;for example, <code>gs://sysbucket123/foo-cluster/jobid-123/driver/output</code>.
661 "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
662 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
663 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Pig command: "name=value").
664 "a_key": "A String",
665 },
666 "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.
667 "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.
668 "A String",
669 ],
670 "queryList": { # A list of queries to run on a cluster. # A list of queries.
671 "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:
672 # "hiveJob": {
673 # "queryList": {
674 # "queries": [
675 # "query1",
676 # "query2",
677 # "query3;query4",
678 # ]
679 # }
680 # }
681 "A String",
682 ],
683 },
684 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
685 "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
686 "a_key": "A String",
687 },
688 },
689 "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.
690 "a_key": "A String",
691 },
692 },
693 "driverOutputResourceUri": "A String", # Output-only A URI pointing to the location of the stdout of the job's driver program.
694 "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
695 "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.
696 "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.
697 "A String",
698 ],
699 "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
700 "A String",
701 ],
702 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
703 "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
704 "a_key": "A String",
705 },
706 },
707 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
708 "A String",
709 ],
710 "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
711 "A String",
712 ],
713 "pythonFileUris": [ # Optional HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
714 "A String",
715 ],
716 "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.
717 "a_key": "A String",
718 },
719 },
720 "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.
721 "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.
722 "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
723 "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.
724 "A String",
725 ],
726 "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
727 "A String",
728 ],
729 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
730 "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
731 "a_key": "A String",
732 },
733 },
734 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]735 "A String",
736 ],
737 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]738 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]739 "A String",
740 ],
741 "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]742 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]743 "a_key": "A String",
744 },
745 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]746 "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>.
747 "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.
748 "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.
749 },
750 "placement": { # Cloud Dataproc job configuration. # Required Job information, including how, when, and where to run the job.
751 "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
752 "clusterUuid": "A String", # Output-only A cluster UUID generated by the Dataproc service when the job is submitted.
753 },
754 "statusHistory": [ # Output-only The previous job status.
755 { # Cloud Dataproc job status.
756 "stateStartTime": "A String", # Output-only The time when this state was entered.
757 "startTime": "A String", # The time when the server started the job.
758 "state": "A String", # Required A state message specifying the overall job state.
759 "details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
760 "insertTime": "A String", # The time of the job request.
761 "endTime": "A String", # The time when the job completed.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]762 },
763 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]764 "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
765 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]766 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Hive command: 'SET name="value";').
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]767 "a_key": "A String",
768 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]769 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]770 "A String",
771 ],
772 "queryList": { # A list of queries to run on a cluster. # A list of queries.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]773 "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:
774 # "hiveJob": {
775 # "queryList": {
776 # "queries": [
777 # "query1",
778 # "query2",
779 # "query3;query4",
780 # ]
781 # }
782 # }
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]783 "A String",
784 ],
785 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]786 "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.
787 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]788 "a_key": "A String",
789 },
790 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]791 "interactive": True or False, # Optional If set to true, then 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.
792 }</pre>
793</div>
794
795<div class="method">
796 <code class="details" id="list">list(projectId, region, body, x__xgafv=None)</code>
797 <pre>Lists regions/{region}/jobs in a project.
798
799Args:
800 projectId: string, Required The ID of the Google Cloud Platform project that the job belongs to. (required)
801 region: string, Required The Dataproc region in which to handle the request. (required)
802 body: object, The request body. (required)
803 The object takes the form of:
804
805{ # A request to list jobs in a project.
806 "filter": "A 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)
807 "pageToken": "A String", # Optional The page token, returned by a previous call, to request the next page of results.
808 "clusterName": "A String", # Optional If set, the returned jobs list includes only jobs that were submitted to the named cluster.
809 "jobStateMatcher": "A String", # Optional Specifies enumerated categories of jobs to list.
810 "pageSize": 42, # Optional The number of results to return in each response.
811 }
812
813 x__xgafv: string, V1 error format.
814 Allowed values
815 1 - v1 error format
816 2 - v2 error format
817
818Returns:
819 An object of the form:
820
821 { # A response to a request to list jobs in a project.
822 "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>.
823 "jobs": [ # Output-only Jobs list.
824 { # A Cloud Dataproc job resource.
825 "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.
826 "stateStartTime": "A String", # Output-only The time when this state was entered.
827 "startTime": "A String", # The time when the server started the job.
828 "state": "A String", # Required A state message specifying the overall job state.
829 "details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
830 "insertTime": "A String", # The time of the job request.
831 "endTime": "A String", # The time when the job completed.
832 },
833 "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
834 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
835 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
836 "a_key": "A String",
837 },
838 "jarFileUris": [ # Optional HCFS URIs of jar files to be added to the Spark CLASSPATH.
839 "A String",
840 ],
841 "queryList": { # A list of queries to run on a cluster. # A list of queries.
842 "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:
843 # "hiveJob": {
844 # "queryList": {
845 # "queries": [
846 # "query1",
847 # "query2",
848 # "query3;query4",
849 # ]
850 # }
851 # }
852 "A String",
853 ],
854 },
855 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
856 "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
857 "a_key": "A String",
858 },
859 },
860 "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.
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 "yarnApplications": [ # Output-only The collection of Yarn applications spun up by this job.
868 { # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.
869 "progress": 3.14, # Required The numerical progress of the application, from 1 to 100.
870 "state": "A String", # Required The application state.
871 "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.
872 "name": "A String", # Required The application name.
873 },
874 ],
875 "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>.
876 "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
877 "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 dashes (-). The maximum length is 100 characters.
878 },
879 "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
880 "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
881 "A String",
882 ],
883 "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.
884 "A String",
885 ],
886 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
887 "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
888 "a_key": "A String",
889 },
890 },
891 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
892 "A String",
893 ],
894 "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.
895 "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.
896 "A String",
897 ],
898 "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
899 "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.
900 "a_key": "A String",
901 },
902 },
903 "driverOutputUri": "A String", # Output-only A URI pointing to the location of the mixed stdout/stderr of the job's driver program&mdash;for example, <code>gs://sysbucket123/foo-cluster/jobid-123/driver/output</code>.
904 "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
905 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
906 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Pig command: "name=value").
907 "a_key": "A String",
908 },
909 "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.
910 "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.
911 "A String",
912 ],
913 "queryList": { # A list of queries to run on a cluster. # A list of queries.
914 "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:
915 # "hiveJob": {
916 # "queryList": {
917 # "queries": [
918 # "query1",
919 # "query2",
920 # "query3;query4",
921 # ]
922 # }
923 # }
924 "A String",
925 ],
926 },
927 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
928 "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
929 "a_key": "A String",
930 },
931 },
932 "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.
933 "a_key": "A String",
934 },
935 },
936 "driverOutputResourceUri": "A String", # Output-only A URI pointing to the location of the stdout of the job's driver program.
937 "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
938 "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.
939 "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.
940 "A String",
941 ],
942 "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
943 "A String",
944 ],
945 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
946 "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
947 "a_key": "A String",
948 },
949 },
950 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
951 "A String",
952 ],
953 "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
954 "A String",
955 ],
956 "pythonFileUris": [ # Optional HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
957 "A String",
958 ],
959 "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.
960 "a_key": "A String",
961 },
962 },
963 "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.
964 "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.
965 "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
966 "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.
967 "A String",
968 ],
969 "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
970 "A String",
971 ],
972 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
973 "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
974 "a_key": "A String",
975 },
976 },
977 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
978 "A String",
979 ],
980 "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.
981 "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.
982 "A String",
983 ],
984 "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.
985 "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.
986 "a_key": "A String",
987 },
988 },
989 "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>.
990 "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.
991 "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.
992 },
993 "placement": { # Cloud Dataproc job configuration. # Required Job information, including how, when, and where to run the job.
994 "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
995 "clusterUuid": "A String", # Output-only A cluster UUID generated by the Dataproc service when the job is submitted.
996 },
997 "statusHistory": [ # Output-only The previous job status.
998 { # Cloud Dataproc job status.
999 "stateStartTime": "A String", # Output-only The time when this state was entered.
1000 "startTime": "A String", # The time when the server started the job.
1001 "state": "A String", # Required A state message specifying the overall job state.
1002 "details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
1003 "insertTime": "A String", # The time of the job request.
1004 "endTime": "A String", # The time when the job completed.
1005 },
1006 ],
1007 "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
1008 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
1009 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Hive command: 'SET name="value";').
1010 "a_key": "A String",
1011 },
1012 "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.
1013 "A String",
1014 ],
1015 "queryList": { # A list of queries to run on a cluster. # A list of queries.
1016 "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:
1017 # "hiveJob": {
1018 # "queryList": {
1019 # "queries": [
1020 # "query1",
1021 # "query2",
1022 # "query3;query4",
1023 # ]
1024 # }
1025 # }
1026 "A String",
1027 ],
1028 },
1029 "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.
1030 "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.
1031 "a_key": "A String",
1032 },
1033 },
1034 "interactive": True or False, # Optional If set to true, then 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.
1035 },
1036 ],
1037 }</pre>
1038</div>
1039
1040<div class="method">
1041 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
1042 <pre>Retrieves the next page of results.
1043
1044Args:
1045 previous_request: The request for the previous page. (required)
1046 previous_response: The response from the request for the previous page. (required)
1047
1048Returns:
1049 A request object that you can call 'execute()' on to request the next
1050 page. Returns None if there are no more items in the collection.
1051 </pre>
1052</div>
1053
1054<div class="method">
1055 <code class="details" id="patch">patch(projectId, region, jobId, body, updateMask=None, x__xgafv=None)</code>
1056 <pre>Updates a job in a project.
1057
1058Args:
1059 projectId: string, Required The ID of the Google Cloud Platform project that the job belongs to. (required)
1060 region: string, Required The Dataproc region in which to handle the request. (required)
1061 jobId: string, Required The job ID. (required)
1062 body: object, The request body. (required)
1063 The object takes the form of:
1064
1065{ # A Cloud Dataproc job resource.
1066 "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.
1067 "stateStartTime": "A String", # Output-only The time when this state was entered.
1068 "startTime": "A String", # The time when the server started the job.
1069 "state": "A String", # Required A state message specifying the overall job state.
1070 "details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
1071 "insertTime": "A String", # The time of the job request.
1072 "endTime": "A String", # The time when the job completed.
1073 },
1074 "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
1075 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
1076 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
1077 "a_key": "A String",
1078 },
1079 "jarFileUris": [ # Optional HCFS URIs of jar files to be added to the Spark CLASSPATH.
1080 "A String",
1081 ],
1082 "queryList": { # A list of queries to run on a cluster. # A list of queries.
1083 "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:
1084 # "hiveJob": {
1085 # "queryList": {
1086 # "queries": [
1087 # "query1",
1088 # "query2",
1089 # "query3;query4",
1090 # ]
1091 # }
1092 # }
1093 "A String",
1094 ],
1095 },
1096 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
1097 "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
1098 "a_key": "A String",
1099 },
1100 },
1101 "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.
1102 "a_key": "A String",
1103 },
1104 },
1105 "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.
1106 "a_key": "A String",
1107 },
1108 "yarnApplications": [ # Output-only The collection of Yarn applications spun up by this job.
1109 { # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.
1110 "progress": 3.14, # Required The numerical progress of the application, from 1 to 100.
1111 "state": "A String", # Required The application state.
1112 "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.
1113 "name": "A String", # Required The application name.
1114 },
1115 ],
1116 "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>.
1117 "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
1118 "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 dashes (-). The maximum length is 100 characters.
1119 },
1120 "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
1121 "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
1122 "A String",
1123 ],
1124 "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.
1125 "A String",
1126 ],
1127 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
1128 "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
1129 "a_key": "A String",
1130 },
1131 },
1132 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
1133 "A String",
1134 ],
1135 "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.
1136 "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.
1137 "A String",
1138 ],
1139 "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
1140 "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.
1141 "a_key": "A String",
1142 },
1143 },
1144 "driverOutputUri": "A String", # Output-only A URI pointing to the location of the mixed stdout/stderr of the job's driver program&mdash;for example, <code>gs://sysbucket123/foo-cluster/jobid-123/driver/output</code>.
1145 "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
1146 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
1147 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Pig command: "name=value").
1148 "a_key": "A String",
1149 },
1150 "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.
1151 "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.
1152 "A String",
1153 ],
1154 "queryList": { # A list of queries to run on a cluster. # A list of queries.
1155 "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:
1156 # "hiveJob": {
1157 # "queryList": {
1158 # "queries": [
1159 # "query1",
1160 # "query2",
1161 # "query3;query4",
1162 # ]
1163 # }
1164 # }
1165 "A String",
1166 ],
1167 },
1168 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
1169 "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
1170 "a_key": "A String",
1171 },
1172 },
1173 "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.
1174 "a_key": "A String",
1175 },
1176 },
1177 "driverOutputResourceUri": "A String", # Output-only A URI pointing to the location of the stdout of the job's driver program.
1178 "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
1179 "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.
1180 "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.
1181 "A String",
1182 ],
1183 "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
1184 "A String",
1185 ],
1186 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
1187 "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
1188 "a_key": "A String",
1189 },
1190 },
1191 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
1192 "A String",
1193 ],
1194 "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
1195 "A String",
1196 ],
1197 "pythonFileUris": [ # Optional HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
1198 "A String",
1199 ],
1200 "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.
1201 "a_key": "A String",
1202 },
1203 },
1204 "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.
1205 "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.
1206 "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
1207 "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.
1208 "A String",
1209 ],
1210 "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
1211 "A String",
1212 ],
1213 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
1214 "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
1215 "a_key": "A String",
1216 },
1217 },
1218 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
1219 "A String",
1220 ],
1221 "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.
1222 "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.
1223 "A String",
1224 ],
1225 "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.
1226 "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.
1227 "a_key": "A String",
1228 },
1229 },
1230 "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>.
1231 "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.
1232 "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.
1233 },
1234 "placement": { # Cloud Dataproc job configuration. # Required Job information, including how, when, and where to run the job.
1235 "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
1236 "clusterUuid": "A String", # Output-only A cluster UUID generated by the Dataproc service when the job is submitted.
1237 },
1238 "statusHistory": [ # Output-only The previous job status.
1239 { # Cloud Dataproc job status.
1240 "stateStartTime": "A String", # Output-only The time when this state was entered.
1241 "startTime": "A String", # The time when the server started the job.
1242 "state": "A String", # Required A state message specifying the overall job state.
1243 "details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
1244 "insertTime": "A String", # The time of the job request.
1245 "endTime": "A String", # The time when the job completed.
1246 },
1247 ],
1248 "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
1249 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
1250 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Hive command: 'SET name="value";').
1251 "a_key": "A String",
1252 },
1253 "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.
1254 "A String",
1255 ],
1256 "queryList": { # A list of queries to run on a cluster. # A list of queries.
1257 "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:
1258 # "hiveJob": {
1259 # "queryList": {
1260 # "queries": [
1261 # "query1",
1262 # "query2",
1263 # "query3;query4",
1264 # ]
1265 # }
1266 # }
1267 "A String",
1268 ],
1269 },
1270 "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.
1271 "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.
1272 "a_key": "A String",
1273 },
1274 },
1275 "interactive": True or False, # Optional If set to true, then 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.
1276}
1277
1278 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.
1279 x__xgafv: string, V1 error format.
1280 Allowed values
1281 1 - v1 error format
1282 2 - v2 error format
1283
1284Returns:
1285 An object of the form:
1286
1287 { # A Cloud Dataproc job resource.
1288 "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.
1289 "stateStartTime": "A String", # Output-only The time when this state was entered.
1290 "startTime": "A String", # The time when the server started the job.
1291 "state": "A String", # Required A state message specifying the overall job state.
1292 "details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
1293 "insertTime": "A String", # The time of the job request.
1294 "endTime": "A String", # The time when the job completed.
1295 },
1296 "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
1297 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
1298 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
1299 "a_key": "A String",
1300 },
1301 "jarFileUris": [ # Optional HCFS URIs of jar files to be added to the Spark CLASSPATH.
1302 "A String",
1303 ],
1304 "queryList": { # A list of queries to run on a cluster. # A list of queries.
1305 "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:
1306 # "hiveJob": {
1307 # "queryList": {
1308 # "queries": [
1309 # "query1",
1310 # "query2",
1311 # "query3;query4",
1312 # ]
1313 # }
1314 # }
1315 "A String",
1316 ],
1317 },
1318 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
1319 "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
1320 "a_key": "A String",
1321 },
1322 },
1323 "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.
1324 "a_key": "A String",
1325 },
1326 },
1327 "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.
1328 "a_key": "A String",
1329 },
1330 "yarnApplications": [ # Output-only The collection of Yarn applications spun up by this job.
1331 { # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.
1332 "progress": 3.14, # Required The numerical progress of the application, from 1 to 100.
1333 "state": "A String", # Required The application state.
1334 "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.
1335 "name": "A String", # Required The application name.
1336 },
1337 ],
1338 "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>.
1339 "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
1340 "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 dashes (-). The maximum length is 100 characters.
1341 },
1342 "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
1343 "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
1344 "A String",
1345 ],
1346 "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.
1347 "A String",
1348 ],
1349 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
1350 "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
1351 "a_key": "A String",
1352 },
1353 },
1354 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
1355 "A String",
1356 ],
1357 "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.
1358 "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.
1359 "A String",
1360 ],
1361 "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
1362 "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.
1363 "a_key": "A String",
1364 },
1365 },
1366 "driverOutputUri": "A String", # Output-only A URI pointing to the location of the mixed stdout/stderr of the job's driver program&mdash;for example, <code>gs://sysbucket123/foo-cluster/jobid-123/driver/output</code>.
1367 "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
1368 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
1369 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Pig command: "name=value").
1370 "a_key": "A String",
1371 },
1372 "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.
1373 "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
1374 "A String",
1375 ],
1376 "queryList": { # A list of queries to run on a cluster. # A list of queries.
1377 "queries": [ # Required The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
1378 # "hiveJob": {
1379 # "queryList": {
1380 # "queries": [
1381 # "query1",
1382 # "query2",
1383 # "query3;query4",
1384 # ]
1385 # }
1386 # }
1387 "A String",
1388 ],
1389 },
1390 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
1391 "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
1392 "a_key": "A String",
1393 },
1394 },
1395 "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.
1396 "a_key": "A String",
1397 },
1398 },
1399 "driverOutputResourceUri": "A String", # Output-only A URI pointing to the location of the stdout of the job's driver program.
1400 "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
1401 "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.
1402 "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.
1403 "A String",
1404 ],
1405 "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
1406 "A String",
1407 ],
1408 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
1409 "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
1410 "a_key": "A String",
1411 },
1412 },
1413 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
1414 "A String",
1415 ],
1416 "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
1417 "A String",
1418 ],
1419 "pythonFileUris": [ # Optional HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
1420 "A String",
1421 ],
1422 "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.
1423 "a_key": "A String",
1424 },
1425 },
1426 "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.
1427 "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.
1428 "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
1429 "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.
1430 "A String",
1431 ],
1432 "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
1433 "A String",
1434 ],
1435 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
1436 "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
1437 "a_key": "A String",
1438 },
1439 },
1440 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
1441 "A String",
1442 ],
1443 "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.
1444 "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.
1445 "A String",
1446 ],
1447 "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.
1448 "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.
1449 "a_key": "A String",
1450 },
1451 },
1452 "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>.
1453 "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.
1454 "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.
1455 },
1456 "placement": { # Cloud Dataproc job configuration. # Required Job information, including how, when, and where to run the job.
1457 "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
1458 "clusterUuid": "A String", # Output-only A cluster UUID generated by the Dataproc service when the job is submitted.
1459 },
1460 "statusHistory": [ # Output-only The previous job status.
1461 { # Cloud Dataproc job status.
1462 "stateStartTime": "A String", # Output-only The time when this state was entered.
1463 "startTime": "A String", # The time when the server started the job.
1464 "state": "A String", # Required A state message specifying the overall job state.
1465 "details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
1466 "insertTime": "A String", # The time of the job request.
1467 "endTime": "A String", # The time when the job completed.
1468 },
1469 ],
1470 "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
1471 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
1472 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Hive command: 'SET name="value";').
1473 "a_key": "A String",
1474 },
1475 "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.
1476 "A String",
1477 ],
1478 "queryList": { # A list of queries to run on a cluster. # A list of queries.
1479 "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:
1480 # "hiveJob": {
1481 # "queryList": {
1482 # "queries": [
1483 # "query1",
1484 # "query2",
1485 # "query3;query4",
1486 # ]
1487 # }
1488 # }
1489 "A String",
1490 ],
1491 },
1492 "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.
1493 "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.
1494 "a_key": "A String",
1495 },
1496 },
1497 "interactive": True or False, # Optional If set to true, then 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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1498 }</pre>
1499</div>
1500
1501<div class="method">
1502 <code class="details" id="submit">submit(projectId, region, body, x__xgafv=None)</code>
1503 <pre>Submits a job to a cluster.
1504
1505Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1506 projectId: string, Required The ID of the Google Cloud Platform project that the job belongs to. (required)
1507 region: string, Required The Dataproc region in which to handle the request. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1508 body: object, The request body. (required)
1509 The object takes the form of:
1510
1511{ # A job submission request.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1512 "job": { # A Cloud Dataproc job resource. # Required The job resource.
1513 "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.
1514 "stateStartTime": "A String", # Output-only The time when this state was entered.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1515 "startTime": "A String", # The time when the server started the job.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1516 "state": "A String", # Required A state message specifying the overall job state.
1517 "details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
1518 "insertTime": "A String", # The time of the job request.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1519 "endTime": "A String", # The time when the job completed.
1520 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1521 "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
1522 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1523 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1524 "a_key": "A String",
1525 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1526 "jarFileUris": [ # Optional HCFS URIs of jar files to be added to the Spark CLASSPATH.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1527 "A String",
1528 ],
1529 "queryList": { # A list of queries to run on a cluster. # A list of queries.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1530 "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:
1531 # "hiveJob": {
1532 # "queryList": {
1533 # "queries": [
1534 # "query1",
1535 # "query2",
1536 # "query3;query4",
1537 # ]
1538 # }
1539 # }
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1540 "A String",
1541 ],
1542 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1543 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
1544 "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
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1545 "a_key": "A String",
1546 },
1547 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1548 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1549 "a_key": "A String",
1550 },
1551 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1552 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1553 "a_key": "A String",
1554 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1555 "yarnApplications": [ # Output-only The collection of Yarn applications spun up by this job.
1556 { # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.
1557 "progress": 3.14, # Required The numerical progress of the application, from 1 to 100.
1558 "state": "A String", # Required The application state.
1559 "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.
1560 "name": "A String", # Required The application name.
1561 },
1562 ],
1563 "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>.
1564 "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
1565 "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 dashes (-). The maximum length is 100 characters.
1566 },
1567 "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
1568 "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1569 "A String",
1570 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1571 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1572 "A String",
1573 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1574 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
1575 "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
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1576 "a_key": "A String",
1577 },
1578 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1579 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
1580 "A String",
1581 ],
1582 "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.
1583 "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.
1584 "A String",
1585 ],
1586 "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
1587 "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.
1588 "a_key": "A String",
1589 },
1590 },
1591 "driverOutputUri": "A String", # Output-only A URI pointing to the location of the mixed stdout/stderr of the job's driver program&mdash;for example, <code>gs://sysbucket123/foo-cluster/jobid-123/driver/output</code>.
1592 "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
1593 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
1594 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Pig command: "name=value").
1595 "a_key": "A String",
1596 },
1597 "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.
1598 "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.
1599 "A String",
1600 ],
1601 "queryList": { # A list of queries to run on a cluster. # A list of queries.
1602 "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:
1603 # "hiveJob": {
1604 # "queryList": {
1605 # "queries": [
1606 # "query1",
1607 # "query2",
1608 # "query3;query4",
1609 # ]
1610 # }
1611 # }
1612 "A String",
1613 ],
1614 },
1615 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
1616 "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
1617 "a_key": "A String",
1618 },
1619 },
1620 "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.
1621 "a_key": "A String",
1622 },
1623 },
1624 "driverOutputResourceUri": "A String", # Output-only A URI pointing to the location of the stdout of the job's driver program.
1625 "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
1626 "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.
1627 "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.
1628 "A String",
1629 ],
1630 "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
1631 "A String",
1632 ],
1633 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
1634 "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
1635 "a_key": "A String",
1636 },
1637 },
1638 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
1639 "A String",
1640 ],
1641 "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
1642 "A String",
1643 ],
1644 "pythonFileUris": [ # Optional HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
1645 "A String",
1646 ],
1647 "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.
1648 "a_key": "A String",
1649 },
1650 },
1651 "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.
1652 "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.
1653 "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
1654 "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.
1655 "A String",
1656 ],
1657 "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
1658 "A String",
1659 ],
1660 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
1661 "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
1662 "a_key": "A String",
1663 },
1664 },
1665 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1666 "A String",
1667 ],
1668 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1669 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1670 "A String",
1671 ],
1672 "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1673 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1674 "a_key": "A String",
1675 },
1676 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1677 "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>.
1678 "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.
1679 "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.
1680 },
1681 "placement": { # Cloud Dataproc job configuration. # Required Job information, including how, when, and where to run the job.
1682 "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
1683 "clusterUuid": "A String", # Output-only A cluster UUID generated by the Dataproc service when the job is submitted.
1684 },
1685 "statusHistory": [ # Output-only The previous job status.
1686 { # Cloud Dataproc job status.
1687 "stateStartTime": "A String", # Output-only The time when this state was entered.
1688 "startTime": "A String", # The time when the server started the job.
1689 "state": "A String", # Required A state message specifying the overall job state.
1690 "details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
1691 "insertTime": "A String", # The time of the job request.
1692 "endTime": "A String", # The time when the job completed.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1693 },
1694 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1695 "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
1696 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1697 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Hive command: 'SET name="value";').
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1698 "a_key": "A String",
1699 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1700 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1701 "A String",
1702 ],
1703 "queryList": { # A list of queries to run on a cluster. # A list of queries.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1704 "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:
1705 # "hiveJob": {
1706 # "queryList": {
1707 # "queries": [
1708 # "query1",
1709 # "query2",
1710 # "query3;query4",
1711 # ]
1712 # }
1713 # }
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1714 "A String",
1715 ],
1716 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1717 "continueOnFailure": True or False, # Optional Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
1718 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1719 "a_key": "A String",
1720 },
1721 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1722 "interactive": True or False, # Optional If set to true, then 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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1723 },
1724 }
1725
1726 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1727 Allowed values
1728 1 - v1 error format
1729 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1730
1731Returns:
1732 An object of the form:
1733
1734 { # A Cloud Dataproc job resource.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1735 "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.
1736 "stateStartTime": "A String", # Output-only The time when this state was entered.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1737 "startTime": "A String", # The time when the server started the job.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1738 "state": "A String", # Required A state message specifying the overall job state.
1739 "details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
1740 "insertTime": "A String", # The time of the job request.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1741 "endTime": "A String", # The time when the job completed.
1742 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1743 "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
1744 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1745 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1746 "a_key": "A String",
1747 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1748 "jarFileUris": [ # Optional HCFS URIs of jar files to be added to the Spark CLASSPATH.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1749 "A String",
1750 ],
1751 "queryList": { # A list of queries to run on a cluster. # A list of queries.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1752 "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:
1753 # "hiveJob": {
1754 # "queryList": {
1755 # "queries": [
1756 # "query1",
1757 # "query2",
1758 # "query3;query4",
1759 # ]
1760 # }
1761 # }
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1762 "A String",
1763 ],
1764 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1765 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
1766 "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
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1767 "a_key": "A String",
1768 },
1769 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1770 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1771 "a_key": "A String",
1772 },
1773 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1774 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1775 "a_key": "A String",
1776 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1777 "yarnApplications": [ # Output-only The collection of Yarn applications spun up by this job.
1778 { # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.
1779 "progress": 3.14, # Required The numerical progress of the application, from 1 to 100.
1780 "state": "A String", # Required The application state.
1781 "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.
1782 "name": "A String", # Required The application name.
1783 },
1784 ],
1785 "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>.
1786 "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
1787 "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 dashes (-). The maximum length is 100 characters.
1788 },
1789 "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
1790 "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1791 "A String",
1792 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1793 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1794 "A String",
1795 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1796 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
1797 "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
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1798 "a_key": "A String",
1799 },
1800 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1801 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
1802 "A String",
1803 ],
1804 "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.
1805 "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.
1806 "A String",
1807 ],
1808 "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
1809 "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.
1810 "a_key": "A String",
1811 },
1812 },
1813 "driverOutputUri": "A String", # Output-only A URI pointing to the location of the mixed stdout/stderr of the job's driver program&mdash;for example, <code>gs://sysbucket123/foo-cluster/jobid-123/driver/output</code>.
1814 "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
1815 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
1816 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Pig command: "name=value").
1817 "a_key": "A String",
1818 },
1819 "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.
1820 "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.
1821 "A String",
1822 ],
1823 "queryList": { # A list of queries to run on a cluster. # A list of queries.
1824 "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:
1825 # "hiveJob": {
1826 # "queryList": {
1827 # "queries": [
1828 # "query1",
1829 # "query2",
1830 # "query3;query4",
1831 # ]
1832 # }
1833 # }
1834 "A String",
1835 ],
1836 },
1837 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
1838 "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
1839 "a_key": "A String",
1840 },
1841 },
1842 "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.
1843 "a_key": "A String",
1844 },
1845 },
1846 "driverOutputResourceUri": "A String", # Output-only A URI pointing to the location of the stdout of the job's driver program.
1847 "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
1848 "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.
1849 "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.
1850 "A String",
1851 ],
1852 "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
1853 "A String",
1854 ],
1855 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
1856 "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
1857 "a_key": "A String",
1858 },
1859 },
1860 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
1861 "A String",
1862 ],
1863 "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
1864 "A String",
1865 ],
1866 "pythonFileUris": [ # Optional HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
1867 "A String",
1868 ],
1869 "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.
1870 "a_key": "A String",
1871 },
1872 },
1873 "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.
1874 "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.
1875 "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
1876 "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.
1877 "A String",
1878 ],
1879 "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
1880 "A String",
1881 ],
1882 "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
1883 "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
1884 "a_key": "A String",
1885 },
1886 },
1887 "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1888 "A String",
1889 ],
1890 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1891 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1892 "A String",
1893 ],
1894 "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1895 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1896 "a_key": "A String",
1897 },
1898 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1899 "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>.
1900 "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.
1901 "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.
1902 },
1903 "placement": { # Cloud Dataproc job configuration. # Required Job information, including how, when, and where to run the job.
1904 "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
1905 "clusterUuid": "A String", # Output-only A cluster UUID generated by the Dataproc service when the job is submitted.
1906 },
1907 "statusHistory": [ # Output-only The previous job status.
1908 { # Cloud Dataproc job status.
1909 "stateStartTime": "A String", # Output-only The time when this state was entered.
1910 "startTime": "A String", # The time when the server started the job.
1911 "state": "A String", # Required A state message specifying the overall job state.
1912 "details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
1913 "insertTime": "A String", # The time of the job request.
1914 "endTime": "A String", # The time when the job completed.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1915 },
1916 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1917 "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
1918 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1919 "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Hive command: 'SET name="value";').
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1920 "a_key": "A String",
1921 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1922 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1923 "A String",
1924 ],
1925 "queryList": { # A list of queries to run on a cluster. # A list of queries.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1926 "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:
1927 # "hiveJob": {
1928 # "queryList": {
1929 # "queries": [
1930 # "query1",
1931 # "query2",
1932 # "query3;query4",
1933 # ]
1934 # }
1935 # }
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1936 "A String",
1937 ],
1938 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1939 "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.
1940 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1941 "a_key": "A String",
1942 },
1943 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1944 "interactive": True or False, # Optional If set to true, then 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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1945 }</pre>
1946</div>
1947
1948</body></html>