| Joe Gregorio | 4189954 | 2012-04-23 09:02:05 -0400 | [diff] [blame^] | 1 | |
| 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| 3 | <html><head><title>Python: class Resource</title> |
| 4 | </head><body bgcolor="#f0f0f8"> |
| 5 | <p> |
| 6 | <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| 7 | <tr bgcolor="#ffc8d8"> |
| 8 | <td colspan=3 valign=bottom> <br> |
| 9 | <font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> |
| 10 | |
| 11 | <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| 12 | <td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr> |
| 13 | <tr><td> </td> |
| 14 | <td width="100%">Methods defined here:<br> |
| 15 | <dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl> |
| 16 | |
| 17 | <dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves the specified job by ID.<br> |
| 18 | <br> |
| 19 | Args:<br> |
| 20 | projectId: string, Project ID of the requested job (required)<br> |
| 21 | jobId: string, Job ID of the requested job (required)<br> |
| 22 | <br> |
| 23 | Returns:<br> |
| 24 | An object of the form<br> |
| 25 | <br> |
| 26 | {<br> |
| 27 | "status": { # [Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.<br> |
| 28 | "state": "A String", # [Output-only] Running state of the job.<br> |
| 29 | "errors": [ # [Output-only] All errors encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.<br> |
| 30 | {<br> |
| 31 | "debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.<br> |
| 32 | "message": "A String", # A human readable explanation of the error.<br> |
| 33 | "reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.<br> |
| 34 | "location": "A String", # Specifies where the error occurred, if present.<br> |
| 35 | },<br> |
| 36 | ],<br> |
| 37 | "errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.<br> |
| 38 | "debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.<br> |
| 39 | "message": "A String", # A human readable explanation of the error.<br> |
| 40 | "reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.<br> |
| 41 | "location": "A String", # Specifies where the error occurred, if present.<br> |
| 42 | },<br> |
| 43 | },<br> |
| 44 | "kind": "bigquery#job", # [Output-only] The type of the resource.<br> |
| 45 | "statistics": { # [Output-only] Information about the job, including starting time and ending time of the job.<br> |
| 46 | "endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch.<br> |
| 47 | "totalBytesProcessed": "A String", # [Output-only] Total bytes processed for this job.<br> |
| 48 | "startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch.<br> |
| 49 | },<br> |
| 50 | "jobReference": { # [Optional] Reference describing the unique-per-user name of the job.<br> |
| 51 | "projectId": "A String", # [Required] Project ID being billed for the job.<br> |
| 52 | "jobId": "A String", # [Required] ID of the job.<br> |
| 53 | },<br> |
| 54 | "etag": "A String", # [Output-only] A hash of this resource.<br> |
| 55 | "configuration": { # [Required] Describes the job configuration.<br> |
| 56 | "load": { # [Pick one] Configures a load job.<br> |
| 57 | "encoding": "A String", # [Optional] Character encoding of the input data. May be UTF-8 or ISO-8859-1. Default is UTF-8.<br> |
| 58 | "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the import data. Default is ','<br> |
| 59 | "destinationTable": { # [Required] Table being written to.<br> |
| 60 | "projectId": "A String", # [Required] ID of the project billed for storage of the table.<br> |
| 61 | "tableId": "A String", # [Required] ID of the table.<br> |
| 62 | "datasetId": "A String", # [Required] ID of the dataset containing the table.<br> |
| 63 | },<br> |
| 64 | "maxBadRecords": 42, # [Optional] Maximum number of bad records that should be ignored before the entire job is aborted and no updates are performed.<br> |
| 65 | "writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.<br> |
| 66 | "sourceUris": [ # [Required] Source URIs describing Google Cloud Storage locations of data to load.<br> |
| 67 | "A String",<br> |
| 68 | ],<br> |
| 69 | "skipLeadingRows": 42, # [Optional] Number of rows of initial data to skip in the data being imported.<br> |
| 70 | "createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.<br> |
| 71 | "schema": { # [Optional] Schema of the table being written to.<br> |
| 72 | "fields": [ # Describes the fields in a table.<br> |
| 73 | {<br> |
| 74 | "fields": [ # [Optional] Describes nested fields when type is RECORD.<br> |
| 75 | # Object with schema name: TableFieldSchema<br> |
| 76 | ],<br> |
| 77 | "type": "A String", # [Required] Data type of the field.<br> |
| 78 | "mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.<br> |
| 79 | "name": "A String", # [Required] Name of the field.<br> |
| 80 | },<br> |
| 81 | ],<br> |
| 82 | },<br> |
| 83 | },<br> |
| 84 | "link": { # [Pick one] Configures a link job.<br> |
| 85 | "createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.<br> |
| 86 | "destinationTable": { # [Required] The destination table of the link job.<br> |
| 87 | "projectId": "A String", # [Required] ID of the project billed for storage of the table.<br> |
| 88 | "tableId": "A String", # [Required] ID of the table.<br> |
| 89 | "datasetId": "A String", # [Required] ID of the dataset containing the table.<br> |
| 90 | },<br> |
| 91 | "sourceUri": "A String", # [Required] URI of source table to link.<br> |
| 92 | },<br> |
| 93 | "query": { # [Pick one] Configures a query job.<br> |
| 94 | "createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.<br> |
| 95 | "query": "A String", # [Required] BigQuery SQL query to execute.<br> |
| 96 | "writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.<br> |
| 97 | "destinationTable": { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results.<br> |
| 98 | "projectId": "A String", # [Required] ID of the project billed for storage of the table.<br> |
| 99 | "tableId": "A String", # [Required] ID of the table.<br> |
| 100 | "datasetId": "A String", # [Required] ID of the dataset containing the table.<br> |
| 101 | },<br> |
| 102 | "defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.<br> |
| 103 | "projectId": "A String", # [Optional] The ID of the container project.<br> |
| 104 | "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.<br> |
| 105 | },<br> |
| 106 | },<br> |
| 107 | "copy": { # [Pick one] Copies a table.<br> |
| 108 | "createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.<br> |
| 109 | "writeDisposition": "A String", # [Optional] Whether or not to append or require the table to be empty.<br> |
| 110 | "destinationTable": { # [Required] The destination table<br> |
| 111 | "projectId": "A String", # [Required] ID of the project billed for storage of the table.<br> |
| 112 | "tableId": "A String", # [Required] ID of the table.<br> |
| 113 | "datasetId": "A String", # [Required] ID of the dataset containing the table.<br> |
| 114 | },<br> |
| 115 | "sourceTable": { # [Required] Source table to copy.<br> |
| 116 | "projectId": "A String", # [Required] ID of the project billed for storage of the table.<br> |
| 117 | "tableId": "A String", # [Required] ID of the table.<br> |
| 118 | "datasetId": "A String", # [Required] ID of the dataset containing the table.<br> |
| 119 | },<br> |
| 120 | },<br> |
| 121 | "extract": { # [Pick one] Configures an extract job.<br> |
| 122 | "destinationUri": "A String", # [Required] The fully-qualified Google Cloud Storage URI where the extracted table should be written.<br> |
| 123 | "sourceTable": { # [Required] A reference to the table being exported.<br> |
| 124 | "projectId": "A String", # [Required] ID of the project billed for storage of the table.<br> |
| 125 | "tableId": "A String", # [Required] ID of the table.<br> |
| 126 | "datasetId": "A String", # [Required] ID of the dataset containing the table.<br> |
| 127 | },<br> |
| 128 | },<br> |
| 129 | "properties": { # [Optional] Properties providing extra details about how the job should be run. Not used for most jobs.<br> |
| 130 | },<br> |
| 131 | },<br> |
| 132 | "id": "A String", # [Output-only] Opaque ID field of the job<br> |
| 133 | "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.<br> |
| 134 | }</tt></dd></dl> |
| 135 | |
| 136 | <dl><dt><a name="Resource-getQueryResults"><strong>getQueryResults</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves the results of a query job.<br> |
| 137 | <br> |
| 138 | Args:<br> |
| 139 | timeoutMs: integer, How long to wait for the query to complete, in milliseconds, before returning. Default is to return immediately. If the timeout passes before the job completes, the request will fail with a TIMEOUT error<br> |
| 140 | projectId: string, Project ID of the query job (required)<br> |
| 141 | maxResults: integer, Maximum number of results to read<br> |
| 142 | jobId: string, Job ID of the query job (required)<br> |
| 143 | startIndex: string, Zero-based index of the starting row<br> |
| 144 | <br> |
| 145 | Returns:<br> |
| 146 | An object of the form<br> |
| 147 | <br> |
| 148 | {<br> |
| 149 | "kind": "bigquery#getQueryResultsResponse", # The resource type of the response.<br> |
| 150 | "rows": [ # An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above. Present only when the query completes successfully.<br> |
| 151 | {<br> |
| 152 | "f": [ # Represents a single row in the result set, consisting of one or more fields.<br> |
| 153 | {<br> |
| 154 | "v": "A String", # Contains the field value in this row, as a string.<br> |
| 155 | },<br> |
| 156 | ],<br> |
| 157 | },<br> |
| 158 | ],<br> |
| 159 | "jobReference": { # Reference to the Helix Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults).<br> |
| 160 | "projectId": "A String", # [Required] Project ID being billed for the job.<br> |
| 161 | "jobId": "A String", # [Required] ID of the job.<br> |
| 162 | },<br> |
| 163 | "jobComplete": True or False, # Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.<br> |
| 164 | "totalRows": "A String", # The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results. Present only when the query completes successfully.<br> |
| 165 | "etag": "A String", # A hash of this response.<br> |
| 166 | "schema": { # The schema of the results. Present only when the query completes successfully.<br> |
| 167 | "fields": [ # Describes the fields in a table.<br> |
| 168 | {<br> |
| 169 | "fields": [ # [Optional] Describes nested fields when type is RECORD.<br> |
| 170 | # Object with schema name: TableFieldSchema<br> |
| 171 | ],<br> |
| 172 | "type": "A String", # [Required] Data type of the field.<br> |
| 173 | "mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.<br> |
| 174 | "name": "A String", # [Required] Name of the field.<br> |
| 175 | },<br> |
| 176 | ],<br> |
| 177 | },<br> |
| 178 | }</tt></dd></dl> |
| 179 | |
| 180 | <dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Starts a new asynchronous job.<br> |
| 181 | <br> |
| 182 | Args:<br> |
| 183 | body: object, The request body.<br> |
| 184 | The object takes the form of:<br> |
| 185 | <br> |
| 186 | {<br> |
| 187 | "status": { # [Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.<br> |
| 188 | "state": "A String", # [Output-only] Running state of the job.<br> |
| 189 | "errors": [ # [Output-only] All errors encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.<br> |
| 190 | {<br> |
| 191 | "debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.<br> |
| 192 | "message": "A String", # A human readable explanation of the error.<br> |
| 193 | "reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.<br> |
| 194 | "location": "A String", # Specifies where the error occurred, if present.<br> |
| 195 | },<br> |
| 196 | ],<br> |
| 197 | "errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.<br> |
| 198 | "debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.<br> |
| 199 | "message": "A String", # A human readable explanation of the error.<br> |
| 200 | "reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.<br> |
| 201 | "location": "A String", # Specifies where the error occurred, if present.<br> |
| 202 | },<br> |
| 203 | },<br> |
| 204 | "kind": "bigquery#job", # [Output-only] The type of the resource.<br> |
| 205 | "statistics": { # [Output-only] Information about the job, including starting time and ending time of the job.<br> |
| 206 | "endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch.<br> |
| 207 | "totalBytesProcessed": "A String", # [Output-only] Total bytes processed for this job.<br> |
| 208 | "startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch.<br> |
| 209 | },<br> |
| 210 | "jobReference": { # [Optional] Reference describing the unique-per-user name of the job.<br> |
| 211 | "projectId": "A String", # [Required] Project ID being billed for the job.<br> |
| 212 | "jobId": "A String", # [Required] ID of the job.<br> |
| 213 | },<br> |
| 214 | "etag": "A String", # [Output-only] A hash of this resource.<br> |
| 215 | "configuration": { # [Required] Describes the job configuration.<br> |
| 216 | "load": { # [Pick one] Configures a load job.<br> |
| 217 | "encoding": "A String", # [Optional] Character encoding of the input data. May be UTF-8 or ISO-8859-1. Default is UTF-8.<br> |
| 218 | "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the import data. Default is ','<br> |
| 219 | "destinationTable": { # [Required] Table being written to.<br> |
| 220 | "projectId": "A String", # [Required] ID of the project billed for storage of the table.<br> |
| 221 | "tableId": "A String", # [Required] ID of the table.<br> |
| 222 | "datasetId": "A String", # [Required] ID of the dataset containing the table.<br> |
| 223 | },<br> |
| 224 | "maxBadRecords": 42, # [Optional] Maximum number of bad records that should be ignored before the entire job is aborted and no updates are performed.<br> |
| 225 | "writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.<br> |
| 226 | "sourceUris": [ # [Required] Source URIs describing Google Cloud Storage locations of data to load.<br> |
| 227 | "A String",<br> |
| 228 | ],<br> |
| 229 | "skipLeadingRows": 42, # [Optional] Number of rows of initial data to skip in the data being imported.<br> |
| 230 | "createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.<br> |
| 231 | "schema": { # [Optional] Schema of the table being written to.<br> |
| 232 | "fields": [ # Describes the fields in a table.<br> |
| 233 | {<br> |
| 234 | "fields": [ # [Optional] Describes nested fields when type is RECORD.<br> |
| 235 | # Object with schema name: TableFieldSchema<br> |
| 236 | ],<br> |
| 237 | "type": "A String", # [Required] Data type of the field.<br> |
| 238 | "mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.<br> |
| 239 | "name": "A String", # [Required] Name of the field.<br> |
| 240 | },<br> |
| 241 | ],<br> |
| 242 | },<br> |
| 243 | },<br> |
| 244 | "link": { # [Pick one] Configures a link job.<br> |
| 245 | "createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.<br> |
| 246 | "destinationTable": { # [Required] The destination table of the link job.<br> |
| 247 | "projectId": "A String", # [Required] ID of the project billed for storage of the table.<br> |
| 248 | "tableId": "A String", # [Required] ID of the table.<br> |
| 249 | "datasetId": "A String", # [Required] ID of the dataset containing the table.<br> |
| 250 | },<br> |
| 251 | "sourceUri": "A String", # [Required] URI of source table to link.<br> |
| 252 | },<br> |
| 253 | "query": { # [Pick one] Configures a query job.<br> |
| 254 | "createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.<br> |
| 255 | "query": "A String", # [Required] BigQuery SQL query to execute.<br> |
| 256 | "writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.<br> |
| 257 | "destinationTable": { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results.<br> |
| 258 | "projectId": "A String", # [Required] ID of the project billed for storage of the table.<br> |
| 259 | "tableId": "A String", # [Required] ID of the table.<br> |
| 260 | "datasetId": "A String", # [Required] ID of the dataset containing the table.<br> |
| 261 | },<br> |
| 262 | "defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.<br> |
| 263 | "projectId": "A String", # [Optional] The ID of the container project.<br> |
| 264 | "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.<br> |
| 265 | },<br> |
| 266 | },<br> |
| 267 | "copy": { # [Pick one] Copies a table.<br> |
| 268 | "createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.<br> |
| 269 | "writeDisposition": "A String", # [Optional] Whether or not to append or require the table to be empty.<br> |
| 270 | "destinationTable": { # [Required] The destination table<br> |
| 271 | "projectId": "A String", # [Required] ID of the project billed for storage of the table.<br> |
| 272 | "tableId": "A String", # [Required] ID of the table.<br> |
| 273 | "datasetId": "A String", # [Required] ID of the dataset containing the table.<br> |
| 274 | },<br> |
| 275 | "sourceTable": { # [Required] Source table to copy.<br> |
| 276 | "projectId": "A String", # [Required] ID of the project billed for storage of the table.<br> |
| 277 | "tableId": "A String", # [Required] ID of the table.<br> |
| 278 | "datasetId": "A String", # [Required] ID of the dataset containing the table.<br> |
| 279 | },<br> |
| 280 | },<br> |
| 281 | "extract": { # [Pick one] Configures an extract job.<br> |
| 282 | "destinationUri": "A String", # [Required] The fully-qualified Google Cloud Storage URI where the extracted table should be written.<br> |
| 283 | "sourceTable": { # [Required] A reference to the table being exported.<br> |
| 284 | "projectId": "A String", # [Required] ID of the project billed for storage of the table.<br> |
| 285 | "tableId": "A String", # [Required] ID of the table.<br> |
| 286 | "datasetId": "A String", # [Required] ID of the dataset containing the table.<br> |
| 287 | },<br> |
| 288 | },<br> |
| 289 | "properties": { # [Optional] Properties providing extra details about how the job should be run. Not used for most jobs.<br> |
| 290 | },<br> |
| 291 | },<br> |
| 292 | "id": "A String", # [Output-only] Opaque ID field of the job<br> |
| 293 | "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.<br> |
| 294 | }<br> |
| 295 | <br> |
| 296 | media_body: string, The filename of the media request body.<br> |
| 297 | projectId: string, Project ID of the project that will be billed for the job (required)<br> |
| 298 | <br> |
| 299 | Returns:<br> |
| 300 | An object of the form<br> |
| 301 | <br> |
| 302 | {<br> |
| 303 | "status": { # [Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.<br> |
| 304 | "state": "A String", # [Output-only] Running state of the job.<br> |
| 305 | "errors": [ # [Output-only] All errors encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.<br> |
| 306 | {<br> |
| 307 | "debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.<br> |
| 308 | "message": "A String", # A human readable explanation of the error.<br> |
| 309 | "reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.<br> |
| 310 | "location": "A String", # Specifies where the error occurred, if present.<br> |
| 311 | },<br> |
| 312 | ],<br> |
| 313 | "errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.<br> |
| 314 | "debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.<br> |
| 315 | "message": "A String", # A human readable explanation of the error.<br> |
| 316 | "reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.<br> |
| 317 | "location": "A String", # Specifies where the error occurred, if present.<br> |
| 318 | },<br> |
| 319 | },<br> |
| 320 | "kind": "bigquery#job", # [Output-only] The type of the resource.<br> |
| 321 | "statistics": { # [Output-only] Information about the job, including starting time and ending time of the job.<br> |
| 322 | "endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch.<br> |
| 323 | "totalBytesProcessed": "A String", # [Output-only] Total bytes processed for this job.<br> |
| 324 | "startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch.<br> |
| 325 | },<br> |
| 326 | "jobReference": { # [Optional] Reference describing the unique-per-user name of the job.<br> |
| 327 | "projectId": "A String", # [Required] Project ID being billed for the job.<br> |
| 328 | "jobId": "A String", # [Required] ID of the job.<br> |
| 329 | },<br> |
| 330 | "etag": "A String", # [Output-only] A hash of this resource.<br> |
| 331 | "configuration": { # [Required] Describes the job configuration.<br> |
| 332 | "load": { # [Pick one] Configures a load job.<br> |
| 333 | "encoding": "A String", # [Optional] Character encoding of the input data. May be UTF-8 or ISO-8859-1. Default is UTF-8.<br> |
| 334 | "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the import data. Default is ','<br> |
| 335 | "destinationTable": { # [Required] Table being written to.<br> |
| 336 | "projectId": "A String", # [Required] ID of the project billed for storage of the table.<br> |
| 337 | "tableId": "A String", # [Required] ID of the table.<br> |
| 338 | "datasetId": "A String", # [Required] ID of the dataset containing the table.<br> |
| 339 | },<br> |
| 340 | "maxBadRecords": 42, # [Optional] Maximum number of bad records that should be ignored before the entire job is aborted and no updates are performed.<br> |
| 341 | "writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.<br> |
| 342 | "sourceUris": [ # [Required] Source URIs describing Google Cloud Storage locations of data to load.<br> |
| 343 | "A String",<br> |
| 344 | ],<br> |
| 345 | "skipLeadingRows": 42, # [Optional] Number of rows of initial data to skip in the data being imported.<br> |
| 346 | "createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.<br> |
| 347 | "schema": { # [Optional] Schema of the table being written to.<br> |
| 348 | "fields": [ # Describes the fields in a table.<br> |
| 349 | {<br> |
| 350 | "fields": [ # [Optional] Describes nested fields when type is RECORD.<br> |
| 351 | # Object with schema name: TableFieldSchema<br> |
| 352 | ],<br> |
| 353 | "type": "A String", # [Required] Data type of the field.<br> |
| 354 | "mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.<br> |
| 355 | "name": "A String", # [Required] Name of the field.<br> |
| 356 | },<br> |
| 357 | ],<br> |
| 358 | },<br> |
| 359 | },<br> |
| 360 | "link": { # [Pick one] Configures a link job.<br> |
| 361 | "createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.<br> |
| 362 | "destinationTable": { # [Required] The destination table of the link job.<br> |
| 363 | "projectId": "A String", # [Required] ID of the project billed for storage of the table.<br> |
| 364 | "tableId": "A String", # [Required] ID of the table.<br> |
| 365 | "datasetId": "A String", # [Required] ID of the dataset containing the table.<br> |
| 366 | },<br> |
| 367 | "sourceUri": "A String", # [Required] URI of source table to link.<br> |
| 368 | },<br> |
| 369 | "query": { # [Pick one] Configures a query job.<br> |
| 370 | "createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.<br> |
| 371 | "query": "A String", # [Required] BigQuery SQL query to execute.<br> |
| 372 | "writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.<br> |
| 373 | "destinationTable": { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results.<br> |
| 374 | "projectId": "A String", # [Required] ID of the project billed for storage of the table.<br> |
| 375 | "tableId": "A String", # [Required] ID of the table.<br> |
| 376 | "datasetId": "A String", # [Required] ID of the dataset containing the table.<br> |
| 377 | },<br> |
| 378 | "defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.<br> |
| 379 | "projectId": "A String", # [Optional] The ID of the container project.<br> |
| 380 | "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.<br> |
| 381 | },<br> |
| 382 | },<br> |
| 383 | "copy": { # [Pick one] Copies a table.<br> |
| 384 | "createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.<br> |
| 385 | "writeDisposition": "A String", # [Optional] Whether or not to append or require the table to be empty.<br> |
| 386 | "destinationTable": { # [Required] The destination table<br> |
| 387 | "projectId": "A String", # [Required] ID of the project billed for storage of the table.<br> |
| 388 | "tableId": "A String", # [Required] ID of the table.<br> |
| 389 | "datasetId": "A String", # [Required] ID of the dataset containing the table.<br> |
| 390 | },<br> |
| 391 | "sourceTable": { # [Required] Source table to copy.<br> |
| 392 | "projectId": "A String", # [Required] ID of the project billed for storage of the table.<br> |
| 393 | "tableId": "A String", # [Required] ID of the table.<br> |
| 394 | "datasetId": "A String", # [Required] ID of the dataset containing the table.<br> |
| 395 | },<br> |
| 396 | },<br> |
| 397 | "extract": { # [Pick one] Configures an extract job.<br> |
| 398 | "destinationUri": "A String", # [Required] The fully-qualified Google Cloud Storage URI where the extracted table should be written.<br> |
| 399 | "sourceTable": { # [Required] A reference to the table being exported.<br> |
| 400 | "projectId": "A String", # [Required] ID of the project billed for storage of the table.<br> |
| 401 | "tableId": "A String", # [Required] ID of the table.<br> |
| 402 | "datasetId": "A String", # [Required] ID of the dataset containing the table.<br> |
| 403 | },<br> |
| 404 | },<br> |
| 405 | "properties": { # [Optional] Properties providing extra details about how the job should be run. Not used for most jobs.<br> |
| 406 | },<br> |
| 407 | },<br> |
| 408 | "id": "A String", # [Output-only] Opaque ID field of the job<br> |
| 409 | "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.<br> |
| 410 | }</tt></dd></dl> |
| 411 | |
| 412 | <dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Lists all the Jobs in the specified project that were started by the user.<br> |
| 413 | <br> |
| 414 | Args:<br> |
| 415 | projection: string, Restrict information returned to a set of selected fields<br> |
| 416 | Allowed values<br> |
| 417 | full - Includes all job data<br> |
| 418 | minimal - Does not include the job configuration<br> |
| 419 | stateFilter: string, Filter for job state (repeated)<br> |
| 420 | Allowed values<br> |
| 421 | done - Finished jobs<br> |
| 422 | pending - Pending jobs<br> |
| 423 | running - Running jobs<br> |
| 424 | pageToken: string, Page token, returned by a previous call, to request the next page of results<br> |
| 425 | projectId: string, Project ID of the jobs to list (required)<br> |
| 426 | allUsers: boolean, Whether to display jobs owned by all users in the project. Default false<br> |
| 427 | maxResults: integer, Maximum number of results to return<br> |
| 428 | <br> |
| 429 | Returns:<br> |
| 430 | An object of the form<br> |
| 431 | <br> |
| 432 | {<br> |
| 433 | "nextPageToken": "A String", # A token to request the next page of results.<br> |
| 434 | "totalItems": 42, # Total number of jobs in this collection.<br> |
| 435 | "kind": "bigquery#jobList", # The resource type of the response.<br> |
| 436 | "etag": "A String", # A hash of this page of results.<br> |
| 437 | "jobs": [ # List of jobs that were requested.<br> |
| 438 | {<br> |
| 439 | "status": { # [Full-projection-only] Describes the state of the job.<br> |
| 440 | "state": "A String", # [Output-only] Running state of the job.<br> |
| 441 | "errors": [ # [Output-only] All errors encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.<br> |
| 442 | {<br> |
| 443 | "debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.<br> |
| 444 | "message": "A String", # A human readable explanation of the error.<br> |
| 445 | "reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.<br> |
| 446 | "location": "A String", # Specifies where the error occurred, if present.<br> |
| 447 | },<br> |
| 448 | ],<br> |
| 449 | "errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.<br> |
| 450 | "debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.<br> |
| 451 | "message": "A String", # A human readable explanation of the error.<br> |
| 452 | "reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.<br> |
| 453 | "location": "A String", # Specifies where the error occurred, if present.<br> |
| 454 | },<br> |
| 455 | },<br> |
| 456 | "kind": "bigquery#job", # The resource type.<br> |
| 457 | "statistics": { # [Output-only] Information about the job, including starting time and ending time of the job.<br> |
| 458 | "endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch.<br> |
| 459 | "totalBytesProcessed": "A String", # [Output-only] Total bytes processed for this job.<br> |
| 460 | "startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch.<br> |
| 461 | },<br> |
| 462 | "jobReference": { # Job reference uniquely identifying the job.<br> |
| 463 | "projectId": "A String", # [Required] Project ID being billed for the job.<br> |
| 464 | "jobId": "A String", # [Required] ID of the job.<br> |
| 465 | },<br> |
| 466 | "state": "A String", # Running state of the job. When the state is DONE, errorResult can be checked to determine whether the job succeeded or failed.<br> |
| 467 | "configuration": { # [Full-projection-only] Specifies the job configuration.<br> |
| 468 | "load": { # [Pick one] Configures a load job.<br> |
| 469 | "encoding": "A String", # [Optional] Character encoding of the input data. May be UTF-8 or ISO-8859-1. Default is UTF-8.<br> |
| 470 | "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the import data. Default is ','<br> |
| 471 | "destinationTable": { # [Required] Table being written to.<br> |
| 472 | "projectId": "A String", # [Required] ID of the project billed for storage of the table.<br> |
| 473 | "tableId": "A String", # [Required] ID of the table.<br> |
| 474 | "datasetId": "A String", # [Required] ID of the dataset containing the table.<br> |
| 475 | },<br> |
| 476 | "maxBadRecords": 42, # [Optional] Maximum number of bad records that should be ignored before the entire job is aborted and no updates are performed.<br> |
| 477 | "writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.<br> |
| 478 | "sourceUris": [ # [Required] Source URIs describing Google Cloud Storage locations of data to load.<br> |
| 479 | "A String",<br> |
| 480 | ],<br> |
| 481 | "skipLeadingRows": 42, # [Optional] Number of rows of initial data to skip in the data being imported.<br> |
| 482 | "createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.<br> |
| 483 | "schema": { # [Optional] Schema of the table being written to.<br> |
| 484 | "fields": [ # Describes the fields in a table.<br> |
| 485 | {<br> |
| 486 | "fields": [ # [Optional] Describes nested fields when type is RECORD.<br> |
| 487 | # Object with schema name: TableFieldSchema<br> |
| 488 | ],<br> |
| 489 | "type": "A String", # [Required] Data type of the field.<br> |
| 490 | "mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.<br> |
| 491 | "name": "A String", # [Required] Name of the field.<br> |
| 492 | },<br> |
| 493 | ],<br> |
| 494 | },<br> |
| 495 | },<br> |
| 496 | "link": { # [Pick one] Configures a link job.<br> |
| 497 | "createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.<br> |
| 498 | "destinationTable": { # [Required] The destination table of the link job.<br> |
| 499 | "projectId": "A String", # [Required] ID of the project billed for storage of the table.<br> |
| 500 | "tableId": "A String", # [Required] ID of the table.<br> |
| 501 | "datasetId": "A String", # [Required] ID of the dataset containing the table.<br> |
| 502 | },<br> |
| 503 | "sourceUri": "A String", # [Required] URI of source table to link.<br> |
| 504 | },<br> |
| 505 | "query": { # [Pick one] Configures a query job.<br> |
| 506 | "createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.<br> |
| 507 | "query": "A String", # [Required] BigQuery SQL query to execute.<br> |
| 508 | "writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.<br> |
| 509 | "destinationTable": { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results.<br> |
| 510 | "projectId": "A String", # [Required] ID of the project billed for storage of the table.<br> |
| 511 | "tableId": "A String", # [Required] ID of the table.<br> |
| 512 | "datasetId": "A String", # [Required] ID of the dataset containing the table.<br> |
| 513 | },<br> |
| 514 | "defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.<br> |
| 515 | "projectId": "A String", # [Optional] The ID of the container project.<br> |
| 516 | "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.<br> |
| 517 | },<br> |
| 518 | },<br> |
| 519 | "copy": { # [Pick one] Copies a table.<br> |
| 520 | "createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.<br> |
| 521 | "writeDisposition": "A String", # [Optional] Whether or not to append or require the table to be empty.<br> |
| 522 | "destinationTable": { # [Required] The destination table<br> |
| 523 | "projectId": "A String", # [Required] ID of the project billed for storage of the table.<br> |
| 524 | "tableId": "A String", # [Required] ID of the table.<br> |
| 525 | "datasetId": "A String", # [Required] ID of the dataset containing the table.<br> |
| 526 | },<br> |
| 527 | "sourceTable": { # [Required] Source table to copy.<br> |
| 528 | "projectId": "A String", # [Required] ID of the project billed for storage of the table.<br> |
| 529 | "tableId": "A String", # [Required] ID of the table.<br> |
| 530 | "datasetId": "A String", # [Required] ID of the dataset containing the table.<br> |
| 531 | },<br> |
| 532 | },<br> |
| 533 | "extract": { # [Pick one] Configures an extract job.<br> |
| 534 | "destinationUri": "A String", # [Required] The fully-qualified Google Cloud Storage URI where the extracted table should be written.<br> |
| 535 | "sourceTable": { # [Required] A reference to the table being exported.<br> |
| 536 | "projectId": "A String", # [Required] ID of the project billed for storage of the table.<br> |
| 537 | "tableId": "A String", # [Required] ID of the table.<br> |
| 538 | "datasetId": "A String", # [Required] ID of the dataset containing the table.<br> |
| 539 | },<br> |
| 540 | },<br> |
| 541 | "properties": { # [Optional] Properties providing extra details about how the job should be run. Not used for most jobs.<br> |
| 542 | },<br> |
| 543 | },<br> |
| 544 | "id": "A String", # Unique opaque ID of the job.<br> |
| 545 | "errorResult": { # A result object that will be present only if the job has failed.<br> |
| 546 | "debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.<br> |
| 547 | "message": "A String", # A human readable explanation of the error.<br> |
| 548 | "reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.<br> |
| 549 | "location": "A String", # Specifies where the error occurred, if present.<br> |
| 550 | },<br> |
| 551 | },<br> |
| 552 | ],<br> |
| 553 | }</tt></dd></dl> |
| 554 | |
| 555 | <dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br> |
| 556 | <br> |
| 557 | Args:<br> |
| 558 | previous_request: The request for the previous page.<br> |
| 559 | previous_response: The response from the request for the previous page.<br> |
| 560 | <br> |
| 561 | Returns:<br> |
| 562 | A request object that you can call 'execute()' on to request the next<br> |
| 563 | page. Returns None if there are no more items in the collection.</tt></dd></dl> |
| 564 | |
| 565 | <dl><dt><a name="Resource-query"><strong>query</strong></a> = method(self, **kwargs)</dt><dd><tt>Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.<br> |
| 566 | <br> |
| 567 | Args:<br> |
| 568 | body: object, The request body. (required)<br> |
| 569 | The object takes the form of:<br> |
| 570 | <br> |
| 571 | {<br> |
| 572 | "timeoutMs": 42, # [Optional] How long to wait for the query to complete, in milliseconds, before returning. Default is to return immediately. If the timeout passes before the job completes, the request will fail with a TIMEOUT error.<br> |
| 573 | "query": "A String", # [Required] A query string, following the BigQuery query syntax of the query to execute. Table names should be qualified by dataset name in the format projectId:datasetId.tableId unless you specify the defaultDataset value. If the table is in the same project as the job, you can omit the project ID. Example: SELECT f1 FROM myProjectId:myDatasetId.myTableId.<br> |
| 574 | "kind": "bigquery#queryRequest", # The resource type of the request.<br> |
| 575 | "maxResults": 42, # [Optional] The maximum number of results to return per page of results. If the response list exceeds the maximum response size for a single response, you will have to page through the results. Default is to return the maximum response size.<br> |
| 576 | "defaultDataset": { # [Optional] Specifies the default datasetId and projectId to assume for any unqualified table names in the query. If not set, all table names in the query string must be fully-qualified in the format projectId:datasetId.tableid.<br> |
| 577 | "projectId": "A String", # [Optional] The ID of the container project.<br> |
| 578 | "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.<br> |
| 579 | },<br> |
| 580 | }<br> |
| 581 | <br> |
| 582 | projectId: string, Project ID of the project billed for the query (required)<br> |
| 583 | <br> |
| 584 | Returns:<br> |
| 585 | An object of the form<br> |
| 586 | <br> |
| 587 | {<br> |
| 588 | "kind": "bigquery#queryResponse", # The resource type.<br> |
| 589 | "rows": [ # An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above.<br> |
| 590 | {<br> |
| 591 | "f": [ # Represents a single row in the result set, consisting of one or more fields.<br> |
| 592 | {<br> |
| 593 | "v": "A String", # Contains the field value in this row, as a string.<br> |
| 594 | },<br> |
| 595 | ],<br> |
| 596 | },<br> |
| 597 | ],<br> |
| 598 | "jobReference": { # Reference to the Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults).<br> |
| 599 | "projectId": "A String", # [Required] Project ID being billed for the job.<br> |
| 600 | "jobId": "A String", # [Required] ID of the job.<br> |
| 601 | },<br> |
| 602 | "jobComplete": True or False, # Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.<br> |
| 603 | "totalRows": "A String", # The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results.<br> |
| 604 | "schema": { # The schema of the results. Present only when the query completes successfully.<br> |
| 605 | "fields": [ # Describes the fields in a table.<br> |
| 606 | {<br> |
| 607 | "fields": [ # [Optional] Describes nested fields when type is RECORD.<br> |
| 608 | # Object with schema name: TableFieldSchema<br> |
| 609 | ],<br> |
| 610 | "type": "A String", # [Required] Data type of the field.<br> |
| 611 | "mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.<br> |
| 612 | "name": "A String", # [Required] Name of the field.<br> |
| 613 | },<br> |
| 614 | ],<br> |
| 615 | },<br> |
| 616 | }</tt></dd></dl> |
| 617 | |
| 618 | <hr> |
| 619 | Data descriptors defined here:<br> |
| 620 | <dl><dt><strong>__dict__</strong></dt> |
| 621 | <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| 622 | </dl> |
| 623 | <dl><dt><strong>__weakref__</strong></dt> |
| 624 | <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| 625 | </dl> |
| 626 | </td></tr></table> |
| 627 | </body></html> |