Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / dataproc_v1beta2.projects.regions.jobs.html
blob: ed68ee99e8363079bb05cf37f327562b2de87ae7 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -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_v1beta2.html">Cloud Dataproc API</a> . <a href="dataproc_v1beta2.projects.html">projects</a> . <a href="dataproc_v1beta2.projects.regions.html">regions</a> . <a href="dataproc_v1beta2.projects.regions.jobs.html">jobs</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#cancel">cancel(projectId, region, jobId, body=None, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]79<p class="firstline">Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list (https://cloud.google.com/dataproc/docs/reference/rest/v1beta2/projects.regions.jobs/list) or regions/{region}/jobs.get (https://cloud.google.com/dataproc/docs/reference/rest/v1beta2/projects.regions.jobs/get).</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]80<p class="toc_element">
81 <code><a href="#delete">delete(projectId, region, jobId, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.</p>
83<p class="toc_element">
84 <code><a href="#get">get(projectId, region, jobId, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets the resource representation for a job in a project.</p>
86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]87 <code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>
89<p class="toc_element">
90 <code><a href="#list">list(projectId, region, pageSize=None, x__xgafv=None, jobStateMatcher=None, pageToken=None, clusterName=None, filter=None)</a></code></p>
91<p class="firstline">Lists regions/{region}/jobs in a project.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]96 <code><a href="#patch">patch(projectId, region, jobId, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]97<p class="firstline">Updates a job in a project.</p>
98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]99 <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
100<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]101<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]102 <code><a href="#submit">submit(projectId, region, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103<p class="firstline">Submits a job to a cluster.</p>
104<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]105 <code><a href="#submitAsOperation">submitAsOperation(projectId, region, body=None, x__xgafv=None)</a></code></p>
106<p class="firstline">Submits job to a cluster.</p>
107<p class="toc_element">
108 <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]109<p class="firstline">Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p>
110<h3>Method Details</h3>
111<div class="method">
112 <code class="details" id="cancel">cancel(projectId, region, jobId, body=None, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]113 <pre>Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list (https://cloud.google.com/dataproc/docs/reference/rest/v1beta2/projects.regions.jobs/list) or regions/{region}/jobs.get (https://cloud.google.com/dataproc/docs/reference/rest/v1beta2/projects.regions.jobs/get).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]114
115Args:
116 projectId: string, Required. The ID of the Google Cloud Platform project that the job belongs to. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]117 region: string, Required. The Dataproc region in which to handle the request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]118 jobId: string, Required. The job ID. (required)
119 body: object, The request body.
120 The object takes the form of:
121
122{ # A request to cancel a job.
123 }
124
125 x__xgafv: string, V1 error format.
126 Allowed values
127 1 - v1 error format
128 2 - v2 error format
129
130Returns:
131 An object of the form:
132
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]133 { # A Dataproc job resource.
134 "status": { # Dataproc job status. # Output only. The job status. Additional application-specific status information may be contained in the &lt;code&gt;type_job&lt;/code&gt; and &lt;code&gt;yarn_applications&lt;/code&gt; fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]135 "state": "A String", # Output only. A state message specifying the overall job state.
136 "stateStartTime": "A String", # Output only. The time when this state was entered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]137 "details": "A String", # Output only. Optional Job state details, such as an error description if the state is &lt;code&gt;ERROR&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]138 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]139 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]140 "hadoopJob": { # A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Optional. Job is a Hadoop job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]141 "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.
142 "A String",
143 ],
144 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
145 "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'
146 "a_key": "A String",
147 },
148 },
149 "jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
150 "A String",
151 ],
152 "fileUris": [ # Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
153 "A String",
154 ],
155 "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.
156 "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.
157 "A String",
158 ],
159 "mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]160 "properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]161 "a_key": "A String",
162 },
163 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]164 "pigJob": { # A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Optional. Job is a Pig job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]165 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
166 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).
167 "a_key": "A String",
168 },
169 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
170 "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'
171 "a_key": "A String",
172 },
173 },
174 "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.
175 "A String",
176 ],
177 "queryList": { # A list of queries to run on a cluster. # A list of queries.
178 "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:
179 # "hiveJob": {
180 # "queryList": {
181 # "queries": [
182 # "query1",
183 # "query2",
184 # "query3;query4",
185 # ]
186 # }
187 # }
188 "A String",
189 ],
190 },
191 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]192 "properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]193 "a_key": "A String",
194 },
195 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]196 "placement": { # Dataproc job config. # Required. Job information, including how, when, and where to run the job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]197 "clusterName": "A String", # Required. The name of the cluster where the job will be submitted.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]198 "clusterUuid": "A String", # Output only. A cluster UUID generated by the Dataproc service when the job is submitted.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]199 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]200 "sparkRJob": { # A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Optional. Job is a SparkR job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]201 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
202 "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'
203 "a_key": "A String",
204 },
205 },
206 "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.
207 "A String",
208 ],
209 "mainRFileUri": "A String", # Required. The HCFS URI of the main R file to use as the driver. Must be a .R file.
210 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of R drivers and distributed tasks. Useful for naively parallel tasks.
211 "A String",
212 ],
213 "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.
214 "A String",
215 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]216 "properties": { # Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]217 "a_key": "A String",
218 },
219 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]220 "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 &lt;code&gt;job_id&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]221 "projectId": "A String", # Required. The ID of the Google Cloud Platform project that the job belongs to.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]222 "jobId": "A String", # Optional. The job ID, which must be unique within the project. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.If not specified by the caller, the job ID will be provided by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]223 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]224 "sparkSqlJob": { # A Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Optional. Job is a SparkSql job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]225 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
226 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
227 "a_key": "A String",
228 },
229 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
230 "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'
231 "a_key": "A String",
232 },
233 },
234 "jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.
235 "A String",
236 ],
237 "queryList": { # A list of queries to run on a cluster. # A list of queries.
238 "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:
239 # "hiveJob": {
240 # "queryList": {
241 # "queries": [
242 # "query1",
243 # "query2",
244 # "query3;query4",
245 # ]
246 # }
247 # }
248 "A String",
249 ],
250 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]251 "properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]252 "a_key": "A String",
253 },
254 },
255 "yarnApplications": [ # Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]256 { # A YARN application created by a job. Application information is a subset of &lt;code&gt;org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto&lt;/code&gt;.Beta Feature: This report is available for testing purposes only. It may be changed before final release.
257 "progress": 3.14, # Output only. The numerical progress of the application, from 1 to 100.
258 "state": "A String", # Output only. The application state.
259 "name": "A String", # Output only. The application name.
260 "trackingUrl": "A String", # Output only. 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]261 },
262 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]263 "submittedBy": "A String", # Output only. The email address of the user submitting the job. For jobs submitted on the cluster, the address is &lt;code&gt;username@hostname&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]264 "jobUuid": "A String", # Output only. A UUID that uniquely identifies a job within the project over time. This is in contrast to a user-settable reference.job_id that may be reused over time.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]265 "labels": { # Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.
266 "a_key": "A String",
267 },
268 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]269 "done": True or False, # Output only. Indicates whether the job is completed. If the value is false, the job is still in progress. If true, the job is completed, and status.state field will indicate if it was successful, failed, or cancelled.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]270 "driverOutputResourceUri": "A String", # Output only. A URI pointing to the location of the stdout of the job's driver program.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]271 "prestoJob": { # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. # Optional. Job is a Presto job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]272 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
273 "outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats
274 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
275 "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'
276 "a_key": "A String",
277 },
278 },
279 "clientTags": [ # Optional. Presto client tags to attach to this query
280 "A String",
281 ],
282 "queryList": { # A list of queries to run on a cluster. # A list of queries.
283 "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:
284 # "hiveJob": {
285 # "queryList": {
286 # "queries": [
287 # "query1",
288 # "query2",
289 # "query3;query4",
290 # ]
291 # }
292 # }
293 "A String",
294 ],
295 },
296 "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.
297 "properties": { # Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI
298 "a_key": "A String",
299 },
300 },
301 "scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.
302 "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.
303 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]304 "sparkJob": { # A Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. The specification of the main method to call to drive the job. Specify either the jar file that contains the main class or the main class name. To pass both a main jar and a main class in that jar, add the jar to CommonJob.jar_file_uris, and then specify the main class name in main_class. # Optional. Job is a Spark job.
305 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
306 "A String",
307 ],
308 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
309 "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'
310 "a_key": "A String",
311 },
312 },
313 "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.
314 "A String",
315 ],
316 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
317 "A String",
318 ],
319 "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.
320 "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.
321 "A String",
322 ],
323 "mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.
324 "properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
325 "a_key": "A String",
326 },
327 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]328 "statusHistory": [ # Output only. The previous job status.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]329 { # Dataproc job status.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]330 "state": "A String", # Output only. A state message specifying the overall job state.
331 "stateStartTime": "A String", # Output only. The time when this state was entered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]332 "details": "A String", # Output only. Optional Job state details, such as an error description if the state is &lt;code&gt;ERROR&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]333 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]334 },
335 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]336 "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Optional. Job is a PySpark job.
337 "mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.
338 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
339 "A String",
340 ],
341 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
342 "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'
343 "a_key": "A String",
344 },
345 },
346 "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.
347 "A String",
348 ],
349 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
350 "A String",
351 ],
352 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
353 "A String",
354 ],
355 "pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
356 "A String",
357 ],
358 "properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
359 "a_key": "A String",
360 },
361 },
362 "hiveJob": { # A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Optional. Job is a Hive job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]363 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
364 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).
365 "a_key": "A String",
366 },
367 "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.
368 "A String",
369 ],
370 "queryList": { # A list of queries to run on a cluster. # A list of queries.
371 "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:
372 # "hiveJob": {
373 # "queryList": {
374 # "queries": [
375 # "query1",
376 # "query2",
377 # "query3;query4",
378 # ]
379 # }
380 # }
381 "A String",
382 ],
383 },
384 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]385 "properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]386 "a_key": "A String",
387 },
388 },
389 }</pre>
390</div>
391
392<div class="method">
393 <code class="details" id="delete">delete(projectId, region, jobId, x__xgafv=None)</code>
394 <pre>Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.
395
396Args:
397 projectId: string, Required. The ID of the Google Cloud Platform project that the job belongs to. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]398 region: string, Required. The Dataproc region in which to handle the request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]399 jobId: string, Required. The job ID. (required)
400 x__xgafv: string, V1 error format.
401 Allowed values
402 1 - v1 error format
403 2 - v2 error format
404
405Returns:
406 An object of the form:
407
408 { # 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:
409 # service Foo {
410 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
411 # }
412 # The JSON representation for Empty is empty JSON object {}.
413 }</pre>
414</div>
415
416<div class="method">
417 <code class="details" id="get">get(projectId, region, jobId, x__xgafv=None)</code>
418 <pre>Gets the resource representation for a job in a project.
419
420Args:
421 projectId: string, Required. The ID of the Google Cloud Platform project that the job belongs to. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]422 region: string, Required. The Dataproc region in which to handle the request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]423 jobId: string, Required. The job ID. (required)
424 x__xgafv: string, V1 error format.
425 Allowed values
426 1 - v1 error format
427 2 - v2 error format
428
429Returns:
430 An object of the form:
431
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]432 { # A Dataproc job resource.
433 "status": { # Dataproc job status. # Output only. The job status. Additional application-specific status information may be contained in the &lt;code&gt;type_job&lt;/code&gt; and &lt;code&gt;yarn_applications&lt;/code&gt; fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]434 "state": "A String", # Output only. A state message specifying the overall job state.
435 "stateStartTime": "A String", # Output only. The time when this state was entered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]436 "details": "A String", # Output only. Optional Job state details, such as an error description if the state is &lt;code&gt;ERROR&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]437 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]438 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]439 "hadoopJob": { # A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Optional. Job is a Hadoop job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]440 "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.
441 "A String",
442 ],
443 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
444 "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'
445 "a_key": "A String",
446 },
447 },
448 "jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
449 "A String",
450 ],
451 "fileUris": [ # Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
452 "A String",
453 ],
454 "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.
455 "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.
456 "A String",
457 ],
458 "mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]459 "properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]460 "a_key": "A String",
461 },
462 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]463 "pigJob": { # A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Optional. Job is a Pig job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]464 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
465 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).
466 "a_key": "A String",
467 },
468 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config 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'
470 "a_key": "A String",
471 },
472 },
473 "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.
474 "A String",
475 ],
476 "queryList": { # A list of queries to run on a cluster. # A list of queries.
477 "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:
478 # "hiveJob": {
479 # "queryList": {
480 # "queries": [
481 # "query1",
482 # "query2",
483 # "query3;query4",
484 # ]
485 # }
486 # }
487 "A String",
488 ],
489 },
490 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]491 "properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]492 "a_key": "A String",
493 },
494 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]495 "placement": { # Dataproc job config. # Required. Job information, including how, when, and where to run the job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]496 "clusterName": "A String", # Required. The name of the cluster where the job will be submitted.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]497 "clusterUuid": "A String", # Output only. A cluster UUID generated by the Dataproc service when the job is submitted.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]498 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]499 "sparkRJob": { # A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Optional. Job is a SparkR job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]500 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
501 "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'
502 "a_key": "A String",
503 },
504 },
505 "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.
506 "A String",
507 ],
508 "mainRFileUri": "A String", # Required. The HCFS URI of the main R file to use as the driver. Must be a .R file.
509 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of R drivers and distributed tasks. Useful for naively parallel tasks.
510 "A String",
511 ],
512 "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.
513 "A String",
514 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]515 "properties": { # Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]516 "a_key": "A String",
517 },
518 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]519 "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 &lt;code&gt;job_id&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]520 "projectId": "A String", # Required. The ID of the Google Cloud Platform project that the job belongs to.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]521 "jobId": "A String", # Optional. The job ID, which must be unique within the project. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.If not specified by the caller, the job ID will be provided by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]522 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]523 "sparkSqlJob": { # A Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Optional. Job is a SparkSql job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]524 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
525 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
526 "a_key": "A String",
527 },
528 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
529 "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'
530 "a_key": "A String",
531 },
532 },
533 "jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.
534 "A String",
535 ],
536 "queryList": { # A list of queries to run on a cluster. # A list of queries.
537 "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:
538 # "hiveJob": {
539 # "queryList": {
540 # "queries": [
541 # "query1",
542 # "query2",
543 # "query3;query4",
544 # ]
545 # }
546 # }
547 "A String",
548 ],
549 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]550 "properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]551 "a_key": "A String",
552 },
553 },
554 "yarnApplications": [ # Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]555 { # A YARN application created by a job. Application information is a subset of &lt;code&gt;org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto&lt;/code&gt;.Beta Feature: This report is available for testing purposes only. It may be changed before final release.
556 "progress": 3.14, # Output only. The numerical progress of the application, from 1 to 100.
557 "state": "A String", # Output only. The application state.
558 "name": "A String", # Output only. The application name.
559 "trackingUrl": "A String", # Output only. 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]560 },
561 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]562 "submittedBy": "A String", # Output only. The email address of the user submitting the job. For jobs submitted on the cluster, the address is &lt;code&gt;username@hostname&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]563 "jobUuid": "A String", # Output only. A UUID that uniquely identifies a job within the project over time. This is in contrast to a user-settable reference.job_id that may be reused over time.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]564 "labels": { # Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.
565 "a_key": "A String",
566 },
567 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]568 "done": True or False, # Output only. Indicates whether the job is completed. If the value is false, the job is still in progress. If true, the job is completed, and status.state field will indicate if it was successful, failed, or cancelled.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]569 "driverOutputResourceUri": "A String", # Output only. A URI pointing to the location of the stdout of the job's driver program.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]570 "prestoJob": { # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. # Optional. Job is a Presto job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]571 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
572 "outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats
573 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
574 "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'
575 "a_key": "A String",
576 },
577 },
578 "clientTags": [ # Optional. Presto client tags to attach to this query
579 "A String",
580 ],
581 "queryList": { # A list of queries to run on a cluster. # A list of queries.
582 "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:
583 # "hiveJob": {
584 # "queryList": {
585 # "queries": [
586 # "query1",
587 # "query2",
588 # "query3;query4",
589 # ]
590 # }
591 # }
592 "A String",
593 ],
594 },
595 "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.
596 "properties": { # Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI
597 "a_key": "A String",
598 },
599 },
600 "scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.
601 "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.
602 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]603 "sparkJob": { # A Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. The specification of the main method to call to drive the job. Specify either the jar file that contains the main class or the main class name. To pass both a main jar and a main class in that jar, add the jar to CommonJob.jar_file_uris, and then specify the main class name in main_class. # Optional. Job is a Spark job.
604 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
605 "A String",
606 ],
607 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config 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'
609 "a_key": "A String",
610 },
611 },
612 "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.
613 "A String",
614 ],
615 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
616 "A String",
617 ],
618 "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.
619 "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.
620 "A String",
621 ],
622 "mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.
623 "properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
624 "a_key": "A String",
625 },
626 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]627 "statusHistory": [ # Output only. The previous job status.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]628 { # Dataproc job status.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]629 "state": "A String", # Output only. A state message specifying the overall job state.
630 "stateStartTime": "A String", # Output only. The time when this state was entered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]631 "details": "A String", # Output only. Optional Job state details, such as an error description if the state is &lt;code&gt;ERROR&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]632 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]633 },
634 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]635 "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Optional. Job is a PySpark job.
636 "mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.
637 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
638 "A String",
639 ],
640 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
641 "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'
642 "a_key": "A String",
643 },
644 },
645 "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.
646 "A String",
647 ],
648 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
649 "A String",
650 ],
651 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
652 "A String",
653 ],
654 "pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
655 "A String",
656 ],
657 "properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
658 "a_key": "A String",
659 },
660 },
661 "hiveJob": { # A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Optional. Job is a Hive job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]662 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
663 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).
664 "a_key": "A String",
665 },
666 "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.
667 "A String",
668 ],
669 "queryList": { # A list of queries to run on a cluster. # A list of queries.
670 "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:
671 # "hiveJob": {
672 # "queryList": {
673 # "queries": [
674 # "query1",
675 # "query2",
676 # "query3;query4",
677 # ]
678 # }
679 # }
680 "A String",
681 ],
682 },
683 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]684 "properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]685 "a_key": "A String",
686 },
687 },
688 }</pre>
689</div>
690
691<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]692 <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]693 <pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
694
695Args:
696 resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]697 options_requestedPolicyVersion: integer, Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]698 x__xgafv: string, V1 error format.
699 Allowed values
700 1 - v1 error format
701 2 - v2 error format
702
703Returns:
704 An object of the form:
705
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]706 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.Optionally, a binding can specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both.JSON example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]707 # {
708 # "bindings": [
709 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]710 # "role": "roles/resourcemanager.organizationAdmin",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]711 # "members": [
712 # "user:mike@example.com",
713 # "group:admins@example.com",
714 # "domain:google.com",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]715 # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]716 # ]
717 # },
718 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]719 # "role": "roles/resourcemanager.organizationViewer",
720 # "members": ["user:eve@example.com"],
721 # "condition": {
722 # "title": "expirable access",
723 # "description": "Does not grant access after Sep 2020",
724 # "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')",
725 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]726 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]727 # ],
728 # "etag": "BwWWja0YfJA=",
729 # "version": 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]730 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]731 # YAML example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]732 # bindings:
733 # - members:
734 # - user:mike@example.com
735 # - group:admins@example.com
736 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]737 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
738 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]739 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]740 # - user:eve@example.com
741 # role: roles/resourcemanager.organizationViewer
742 # condition:
743 # title: expirable access
744 # description: Does not grant access after Sep 2020
745 # expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z')
746 # - etag: BwWWja0YfJA=
747 # - version: 3
748 # For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
749 "bindings": [ # Associates a list of members to a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one member.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]750 { # Associates members with a role.
751 "role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.
752 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:
753 # allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
754 # allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]755 # user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com .
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]756 # serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
757 # group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]758 # deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding.
759 # deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding.
760 # deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]761 # domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
762 "A String",
763 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]764 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
765 # title: "Summary size limit"
766 # description: "Determines if a summary is less than 100 chars"
767 # expression: "document.summary.size() &lt; 100"
768 # Example (Equality):
769 # title: "Requestor is owner"
770 # description: "Determines if requestor is the document owner"
771 # expression: "document.owner == request.auth.claims.email"
772 # Example (Logic):
773 # title: "Public documents"
774 # description: "Determine whether the document should be publicly visible"
775 # expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
776 # Example (Data Manipulation):
777 # title: "Notification string"
778 # description: "Create a notification string with a timestamp."
779 # expression: "'New message received at ' + string(document.create_time)"
780 # The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
781 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
782 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
783 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
784 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]785 },
786 },
787 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]788 "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
789 "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations:
790 # Getting a policy that includes a conditional role binding
791 # Adding a conditional role binding to a policy
792 # Changing a conditional role binding in a policy
793 # Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]794 }</pre>
795</div>
796
797<div class="method">
798 <code class="details" id="list">list(projectId, region, pageSize=None, x__xgafv=None, jobStateMatcher=None, pageToken=None, clusterName=None, filter=None)</code>
799 <pre>Lists regions/{region}/jobs in a project.
800
801Args:
802 projectId: string, Required. The ID of the Google Cloud Platform project that the job belongs to. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]803 region: string, Required. The Dataproc region in which to handle the request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]804 pageSize: integer, Optional. The number of results to return in each response.
805 x__xgafv: string, V1 error format.
806 Allowed values
807 1 - v1 error format
808 2 - v2 error format
809 jobStateMatcher: string, Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs).If filter is provided, jobStateMatcher will be ignored.
810 pageToken: string, Optional. The page token, returned by a previous call, to request the next page of results.
811 clusterName: string, Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.
812 filter: string, Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is status.state or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or NON_ACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND labels.env = staging AND labels.starred = *
813
814Returns:
815 An object of the form:
816
817 { # A list of jobs in a project.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]818 "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 &lt;code&gt;ListJobsRequest&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]819 "jobs": [ # Output only. Jobs list.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]820 { # A Dataproc job resource.
821 "status": { # Dataproc job status. # Output only. The job status. Additional application-specific status information may be contained in the &lt;code&gt;type_job&lt;/code&gt; and &lt;code&gt;yarn_applications&lt;/code&gt; fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]822 "state": "A String", # Output only. A state message specifying the overall job state.
823 "stateStartTime": "A String", # Output only. The time when this state was entered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]824 "details": "A String", # Output only. Optional Job state details, such as an error description if the state is &lt;code&gt;ERROR&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]825 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]826 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]827 "hadoopJob": { # A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Optional. Job is a Hadoop job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]828 "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.
829 "A String",
830 ],
831 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
832 "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'
833 "a_key": "A String",
834 },
835 },
836 "jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
837 "A String",
838 ],
839 "fileUris": [ # Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
840 "A String",
841 ],
842 "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.
843 "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.
844 "A String",
845 ],
846 "mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]847 "properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]848 "a_key": "A String",
849 },
850 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]851 "pigJob": { # A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Optional. Job is a Pig job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]852 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
853 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).
854 "a_key": "A String",
855 },
856 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
857 "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'
858 "a_key": "A String",
859 },
860 },
861 "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.
862 "A String",
863 ],
864 "queryList": { # A list of queries to run on a cluster. # A list of queries.
865 "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:
866 # "hiveJob": {
867 # "queryList": {
868 # "queries": [
869 # "query1",
870 # "query2",
871 # "query3;query4",
872 # ]
873 # }
874 # }
875 "A String",
876 ],
877 },
878 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]879 "properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]880 "a_key": "A String",
881 },
882 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]883 "placement": { # Dataproc job config. # Required. Job information, including how, when, and where to run the job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]884 "clusterName": "A String", # Required. The name of the cluster where the job will be submitted.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]885 "clusterUuid": "A String", # Output only. A cluster UUID generated by the Dataproc service when the job is submitted.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]886 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]887 "sparkRJob": { # A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Optional. Job is a SparkR job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]888 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
889 "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'
890 "a_key": "A String",
891 },
892 },
893 "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.
894 "A String",
895 ],
896 "mainRFileUri": "A String", # Required. The HCFS URI of the main R file to use as the driver. Must be a .R file.
897 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of R drivers and distributed tasks. Useful for naively parallel tasks.
898 "A String",
899 ],
900 "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.
901 "A String",
902 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]903 "properties": { # Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]904 "a_key": "A String",
905 },
906 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]907 "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 &lt;code&gt;job_id&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]908 "projectId": "A String", # Required. The ID of the Google Cloud Platform project that the job belongs to.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]909 "jobId": "A String", # Optional. The job ID, which must be unique within the project. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.If not specified by the caller, the job ID will be provided by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]910 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]911 "sparkSqlJob": { # A Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Optional. Job is a SparkSql job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]912 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
913 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
914 "a_key": "A String",
915 },
916 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
917 "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'
918 "a_key": "A String",
919 },
920 },
921 "jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.
922 "A String",
923 ],
924 "queryList": { # A list of queries to run on a cluster. # A list of queries.
925 "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:
926 # "hiveJob": {
927 # "queryList": {
928 # "queries": [
929 # "query1",
930 # "query2",
931 # "query3;query4",
932 # ]
933 # }
934 # }
935 "A String",
936 ],
937 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]938 "properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]939 "a_key": "A String",
940 },
941 },
942 "yarnApplications": [ # Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]943 { # A YARN application created by a job. Application information is a subset of &lt;code&gt;org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto&lt;/code&gt;.Beta Feature: This report is available for testing purposes only. It may be changed before final release.
944 "progress": 3.14, # Output only. The numerical progress of the application, from 1 to 100.
945 "state": "A String", # Output only. The application state.
946 "name": "A String", # Output only. The application name.
947 "trackingUrl": "A String", # Output only. 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]948 },
949 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]950 "submittedBy": "A String", # Output only. The email address of the user submitting the job. For jobs submitted on the cluster, the address is &lt;code&gt;username@hostname&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]951 "jobUuid": "A String", # Output only. A UUID that uniquely identifies a job within the project over time. This is in contrast to a user-settable reference.job_id that may be reused over time.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]952 "labels": { # Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.
953 "a_key": "A String",
954 },
955 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]956 "done": True or False, # Output only. Indicates whether the job is completed. If the value is false, the job is still in progress. If true, the job is completed, and status.state field will indicate if it was successful, failed, or cancelled.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]957 "driverOutputResourceUri": "A String", # Output only. A URI pointing to the location of the stdout of the job's driver program.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]958 "prestoJob": { # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. # Optional. Job is a Presto job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]959 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
960 "outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats
961 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
962 "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'
963 "a_key": "A String",
964 },
965 },
966 "clientTags": [ # Optional. Presto client tags to attach to this query
967 "A String",
968 ],
969 "queryList": { # A list of queries to run on a cluster. # A list of queries.
970 "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:
971 # "hiveJob": {
972 # "queryList": {
973 # "queries": [
974 # "query1",
975 # "query2",
976 # "query3;query4",
977 # ]
978 # }
979 # }
980 "A String",
981 ],
982 },
983 "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.
984 "properties": { # Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI
985 "a_key": "A String",
986 },
987 },
988 "scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.
989 "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.
990 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]991 "sparkJob": { # A Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. The specification of the main method to call to drive the job. Specify either the jar file that contains the main class or the main class name. To pass both a main jar and a main class in that jar, add the jar to CommonJob.jar_file_uris, and then specify the main class name in main_class. # Optional. Job is a Spark job.
992 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
993 "A String",
994 ],
995 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
996 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
997 "a_key": "A String",
998 },
999 },
1000 "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.
1001 "A String",
1002 ],
1003 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
1004 "A String",
1005 ],
1006 "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.
1007 "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.
1008 "A String",
1009 ],
1010 "mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.
1011 "properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
1012 "a_key": "A String",
1013 },
1014 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1015 "statusHistory": [ # Output only. The previous job status.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1016 { # Dataproc job status.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1017 "state": "A String", # Output only. A state message specifying the overall job state.
1018 "stateStartTime": "A String", # Output only. The time when this state was entered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1019 "details": "A String", # Output only. Optional Job state details, such as an error description if the state is &lt;code&gt;ERROR&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1020 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1021 },
1022 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1023 "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Optional. Job is a PySpark job.
1024 "mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.
1025 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
1026 "A String",
1027 ],
1028 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
1029 "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'
1030 "a_key": "A String",
1031 },
1032 },
1033 "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.
1034 "A String",
1035 ],
1036 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
1037 "A String",
1038 ],
1039 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
1040 "A String",
1041 ],
1042 "pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
1043 "A String",
1044 ],
1045 "properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
1046 "a_key": "A String",
1047 },
1048 },
1049 "hiveJob": { # A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Optional. Job is a Hive job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1050 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
1051 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).
1052 "a_key": "A String",
1053 },
1054 "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.
1055 "A String",
1056 ],
1057 "queryList": { # A list of queries to run on a cluster. # A list of queries.
1058 "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:
1059 # "hiveJob": {
1060 # "queryList": {
1061 # "queries": [
1062 # "query1",
1063 # "query2",
1064 # "query3;query4",
1065 # ]
1066 # }
1067 # }
1068 "A String",
1069 ],
1070 },
1071 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1072 "properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1073 "a_key": "A String",
1074 },
1075 },
1076 },
1077 ],
1078 }</pre>
1079</div>
1080
1081<div class="method">
1082 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
1083 <pre>Retrieves the next page of results.
1084
1085Args:
1086 previous_request: The request for the previous page. (required)
1087 previous_response: The response from the request for the previous page. (required)
1088
1089Returns:
1090 A request object that you can call 'execute()' on to request the next
1091 page. Returns None if there are no more items in the collection.
1092 </pre>
1093</div>
1094
1095<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1096 <code class="details" id="patch">patch(projectId, region, jobId, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1097 <pre>Updates a job in a project.
1098
1099Args:
1100 projectId: string, Required. The ID of the Google Cloud Platform project that the job belongs to. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1101 region: string, Required. The Dataproc region in which to handle the request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1102 jobId: string, Required. The job ID. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1103 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1104 The object takes the form of:
1105
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1106{ # A Dataproc job resource.
1107 "status": { # Dataproc job status. # Output only. The job status. Additional application-specific status information may be contained in the &lt;code&gt;type_job&lt;/code&gt; and &lt;code&gt;yarn_applications&lt;/code&gt; fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1108 "state": "A String", # Output only. A state message specifying the overall job state.
1109 "stateStartTime": "A String", # Output only. The time when this state was entered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1110 "details": "A String", # Output only. Optional Job state details, such as an error description if the state is &lt;code&gt;ERROR&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1111 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1112 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1113 "hadoopJob": { # A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Optional. Job is a Hadoop job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1114 "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.
1115 "A String",
1116 ],
1117 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
1118 "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'
1119 "a_key": "A String",
1120 },
1121 },
1122 "jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
1123 "A String",
1124 ],
1125 "fileUris": [ # Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
1126 "A String",
1127 ],
1128 "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.
1129 "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.
1130 "A String",
1131 ],
1132 "mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1133 "properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1134 "a_key": "A String",
1135 },
1136 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1137 "pigJob": { # A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Optional. Job is a Pig job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1138 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
1139 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).
1140 "a_key": "A String",
1141 },
1142 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
1143 "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'
1144 "a_key": "A String",
1145 },
1146 },
1147 "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.
1148 "A String",
1149 ],
1150 "queryList": { # A list of queries to run on a cluster. # A list of queries.
1151 "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:
1152 # "hiveJob": {
1153 # "queryList": {
1154 # "queries": [
1155 # "query1",
1156 # "query2",
1157 # "query3;query4",
1158 # ]
1159 # }
1160 # }
1161 "A String",
1162 ],
1163 },
1164 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1165 "properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1166 "a_key": "A String",
1167 },
1168 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1169 "placement": { # Dataproc job config. # Required. Job information, including how, when, and where to run the job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1170 "clusterName": "A String", # Required. The name of the cluster where the job will be submitted.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1171 "clusterUuid": "A String", # Output only. A cluster UUID generated by the Dataproc service when the job is submitted.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1172 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1173 "sparkRJob": { # A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Optional. Job is a SparkR job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1174 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
1175 "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'
1176 "a_key": "A String",
1177 },
1178 },
1179 "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.
1180 "A String",
1181 ],
1182 "mainRFileUri": "A String", # Required. The HCFS URI of the main R file to use as the driver. Must be a .R file.
1183 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of R drivers and distributed tasks. Useful for naively parallel tasks.
1184 "A String",
1185 ],
1186 "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.
1187 "A String",
1188 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1189 "properties": { # Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1190 "a_key": "A String",
1191 },
1192 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1193 "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 &lt;code&gt;job_id&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1194 "projectId": "A String", # Required. The ID of the Google Cloud Platform project that the job belongs to.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1195 "jobId": "A String", # Optional. The job ID, which must be unique within the project. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.If not specified by the caller, the job ID will be provided by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1196 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1197 "sparkSqlJob": { # A Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Optional. Job is a SparkSql job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1198 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
1199 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
1200 "a_key": "A String",
1201 },
1202 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
1203 "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'
1204 "a_key": "A String",
1205 },
1206 },
1207 "jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.
1208 "A String",
1209 ],
1210 "queryList": { # A list of queries to run on a cluster. # A list of queries.
1211 "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:
1212 # "hiveJob": {
1213 # "queryList": {
1214 # "queries": [
1215 # "query1",
1216 # "query2",
1217 # "query3;query4",
1218 # ]
1219 # }
1220 # }
1221 "A String",
1222 ],
1223 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1224 "properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1225 "a_key": "A String",
1226 },
1227 },
1228 "yarnApplications": [ # Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1229 { # A YARN application created by a job. Application information is a subset of &lt;code&gt;org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto&lt;/code&gt;.Beta Feature: This report is available for testing purposes only. It may be changed before final release.
1230 "progress": 3.14, # Output only. The numerical progress of the application, from 1 to 100.
1231 "state": "A String", # Output only. The application state.
1232 "name": "A String", # Output only. The application name.
1233 "trackingUrl": "A String", # Output only. 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1234 },
1235 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1236 "submittedBy": "A String", # Output only. The email address of the user submitting the job. For jobs submitted on the cluster, the address is &lt;code&gt;username@hostname&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1237 "jobUuid": "A String", # Output only. A UUID that uniquely identifies a job within the project over time. This is in contrast to a user-settable reference.job_id that may be reused over time.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1238 "labels": { # Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.
1239 "a_key": "A String",
1240 },
1241 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1242 "done": True or False, # Output only. Indicates whether the job is completed. If the value is false, the job is still in progress. If true, the job is completed, and status.state field will indicate if it was successful, failed, or cancelled.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1243 "driverOutputResourceUri": "A String", # Output only. A URI pointing to the location of the stdout of the job's driver program.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1244 "prestoJob": { # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. # Optional. Job is a Presto job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1245 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
1246 "outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats
1247 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
1248 "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'
1249 "a_key": "A String",
1250 },
1251 },
1252 "clientTags": [ # Optional. Presto client tags to attach to this query
1253 "A String",
1254 ],
1255 "queryList": { # A list of queries to run on a cluster. # A list of queries.
1256 "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:
1257 # "hiveJob": {
1258 # "queryList": {
1259 # "queries": [
1260 # "query1",
1261 # "query2",
1262 # "query3;query4",
1263 # ]
1264 # }
1265 # }
1266 "A String",
1267 ],
1268 },
1269 "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.
1270 "properties": { # Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI
1271 "a_key": "A String",
1272 },
1273 },
1274 "scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.
1275 "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.
1276 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1277 "sparkJob": { # A Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. The specification of the main method to call to drive the job. Specify either the jar file that contains the main class or the main class name. To pass both a main jar and a main class in that jar, add the jar to CommonJob.jar_file_uris, and then specify the main class name in main_class. # Optional. Job is a Spark job.
1278 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
1279 "A String",
1280 ],
1281 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
1282 "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'
1283 "a_key": "A String",
1284 },
1285 },
1286 "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.
1287 "A String",
1288 ],
1289 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
1290 "A String",
1291 ],
1292 "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.
1293 "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.
1294 "A String",
1295 ],
1296 "mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.
1297 "properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
1298 "a_key": "A String",
1299 },
1300 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1301 "statusHistory": [ # Output only. The previous job status.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1302 { # Dataproc job status.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1303 "state": "A String", # Output only. A state message specifying the overall job state.
1304 "stateStartTime": "A String", # Output only. The time when this state was entered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1305 "details": "A String", # Output only. Optional Job state details, such as an error description if the state is &lt;code&gt;ERROR&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1306 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1307 },
1308 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1309 "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Optional. Job is a PySpark job.
1310 "mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.
1311 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
1312 "A String",
1313 ],
1314 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
1315 "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'
1316 "a_key": "A String",
1317 },
1318 },
1319 "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.
1320 "A String",
1321 ],
1322 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
1323 "A String",
1324 ],
1325 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
1326 "A String",
1327 ],
1328 "pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
1329 "A String",
1330 ],
1331 "properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
1332 "a_key": "A String",
1333 },
1334 },
1335 "hiveJob": { # A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Optional. Job is a Hive job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1336 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
1337 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).
1338 "a_key": "A String",
1339 },
1340 "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.
1341 "A String",
1342 ],
1343 "queryList": { # A list of queries to run on a cluster. # A list of queries.
1344 "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:
1345 # "hiveJob": {
1346 # "queryList": {
1347 # "queries": [
1348 # "query1",
1349 # "query2",
1350 # "query3;query4",
1351 # ]
1352 # }
1353 # }
1354 "A String",
1355 ],
1356 },
1357 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1358 "properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1359 "a_key": "A String",
1360 },
1361 },
1362}
1363
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1364 updateMask: string, Required. Specifies the path, relative to &lt;code&gt;Job&lt;/code&gt;, of the field to update. For example, to update the labels of a Job the &lt;code&gt;update_mask&lt;/code&gt; parameter would be specified as &lt;code&gt;labels&lt;/code&gt;, and the PATCH request body would specify the new value. &lt;strong&gt;Note:&lt;/strong&gt; Currently, &lt;code&gt;labels&lt;/code&gt; is the only field that can be updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1365 x__xgafv: string, V1 error format.
1366 Allowed values
1367 1 - v1 error format
1368 2 - v2 error format
1369
1370Returns:
1371 An object of the form:
1372
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1373 { # A Dataproc job resource.
1374 "status": { # Dataproc job status. # Output only. The job status. Additional application-specific status information may be contained in the &lt;code&gt;type_job&lt;/code&gt; and &lt;code&gt;yarn_applications&lt;/code&gt; fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1375 "state": "A String", # Output only. A state message specifying the overall job state.
1376 "stateStartTime": "A String", # Output only. The time when this state was entered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1377 "details": "A String", # Output only. Optional Job state details, such as an error description if the state is &lt;code&gt;ERROR&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1378 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1379 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1380 "hadoopJob": { # A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Optional. Job is a Hadoop job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1381 "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.
1382 "A String",
1383 ],
1384 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
1385 "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'
1386 "a_key": "A String",
1387 },
1388 },
1389 "jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
1390 "A String",
1391 ],
1392 "fileUris": [ # Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
1393 "A String",
1394 ],
1395 "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.
1396 "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.
1397 "A String",
1398 ],
1399 "mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1400 "properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1401 "a_key": "A String",
1402 },
1403 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1404 "pigJob": { # A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Optional. Job is a Pig job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1405 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
1406 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).
1407 "a_key": "A String",
1408 },
1409 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
1410 "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'
1411 "a_key": "A String",
1412 },
1413 },
1414 "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.
1415 "A String",
1416 ],
1417 "queryList": { # A list of queries to run on a cluster. # A list of queries.
1418 "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:
1419 # "hiveJob": {
1420 # "queryList": {
1421 # "queries": [
1422 # "query1",
1423 # "query2",
1424 # "query3;query4",
1425 # ]
1426 # }
1427 # }
1428 "A String",
1429 ],
1430 },
1431 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1432 "properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1433 "a_key": "A String",
1434 },
1435 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1436 "placement": { # Dataproc job config. # Required. Job information, including how, when, and where to run the job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1437 "clusterName": "A String", # Required. The name of the cluster where the job will be submitted.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1438 "clusterUuid": "A String", # Output only. A cluster UUID generated by the Dataproc service when the job is submitted.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1439 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1440 "sparkRJob": { # A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Optional. Job is a SparkR job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1441 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
1442 "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'
1443 "a_key": "A String",
1444 },
1445 },
1446 "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.
1447 "A String",
1448 ],
1449 "mainRFileUri": "A String", # Required. The HCFS URI of the main R file to use as the driver. Must be a .R file.
1450 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of R drivers and distributed tasks. Useful for naively parallel tasks.
1451 "A String",
1452 ],
1453 "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.
1454 "A String",
1455 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1456 "properties": { # Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1457 "a_key": "A String",
1458 },
1459 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1460 "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 &lt;code&gt;job_id&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1461 "projectId": "A String", # Required. The ID of the Google Cloud Platform project that the job belongs to.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1462 "jobId": "A String", # Optional. The job ID, which must be unique within the project. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.If not specified by the caller, the job ID will be provided by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1463 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1464 "sparkSqlJob": { # A Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Optional. Job is a SparkSql job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1465 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
1466 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
1467 "a_key": "A String",
1468 },
1469 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
1470 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
1471 "a_key": "A String",
1472 },
1473 },
1474 "jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.
1475 "A String",
1476 ],
1477 "queryList": { # A list of queries to run on a cluster. # A list of queries.
1478 "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:
1479 # "hiveJob": {
1480 # "queryList": {
1481 # "queries": [
1482 # "query1",
1483 # "query2",
1484 # "query3;query4",
1485 # ]
1486 # }
1487 # }
1488 "A String",
1489 ],
1490 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1491 "properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1492 "a_key": "A String",
1493 },
1494 },
1495 "yarnApplications": [ # Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1496 { # A YARN application created by a job. Application information is a subset of &lt;code&gt;org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto&lt;/code&gt;.Beta Feature: This report is available for testing purposes only. It may be changed before final release.
1497 "progress": 3.14, # Output only. The numerical progress of the application, from 1 to 100.
1498 "state": "A String", # Output only. The application state.
1499 "name": "A String", # Output only. The application name.
1500 "trackingUrl": "A String", # Output only. 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1501 },
1502 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1503 "submittedBy": "A String", # Output only. The email address of the user submitting the job. For jobs submitted on the cluster, the address is &lt;code&gt;username@hostname&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1504 "jobUuid": "A String", # Output only. A UUID that uniquely identifies a job within the project over time. This is in contrast to a user-settable reference.job_id that may be reused over time.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1505 "labels": { # Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.
1506 "a_key": "A String",
1507 },
1508 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1509 "done": True or False, # Output only. Indicates whether the job is completed. If the value is false, the job is still in progress. If true, the job is completed, and status.state field will indicate if it was successful, failed, or cancelled.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1510 "driverOutputResourceUri": "A String", # Output only. A URI pointing to the location of the stdout of the job's driver program.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1511 "prestoJob": { # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. # Optional. Job is a Presto job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1512 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
1513 "outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats
1514 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
1515 "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'
1516 "a_key": "A String",
1517 },
1518 },
1519 "clientTags": [ # Optional. Presto client tags to attach to this query
1520 "A String",
1521 ],
1522 "queryList": { # A list of queries to run on a cluster. # A list of queries.
1523 "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:
1524 # "hiveJob": {
1525 # "queryList": {
1526 # "queries": [
1527 # "query1",
1528 # "query2",
1529 # "query3;query4",
1530 # ]
1531 # }
1532 # }
1533 "A String",
1534 ],
1535 },
1536 "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.
1537 "properties": { # Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI
1538 "a_key": "A String",
1539 },
1540 },
1541 "scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.
1542 "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.
1543 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1544 "sparkJob": { # A Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. The specification of the main method to call to drive the job. Specify either the jar file that contains the main class or the main class name. To pass both a main jar and a main class in that jar, add the jar to CommonJob.jar_file_uris, and then specify the main class name in main_class. # Optional. Job is a Spark job.
1545 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
1546 "A String",
1547 ],
1548 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
1549 "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'
1550 "a_key": "A String",
1551 },
1552 },
1553 "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.
1554 "A String",
1555 ],
1556 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
1557 "A String",
1558 ],
1559 "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.
1560 "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.
1561 "A String",
1562 ],
1563 "mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.
1564 "properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
1565 "a_key": "A String",
1566 },
1567 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1568 "statusHistory": [ # Output only. The previous job status.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1569 { # Dataproc job status.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1570 "state": "A String", # Output only. A state message specifying the overall job state.
1571 "stateStartTime": "A String", # Output only. The time when this state was entered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1572 "details": "A String", # Output only. Optional Job state details, such as an error description if the state is &lt;code&gt;ERROR&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1573 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1574 },
1575 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1576 "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Optional. Job is a PySpark job.
1577 "mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.
1578 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
1579 "A String",
1580 ],
1581 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
1582 "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'
1583 "a_key": "A String",
1584 },
1585 },
1586 "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.
1587 "A String",
1588 ],
1589 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
1590 "A String",
1591 ],
1592 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
1593 "A String",
1594 ],
1595 "pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
1596 "A String",
1597 ],
1598 "properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
1599 "a_key": "A String",
1600 },
1601 },
1602 "hiveJob": { # A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Optional. Job is a Hive job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1603 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
1604 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).
1605 "a_key": "A String",
1606 },
1607 "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.
1608 "A String",
1609 ],
1610 "queryList": { # A list of queries to run on a cluster. # A list of queries.
1611 "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:
1612 # "hiveJob": {
1613 # "queryList": {
1614 # "queries": [
1615 # "query1",
1616 # "query2",
1617 # "query3;query4",
1618 # ]
1619 # }
1620 # }
1621 "A String",
1622 ],
1623 },
1624 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1625 "properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1626 "a_key": "A String",
1627 },
1628 },
1629 }</pre>
1630</div>
1631
1632<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1633 <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
1634 <pre>Sets the access control policy on the specified resource. Replaces any existing policy.Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1635
1636Args:
1637 resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1638 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1639 The object takes the form of:
1640
1641{ # Request message for SetIamPolicy method.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1642 "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.Optionally, a binding can specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both.JSON example: # REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1643 # {
1644 # "bindings": [
1645 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1646 # "role": "roles/resourcemanager.organizationAdmin",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1647 # "members": [
1648 # "user:mike@example.com",
1649 # "group:admins@example.com",
1650 # "domain:google.com",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1651 # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1652 # ]
1653 # },
1654 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1655 # "role": "roles/resourcemanager.organizationViewer",
1656 # "members": ["user:eve@example.com"],
1657 # "condition": {
1658 # "title": "expirable access",
1659 # "description": "Does not grant access after Sep 2020",
1660 # "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')",
1661 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1662 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1663 # ],
1664 # "etag": "BwWWja0YfJA=",
1665 # "version": 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1666 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1667 # YAML example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1668 # bindings:
1669 # - members:
1670 # - user:mike@example.com
1671 # - group:admins@example.com
1672 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1673 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
1674 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1675 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1676 # - user:eve@example.com
1677 # role: roles/resourcemanager.organizationViewer
1678 # condition:
1679 # title: expirable access
1680 # description: Does not grant access after Sep 2020
1681 # expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z')
1682 # - etag: BwWWja0YfJA=
1683 # - version: 3
1684 # For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
1685 "bindings": [ # Associates a list of members to a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one member.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1686 { # Associates members with a role.
1687 "role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.
1688 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:
1689 # allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
1690 # allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1691 # user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com .
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1692 # serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
1693 # group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1694 # deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding.
1695 # deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding.
1696 # deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1697 # domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
1698 "A String",
1699 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1700 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
1701 # title: "Summary size limit"
1702 # description: "Determines if a summary is less than 100 chars"
1703 # expression: "document.summary.size() &lt; 100"
1704 # Example (Equality):
1705 # title: "Requestor is owner"
1706 # description: "Determines if requestor is the document owner"
1707 # expression: "document.owner == request.auth.claims.email"
1708 # Example (Logic):
1709 # title: "Public documents"
1710 # description: "Determine whether the document should be publicly visible"
1711 # expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
1712 # Example (Data Manipulation):
1713 # title: "Notification string"
1714 # description: "Create a notification string with a timestamp."
1715 # expression: "'New message received at ' + string(document.create_time)"
1716 # The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
1717 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
1718 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
1719 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
1720 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1721 },
1722 },
1723 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1724 "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
1725 "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations:
1726 # Getting a policy that includes a conditional role binding
1727 # Adding a conditional role binding to a policy
1728 # Changing a conditional role binding in a policy
1729 # Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1730 },
1731 }
1732
1733 x__xgafv: string, V1 error format.
1734 Allowed values
1735 1 - v1 error format
1736 2 - v2 error format
1737
1738Returns:
1739 An object of the form:
1740
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1741 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.Optionally, a binding can specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both.JSON example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1742 # {
1743 # "bindings": [
1744 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1745 # "role": "roles/resourcemanager.organizationAdmin",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1746 # "members": [
1747 # "user:mike@example.com",
1748 # "group:admins@example.com",
1749 # "domain:google.com",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1750 # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1751 # ]
1752 # },
1753 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1754 # "role": "roles/resourcemanager.organizationViewer",
1755 # "members": ["user:eve@example.com"],
1756 # "condition": {
1757 # "title": "expirable access",
1758 # "description": "Does not grant access after Sep 2020",
1759 # "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')",
1760 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1761 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1762 # ],
1763 # "etag": "BwWWja0YfJA=",
1764 # "version": 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1765 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1766 # YAML example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1767 # bindings:
1768 # - members:
1769 # - user:mike@example.com
1770 # - group:admins@example.com
1771 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1772 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
1773 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1774 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1775 # - user:eve@example.com
1776 # role: roles/resourcemanager.organizationViewer
1777 # condition:
1778 # title: expirable access
1779 # description: Does not grant access after Sep 2020
1780 # expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z')
1781 # - etag: BwWWja0YfJA=
1782 # - version: 3
1783 # For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
1784 "bindings": [ # Associates a list of members to a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one member.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1785 { # Associates members with a role.
1786 "role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.
1787 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:
1788 # allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
1789 # allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1790 # user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com .
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1791 # serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
1792 # group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1793 # deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding.
1794 # deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding.
1795 # deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1796 # domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
1797 "A String",
1798 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1799 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
1800 # title: "Summary size limit"
1801 # description: "Determines if a summary is less than 100 chars"
1802 # expression: "document.summary.size() &lt; 100"
1803 # Example (Equality):
1804 # title: "Requestor is owner"
1805 # description: "Determines if requestor is the document owner"
1806 # expression: "document.owner == request.auth.claims.email"
1807 # Example (Logic):
1808 # title: "Public documents"
1809 # description: "Determine whether the document should be publicly visible"
1810 # expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
1811 # Example (Data Manipulation):
1812 # title: "Notification string"
1813 # description: "Create a notification string with a timestamp."
1814 # expression: "'New message received at ' + string(document.create_time)"
1815 # The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
1816 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
1817 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
1818 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
1819 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1820 },
1821 },
1822 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1823 "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
1824 "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations:
1825 # Getting a policy that includes a conditional role binding
1826 # Adding a conditional role binding to a policy
1827 # Changing a conditional role binding in a policy
1828 # Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1829 }</pre>
1830</div>
1831
1832<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1833 <code class="details" id="submit">submit(projectId, region, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1834 <pre>Submits a job to a cluster.
1835
1836Args:
1837 projectId: string, Required. The ID of the Google Cloud Platform project that the job belongs to. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1838 region: string, Required. The Dataproc region in which to handle the request. (required)
1839 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1840 The object takes the form of:
1841
1842{ # A request to submit a job.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1843 "job": { # A Dataproc job resource. # Required. The job resource.
1844 "status": { # Dataproc job status. # Output only. The job status. Additional application-specific status information may be contained in the &lt;code&gt;type_job&lt;/code&gt; and &lt;code&gt;yarn_applications&lt;/code&gt; fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1845 "state": "A String", # Output only. A state message specifying the overall job state.
1846 "stateStartTime": "A String", # Output only. The time when this state was entered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1847 "details": "A String", # Output only. Optional Job state details, such as an error description if the state is &lt;code&gt;ERROR&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1848 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1849 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1850 "hadoopJob": { # A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Optional. Job is a Hadoop job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1851 "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.
1852 "A String",
1853 ],
1854 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
1855 "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'
1856 "a_key": "A String",
1857 },
1858 },
1859 "jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
1860 "A String",
1861 ],
1862 "fileUris": [ # Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
1863 "A String",
1864 ],
1865 "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.
1866 "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.
1867 "A String",
1868 ],
1869 "mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1870 "properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1871 "a_key": "A String",
1872 },
1873 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1874 "pigJob": { # A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Optional. Job is a Pig job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1875 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
1876 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).
1877 "a_key": "A String",
1878 },
1879 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
1880 "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'
1881 "a_key": "A String",
1882 },
1883 },
1884 "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.
1885 "A String",
1886 ],
1887 "queryList": { # A list of queries to run on a cluster. # A list of queries.
1888 "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:
1889 # "hiveJob": {
1890 # "queryList": {
1891 # "queries": [
1892 # "query1",
1893 # "query2",
1894 # "query3;query4",
1895 # ]
1896 # }
1897 # }
1898 "A String",
1899 ],
1900 },
1901 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1902 "properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1903 "a_key": "A String",
1904 },
1905 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1906 "placement": { # Dataproc job config. # Required. Job information, including how, when, and where to run the job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1907 "clusterName": "A String", # Required. The name of the cluster where the job will be submitted.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1908 "clusterUuid": "A String", # Output only. A cluster UUID generated by the Dataproc service when the job is submitted.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1909 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1910 "sparkRJob": { # A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Optional. Job is a SparkR job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1911 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
1912 "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'
1913 "a_key": "A String",
1914 },
1915 },
1916 "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.
1917 "A String",
1918 ],
1919 "mainRFileUri": "A String", # Required. The HCFS URI of the main R file to use as the driver. Must be a .R file.
1920 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of R drivers and distributed tasks. Useful for naively parallel tasks.
1921 "A String",
1922 ],
1923 "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.
1924 "A String",
1925 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1926 "properties": { # Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1927 "a_key": "A String",
1928 },
1929 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1930 "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 &lt;code&gt;job_id&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1931 "projectId": "A String", # Required. The ID of the Google Cloud Platform project that the job belongs to.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1932 "jobId": "A String", # Optional. The job ID, which must be unique within the project. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.If not specified by the caller, the job ID will be provided by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1933 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1934 "sparkSqlJob": { # A Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Optional. Job is a SparkSql job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1935 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
1936 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
1937 "a_key": "A String",
1938 },
1939 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
1940 "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'
1941 "a_key": "A String",
1942 },
1943 },
1944 "jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.
1945 "A String",
1946 ],
1947 "queryList": { # A list of queries to run on a cluster. # A list of queries.
1948 "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:
1949 # "hiveJob": {
1950 # "queryList": {
1951 # "queries": [
1952 # "query1",
1953 # "query2",
1954 # "query3;query4",
1955 # ]
1956 # }
1957 # }
1958 "A String",
1959 ],
1960 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1961 "properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1962 "a_key": "A String",
1963 },
1964 },
1965 "yarnApplications": [ # Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1966 { # A YARN application created by a job. Application information is a subset of &lt;code&gt;org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto&lt;/code&gt;.Beta Feature: This report is available for testing purposes only. It may be changed before final release.
1967 "progress": 3.14, # Output only. The numerical progress of the application, from 1 to 100.
1968 "state": "A String", # Output only. The application state.
1969 "name": "A String", # Output only. The application name.
1970 "trackingUrl": "A String", # Output only. 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1971 },
1972 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1973 "submittedBy": "A String", # Output only. The email address of the user submitting the job. For jobs submitted on the cluster, the address is &lt;code&gt;username@hostname&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1974 "jobUuid": "A String", # Output only. A UUID that uniquely identifies a job within the project over time. This is in contrast to a user-settable reference.job_id that may be reused over time.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1975 "labels": { # Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.
1976 "a_key": "A String",
1977 },
1978 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1979 "done": True or False, # Output only. Indicates whether the job is completed. If the value is false, the job is still in progress. If true, the job is completed, and status.state field will indicate if it was successful, failed, or cancelled.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1980 "driverOutputResourceUri": "A String", # Output only. A URI pointing to the location of the stdout of the job's driver program.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1981 "prestoJob": { # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. # Optional. Job is a Presto job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1982 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
1983 "outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats
1984 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
1985 "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'
1986 "a_key": "A String",
1987 },
1988 },
1989 "clientTags": [ # Optional. Presto client tags to attach to this query
1990 "A String",
1991 ],
1992 "queryList": { # A list of queries to run on a cluster. # A list of queries.
1993 "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:
1994 # "hiveJob": {
1995 # "queryList": {
1996 # "queries": [
1997 # "query1",
1998 # "query2",
1999 # "query3;query4",
2000 # ]
2001 # }
2002 # }
2003 "A String",
2004 ],
2005 },
2006 "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.
2007 "properties": { # Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI
2008 "a_key": "A String",
2009 },
2010 },
2011 "scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.
2012 "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.
2013 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2014 "sparkJob": { # A Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. The specification of the main method to call to drive the job. Specify either the jar file that contains the main class or the main class name. To pass both a main jar and a main class in that jar, add the jar to CommonJob.jar_file_uris, and then specify the main class name in main_class. # Optional. Job is a Spark job.
2015 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
2016 "A String",
2017 ],
2018 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
2019 "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'
2020 "a_key": "A String",
2021 },
2022 },
2023 "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.
2024 "A String",
2025 ],
2026 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
2027 "A String",
2028 ],
2029 "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.
2030 "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.
2031 "A String",
2032 ],
2033 "mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.
2034 "properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
2035 "a_key": "A String",
2036 },
2037 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2038 "statusHistory": [ # Output only. The previous job status.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2039 { # Dataproc job status.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2040 "state": "A String", # Output only. A state message specifying the overall job state.
2041 "stateStartTime": "A String", # Output only. The time when this state was entered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2042 "details": "A String", # Output only. Optional Job state details, such as an error description if the state is &lt;code&gt;ERROR&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2043 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2044 },
2045 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2046 "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Optional. Job is a PySpark job.
2047 "mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.
2048 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
2049 "A String",
2050 ],
2051 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
2052 "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'
2053 "a_key": "A String",
2054 },
2055 },
2056 "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.
2057 "A String",
2058 ],
2059 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
2060 "A String",
2061 ],
2062 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
2063 "A String",
2064 ],
2065 "pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
2066 "A String",
2067 ],
2068 "properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
2069 "a_key": "A String",
2070 },
2071 },
2072 "hiveJob": { # A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Optional. Job is a Hive job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2073 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
2074 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).
2075 "a_key": "A String",
2076 },
2077 "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.
2078 "A String",
2079 ],
2080 "queryList": { # A list of queries to run on a cluster. # A list of queries.
2081 "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:
2082 # "hiveJob": {
2083 # "queryList": {
2084 # "queries": [
2085 # "query1",
2086 # "query2",
2087 # "query3;query4",
2088 # ]
2089 # }
2090 # }
2091 "A String",
2092 ],
2093 },
2094 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2095 "properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2096 "a_key": "A String",
2097 },
2098 },
2099 },
2100 "requestId": "A String", # Optional. A unique id used to identify the request. If the server receives two SubmitJobRequest requests with the same id, then the second request will be ignored and the first Job created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
2101 }
2102
2103 x__xgafv: string, V1 error format.
2104 Allowed values
2105 1 - v1 error format
2106 2 - v2 error format
2107
2108Returns:
2109 An object of the form:
2110
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2111 { # A Dataproc job resource.
2112 "status": { # Dataproc job status. # Output only. The job status. Additional application-specific status information may be contained in the &lt;code&gt;type_job&lt;/code&gt; and &lt;code&gt;yarn_applications&lt;/code&gt; fields.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2113 "state": "A String", # Output only. A state message specifying the overall job state.
2114 "stateStartTime": "A String", # Output only. The time when this state was entered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2115 "details": "A String", # Output only. Optional Job state details, such as an error description if the state is &lt;code&gt;ERROR&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2116 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2117 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2118 "hadoopJob": { # A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Optional. Job is a Hadoop job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2119 "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.
2120 "A String",
2121 ],
2122 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
2123 "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'
2124 "a_key": "A String",
2125 },
2126 },
2127 "jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
2128 "A String",
2129 ],
2130 "fileUris": [ # Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
2131 "A String",
2132 ],
2133 "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.
2134 "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.
2135 "A String",
2136 ],
2137 "mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2138 "properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2139 "a_key": "A String",
2140 },
2141 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2142 "pigJob": { # A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Optional. Job is a Pig job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2143 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
2144 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).
2145 "a_key": "A String",
2146 },
2147 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
2148 "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'
2149 "a_key": "A String",
2150 },
2151 },
2152 "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.
2153 "A String",
2154 ],
2155 "queryList": { # A list of queries to run on a cluster. # A list of queries.
2156 "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:
2157 # "hiveJob": {
2158 # "queryList": {
2159 # "queries": [
2160 # "query1",
2161 # "query2",
2162 # "query3;query4",
2163 # ]
2164 # }
2165 # }
2166 "A String",
2167 ],
2168 },
2169 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2170 "properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2171 "a_key": "A String",
2172 },
2173 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2174 "placement": { # Dataproc job config. # Required. Job information, including how, when, and where to run the job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2175 "clusterName": "A String", # Required. The name of the cluster where the job will be submitted.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2176 "clusterUuid": "A String", # Output only. A cluster UUID generated by the Dataproc service when the job is submitted.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2177 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2178 "sparkRJob": { # A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Optional. Job is a SparkR job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2179 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
2180 "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'
2181 "a_key": "A String",
2182 },
2183 },
2184 "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.
2185 "A String",
2186 ],
2187 "mainRFileUri": "A String", # Required. The HCFS URI of the main R file to use as the driver. Must be a .R file.
2188 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of R drivers and distributed tasks. Useful for naively parallel tasks.
2189 "A String",
2190 ],
2191 "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.
2192 "A String",
2193 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2194 "properties": { # Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2195 "a_key": "A String",
2196 },
2197 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2198 "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 &lt;code&gt;job_id&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2199 "projectId": "A String", # Required. The ID of the Google Cloud Platform project that the job belongs to.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2200 "jobId": "A String", # Optional. The job ID, which must be unique within the project. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.If not specified by the caller, the job ID will be provided by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2201 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2202 "sparkSqlJob": { # A Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Optional. Job is a SparkSql job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2203 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
2204 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
2205 "a_key": "A String",
2206 },
2207 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
2208 "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'
2209 "a_key": "A String",
2210 },
2211 },
2212 "jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.
2213 "A String",
2214 ],
2215 "queryList": { # A list of queries to run on a cluster. # A list of queries.
2216 "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:
2217 # "hiveJob": {
2218 # "queryList": {
2219 # "queries": [
2220 # "query1",
2221 # "query2",
2222 # "query3;query4",
2223 # ]
2224 # }
2225 # }
2226 "A String",
2227 ],
2228 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2229 "properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2230 "a_key": "A String",
2231 },
2232 },
2233 "yarnApplications": [ # Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2234 { # A YARN application created by a job. Application information is a subset of &lt;code&gt;org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto&lt;/code&gt;.Beta Feature: This report is available for testing purposes only. It may be changed before final release.
2235 "progress": 3.14, # Output only. The numerical progress of the application, from 1 to 100.
2236 "state": "A String", # Output only. The application state.
2237 "name": "A String", # Output only. The application name.
2238 "trackingUrl": "A String", # Output only. 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2239 },
2240 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2241 "submittedBy": "A String", # Output only. The email address of the user submitting the job. For jobs submitted on the cluster, the address is &lt;code&gt;username@hostname&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2242 "jobUuid": "A String", # Output only. A UUID that uniquely identifies a job within the project over time. This is in contrast to a user-settable reference.job_id that may be reused over time.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2243 "labels": { # Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.
2244 "a_key": "A String",
2245 },
2246 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2247 "done": True or False, # Output only. Indicates whether the job is completed. If the value is false, the job is still in progress. If true, the job is completed, and status.state field will indicate if it was successful, failed, or cancelled.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2248 "driverOutputResourceUri": "A String", # Output only. A URI pointing to the location of the stdout of the job's driver program.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2249 "prestoJob": { # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. # Optional. Job is a Presto job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2250 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
2251 "outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats
2252 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
2253 "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'
2254 "a_key": "A String",
2255 },
2256 },
2257 "clientTags": [ # Optional. Presto client tags to attach to this query
2258 "A String",
2259 ],
2260 "queryList": { # A list of queries to run on a cluster. # A list of queries.
2261 "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:
2262 # "hiveJob": {
2263 # "queryList": {
2264 # "queries": [
2265 # "query1",
2266 # "query2",
2267 # "query3;query4",
2268 # ]
2269 # }
2270 # }
2271 "A String",
2272 ],
2273 },
2274 "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.
2275 "properties": { # Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI
2276 "a_key": "A String",
2277 },
2278 },
2279 "scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.
2280 "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.
2281 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2282 "sparkJob": { # A Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. The specification of the main method to call to drive the job. Specify either the jar file that contains the main class or the main class name. To pass both a main jar and a main class in that jar, add the jar to CommonJob.jar_file_uris, and then specify the main class name in main_class. # Optional. Job is a Spark job.
2283 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
2284 "A String",
2285 ],
2286 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
2287 "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'
2288 "a_key": "A String",
2289 },
2290 },
2291 "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.
2292 "A String",
2293 ],
2294 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
2295 "A String",
2296 ],
2297 "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.
2298 "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.
2299 "A String",
2300 ],
2301 "mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.
2302 "properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
2303 "a_key": "A String",
2304 },
2305 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2306 "statusHistory": [ # Output only. The previous job status.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2307 { # Dataproc job status.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2308 "state": "A String", # Output only. A state message specifying the overall job state.
2309 "stateStartTime": "A String", # Output only. The time when this state was entered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2310 "details": "A String", # Output only. Optional Job state details, such as an error description if the state is &lt;code&gt;ERROR&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2311 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2312 },
2313 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2314 "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Optional. Job is a PySpark job.
2315 "mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.
2316 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
2317 "A String",
2318 ],
2319 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
2320 "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'
2321 "a_key": "A String",
2322 },
2323 },
2324 "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.
2325 "A String",
2326 ],
2327 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
2328 "A String",
2329 ],
2330 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
2331 "A String",
2332 ],
2333 "pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
2334 "A String",
2335 ],
2336 "properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
2337 "a_key": "A String",
2338 },
2339 },
2340 "hiveJob": { # A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Optional. Job is a Hive job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2341 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
2342 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).
2343 "a_key": "A String",
2344 },
2345 "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.
2346 "A String",
2347 ],
2348 "queryList": { # A list of queries to run on a cluster. # A list of queries.
2349 "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:
2350 # "hiveJob": {
2351 # "queryList": {
2352 # "queries": [
2353 # "query1",
2354 # "query2",
2355 # "query3;query4",
2356 # ]
2357 # }
2358 # }
2359 "A String",
2360 ],
2361 },
2362 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2363 "properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2364 "a_key": "A String",
2365 },
2366 },
2367 }</pre>
2368</div>
2369
2370<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2371 <code class="details" id="submitAsOperation">submitAsOperation(projectId, region, body=None, x__xgafv=None)</code>
2372 <pre>Submits job to a cluster.
2373
2374Args:
2375 projectId: string, Required. The ID of the Google Cloud Platform project that the job belongs to. (required)
2376 region: string, Required. The Dataproc region in which to handle the request. (required)
2377 body: object, The request body.
2378 The object takes the form of:
2379
2380{ # A request to submit a job.
2381 "job": { # A Dataproc job resource. # Required. The job resource.
2382 "status": { # Dataproc job status. # Output only. The job status. Additional application-specific status information may be contained in the &lt;code&gt;type_job&lt;/code&gt; and &lt;code&gt;yarn_applications&lt;/code&gt; fields.
2383 "state": "A String", # Output only. A state message specifying the overall job state.
2384 "stateStartTime": "A String", # Output only. The time when this state was entered.
2385 "details": "A String", # Output only. Optional Job state details, such as an error description if the state is &lt;code&gt;ERROR&lt;/code&gt;.
2386 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent.
2387 },
2388 "hadoopJob": { # A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Optional. Job is a Hadoop job.
2389 "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.
2390 "A String",
2391 ],
2392 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
2393 "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'
2394 "a_key": "A String",
2395 },
2396 },
2397 "jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
2398 "A String",
2399 ],
2400 "fileUris": [ # Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
2401 "A String",
2402 ],
2403 "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.
2404 "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.
2405 "A String",
2406 ],
2407 "mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
2408 "properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
2409 "a_key": "A String",
2410 },
2411 },
2412 "pigJob": { # A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Optional. Job is a Pig job.
2413 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
2414 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).
2415 "a_key": "A String",
2416 },
2417 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
2418 "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'
2419 "a_key": "A String",
2420 },
2421 },
2422 "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.
2423 "A String",
2424 ],
2425 "queryList": { # A list of queries to run on a cluster. # A list of queries.
2426 "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:
2427 # "hiveJob": {
2428 # "queryList": {
2429 # "queries": [
2430 # "query1",
2431 # "query2",
2432 # "query3;query4",
2433 # ]
2434 # }
2435 # }
2436 "A String",
2437 ],
2438 },
2439 "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.
2440 "properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
2441 "a_key": "A String",
2442 },
2443 },
2444 "placement": { # Dataproc job config. # Required. Job information, including how, when, and where to run the job.
2445 "clusterName": "A String", # Required. The name of the cluster where the job will be submitted.
2446 "clusterUuid": "A String", # Output only. A cluster UUID generated by the Dataproc service when the job is submitted.
2447 },
2448 "sparkRJob": { # A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Optional. Job is a SparkR job.
2449 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
2450 "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'
2451 "a_key": "A String",
2452 },
2453 },
2454 "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.
2455 "A String",
2456 ],
2457 "mainRFileUri": "A String", # Required. The HCFS URI of the main R file to use as the driver. Must be a .R file.
2458 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of R drivers and distributed tasks. Useful for naively parallel tasks.
2459 "A String",
2460 ],
2461 "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.
2462 "A String",
2463 ],
2464 "properties": { # Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
2465 "a_key": "A String",
2466 },
2467 },
2468 "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 &lt;code&gt;job_id&lt;/code&gt;.
2469 "projectId": "A String", # Required. The ID of the Google Cloud Platform project that the job belongs to.
2470 "jobId": "A String", # Optional. The job ID, which must be unique within the project. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.If not specified by the caller, the job ID will be provided by the server.
2471 },
2472 "sparkSqlJob": { # A Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Optional. Job is a SparkSql job.
2473 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
2474 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
2475 "a_key": "A String",
2476 },
2477 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
2478 "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'
2479 "a_key": "A String",
2480 },
2481 },
2482 "jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.
2483 "A String",
2484 ],
2485 "queryList": { # A list of queries to run on a cluster. # A list of queries.
2486 "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:
2487 # "hiveJob": {
2488 # "queryList": {
2489 # "queries": [
2490 # "query1",
2491 # "query2",
2492 # "query3;query4",
2493 # ]
2494 # }
2495 # }
2496 "A String",
2497 ],
2498 },
2499 "properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.
2500 "a_key": "A String",
2501 },
2502 },
2503 "yarnApplications": [ # Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release.
2504 { # A YARN application created by a job. Application information is a subset of &lt;code&gt;org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto&lt;/code&gt;.Beta Feature: This report is available for testing purposes only. It may be changed before final release.
2505 "progress": 3.14, # Output only. The numerical progress of the application, from 1 to 100.
2506 "state": "A String", # Output only. The application state.
2507 "name": "A String", # Output only. The application name.
2508 "trackingUrl": "A String", # Output only. 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.
2509 },
2510 ],
2511 "submittedBy": "A String", # Output only. The email address of the user submitting the job. For jobs submitted on the cluster, the address is &lt;code&gt;username@hostname&lt;/code&gt;.
2512 "jobUuid": "A String", # Output only. A UUID that uniquely identifies a job within the project over time. This is in contrast to a user-settable reference.job_id that may be reused over time.
2513 "labels": { # Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.
2514 "a_key": "A String",
2515 },
2516 "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.
2517 "done": True or False, # Output only. Indicates whether the job is completed. If the value is false, the job is still in progress. If true, the job is completed, and status.state field will indicate if it was successful, failed, or cancelled.
2518 "driverOutputResourceUri": "A String", # Output only. A URI pointing to the location of the stdout of the job's driver program.
2519 "prestoJob": { # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. # Optional. Job is a Presto job.
2520 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
2521 "outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats
2522 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
2523 "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'
2524 "a_key": "A String",
2525 },
2526 },
2527 "clientTags": [ # Optional. Presto client tags to attach to this query
2528 "A String",
2529 ],
2530 "queryList": { # A list of queries to run on a cluster. # A list of queries.
2531 "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:
2532 # "hiveJob": {
2533 # "queryList": {
2534 # "queries": [
2535 # "query1",
2536 # "query2",
2537 # "query3;query4",
2538 # ]
2539 # }
2540 # }
2541 "A String",
2542 ],
2543 },
2544 "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.
2545 "properties": { # Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI
2546 "a_key": "A String",
2547 },
2548 },
2549 "scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.
2550 "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.
2551 },
2552 "sparkJob": { # A Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. The specification of the main method to call to drive the job. Specify either the jar file that contains the main class or the main class name. To pass both a main jar and a main class in that jar, add the jar to CommonJob.jar_file_uris, and then specify the main class name in main_class. # Optional. Job is a Spark job.
2553 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
2554 "A String",
2555 ],
2556 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
2557 "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'
2558 "a_key": "A String",
2559 },
2560 },
2561 "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.
2562 "A String",
2563 ],
2564 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
2565 "A String",
2566 ],
2567 "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.
2568 "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.
2569 "A String",
2570 ],
2571 "mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.
2572 "properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
2573 "a_key": "A String",
2574 },
2575 },
2576 "statusHistory": [ # Output only. The previous job status.
2577 { # Dataproc job status.
2578 "state": "A String", # Output only. A state message specifying the overall job state.
2579 "stateStartTime": "A String", # Output only. The time when this state was entered.
2580 "details": "A String", # Output only. Optional Job state details, such as an error description if the state is &lt;code&gt;ERROR&lt;/code&gt;.
2581 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent.
2582 },
2583 ],
2584 "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Optional. Job is a PySpark job.
2585 "mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.
2586 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
2587 "A String",
2588 ],
2589 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
2590 "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'
2591 "a_key": "A String",
2592 },
2593 },
2594 "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.
2595 "A String",
2596 ],
2597 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
2598 "A String",
2599 ],
2600 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
2601 "A String",
2602 ],
2603 "pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
2604 "A String",
2605 ],
2606 "properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
2607 "a_key": "A String",
2608 },
2609 },
2610 "hiveJob": { # A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Optional. Job is a Hive job.
2611 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
2612 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).
2613 "a_key": "A String",
2614 },
2615 "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.
2616 "A String",
2617 ],
2618 "queryList": { # A list of queries to run on a cluster. # A list of queries.
2619 "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:
2620 # "hiveJob": {
2621 # "queryList": {
2622 # "queries": [
2623 # "query1",
2624 # "query2",
2625 # "query3;query4",
2626 # ]
2627 # }
2628 # }
2629 "A String",
2630 ],
2631 },
2632 "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.
2633 "properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
2634 "a_key": "A String",
2635 },
2636 },
2637 },
2638 "requestId": "A String", # Optional. A unique id used to identify the request. If the server receives two SubmitJobRequest requests with the same id, then the second request will be ignored and the first Job created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
2639 }
2640
2641 x__xgafv: string, V1 error format.
2642 Allowed values
2643 1 - v1 error format
2644 2 - v2 error format
2645
2646Returns:
2647 An object of the form:
2648
2649 { # This resource represents a long-running operation that is the result of a network API call.
2650 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
2651 "a_key": "", # Properties of the object. Contains field @type with type URL.
2652 },
2653 "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
2654 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
2655 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
2656 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
2657 {
2658 "a_key": "", # Properties of the object. Contains field @type with type URL.
2659 },
2660 ],
2661 },
2662 "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
2663 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
2664 "a_key": "", # Properties of the object. Contains field @type with type URL.
2665 },
2666 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
2667 }</pre>
2668</div>
2669
2670<div class="method">
2671 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2672 <pre>Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
2673
2674Args:
2675 resource: string, REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2676 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2677 The object takes the form of:
2678
2679{ # Request message for TestIamPermissions method.
2680 "permissions": [ # The set of permissions to check for the resource. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview (https://cloud.google.com/iam/docs/overview#permissions).
2681 "A String",
2682 ],
2683 }
2684
2685 x__xgafv: string, V1 error format.
2686 Allowed values
2687 1 - v1 error format
2688 2 - v2 error format
2689
2690Returns:
2691 An object of the form:
2692
2693 { # Response message for TestIamPermissions method.
2694 "permissions": [ # A subset of TestPermissionsRequest.permissions that the caller is allowed.
2695 "A String",
2696 ],
2697 }</pre>
2698</div>
2699
2700</body></html>