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