blob: c9a93c5b37e8adc1694df743477d5b0026b88af7 [file] [log] [blame]
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001<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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070075<h1><a href="dataproc_v1.html">Cloud Dataproc API</a> . <a href="dataproc_v1.projects.html">projects</a> . <a href="dataproc_v1.projects.regions.html">regions</a> . <a href="dataproc_v1.projects.regions.jobs.html">jobs</a></h1>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080076<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070078 <code><a href="#cancel">cancel(projectId, region, jobId, body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040079<p class="firstline">Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080080<p class="toc_element">
81 <code><a href="#delete">delete(projectId, region, jobId, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040082<p class="firstline">Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080083<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">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070087 <code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>
89<p class="toc_element">
90 <code><a href="#list">list(projectId, region, pageSize=None, x__xgafv=None, jobStateMatcher=None, pageToken=None, clusterName=None, filter=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080091<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">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040096 <code><a href="#patch">patch(projectId, region, jobId, body, updateMask=None, x__xgafv=None)</a></code></p>
97<p class="firstline">Updates a job in a project.</p>
98<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070099 <code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p>
100<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p>
101<p class="toc_element">
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800102 <code><a href="#submit">submit(projectId, region, body, x__xgafv=None)</a></code></p>
103<p class="firstline">Submits a job to a cluster.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700104<p class="toc_element">
105 <code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p>
106<p class="firstline">Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800107<h3>Method Details</h3>
108<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700109 <code class="details" id="cancel">cancel(projectId, region, jobId, body=None, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400110 <pre>Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800111
112Args:
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400113 projectId: string, Required. The ID of the Google Cloud Platform project that the job belongs to. (required)
114 region: string, Required. The Cloud Dataproc region in which to handle the request. (required)
115 jobId: string, Required. The job ID. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700116 body: object, The request body.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800117 The object takes the form of:
118
119{ # A request to cancel a job.
120 }
121
122 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400123 Allowed values
124 1 - v1 error format
125 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800126
127Returns:
128 An object of the form:
129
130 { # A Cloud Dataproc job resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700131 "status": { # Cloud Dataproc job status. # Output only. The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields.
132 "state": "A String", # Output only. A state message specifying the overall job state.
133 "stateStartTime": "A String", # Output only. The time when this state was entered.
134 "details": "A String", # Output only. Optional job state details, such as an error description if the state is <code>ERROR</code>.
135 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800136 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400137 "sparkSqlJob": { # A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Job is a SparkSql job.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800138 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400139 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800140 "a_key": "A String",
141 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400142 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400143 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800144 "a_key": "A String",
145 },
146 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400147 "jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800148 "A String",
149 ],
150 "queryList": { # A list of queries to run on a cluster. # A list of queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400151 "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:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400152 # "hiveJob": {
153 # "queryList": {
154 # "queries": [
155 # "query1",
156 # "query2",
157 # "query3;query4",
158 # ]
159 # }
160 # }
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800161 "A String",
162 ],
163 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400164 "properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800165 "a_key": "A String",
166 },
167 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700168 "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.
169 "a_key": "A String",
170 },
171 "placement": { # Cloud Dataproc job config. # Required. Job information, including how, when, and where to run the job.
172 "clusterName": "A String", # Required. The name of the cluster where the job will be submitted.
173 "clusterUuid": "A String", # Output only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted.
174 },
175 "reference": { # Encapsulates the full scoping used to reference a job. # Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
176 "projectId": "A String", # Required. The ID of the Google Cloud Platform project that the job belongs to.
177 "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.
178 },
179 "hadoopJob": { # A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Job is a Hadoop job.
180 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
181 "A String",
182 ],
183 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
184 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
185 "a_key": "A String",
186 },
187 },
188 "jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
189 "A String",
190 ],
191 "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.
192 "A String",
193 ],
194 "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.
195 "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.
196 "A String",
197 ],
198 "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'
199 "properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
200 "a_key": "A String",
201 },
202 },
203 "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.
204 { # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.Beta Feature: This report is available for testing purposes only. It may be changed before final release.
205 "progress": 3.14, # Required. The numerical progress of the application, from 1 to 100.
206 "state": "A String", # Required. The application state.
207 "name": "A String", # Required. The application name.
208 "trackingUrl": "A String", # Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
209 },
210 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400211 "pigJob": { # A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Job is a Pig job.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800212 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400213 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800214 "a_key": "A String",
215 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400216 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400217 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800218 "a_key": "A String",
219 },
220 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400221 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800222 "A String",
223 ],
224 "queryList": { # A list of queries to run on a cluster. # A list of queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400225 "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:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400226 # "hiveJob": {
227 # "queryList": {
228 # "queries": [
229 # "query1",
230 # "query2",
231 # "query3;query4",
232 # ]
233 # }
234 # }
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800235 "A String",
236 ],
237 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400238 "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.
239 "properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800240 "a_key": "A String",
241 },
242 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700243 "driverOutputResourceUri": "A String", # Output only. A URI pointing to the location of the stdout of the job's driver program.
Thomas Coffee2f245372017-03-27 10:39:26 -0700244 "pysparkJob": { # A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Job is a Pyspark job.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400245 "mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700246 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800247 "A String",
248 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400249 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
Thomas Coffee2f245372017-03-27 10:39:26 -0700250 "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'
251 "a_key": "A String",
252 },
253 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700254 "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.
Thomas Coffee2f245372017-03-27 10:39:26 -0700255 "A String",
256 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400257 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800258 "A String",
259 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400260 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400261 "A String",
262 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400263 "pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400264 "A String",
265 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400266 "properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400267 "a_key": "A String",
268 },
269 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700270 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400271 "sparkJob": { # A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Job is a Spark job.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400272 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400273 "A String",
274 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400275 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400276 "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'
277 "a_key": "A String",
278 },
279 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400280 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400281 "A String",
282 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400283 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400284 "A String",
285 ],
286 "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400287 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800288 "A String",
289 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700290 "mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400291 "properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800292 "a_key": "A String",
293 },
294 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700295 "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.
296 "scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400297 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800298 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700299 "statusHistory": [ # Output only. The previous job status.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400300 { # Cloud Dataproc job status.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700301 "state": "A String", # Output only. A state message specifying the overall job state.
302 "stateStartTime": "A String", # Output only. The time when this state was entered.
303 "details": "A String", # Output only. Optional job state details, such as an error description if the state is <code>ERROR</code>.
304 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400305 },
306 ],
307 "hiveJob": { # A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Job is a Hive job.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800308 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400309 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800310 "a_key": "A String",
311 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400312 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800313 "A String",
314 ],
315 "queryList": { # A list of queries to run on a cluster. # A list of queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400316 "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:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400317 # "hiveJob": {
318 # "queryList": {
319 # "queries": [
320 # "query1",
321 # "query2",
322 # "query3;query4",
323 # ]
324 # }
325 # }
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800326 "A String",
327 ],
328 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400329 "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.
330 "properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800331 "a_key": "A String",
332 },
333 },
334 }</pre>
335</div>
336
337<div class="method">
338 <code class="details" id="delete">delete(projectId, region, jobId, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400339 <pre>Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800340
341Args:
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400342 projectId: string, Required. The ID of the Google Cloud Platform project that the job belongs to. (required)
343 region: string, Required. The Cloud Dataproc region in which to handle the request. (required)
344 jobId: string, Required. The job ID. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800345 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400346 Allowed values
347 1 - v1 error format
348 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800349
350Returns:
351 An object of the form:
352
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400353 { # 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:
354 # service Foo {
355 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
356 # }
357 # The JSON representation for Empty is empty JSON object {}.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800358 }</pre>
359</div>
360
361<div class="method">
362 <code class="details" id="get">get(projectId, region, jobId, x__xgafv=None)</code>
363 <pre>Gets the resource representation for a job in a project.
364
365Args:
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400366 projectId: string, Required. The ID of the Google Cloud Platform project that the job belongs to. (required)
367 region: string, Required. The Cloud Dataproc region in which to handle the request. (required)
368 jobId: string, Required. The job ID. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800369 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400370 Allowed values
371 1 - v1 error format
372 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800373
374Returns:
375 An object of the form:
376
377 { # A Cloud Dataproc job resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700378 "status": { # Cloud Dataproc job status. # Output only. The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields.
379 "state": "A String", # Output only. A state message specifying the overall job state.
380 "stateStartTime": "A String", # Output only. The time when this state was entered.
381 "details": "A String", # Output only. Optional job state details, such as an error description if the state is <code>ERROR</code>.
382 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800383 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400384 "sparkSqlJob": { # A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Job is a SparkSql job.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800385 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400386 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800387 "a_key": "A String",
388 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400389 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400390 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800391 "a_key": "A String",
392 },
393 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400394 "jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800395 "A String",
396 ],
397 "queryList": { # A list of queries to run on a cluster. # A list of queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400398 "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:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400399 # "hiveJob": {
400 # "queryList": {
401 # "queries": [
402 # "query1",
403 # "query2",
404 # "query3;query4",
405 # ]
406 # }
407 # }
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800408 "A String",
409 ],
410 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400411 "properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800412 "a_key": "A String",
413 },
414 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700415 "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.
416 "a_key": "A String",
417 },
418 "placement": { # Cloud Dataproc job config. # Required. Job information, including how, when, and where to run the job.
419 "clusterName": "A String", # Required. The name of the cluster where the job will be submitted.
420 "clusterUuid": "A String", # Output only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted.
421 },
422 "reference": { # Encapsulates the full scoping used to reference a job. # Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
423 "projectId": "A String", # Required. The ID of the Google Cloud Platform project that the job belongs to.
424 "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.
425 },
426 "hadoopJob": { # A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Job is a Hadoop job.
427 "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.
428 "A String",
429 ],
430 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
431 "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'
432 "a_key": "A String",
433 },
434 },
435 "jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
436 "A String",
437 ],
438 "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.
439 "A String",
440 ],
441 "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.
442 "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.
443 "A String",
444 ],
445 "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'
446 "properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
447 "a_key": "A String",
448 },
449 },
450 "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.
451 { # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.Beta Feature: This report is available for testing purposes only. It may be changed before final release.
452 "progress": 3.14, # Required. The numerical progress of the application, from 1 to 100.
453 "state": "A String", # Required. The application state.
454 "name": "A String", # Required. The application name.
455 "trackingUrl": "A String", # Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
456 },
457 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400458 "pigJob": { # A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Job is a Pig job.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800459 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400460 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800461 "a_key": "A String",
462 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400463 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400464 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800465 "a_key": "A String",
466 },
467 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400468 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800469 "A String",
470 ],
471 "queryList": { # A list of queries to run on a cluster. # A list of queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400472 "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:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400473 # "hiveJob": {
474 # "queryList": {
475 # "queries": [
476 # "query1",
477 # "query2",
478 # "query3;query4",
479 # ]
480 # }
481 # }
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800482 "A String",
483 ],
484 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400485 "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.
486 "properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800487 "a_key": "A String",
488 },
489 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700490 "driverOutputResourceUri": "A String", # Output only. A URI pointing to the location of the stdout of the job's driver program.
Thomas Coffee2f245372017-03-27 10:39:26 -0700491 "pysparkJob": { # A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Job is a Pyspark job.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400492 "mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700493 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800494 "A String",
495 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400496 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
Thomas Coffee2f245372017-03-27 10:39:26 -0700497 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
498 "a_key": "A String",
499 },
500 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700501 "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.
Thomas Coffee2f245372017-03-27 10:39:26 -0700502 "A String",
503 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400504 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800505 "A String",
506 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400507 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400508 "A String",
509 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400510 "pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400511 "A String",
512 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400513 "properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400514 "a_key": "A String",
515 },
516 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700517 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400518 "sparkJob": { # A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Job is a Spark job.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400519 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400520 "A String",
521 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400522 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400523 "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'
524 "a_key": "A String",
525 },
526 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400527 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400528 "A String",
529 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400530 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400531 "A String",
532 ],
533 "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400534 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800535 "A String",
536 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700537 "mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400538 "properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800539 "a_key": "A String",
540 },
541 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700542 "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.
543 "scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400544 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800545 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700546 "statusHistory": [ # Output only. The previous job status.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400547 { # Cloud Dataproc job status.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700548 "state": "A String", # Output only. A state message specifying the overall job state.
549 "stateStartTime": "A String", # Output only. The time when this state was entered.
550 "details": "A String", # Output only. Optional job state details, such as an error description if the state is <code>ERROR</code>.
551 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400552 },
553 ],
554 "hiveJob": { # A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Job is a Hive job.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800555 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400556 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800557 "a_key": "A String",
558 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400559 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800560 "A String",
561 ],
562 "queryList": { # A list of queries to run on a cluster. # A list of queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400563 "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:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400564 # "hiveJob": {
565 # "queryList": {
566 # "queries": [
567 # "query1",
568 # "query2",
569 # "query3;query4",
570 # ]
571 # }
572 # }
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800573 "A String",
574 ],
575 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400576 "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.
577 "properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800578 "a_key": "A String",
579 },
580 },
581 }</pre>
582</div>
583
584<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700585 <code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code>
586 <pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
587
588Args:
589 resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required)
590 body: object, The request body.
591 The object takes the form of:
592
593{ # Request message for GetIamPolicy method.
594 }
595
596 x__xgafv: string, V1 error format.
597 Allowed values
598 1 - v1 error format
599 2 - v2 error format
600
601Returns:
602 An object of the form:
603
604 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.A Policy consists of a list of bindings. A binding binds a list of members to a role, where the members can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM.JSON Example
605 # {
606 # "bindings": [
607 # {
608 # "role": "roles/owner",
609 # "members": [
610 # "user:mike@example.com",
611 # "group:admins@example.com",
612 # "domain:google.com",
613 # "serviceAccount:my-other-app@appspot.gserviceaccount.com"
614 # ]
615 # },
616 # {
617 # "role": "roles/viewer",
618 # "members": ["user:sean@example.com"]
619 # }
620 # ]
621 # }
622 # YAML Example
623 # bindings:
624 # - members:
625 # - user:mike@example.com
626 # - group:admins@example.com
627 # - domain:google.com
628 # - serviceAccount:my-other-app@appspot.gserviceaccount.com
629 # role: roles/owner
630 # - members:
631 # - user:sean@example.com
632 # role: roles/viewer
633 # For a description of IAM and its features, see the IAM developer's guide (https://cloud.google.com/iam/docs).
634 "bindings": [ # Associates a list of members to a role. bindings with no members will result in an error.
635 { # Associates members with a role.
636 "role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.
637 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:
638 # allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
639 # allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
640 # user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com .
641 # serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
642 # group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
643 # domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
644 "A String",
645 ],
646 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
647 # title: "User account presence"
648 # description: "Determines whether the request has a user account"
649 # expression: "size(request.user) > 0"
650 "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
651 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.The application context of the containing message determines which well-known feature set of CEL is supported.
652 "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
653 "title": "A String", # An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
654 },
655 },
656 ],
657 "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.If no etag is provided in the call to setIamPolicy, then the existing policy is overwritten blindly.
658 "version": 42, # Deprecated.
659 }</pre>
660</div>
661
662<div class="method">
663 <code class="details" id="list">list(projectId, region, pageSize=None, x__xgafv=None, jobStateMatcher=None, pageToken=None, clusterName=None, filter=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800664 <pre>Lists regions/{region}/jobs in a project.
665
666Args:
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400667 projectId: string, Required. The ID of the Google Cloud Platform project that the job belongs to. (required)
668 region: string, Required. The Cloud Dataproc region in which to handle the request. (required)
669 pageSize: integer, Optional. The number of results to return in each response.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800670 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400671 Allowed values
672 1 - v1 error format
673 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700674 jobStateMatcher: string, Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs).If filter is provided, jobStateMatcher will be ignored.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400675 pageToken: string, Optional. The page token, returned by a previous call, to request the next page of results.
676 clusterName: string, Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700677 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 = *
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800678
679Returns:
680 An object of the form:
681
682 { # A list of jobs in a project.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400683 "nextPageToken": "A String", # Optional. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent <code>ListJobsRequest</code>.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700684 "jobs": [ # Output only. Jobs list.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800685 { # A Cloud Dataproc job resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700686 "status": { # Cloud Dataproc job status. # Output only. The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields.
687 "state": "A String", # Output only. A state message specifying the overall job state.
688 "stateStartTime": "A String", # Output only. The time when this state was entered.
689 "details": "A String", # Output only. Optional job state details, such as an error description if the state is <code>ERROR</code>.
690 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800691 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400692 "sparkSqlJob": { # A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Job is a SparkSql job.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800693 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400694 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800695 "a_key": "A String",
696 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400697 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400698 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800699 "a_key": "A String",
700 },
701 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400702 "jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800703 "A String",
704 ],
705 "queryList": { # A list of queries to run on a cluster. # A list of queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400706 "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:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400707 # "hiveJob": {
708 # "queryList": {
709 # "queries": [
710 # "query1",
711 # "query2",
712 # "query3;query4",
713 # ]
714 # }
715 # }
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800716 "A String",
717 ],
718 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400719 "properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800720 "a_key": "A String",
721 },
722 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700723 "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.
724 "a_key": "A String",
725 },
726 "placement": { # Cloud Dataproc job config. # Required. Job information, including how, when, and where to run the job.
727 "clusterName": "A String", # Required. The name of the cluster where the job will be submitted.
728 "clusterUuid": "A String", # Output only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted.
729 },
730 "reference": { # Encapsulates the full scoping used to reference a job. # Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
731 "projectId": "A String", # Required. The ID of the Google Cloud Platform project that the job belongs to.
732 "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.
733 },
734 "hadoopJob": { # A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Job is a Hadoop job.
735 "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.
736 "A String",
737 ],
738 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
739 "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'
740 "a_key": "A String",
741 },
742 },
743 "jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
744 "A String",
745 ],
746 "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.
747 "A String",
748 ],
749 "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.
750 "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.
751 "A String",
752 ],
753 "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'
754 "properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
755 "a_key": "A String",
756 },
757 },
758 "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.
759 { # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.Beta Feature: This report is available for testing purposes only. It may be changed before final release.
760 "progress": 3.14, # Required. The numerical progress of the application, from 1 to 100.
761 "state": "A String", # Required. The application state.
762 "name": "A String", # Required. The application name.
763 "trackingUrl": "A String", # Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
764 },
765 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400766 "pigJob": { # A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Job is a Pig job.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800767 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400768 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800769 "a_key": "A String",
770 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400771 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400772 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800773 "a_key": "A String",
774 },
775 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400776 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800777 "A String",
778 ],
779 "queryList": { # A list of queries to run on a cluster. # A list of queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400780 "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:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400781 # "hiveJob": {
782 # "queryList": {
783 # "queries": [
784 # "query1",
785 # "query2",
786 # "query3;query4",
787 # ]
788 # }
789 # }
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800790 "A String",
791 ],
792 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400793 "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.
794 "properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800795 "a_key": "A String",
796 },
797 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700798 "driverOutputResourceUri": "A String", # Output only. A URI pointing to the location of the stdout of the job's driver program.
Thomas Coffee2f245372017-03-27 10:39:26 -0700799 "pysparkJob": { # A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Job is a Pyspark job.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400800 "mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700801 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800802 "A String",
803 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400804 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
Thomas Coffee2f245372017-03-27 10:39:26 -0700805 "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'
806 "a_key": "A String",
807 },
808 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700809 "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.
Thomas Coffee2f245372017-03-27 10:39:26 -0700810 "A String",
811 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400812 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800813 "A String",
814 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400815 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400816 "A String",
817 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400818 "pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400819 "A String",
820 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400821 "properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400822 "a_key": "A String",
823 },
824 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700825 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400826 "sparkJob": { # A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Job is a Spark job.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400827 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400828 "A String",
829 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400830 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400831 "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'
832 "a_key": "A String",
833 },
834 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400835 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400836 "A String",
837 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400838 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400839 "A String",
840 ],
841 "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400842 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800843 "A String",
844 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700845 "mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400846 "properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800847 "a_key": "A String",
848 },
849 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700850 "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.
851 "scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400852 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800853 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700854 "statusHistory": [ # Output only. The previous job status.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400855 { # Cloud Dataproc job status.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700856 "state": "A String", # Output only. A state message specifying the overall job state.
857 "stateStartTime": "A String", # Output only. The time when this state was entered.
858 "details": "A String", # Output only. Optional job state details, such as an error description if the state is <code>ERROR</code>.
859 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400860 },
861 ],
862 "hiveJob": { # A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Job is a Hive job.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800863 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400864 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800865 "a_key": "A String",
866 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400867 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800868 "A String",
869 ],
870 "queryList": { # A list of queries to run on a cluster. # A list of queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400871 "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:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400872 # "hiveJob": {
873 # "queryList": {
874 # "queries": [
875 # "query1",
876 # "query2",
877 # "query3;query4",
878 # ]
879 # }
880 # }
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800881 "A String",
882 ],
883 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400884 "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.
885 "properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800886 "a_key": "A String",
887 },
888 },
889 },
890 ],
891 }</pre>
892</div>
893
894<div class="method">
895 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
896 <pre>Retrieves the next page of results.
897
898Args:
899 previous_request: The request for the previous page. (required)
900 previous_response: The response from the request for the previous page. (required)
901
902Returns:
903 A request object that you can call 'execute()' on to request the next
904 page. Returns None if there are no more items in the collection.
905 </pre>
906</div>
907
908<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400909 <code class="details" id="patch">patch(projectId, region, jobId, body, updateMask=None, x__xgafv=None)</code>
910 <pre>Updates a job in a project.
911
912Args:
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400913 projectId: string, Required. The ID of the Google Cloud Platform project that the job belongs to. (required)
914 region: string, Required. The Cloud Dataproc region in which to handle the request. (required)
915 jobId: string, Required. The job ID. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400916 body: object, The request body. (required)
917 The object takes the form of:
918
919{ # A Cloud Dataproc job resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700920 "status": { # Cloud Dataproc job status. # Output only. The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields.
921 "state": "A String", # Output only. A state message specifying the overall job state.
922 "stateStartTime": "A String", # Output only. The time when this state was entered.
923 "details": "A String", # Output only. Optional job state details, such as an error description if the state is <code>ERROR</code>.
924 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400925 },
926 "sparkSqlJob": { # A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Job is a SparkSql job.
927 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400928 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400929 "a_key": "A String",
930 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400931 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400932 "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'
933 "a_key": "A String",
934 },
935 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400936 "jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400937 "A String",
938 ],
939 "queryList": { # A list of queries to run on a cluster. # A list of queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400940 "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:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400941 # "hiveJob": {
942 # "queryList": {
943 # "queries": [
944 # "query1",
945 # "query2",
946 # "query3;query4",
947 # ]
948 # }
949 # }
950 "A String",
951 ],
952 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400953 "properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400954 "a_key": "A String",
955 },
956 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700957 "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.
958 "a_key": "A String",
959 },
960 "placement": { # Cloud Dataproc job config. # Required. Job information, including how, when, and where to run the job.
961 "clusterName": "A String", # Required. The name of the cluster where the job will be submitted.
962 "clusterUuid": "A String", # Output only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted.
963 },
964 "reference": { # Encapsulates the full scoping used to reference a job. # Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
965 "projectId": "A String", # Required. The ID of the Google Cloud Platform project that the job belongs to.
966 "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.
967 },
968 "hadoopJob": { # A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Job is a Hadoop job.
969 "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.
970 "A String",
971 ],
972 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
973 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
974 "a_key": "A String",
975 },
976 },
977 "jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
978 "A String",
979 ],
980 "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.
981 "A String",
982 ],
983 "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.
984 "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.
985 "A String",
986 ],
987 "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'
988 "properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
989 "a_key": "A String",
990 },
991 },
992 "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.
993 { # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.Beta Feature: This report is available for testing purposes only. It may be changed before final release.
994 "progress": 3.14, # Required. The numerical progress of the application, from 1 to 100.
995 "state": "A String", # Required. The application state.
996 "name": "A String", # Required. The application name.
997 "trackingUrl": "A String", # Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
998 },
999 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001000 "pigJob": { # A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Job is a Pig job.
1001 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001002 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001003 "a_key": "A String",
1004 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001005 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001006 "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'
1007 "a_key": "A String",
1008 },
1009 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001010 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001011 "A String",
1012 ],
1013 "queryList": { # A list of queries to run on a cluster. # A list of queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001014 "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:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001015 # "hiveJob": {
1016 # "queryList": {
1017 # "queries": [
1018 # "query1",
1019 # "query2",
1020 # "query3;query4",
1021 # ]
1022 # }
1023 # }
1024 "A String",
1025 ],
1026 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001027 "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.
1028 "properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001029 "a_key": "A String",
1030 },
1031 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001032 "driverOutputResourceUri": "A String", # Output only. A URI pointing to the location of the stdout of the job's driver program.
Thomas Coffee2f245372017-03-27 10:39:26 -07001033 "pysparkJob": { # A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Job is a Pyspark job.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001034 "mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001035 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001036 "A String",
1037 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001038 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
Thomas Coffee2f245372017-03-27 10:39:26 -07001039 "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'
1040 "a_key": "A String",
1041 },
1042 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001043 "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.
Thomas Coffee2f245372017-03-27 10:39:26 -07001044 "A String",
1045 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001046 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001047 "A String",
1048 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001049 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001050 "A String",
1051 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001052 "pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001053 "A String",
1054 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001055 "properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001056 "a_key": "A String",
1057 },
1058 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001059 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001060 "sparkJob": { # A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Job is a Spark job.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001061 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001062 "A String",
1063 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001064 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001065 "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'
1066 "a_key": "A String",
1067 },
1068 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001069 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001070 "A String",
1071 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001072 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001073 "A String",
1074 ],
1075 "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001076 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001077 "A String",
1078 ],
1079 "mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001080 "properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001081 "a_key": "A String",
1082 },
1083 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001084 "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.
1085 "scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001086 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001087 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001088 "statusHistory": [ # Output only. The previous job status.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001089 { # Cloud Dataproc job status.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001090 "state": "A String", # Output only. A state message specifying the overall job state.
1091 "stateStartTime": "A String", # Output only. The time when this state was entered.
1092 "details": "A String", # Output only. Optional job state details, such as an error description if the state is <code>ERROR</code>.
1093 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001094 },
1095 ],
1096 "hiveJob": { # A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Job is a Hive job.
1097 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001098 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001099 "a_key": "A String",
1100 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001101 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001102 "A String",
1103 ],
1104 "queryList": { # A list of queries to run on a cluster. # A list of queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001105 "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:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001106 # "hiveJob": {
1107 # "queryList": {
1108 # "queries": [
1109 # "query1",
1110 # "query2",
1111 # "query3;query4",
1112 # ]
1113 # }
1114 # }
1115 "A String",
1116 ],
1117 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001118 "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.
1119 "properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001120 "a_key": "A String",
1121 },
1122 },
1123}
1124
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001125 updateMask: string, Required. Specifies the path, relative to <code>Job</code>, of the field to update. For example, to update the labels of a Job the <code>update_mask</code> parameter would be specified as <code>labels</code>, and the PATCH request body would specify the new value. <strong>Note:</strong> Currently, <code>labels</code> is the only field that can be updated.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001126 x__xgafv: string, V1 error format.
1127 Allowed values
1128 1 - v1 error format
1129 2 - v2 error format
1130
1131Returns:
1132 An object of the form:
1133
1134 { # A Cloud Dataproc job resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001135 "status": { # Cloud Dataproc job status. # Output only. The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields.
1136 "state": "A String", # Output only. A state message specifying the overall job state.
1137 "stateStartTime": "A String", # Output only. The time when this state was entered.
1138 "details": "A String", # Output only. Optional job state details, such as an error description if the state is <code>ERROR</code>.
1139 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001140 },
1141 "sparkSqlJob": { # A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Job is a SparkSql job.
1142 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001143 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001144 "a_key": "A String",
1145 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001146 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001147 "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'
1148 "a_key": "A String",
1149 },
1150 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001151 "jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001152 "A String",
1153 ],
1154 "queryList": { # A list of queries to run on a cluster. # A list of queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001155 "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:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001156 # "hiveJob": {
1157 # "queryList": {
1158 # "queries": [
1159 # "query1",
1160 # "query2",
1161 # "query3;query4",
1162 # ]
1163 # }
1164 # }
1165 "A String",
1166 ],
1167 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001168 "properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001169 "a_key": "A String",
1170 },
1171 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001172 "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.
1173 "a_key": "A String",
1174 },
1175 "placement": { # Cloud Dataproc job config. # Required. Job information, including how, when, and where to run the job.
1176 "clusterName": "A String", # Required. The name of the cluster where the job will be submitted.
1177 "clusterUuid": "A String", # Output only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted.
1178 },
1179 "reference": { # Encapsulates the full scoping used to reference a job. # Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
1180 "projectId": "A String", # Required. The ID of the Google Cloud Platform project that the job belongs to.
1181 "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.
1182 },
1183 "hadoopJob": { # A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Job is a Hadoop job.
1184 "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.
1185 "A String",
1186 ],
1187 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
1188 "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'
1189 "a_key": "A String",
1190 },
1191 },
1192 "jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
1193 "A String",
1194 ],
1195 "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.
1196 "A String",
1197 ],
1198 "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.
1199 "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.
1200 "A String",
1201 ],
1202 "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'
1203 "properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
1204 "a_key": "A String",
1205 },
1206 },
1207 "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.
1208 { # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.Beta Feature: This report is available for testing purposes only. It may be changed before final release.
1209 "progress": 3.14, # Required. The numerical progress of the application, from 1 to 100.
1210 "state": "A String", # Required. The application state.
1211 "name": "A String", # Required. The application name.
1212 "trackingUrl": "A String", # Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
1213 },
1214 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001215 "pigJob": { # A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Job is a Pig job.
1216 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001217 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001218 "a_key": "A String",
1219 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001220 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001221 "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'
1222 "a_key": "A String",
1223 },
1224 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001225 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001226 "A String",
1227 ],
1228 "queryList": { # A list of queries to run on a cluster. # A list of queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001229 "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:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001230 # "hiveJob": {
1231 # "queryList": {
1232 # "queries": [
1233 # "query1",
1234 # "query2",
1235 # "query3;query4",
1236 # ]
1237 # }
1238 # }
1239 "A String",
1240 ],
1241 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001242 "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.
1243 "properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001244 "a_key": "A String",
1245 },
1246 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001247 "driverOutputResourceUri": "A String", # Output only. A URI pointing to the location of the stdout of the job's driver program.
Thomas Coffee2f245372017-03-27 10:39:26 -07001248 "pysparkJob": { # A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Job is a Pyspark job.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001249 "mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001250 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001251 "A String",
1252 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001253 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
Thomas Coffee2f245372017-03-27 10:39:26 -07001254 "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'
1255 "a_key": "A String",
1256 },
1257 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001258 "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.
Thomas Coffee2f245372017-03-27 10:39:26 -07001259 "A String",
1260 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001261 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001262 "A String",
1263 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001264 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001265 "A String",
1266 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001267 "pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001268 "A String",
1269 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001270 "properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001271 "a_key": "A String",
1272 },
1273 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001274 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001275 "sparkJob": { # A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Job is a Spark job.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001276 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001277 "A String",
1278 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001279 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001280 "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'
1281 "a_key": "A String",
1282 },
1283 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001284 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001285 "A String",
1286 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001287 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001288 "A String",
1289 ],
1290 "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001291 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001292 "A String",
1293 ],
1294 "mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001295 "properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001296 "a_key": "A String",
1297 },
1298 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001299 "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.
1300 "scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001301 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001302 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001303 "statusHistory": [ # Output only. The previous job status.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001304 { # Cloud Dataproc job status.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001305 "state": "A String", # Output only. A state message specifying the overall job state.
1306 "stateStartTime": "A String", # Output only. The time when this state was entered.
1307 "details": "A String", # Output only. Optional job state details, such as an error description if the state is <code>ERROR</code>.
1308 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001309 },
1310 ],
1311 "hiveJob": { # A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Job is a Hive job.
1312 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001313 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001314 "a_key": "A String",
1315 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001316 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001317 "A String",
1318 ],
1319 "queryList": { # A list of queries to run on a cluster. # A list of queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001320 "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:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001321 # "hiveJob": {
1322 # "queryList": {
1323 # "queries": [
1324 # "query1",
1325 # "query2",
1326 # "query3;query4",
1327 # ]
1328 # }
1329 # }
1330 "A String",
1331 ],
1332 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001333 "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.
1334 "properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001335 "a_key": "A String",
1336 },
1337 },
1338 }</pre>
1339</div>
1340
1341<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001342 <code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>
1343 <pre>Sets the access control policy on the specified resource. Replaces any existing policy.
1344
1345Args:
1346 resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required)
1347 body: object, The request body. (required)
1348 The object takes the form of:
1349
1350{ # Request message for SetIamPolicy method.
1351 "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.A Policy consists of a list of bindings. A binding binds a list of members to a role, where the members can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM.JSON Example # REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
1352 # {
1353 # "bindings": [
1354 # {
1355 # "role": "roles/owner",
1356 # "members": [
1357 # "user:mike@example.com",
1358 # "group:admins@example.com",
1359 # "domain:google.com",
1360 # "serviceAccount:my-other-app@appspot.gserviceaccount.com"
1361 # ]
1362 # },
1363 # {
1364 # "role": "roles/viewer",
1365 # "members": ["user:sean@example.com"]
1366 # }
1367 # ]
1368 # }
1369 # YAML Example
1370 # bindings:
1371 # - members:
1372 # - user:mike@example.com
1373 # - group:admins@example.com
1374 # - domain:google.com
1375 # - serviceAccount:my-other-app@appspot.gserviceaccount.com
1376 # role: roles/owner
1377 # - members:
1378 # - user:sean@example.com
1379 # role: roles/viewer
1380 # For a description of IAM and its features, see the IAM developer's guide (https://cloud.google.com/iam/docs).
1381 "bindings": [ # Associates a list of members to a role. bindings with no members will result in an error.
1382 { # Associates members with a role.
1383 "role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.
1384 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:
1385 # allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
1386 # allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
1387 # user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com .
1388 # serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
1389 # group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
1390 # domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
1391 "A String",
1392 ],
1393 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
1394 # title: "User account presence"
1395 # description: "Determines whether the request has a user account"
1396 # expression: "size(request.user) > 0"
1397 "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
1398 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.The application context of the containing message determines which well-known feature set of CEL is supported.
1399 "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
1400 "title": "A String", # An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
1401 },
1402 },
1403 ],
1404 "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.If no etag is provided in the call to setIamPolicy, then the existing policy is overwritten blindly.
1405 "version": 42, # Deprecated.
1406 },
1407 }
1408
1409 x__xgafv: string, V1 error format.
1410 Allowed values
1411 1 - v1 error format
1412 2 - v2 error format
1413
1414Returns:
1415 An object of the form:
1416
1417 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.A Policy consists of a list of bindings. A binding binds a list of members to a role, where the members can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM.JSON Example
1418 # {
1419 # "bindings": [
1420 # {
1421 # "role": "roles/owner",
1422 # "members": [
1423 # "user:mike@example.com",
1424 # "group:admins@example.com",
1425 # "domain:google.com",
1426 # "serviceAccount:my-other-app@appspot.gserviceaccount.com"
1427 # ]
1428 # },
1429 # {
1430 # "role": "roles/viewer",
1431 # "members": ["user:sean@example.com"]
1432 # }
1433 # ]
1434 # }
1435 # YAML Example
1436 # bindings:
1437 # - members:
1438 # - user:mike@example.com
1439 # - group:admins@example.com
1440 # - domain:google.com
1441 # - serviceAccount:my-other-app@appspot.gserviceaccount.com
1442 # role: roles/owner
1443 # - members:
1444 # - user:sean@example.com
1445 # role: roles/viewer
1446 # For a description of IAM and its features, see the IAM developer's guide (https://cloud.google.com/iam/docs).
1447 "bindings": [ # Associates a list of members to a role. bindings with no members will result in an error.
1448 { # Associates members with a role.
1449 "role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.
1450 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:
1451 # allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
1452 # allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
1453 # user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com .
1454 # serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
1455 # group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
1456 # domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
1457 "A String",
1458 ],
1459 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
1460 # title: "User account presence"
1461 # description: "Determines whether the request has a user account"
1462 # expression: "size(request.user) > 0"
1463 "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
1464 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.The application context of the containing message determines which well-known feature set of CEL is supported.
1465 "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
1466 "title": "A String", # An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
1467 },
1468 },
1469 ],
1470 "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.If no etag is provided in the call to setIamPolicy, then the existing policy is overwritten blindly.
1471 "version": 42, # Deprecated.
1472 }</pre>
1473</div>
1474
1475<div class="method">
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001476 <code class="details" id="submit">submit(projectId, region, body, x__xgafv=None)</code>
1477 <pre>Submits a job to a cluster.
1478
1479Args:
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001480 projectId: string, Required. The ID of the Google Cloud Platform project that the job belongs to. (required)
1481 region: string, Required. The Cloud Dataproc region in which to handle the request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001482 body: object, The request body. (required)
1483 The object takes the form of:
1484
1485{ # A request to submit a job.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001486 "job": { # A Cloud Dataproc job resource. # Required. The job resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001487 "status": { # Cloud Dataproc job status. # Output only. The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields.
1488 "state": "A String", # Output only. A state message specifying the overall job state.
1489 "stateStartTime": "A String", # Output only. The time when this state was entered.
1490 "details": "A String", # Output only. Optional job state details, such as an error description if the state is <code>ERROR</code>.
1491 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001492 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001493 "sparkSqlJob": { # A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Job is a SparkSql job.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001494 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001495 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001496 "a_key": "A String",
1497 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001498 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001499 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001500 "a_key": "A String",
1501 },
1502 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001503 "jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001504 "A String",
1505 ],
1506 "queryList": { # A list of queries to run on a cluster. # A list of queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001507 "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:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001508 # "hiveJob": {
1509 # "queryList": {
1510 # "queries": [
1511 # "query1",
1512 # "query2",
1513 # "query3;query4",
1514 # ]
1515 # }
1516 # }
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001517 "A String",
1518 ],
1519 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001520 "properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001521 "a_key": "A String",
1522 },
1523 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001524 "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.
1525 "a_key": "A String",
1526 },
1527 "placement": { # Cloud Dataproc job config. # Required. Job information, including how, when, and where to run the job.
1528 "clusterName": "A String", # Required. The name of the cluster where the job will be submitted.
1529 "clusterUuid": "A String", # Output only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted.
1530 },
1531 "reference": { # Encapsulates the full scoping used to reference a job. # Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
1532 "projectId": "A String", # Required. The ID of the Google Cloud Platform project that the job belongs to.
1533 "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.
1534 },
1535 "hadoopJob": { # A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Job is a Hadoop job.
1536 "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.
1537 "A String",
1538 ],
1539 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
1540 "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'
1541 "a_key": "A String",
1542 },
1543 },
1544 "jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
1545 "A String",
1546 ],
1547 "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.
1548 "A String",
1549 ],
1550 "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.
1551 "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.
1552 "A String",
1553 ],
1554 "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'
1555 "properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
1556 "a_key": "A String",
1557 },
1558 },
1559 "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.
1560 { # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.Beta Feature: This report is available for testing purposes only. It may be changed before final release.
1561 "progress": 3.14, # Required. The numerical progress of the application, from 1 to 100.
1562 "state": "A String", # Required. The application state.
1563 "name": "A String", # Required. The application name.
1564 "trackingUrl": "A String", # Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
1565 },
1566 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001567 "pigJob": { # A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Job is a Pig job.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001568 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001569 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001570 "a_key": "A String",
1571 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001572 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001573 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001574 "a_key": "A String",
1575 },
1576 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001577 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001578 "A String",
1579 ],
1580 "queryList": { # A list of queries to run on a cluster. # A list of queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001581 "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:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001582 # "hiveJob": {
1583 # "queryList": {
1584 # "queries": [
1585 # "query1",
1586 # "query2",
1587 # "query3;query4",
1588 # ]
1589 # }
1590 # }
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001591 "A String",
1592 ],
1593 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001594 "continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
1595 "properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001596 "a_key": "A String",
1597 },
1598 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001599 "driverOutputResourceUri": "A String", # Output only. A URI pointing to the location of the stdout of the job's driver program.
Thomas Coffee2f245372017-03-27 10:39:26 -07001600 "pysparkJob": { # A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Job is a Pyspark job.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001601 "mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001602 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001603 "A String",
1604 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001605 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
Thomas Coffee2f245372017-03-27 10:39:26 -07001606 "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'
1607 "a_key": "A String",
1608 },
1609 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001610 "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.
Thomas Coffee2f245372017-03-27 10:39:26 -07001611 "A String",
1612 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001613 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001614 "A String",
1615 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001616 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001617 "A String",
1618 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001619 "pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001620 "A String",
1621 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001622 "properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001623 "a_key": "A String",
1624 },
1625 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001626 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001627 "sparkJob": { # A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Job is a Spark job.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001628 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001629 "A String",
1630 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001631 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001632 "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'
1633 "a_key": "A String",
1634 },
1635 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001636 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001637 "A String",
1638 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001639 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001640 "A String",
1641 ],
1642 "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001643 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001644 "A String",
1645 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -07001646 "mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001647 "properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001648 "a_key": "A String",
1649 },
1650 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001651 "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.
1652 "scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001653 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001654 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001655 "statusHistory": [ # Output only. The previous job status.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001656 { # Cloud Dataproc job status.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001657 "state": "A String", # Output only. A state message specifying the overall job state.
1658 "stateStartTime": "A String", # Output only. The time when this state was entered.
1659 "details": "A String", # Output only. Optional job state details, such as an error description if the state is <code>ERROR</code>.
1660 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001661 },
1662 ],
1663 "hiveJob": { # A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Job is a Hive job.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001664 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001665 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001666 "a_key": "A String",
1667 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001668 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001669 "A String",
1670 ],
1671 "queryList": { # A list of queries to run on a cluster. # A list of queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001672 "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:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001673 # "hiveJob": {
1674 # "queryList": {
1675 # "queries": [
1676 # "query1",
1677 # "query2",
1678 # "query3;query4",
1679 # ]
1680 # }
1681 # }
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001682 "A String",
1683 ],
1684 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001685 "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.
1686 "properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001687 "a_key": "A String",
1688 },
1689 },
1690 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001691 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001692 }
1693
1694 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001695 Allowed values
1696 1 - v1 error format
1697 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001698
1699Returns:
1700 An object of the form:
1701
1702 { # A Cloud Dataproc job resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001703 "status": { # Cloud Dataproc job status. # Output only. The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields.
1704 "state": "A String", # Output only. A state message specifying the overall job state.
1705 "stateStartTime": "A String", # Output only. The time when this state was entered.
1706 "details": "A String", # Output only. Optional job state details, such as an error description if the state is <code>ERROR</code>.
1707 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001708 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001709 "sparkSqlJob": { # A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Job is a SparkSql job.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001710 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001711 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001712 "a_key": "A String",
1713 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001714 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001715 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001716 "a_key": "A String",
1717 },
1718 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001719 "jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001720 "A String",
1721 ],
1722 "queryList": { # A list of queries to run on a cluster. # A list of queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001723 "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:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001724 # "hiveJob": {
1725 # "queryList": {
1726 # "queries": [
1727 # "query1",
1728 # "query2",
1729 # "query3;query4",
1730 # ]
1731 # }
1732 # }
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001733 "A String",
1734 ],
1735 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001736 "properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001737 "a_key": "A String",
1738 },
1739 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001740 "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.
1741 "a_key": "A String",
1742 },
1743 "placement": { # Cloud Dataproc job config. # Required. Job information, including how, when, and where to run the job.
1744 "clusterName": "A String", # Required. The name of the cluster where the job will be submitted.
1745 "clusterUuid": "A String", # Output only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted.
1746 },
1747 "reference": { # Encapsulates the full scoping used to reference a job. # Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
1748 "projectId": "A String", # Required. The ID of the Google Cloud Platform project that the job belongs to.
1749 "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.
1750 },
1751 "hadoopJob": { # A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Job is a Hadoop job.
1752 "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.
1753 "A String",
1754 ],
1755 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
1756 "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'
1757 "a_key": "A String",
1758 },
1759 },
1760 "jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
1761 "A String",
1762 ],
1763 "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.
1764 "A String",
1765 ],
1766 "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.
1767 "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.
1768 "A String",
1769 ],
1770 "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'
1771 "properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
1772 "a_key": "A String",
1773 },
1774 },
1775 "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.
1776 { # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.Beta Feature: This report is available for testing purposes only. It may be changed before final release.
1777 "progress": 3.14, # Required. The numerical progress of the application, from 1 to 100.
1778 "state": "A String", # Required. The application state.
1779 "name": "A String", # Required. The application name.
1780 "trackingUrl": "A String", # Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
1781 },
1782 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001783 "pigJob": { # A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Job is a Pig job.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001784 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001785 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001786 "a_key": "A String",
1787 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001788 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001789 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001790 "a_key": "A String",
1791 },
1792 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001793 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001794 "A String",
1795 ],
1796 "queryList": { # A list of queries to run on a cluster. # A list of queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001797 "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:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001798 # "hiveJob": {
1799 # "queryList": {
1800 # "queries": [
1801 # "query1",
1802 # "query2",
1803 # "query3;query4",
1804 # ]
1805 # }
1806 # }
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001807 "A String",
1808 ],
1809 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001810 "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.
1811 "properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001812 "a_key": "A String",
1813 },
1814 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001815 "driverOutputResourceUri": "A String", # Output only. A URI pointing to the location of the stdout of the job's driver program.
Thomas Coffee2f245372017-03-27 10:39:26 -07001816 "pysparkJob": { # A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Job is a Pyspark job.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001817 "mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001818 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001819 "A String",
1820 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001821 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
Thomas Coffee2f245372017-03-27 10:39:26 -07001822 "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'
1823 "a_key": "A String",
1824 },
1825 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001826 "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.
Thomas Coffee2f245372017-03-27 10:39:26 -07001827 "A String",
1828 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001829 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001830 "A String",
1831 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001832 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001833 "A String",
1834 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001835 "pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001836 "A String",
1837 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001838 "properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001839 "a_key": "A String",
1840 },
1841 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001842 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001843 "sparkJob": { # A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Job is a Spark job.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001844 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001845 "A String",
1846 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001847 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001848 "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'
1849 "a_key": "A String",
1850 },
1851 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001852 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001853 "A String",
1854 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001855 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001856 "A String",
1857 ],
1858 "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001859 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001860 "A String",
1861 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -07001862 "mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001863 "properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001864 "a_key": "A String",
1865 },
1866 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001867 "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.
1868 "scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001869 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001870 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001871 "statusHistory": [ # Output only. The previous job status.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001872 { # Cloud Dataproc job status.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001873 "state": "A String", # Output only. A state message specifying the overall job state.
1874 "stateStartTime": "A String", # Output only. The time when this state was entered.
1875 "details": "A String", # Output only. Optional job state details, such as an error description if the state is <code>ERROR</code>.
1876 "substate": "A String", # Output only. Additional state information, which includes status reported by the agent.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001877 },
1878 ],
1879 "hiveJob": { # A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Job is a Hive job.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001880 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001881 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001882 "a_key": "A String",
1883 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001884 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001885 "A String",
1886 ],
1887 "queryList": { # A list of queries to run on a cluster. # A list of queries.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001888 "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:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001889 # "hiveJob": {
1890 # "queryList": {
1891 # "queries": [
1892 # "query1",
1893 # "query2",
1894 # "query3;query4",
1895 # ]
1896 # }
1897 # }
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001898 "A String",
1899 ],
1900 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001901 "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.
1902 "properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001903 "a_key": "A String",
1904 },
1905 },
1906 }</pre>
1907</div>
1908
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001909<div class="method">
1910 <code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code>
1911 <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.
1912
1913Args:
1914 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)
1915 body: object, The request body. (required)
1916 The object takes the form of:
1917
1918{ # Request message for TestIamPermissions method.
1919 "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).
1920 "A String",
1921 ],
1922 }
1923
1924 x__xgafv: string, V1 error format.
1925 Allowed values
1926 1 - v1 error format
1927 2 - v2 error format
1928
1929Returns:
1930 An object of the form:
1931
1932 { # Response message for TestIamPermissions method.
1933 "permissions": [ # A subset of TestPermissionsRequest.permissions that the caller is allowed.
1934 "A String",
1935 ],
1936 }</pre>
1937</div>
1938
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001939</body></html>