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