| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="bigquery_v2.html">BigQuery API</a> . <a href="bigquery_v2.jobs.html">jobs</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#cancel">cancel(projectId, jobId, location=None)</a></code></p> |
| <p class="firstline">Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs.</p> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(projectId, jobId, location=None)</a></code></p> |
| <p class="firstline">Requests the deletion of the metadata of a job. This call returns when the job's metadata is deleted.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(projectId, jobId, location=None)</a></code></p> |
| <p class="firstline">Returns information about a specific job. Job information is available for a six month period after creation. Requires that you're the person who ran the job, or have the Is Owner project role.</p> |
| <p class="toc_element"> |
| <code><a href="#getQueryResults">getQueryResults(projectId, jobId, location=None, maxResults=None, pageToken=None, startIndex=None, timeoutMs=None)</a></code></p> |
| <p class="firstline">Retrieves the results of a query job.</p> |
| <p class="toc_element"> |
| <code><a href="#getQueryResults_next">getQueryResults_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#insert">insert(projectId, body=None, media_body=None, media_mime_type=None)</a></code></p> |
| <p class="firstline">Starts a new asynchronous job. Requires the Can View project role.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(projectId, allUsers=None, maxCreationTime=None, maxResults=None, minCreationTime=None, pageToken=None, parentJobId=None, projection=None, stateFilter=None)</a></code></p> |
| <p class="firstline">Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#query">query(projectId, body=None)</a></code></p> |
| <p class="firstline">Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="cancel">cancel(projectId, jobId, location=None)</code> |
| <pre>Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs. |
| |
| Args: |
| projectId: string, [Required] Project ID of the job to cancel (required) |
| jobId: string, [Required] Job ID of the job to cancel (required) |
| location: string, The geographic location of the job. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location. |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "job": { # The final state of the job. |
| "configuration": { # [Required] Describes the job configuration. |
| "copy": { # [Pick one] Copies a table. |
| "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. |
| "destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys). |
| "kmsKeyName": "A String", # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. |
| }, |
| "destinationExpirationTime": "", # [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed. |
| "destinationTable": { # [Required] The destination table |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "operationType": "A String", # [Optional] Supported operation types in table copy job. |
| "sourceTable": { # [Pick one] Source table to copy. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "sourceTables": [ # [Pick one] Source tables to copy. |
| { |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| ], |
| "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. |
| }, |
| "dryRun": True or False, # [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined. |
| "extract": { # [Pick one] Configures an extract job. |
| "compression": "A String", # [Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models. |
| "destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL. |
| "destinationUri": "A String", # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written. |
| "destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written. |
| "A String", |
| ], |
| "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models. |
| "printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models. |
| "sourceModel": { # A reference to the model being exported. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this model. |
| "modelId": "A String", # [Required] The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| "projectId": "A String", # [Required] The ID of the project containing this model. |
| }, |
| "sourceTable": { # A reference to the table being exported. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "useAvroLogicalTypes": True or False, # [Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models. |
| }, |
| "jobTimeoutMs": "A String", # [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job. |
| "jobType": "A String", # [Output-only] The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN. |
| "labels": { # The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key. |
| "a_key": "A String", |
| }, |
| "load": { # [Pick one] Configures a load job. |
| "allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats. |
| "allowQuotedNewlines": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. |
| "autodetect": True or False, # [Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources. |
| "clustering": { # [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered. |
| "fields": [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data. |
| "A String", |
| ], |
| }, |
| "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. |
| "decimalTargetTypes": [ # [Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. |
| "A String", |
| ], |
| "destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys). |
| "kmsKeyName": "A String", # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. |
| }, |
| "destinationTable": { # [Required] The destination table to load the data into. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "destinationTableProperties": { # [Beta] [Optional] Properties with which to create the destination table if it is new. |
| "description": "A String", # [Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail. |
| "expirationTime": "A String", # [Internal] This field is for Google internal use only. |
| "friendlyName": "A String", # [Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail. |
| "labels": { # [Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail. |
| "a_key": "A String", |
| }, |
| }, |
| "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. |
| "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). |
| "hivePartitioningOptions": { # [Optional] Options to configure hive partitioning support. |
| "mode": "A String", # [Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet. |
| "requirePartitionFilter": True or False, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail. |
| "sourceUriPrefix": "A String", # [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter). |
| }, |
| "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names |
| "jsonExtension": "A String", # [Optional] If sourceFormat is set to newline-delimited JSON, indicates whether it should be processed as a JSON variant such as GeoJSON. For a sourceFormat other than JSON, omit this field. If the sourceFormat is newline-delimited JSON: - for newline-delimited GeoJSON: set to GEOJSON. |
| "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid. |
| "nullMarker": "A String", # [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value. |
| "parquetOptions": { # [Optional] Options to configure parquet support. |
| "enableListInference": True or False, # [Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type. |
| "enumAsString": True or False, # [Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default. |
| }, |
| "projectionFields": [ # If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result. |
| "A String", |
| ], |
| "quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. |
| "rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified. |
| "field": "A String", # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64. |
| "range": { # [TrustedTester] [Required] Defines the ranges for range partitioning. |
| "end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive. |
| "interval": "A String", # [TrustedTester] [Required] The width of each interval. |
| "start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive. |
| }, |
| }, |
| "schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore. |
| "fields": [ # Describes the fields in a table. |
| { |
| "categories": { # [Optional] The categories attached to this field, used for field-level access control. |
| "names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed. |
| "A String", |
| ], |
| }, |
| "collationSpec": "A String", # Optional. Collation specification of the field. It only can be set on string type field. |
| "description": "A String", # [Optional] The field description. The maximum length is 1,024 characters. |
| "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD. |
| # Object with schema name: TableFieldSchema |
| ], |
| "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". |
| "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. |
| "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. |
| "policyTags": { |
| "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. |
| "A String", |
| ], |
| }, |
| "precision": "A String", # [Optional] Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: - Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: - If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. - If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): - If type = "NUMERIC": 1 ≤ precision ≤ 29. - If type = "BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid. |
| "scale": "A String", # [Optional] See documentation for precision. |
| "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, INTERVAL, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD). |
| }, |
| ], |
| }, |
| "schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT". |
| "schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property. |
| "schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. |
| "A String", |
| ], |
| "skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. |
| "sourceFormat": "A String", # [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV. |
| "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '*' wildcard character is not allowed. |
| "A String", |
| ], |
| "timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. |
| "expirationMs": "A String", # [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value. |
| "field": "A String", # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED. |
| "requirePartitionFilter": True or False, |
| "type": "A String", # [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY. |
| }, |
| "useAvroLogicalTypes": True or False, # [Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER). |
| "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. |
| }, |
| "query": { # [Pick one] Configures a query job. |
| "allowLargeResults": false, # [Optional] If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For standard SQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size. |
| "clustering": { # [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered. |
| "fields": [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data. |
| "A String", |
| ], |
| }, |
| "connectionProperties": [ # Connection properties. |
| { |
| "key": "A String", # [Required] Name of the connection property to set. |
| "value": "A String", # [Required] Value of the connection property. |
| }, |
| ], |
| "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. |
| "createSession": True or False, # If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode. |
| "defaultDataset": { # [Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names. |
| "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| "projectId": "A String", # [Optional] The ID of the project containing this dataset. |
| }, |
| "destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys). |
| "kmsKeyName": "A String", # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. |
| }, |
| "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. This property must be set for large results that exceed the maximum response size. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "flattenResults": true, # [Optional] If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results. allowLargeResults must be true if this is set to false. For standard SQL queries, this flag is ignored and results are never flattened. |
| "maximumBillingTier": 1, # [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default. |
| "maximumBytesBilled": "A String", # [Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default. |
| "parameterMode": "A String", # Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query. |
| "preserveNulls": True or False, # [Deprecated] This property is deprecated. |
| "priority": "A String", # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE. |
| "query": "A String", # [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL. |
| "queryParameters": [ # Query parameters for standard SQL queries. |
| { |
| "name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query. |
| "parameterType": { # [Required] The type of this parameter. |
| "arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array. |
| "structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct. |
| { |
| "description": "A String", # [Optional] Human-oriented description of the field. |
| "name": "A String", # [Optional] The name of this field. |
| "type": # Object with schema name: QueryParameterType # [Required] The type of this field. |
| }, |
| ], |
| "type": "A String", # [Required] The top level type of this field. |
| }, |
| "parameterValue": { # [Required] The value of this parameter. |
| "arrayValues": [ # [Optional] The array values, if this is an array type. |
| # Object with schema name: QueryParameterValue |
| ], |
| "structValues": { # [Optional] The struct field values, in order of the struct type's declaration. |
| "a_key": # Object with schema name: QueryParameterValue |
| }, |
| "value": "A String", # [Optional] The value of this value, if a simple scalar type. |
| }, |
| }, |
| ], |
| "rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified. |
| "field": "A String", # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64. |
| "range": { # [TrustedTester] [Required] Defines the ranges for range partitioning. |
| "end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive. |
| "interval": "A String", # [TrustedTester] [Required] The width of each interval. |
| "start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive. |
| }, |
| }, |
| "schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. |
| "A String", |
| ], |
| "tableDefinitions": { # [Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. |
| "a_key": { |
| "autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored. |
| "avroOptions": { # Additional properties to set if sourceFormat is set to Avro. |
| "useAvroLogicalTypes": True or False, # [Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER). |
| }, |
| "bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE. |
| "columnFamilies": [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable. |
| { |
| "columns": [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field. |
| { |
| "encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels. |
| "fieldName": "A String", # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries. |
| "onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels. |
| "qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name. |
| "qualifierString": "A String", |
| "type": "A String", # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels. |
| }, |
| ], |
| "encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it. |
| "familyId": "A String", # Identifier of the column family. |
| "onlyReadLatest": True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column. |
| "type": "A String", # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it. |
| }, |
| ], |
| "ignoreUnspecifiedColumnFamilies": True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false. |
| "readRowkeyAsString": True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false. |
| }, |
| "compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats. |
| "connectionId": "A String", # [Optional, Trusted Tester] Connection for external data source. |
| "csvOptions": { # Additional properties to set if sourceFormat is set to CSV. |
| "allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. |
| "allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. |
| "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. |
| "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). |
| "null_marker": "A String", # [Optional] An custom string that will represent a NULL value in CSV import data. |
| "quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. |
| "skipLeadingRows": "A String", # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema. |
| }, |
| "decimalTargetTypes": [ # [Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. |
| "A String", |
| ], |
| "googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS. |
| "range": "A String", # [Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20 |
| "skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema. |
| }, |
| "hivePartitioningOptions": { # [Optional] Options to configure hive partitioning support. |
| "mode": "A String", # [Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet. |
| "requirePartitionFilter": True or False, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail. |
| "sourceUriPrefix": "A String", # [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter). |
| }, |
| "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored. |
| "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats. |
| "parquetOptions": { # Additional properties to set if sourceFormat is set to Parquet. |
| "enableListInference": True or False, # [Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type. |
| "enumAsString": True or False, # [Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default. |
| }, |
| "schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats. |
| "fields": [ # Describes the fields in a table. |
| { |
| "categories": { # [Optional] The categories attached to this field, used for field-level access control. |
| "names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed. |
| "A String", |
| ], |
| }, |
| "collationSpec": "A String", # Optional. Collation specification of the field. It only can be set on string type field. |
| "description": "A String", # [Optional] The field description. The maximum length is 1,024 characters. |
| "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD. |
| # Object with schema name: TableFieldSchema |
| ], |
| "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". |
| "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. |
| "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. |
| "policyTags": { |
| "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. |
| "A String", |
| ], |
| }, |
| "precision": "A String", # [Optional] Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: - Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: - If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. - If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): - If type = "NUMERIC": 1 ≤ precision ≤ 29. - If type = "BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid. |
| "scale": "A String", # [Optional] See documentation for precision. |
| "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, INTERVAL, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD). |
| }, |
| ], |
| }, |
| "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE". |
| "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed. |
| "A String", |
| ], |
| }, |
| }, |
| "timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. |
| "expirationMs": "A String", # [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value. |
| "field": "A String", # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED. |
| "requirePartitionFilter": True or False, |
| "type": "A String", # [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY. |
| }, |
| "useLegacySql": true, # Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false. |
| "useQueryCache": true, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true. |
| "userDefinedFunctionResources": [ # Describes user-defined function resources used in the query. |
| { # This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of Standard SQL should leverage either DDL (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions |
| "inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code. |
| "resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path). |
| }, |
| ], |
| "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. |
| }, |
| }, |
| "etag": "A String", # [Output-only] A hash of this resource. |
| "id": "A String", # [Output-only] Opaque ID field of the job |
| "jobReference": { # [Optional] Reference describing the unique-per-user name of the job. |
| "jobId": "A String", # [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters. |
| "location": "A String", # The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location. |
| "projectId": "A String", # [Required] The ID of the project containing this job. |
| }, |
| "kind": "bigquery#job", # [Output-only] The type of the resource. |
| "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again. |
| "statistics": { # [Output-only] Information about the job, including starting time and ending time of the job. |
| "completionRatio": 3.14, # [TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs. |
| "creationTime": "A String", # [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs. |
| "endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state. |
| "extract": { # [Output-only] Statistics for an extract job. |
| "destinationUriFileCounts": [ # [Output-only] Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field. |
| "A String", |
| ], |
| "inputBytes": "A String", # [Output-only] Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes. |
| }, |
| "load": { # [Output-only] Statistics for a load job. |
| "badRecords": "A String", # [Output-only] The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data. |
| "inputFileBytes": "A String", # [Output-only] Number of bytes of source data in a load job. |
| "inputFiles": "A String", # [Output-only] Number of source files in a load job. |
| "outputBytes": "A String", # [Output-only] Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change. |
| "outputRows": "A String", # [Output-only] Number of rows imported in a load job. Note that while an import job is in the running state, this value may change. |
| }, |
| "numChildJobs": "A String", # [Output-only] Number of child jobs executed. |
| "parentJobId": "A String", # [Output-only] If this is a child job, the id of the parent. |
| "query": { # [Output-only] Statistics for a query job. |
| "biEngineStatistics": { # BI Engine specific Statistics. [Output-only] BI Engine specific Statistics. |
| "biEngineMode": "$(stats.bi_engine_mode)", # [Output-only] Specifies which mode of BI Engine acceleration was performed (if any). |
| "biEngineReasons": [ # In case of DISABLED or PARTIAL bi_engine_mode, these contain the explanatory reasons as to why BI Engine could not accelerate. In case the full query was accelerated, this field is not populated. |
| { |
| "code": "$(reason.code)", # [Output-only] High-level BI Engine reason for partial or disabled acceleration. |
| "message": "$(reason.message)", # [Output-only] Free form human-readable reason for partial or disabled acceleration. |
| }, |
| ], |
| }, |
| "billingTier": 42, # [Output-only] Billing tier for the job. |
| "cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache. |
| "ddlAffectedRowAccessPolicyCount": "A String", # [Output-only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries. |
| "ddlDestinationTable": { # [Output-only] The DDL destination table. Present only for ALTER TABLE RENAME TO queries. Note that ddl_target_table is used just for its type information. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "ddlOperationPerformed": "A String", # The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target. |
| "ddlTargetDataset": { # [Output-only] The DDL target dataset. Present only for CREATE/ALTER/DROP SCHEMA queries. |
| "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| "projectId": "A String", # [Optional] The ID of the project containing this dataset. |
| }, |
| "ddlTargetRoutine": { # The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this routine. |
| "projectId": "A String", # [Required] The ID of the project containing this routine. |
| "routineId": "A String", # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. |
| }, |
| "ddlTargetRowAccessPolicy": { # [Output-only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this row access policy. |
| "policyId": "A String", # [Required] The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. |
| "projectId": "A String", # [Required] The ID of the project containing this row access policy. |
| "tableId": "A String", # [Required] The ID of the table containing this row access policy. |
| }, |
| "ddlTargetTable": { # [Output-only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "dmlStats": { # [Output-only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE. |
| "deletedRowCount": "A String", # Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements. |
| "insertedRowCount": "A String", # Number of inserted Rows. Populated by DML INSERT and MERGE statements. |
| "updatedRowCount": "A String", # Number of updated Rows. Populated by DML UPDATE and MERGE statements. |
| }, |
| "estimatedBytesProcessed": "A String", # [Output-only] The original estimate of bytes processed for the job. |
| "mlStatistics": { # [Output-only] Statistics of a BigQuery ML training job. |
| "iterationResults": [ # Results for all completed iterations. |
| { |
| "durationMs": "A String", # Time taken to run the iteration in milliseconds. |
| "evalLoss": 3.14, # Loss computed on the eval data at the end of iteration. |
| "index": 42, # Index of the iteration, 0 based. |
| "learnRate": 3.14, # Learn rate used for this iteration. |
| "trainingLoss": 3.14, # Loss computed on the training data at the end of iteration. |
| }, |
| ], |
| "maxIterations": "A String", # Maximum number of iterations specified as max_iterations in the 'CREATE MODEL' query. The actual number of iterations may be less than this number due to early stop. |
| }, |
| "modelTraining": { # [Output-only, Beta] Information about create model query job progress. |
| "currentIteration": 42, # [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress. |
| "expectedTotalIterations": "A String", # [Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop. |
| }, |
| "modelTrainingCurrentIteration": 42, # [Output-only, Beta] Deprecated; do not use. |
| "modelTrainingExpectedTotalIteration": "A String", # [Output-only, Beta] Deprecated; do not use. |
| "numDmlAffectedRows": "A String", # [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. |
| "queryPlan": [ # [Output-only] Describes execution plan for the query. |
| { |
| "completedParallelInputs": "A String", # Number of parallel input segments completed. |
| "computeMsAvg": "A String", # Milliseconds the average shard spent on CPU-bound tasks. |
| "computeMsMax": "A String", # Milliseconds the slowest shard spent on CPU-bound tasks. |
| "computeRatioAvg": 3.14, # Relative amount of time the average shard spent on CPU-bound tasks. |
| "computeRatioMax": 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks. |
| "endMs": "A String", # Stage end time represented as milliseconds since epoch. |
| "id": "A String", # Unique ID for stage within plan. |
| "inputStages": [ # IDs for stages that are inputs to this stage. |
| "A String", |
| ], |
| "name": "A String", # Human-readable name for stage. |
| "parallelInputs": "A String", # Number of parallel input segments to be processed. |
| "readMsAvg": "A String", # Milliseconds the average shard spent reading input. |
| "readMsMax": "A String", # Milliseconds the slowest shard spent reading input. |
| "readRatioAvg": 3.14, # Relative amount of time the average shard spent reading input. |
| "readRatioMax": 3.14, # Relative amount of time the slowest shard spent reading input. |
| "recordsRead": "A String", # Number of records read into the stage. |
| "recordsWritten": "A String", # Number of records written by the stage. |
| "shuffleOutputBytes": "A String", # Total number of bytes written to shuffle. |
| "shuffleOutputBytesSpilled": "A String", # Total number of bytes written to shuffle and spilled to disk. |
| "slotMs": "A String", # Slot-milliseconds used by the stage. |
| "startMs": "A String", # Stage start time represented as milliseconds since epoch. |
| "status": "A String", # Current status for the stage. |
| "steps": [ # List of operations within the stage in dependency order (approximately chronological). |
| { |
| "kind": "A String", # Machine-readable operation type. |
| "substeps": [ # Human-readable stage descriptions. |
| "A String", |
| ], |
| }, |
| ], |
| "waitMsAvg": "A String", # Milliseconds the average shard spent waiting to be scheduled. |
| "waitMsMax": "A String", # Milliseconds the slowest shard spent waiting to be scheduled. |
| "waitRatioAvg": 3.14, # Relative amount of time the average shard spent waiting to be scheduled. |
| "waitRatioMax": 3.14, # Relative amount of time the slowest shard spent waiting to be scheduled. |
| "writeMsAvg": "A String", # Milliseconds the average shard spent on writing output. |
| "writeMsMax": "A String", # Milliseconds the slowest shard spent on writing output. |
| "writeRatioAvg": 3.14, # Relative amount of time the average shard spent on writing output. |
| "writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output. |
| }, |
| ], |
| "referencedRoutines": [ # [Output-only] Referenced routines (persistent user-defined functions and stored procedures) for the job. |
| { |
| "datasetId": "A String", # [Required] The ID of the dataset containing this routine. |
| "projectId": "A String", # [Required] The ID of the project containing this routine. |
| "routineId": "A String", # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. |
| }, |
| ], |
| "referencedTables": [ # [Output-only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list. |
| { |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| ], |
| "reservationUsage": [ # [Output-only] Job resource usage breakdown by reservation. |
| { |
| "name": "A String", # [Output-only] Reservation name or "unreserved" for on-demand resources usage. |
| "slotMs": "A String", # [Output-only] Slot-milliseconds the job spent in the given reservation. |
| }, |
| ], |
| "schema": { # [Output-only] The schema of the results. Present only for successful dry run of non-legacy SQL queries. |
| "fields": [ # Describes the fields in a table. |
| { |
| "categories": { # [Optional] The categories attached to this field, used for field-level access control. |
| "names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed. |
| "A String", |
| ], |
| }, |
| "collationSpec": "A String", # Optional. Collation specification of the field. It only can be set on string type field. |
| "description": "A String", # [Optional] The field description. The maximum length is 1,024 characters. |
| "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD. |
| # Object with schema name: TableFieldSchema |
| ], |
| "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". |
| "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. |
| "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. |
| "policyTags": { |
| "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. |
| "A String", |
| ], |
| }, |
| "precision": "A String", # [Optional] Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: - Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: - If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. - If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): - If type = "NUMERIC": 1 ≤ precision ≤ 29. - If type = "BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid. |
| "scale": "A String", # [Optional] See documentation for precision. |
| "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, INTERVAL, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD). |
| }, |
| ], |
| }, |
| "statementType": "A String", # The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "ASSERT": ASSERT condition AS 'description'. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query. |
| "timeline": [ # [Output-only] [Beta] Describes a timeline of job execution. |
| { |
| "activeUnits": "A String", # Total number of units currently being processed by workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample. |
| "completedUnits": "A String", # Total parallel units of work completed by this query. |
| "elapsedMs": "A String", # Milliseconds elapsed since the start of query execution. |
| "pendingUnits": "A String", # Total parallel units of work remaining for the active stages. |
| "totalSlotMs": "A String", # Cumulative slot-ms consumed by the query. |
| }, |
| ], |
| "totalBytesBilled": "A String", # [Output-only] Total bytes billed for the job. |
| "totalBytesProcessed": "A String", # [Output-only] Total bytes processed for the job. |
| "totalBytesProcessedAccuracy": "A String", # [Output-only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost. |
| "totalPartitionsProcessed": "A String", # [Output-only] Total number of partitions processed from all partitioned tables referenced in the job. |
| "totalSlotMs": "A String", # [Output-only] Slot-milliseconds for the job. |
| "undeclaredQueryParameters": [ # Standard SQL only: list of undeclared query parameters detected during a dry run validation. |
| { |
| "name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query. |
| "parameterType": { # [Required] The type of this parameter. |
| "arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array. |
| "structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct. |
| { |
| "description": "A String", # [Optional] Human-oriented description of the field. |
| "name": "A String", # [Optional] The name of this field. |
| "type": # Object with schema name: QueryParameterType # [Required] The type of this field. |
| }, |
| ], |
| "type": "A String", # [Required] The top level type of this field. |
| }, |
| "parameterValue": { # [Required] The value of this parameter. |
| "arrayValues": [ # [Optional] The array values, if this is an array type. |
| # Object with schema name: QueryParameterValue |
| ], |
| "structValues": { # [Optional] The struct field values, in order of the struct type's declaration. |
| "a_key": # Object with schema name: QueryParameterValue |
| }, |
| "value": "A String", # [Optional] The value of this value, if a simple scalar type. |
| }, |
| }, |
| ], |
| }, |
| "quotaDeferments": [ # [Output-only] Quotas which delayed this job's start time. |
| "A String", |
| ], |
| "reservationUsage": [ # [Output-only] Job resource usage breakdown by reservation. |
| { |
| "name": "A String", # [Output-only] Reservation name or "unreserved" for on-demand resources usage. |
| "slotMs": "A String", # [Output-only] Slot-milliseconds the job spent in the given reservation. |
| }, |
| ], |
| "reservation_id": "A String", # [Output-only] Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job. |
| "rowLevelSecurityStatistics": { # [Output-only] [Preview] Statistics for row-level security. Present only for query and extract jobs. |
| "rowLevelSecurityApplied": True or False, # [Output-only] [Preview] Whether any accessed data was protected by row access policies. |
| }, |
| "scriptStatistics": { # [Output-only] Statistics for a child job of a script. |
| "evaluationKind": "A String", # [Output-only] Whether this child job was a statement or expression. |
| "stackFrames": [ # Stack trace showing the line/column/procedure name of each frame on the stack at the point where the current evaluation happened. The leaf frame is first, the primary script is last. Never empty. |
| { |
| "endColumn": 42, # [Output-only] One-based end column. |
| "endLine": 42, # [Output-only] One-based end line. |
| "procedureId": "A String", # [Output-only] Name of the active procedure, empty if in a top-level script. |
| "startColumn": 42, # [Output-only] One-based start column. |
| "startLine": 42, # [Output-only] One-based start line. |
| "text": "A String", # [Output-only] Text of the current statement/expression. |
| }, |
| ], |
| }, |
| "sessionInfo": { # [Output-only] [Preview] Information of the session if this job is part of one. |
| "sessionId": "A String", # [Output-only] // [Preview] Id of the session. |
| }, |
| "startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE. |
| "totalBytesProcessed": "A String", # [Output-only] [Deprecated] Use the bytes processed in the query statistics instead. |
| "totalSlotMs": "A String", # [Output-only] Slot-milliseconds for the job. |
| "transactionInfo": { # [Output-only] [Alpha] Information of the multi-statement transaction if this job is part of one. |
| "transactionId": "A String", # [Output-only] // [Alpha] Id of the transaction. |
| }, |
| }, |
| "status": { # [Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete. |
| "errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful. |
| "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used. |
| "location": "A String", # Specifies where the error occurred, if present. |
| "message": "A String", # A human-readable description of the error. |
| "reason": "A String", # A short error code that summarizes the error. |
| }, |
| "errors": [ # [Output-only] The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful. |
| { |
| "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used. |
| "location": "A String", # Specifies where the error occurred, if present. |
| "message": "A String", # A human-readable description of the error. |
| "reason": "A String", # A short error code that summarizes the error. |
| }, |
| ], |
| "state": "A String", # [Output-only] Running state of the job. |
| }, |
| "user_email": "A String", # [Output-only] Email address of the user who ran the job. |
| }, |
| "kind": "bigquery#jobCancelResponse", # The resource type of the response. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(projectId, jobId, location=None)</code> |
| <pre>Requests the deletion of the metadata of a job. This call returns when the job's metadata is deleted. |
| |
| Args: |
| projectId: string, Required. Project ID of the job for which metadata is to be deleted. (required) |
| jobId: string, Required. Job ID of the job for which metadata is to be deleted. If this is a parent job which has child jobs, the metadata from all child jobs will be deleted as well. Direct deletion of the metadata of child jobs is not allowed. (required) |
| location: string, The geographic location of the job. Required. See details at: https://cloud.google.com/bigquery/docs/locations#specifying_your_location. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(projectId, jobId, location=None)</code> |
| <pre>Returns information about a specific job. Job information is available for a six month period after creation. Requires that you're the person who ran the job, or have the Is Owner project role. |
| |
| Args: |
| projectId: string, [Required] Project ID of the requested job (required) |
| jobId: string, [Required] Job ID of the requested job (required) |
| location: string, The geographic location of the job. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location. |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "configuration": { # [Required] Describes the job configuration. |
| "copy": { # [Pick one] Copies a table. |
| "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. |
| "destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys). |
| "kmsKeyName": "A String", # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. |
| }, |
| "destinationExpirationTime": "", # [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed. |
| "destinationTable": { # [Required] The destination table |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "operationType": "A String", # [Optional] Supported operation types in table copy job. |
| "sourceTable": { # [Pick one] Source table to copy. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "sourceTables": [ # [Pick one] Source tables to copy. |
| { |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| ], |
| "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. |
| }, |
| "dryRun": True or False, # [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined. |
| "extract": { # [Pick one] Configures an extract job. |
| "compression": "A String", # [Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models. |
| "destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL. |
| "destinationUri": "A String", # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written. |
| "destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written. |
| "A String", |
| ], |
| "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models. |
| "printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models. |
| "sourceModel": { # A reference to the model being exported. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this model. |
| "modelId": "A String", # [Required] The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| "projectId": "A String", # [Required] The ID of the project containing this model. |
| }, |
| "sourceTable": { # A reference to the table being exported. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "useAvroLogicalTypes": True or False, # [Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models. |
| }, |
| "jobTimeoutMs": "A String", # [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job. |
| "jobType": "A String", # [Output-only] The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN. |
| "labels": { # The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key. |
| "a_key": "A String", |
| }, |
| "load": { # [Pick one] Configures a load job. |
| "allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats. |
| "allowQuotedNewlines": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. |
| "autodetect": True or False, # [Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources. |
| "clustering": { # [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered. |
| "fields": [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data. |
| "A String", |
| ], |
| }, |
| "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. |
| "decimalTargetTypes": [ # [Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. |
| "A String", |
| ], |
| "destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys). |
| "kmsKeyName": "A String", # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. |
| }, |
| "destinationTable": { # [Required] The destination table to load the data into. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "destinationTableProperties": { # [Beta] [Optional] Properties with which to create the destination table if it is new. |
| "description": "A String", # [Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail. |
| "expirationTime": "A String", # [Internal] This field is for Google internal use only. |
| "friendlyName": "A String", # [Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail. |
| "labels": { # [Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail. |
| "a_key": "A String", |
| }, |
| }, |
| "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. |
| "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). |
| "hivePartitioningOptions": { # [Optional] Options to configure hive partitioning support. |
| "mode": "A String", # [Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet. |
| "requirePartitionFilter": True or False, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail. |
| "sourceUriPrefix": "A String", # [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter). |
| }, |
| "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names |
| "jsonExtension": "A String", # [Optional] If sourceFormat is set to newline-delimited JSON, indicates whether it should be processed as a JSON variant such as GeoJSON. For a sourceFormat other than JSON, omit this field. If the sourceFormat is newline-delimited JSON: - for newline-delimited GeoJSON: set to GEOJSON. |
| "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid. |
| "nullMarker": "A String", # [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value. |
| "parquetOptions": { # [Optional] Options to configure parquet support. |
| "enableListInference": True or False, # [Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type. |
| "enumAsString": True or False, # [Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default. |
| }, |
| "projectionFields": [ # If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result. |
| "A String", |
| ], |
| "quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. |
| "rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified. |
| "field": "A String", # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64. |
| "range": { # [TrustedTester] [Required] Defines the ranges for range partitioning. |
| "end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive. |
| "interval": "A String", # [TrustedTester] [Required] The width of each interval. |
| "start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive. |
| }, |
| }, |
| "schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore. |
| "fields": [ # Describes the fields in a table. |
| { |
| "categories": { # [Optional] The categories attached to this field, used for field-level access control. |
| "names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed. |
| "A String", |
| ], |
| }, |
| "collationSpec": "A String", # Optional. Collation specification of the field. It only can be set on string type field. |
| "description": "A String", # [Optional] The field description. The maximum length is 1,024 characters. |
| "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD. |
| # Object with schema name: TableFieldSchema |
| ], |
| "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". |
| "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. |
| "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. |
| "policyTags": { |
| "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. |
| "A String", |
| ], |
| }, |
| "precision": "A String", # [Optional] Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: - Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: - If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. - If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): - If type = "NUMERIC": 1 ≤ precision ≤ 29. - If type = "BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid. |
| "scale": "A String", # [Optional] See documentation for precision. |
| "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, INTERVAL, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD). |
| }, |
| ], |
| }, |
| "schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT". |
| "schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property. |
| "schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. |
| "A String", |
| ], |
| "skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. |
| "sourceFormat": "A String", # [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV. |
| "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '*' wildcard character is not allowed. |
| "A String", |
| ], |
| "timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. |
| "expirationMs": "A String", # [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value. |
| "field": "A String", # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED. |
| "requirePartitionFilter": True or False, |
| "type": "A String", # [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY. |
| }, |
| "useAvroLogicalTypes": True or False, # [Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER). |
| "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. |
| }, |
| "query": { # [Pick one] Configures a query job. |
| "allowLargeResults": false, # [Optional] If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For standard SQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size. |
| "clustering": { # [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered. |
| "fields": [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data. |
| "A String", |
| ], |
| }, |
| "connectionProperties": [ # Connection properties. |
| { |
| "key": "A String", # [Required] Name of the connection property to set. |
| "value": "A String", # [Required] Value of the connection property. |
| }, |
| ], |
| "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. |
| "createSession": True or False, # If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode. |
| "defaultDataset": { # [Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names. |
| "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| "projectId": "A String", # [Optional] The ID of the project containing this dataset. |
| }, |
| "destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys). |
| "kmsKeyName": "A String", # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. |
| }, |
| "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. This property must be set for large results that exceed the maximum response size. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "flattenResults": true, # [Optional] If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results. allowLargeResults must be true if this is set to false. For standard SQL queries, this flag is ignored and results are never flattened. |
| "maximumBillingTier": 1, # [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default. |
| "maximumBytesBilled": "A String", # [Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default. |
| "parameterMode": "A String", # Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query. |
| "preserveNulls": True or False, # [Deprecated] This property is deprecated. |
| "priority": "A String", # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE. |
| "query": "A String", # [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL. |
| "queryParameters": [ # Query parameters for standard SQL queries. |
| { |
| "name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query. |
| "parameterType": { # [Required] The type of this parameter. |
| "arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array. |
| "structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct. |
| { |
| "description": "A String", # [Optional] Human-oriented description of the field. |
| "name": "A String", # [Optional] The name of this field. |
| "type": # Object with schema name: QueryParameterType # [Required] The type of this field. |
| }, |
| ], |
| "type": "A String", # [Required] The top level type of this field. |
| }, |
| "parameterValue": { # [Required] The value of this parameter. |
| "arrayValues": [ # [Optional] The array values, if this is an array type. |
| # Object with schema name: QueryParameterValue |
| ], |
| "structValues": { # [Optional] The struct field values, in order of the struct type's declaration. |
| "a_key": # Object with schema name: QueryParameterValue |
| }, |
| "value": "A String", # [Optional] The value of this value, if a simple scalar type. |
| }, |
| }, |
| ], |
| "rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified. |
| "field": "A String", # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64. |
| "range": { # [TrustedTester] [Required] Defines the ranges for range partitioning. |
| "end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive. |
| "interval": "A String", # [TrustedTester] [Required] The width of each interval. |
| "start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive. |
| }, |
| }, |
| "schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. |
| "A String", |
| ], |
| "tableDefinitions": { # [Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. |
| "a_key": { |
| "autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored. |
| "avroOptions": { # Additional properties to set if sourceFormat is set to Avro. |
| "useAvroLogicalTypes": True or False, # [Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER). |
| }, |
| "bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE. |
| "columnFamilies": [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable. |
| { |
| "columns": [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field. |
| { |
| "encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels. |
| "fieldName": "A String", # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries. |
| "onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels. |
| "qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name. |
| "qualifierString": "A String", |
| "type": "A String", # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels. |
| }, |
| ], |
| "encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it. |
| "familyId": "A String", # Identifier of the column family. |
| "onlyReadLatest": True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column. |
| "type": "A String", # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it. |
| }, |
| ], |
| "ignoreUnspecifiedColumnFamilies": True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false. |
| "readRowkeyAsString": True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false. |
| }, |
| "compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats. |
| "connectionId": "A String", # [Optional, Trusted Tester] Connection for external data source. |
| "csvOptions": { # Additional properties to set if sourceFormat is set to CSV. |
| "allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. |
| "allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. |
| "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. |
| "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). |
| "null_marker": "A String", # [Optional] An custom string that will represent a NULL value in CSV import data. |
| "quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. |
| "skipLeadingRows": "A String", # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema. |
| }, |
| "decimalTargetTypes": [ # [Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. |
| "A String", |
| ], |
| "googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS. |
| "range": "A String", # [Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20 |
| "skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema. |
| }, |
| "hivePartitioningOptions": { # [Optional] Options to configure hive partitioning support. |
| "mode": "A String", # [Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet. |
| "requirePartitionFilter": True or False, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail. |
| "sourceUriPrefix": "A String", # [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter). |
| }, |
| "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored. |
| "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats. |
| "parquetOptions": { # Additional properties to set if sourceFormat is set to Parquet. |
| "enableListInference": True or False, # [Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type. |
| "enumAsString": True or False, # [Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default. |
| }, |
| "schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats. |
| "fields": [ # Describes the fields in a table. |
| { |
| "categories": { # [Optional] The categories attached to this field, used for field-level access control. |
| "names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed. |
| "A String", |
| ], |
| }, |
| "collationSpec": "A String", # Optional. Collation specification of the field. It only can be set on string type field. |
| "description": "A String", # [Optional] The field description. The maximum length is 1,024 characters. |
| "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD. |
| # Object with schema name: TableFieldSchema |
| ], |
| "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". |
| "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. |
| "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. |
| "policyTags": { |
| "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. |
| "A String", |
| ], |
| }, |
| "precision": "A String", # [Optional] Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: - Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: - If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. - If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): - If type = "NUMERIC": 1 ≤ precision ≤ 29. - If type = "BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid. |
| "scale": "A String", # [Optional] See documentation for precision. |
| "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, INTERVAL, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD). |
| }, |
| ], |
| }, |
| "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE". |
| "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed. |
| "A String", |
| ], |
| }, |
| }, |
| "timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. |
| "expirationMs": "A String", # [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value. |
| "field": "A String", # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED. |
| "requirePartitionFilter": True or False, |
| "type": "A String", # [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY. |
| }, |
| "useLegacySql": true, # Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false. |
| "useQueryCache": true, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true. |
| "userDefinedFunctionResources": [ # Describes user-defined function resources used in the query. |
| { # This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of Standard SQL should leverage either DDL (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions |
| "inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code. |
| "resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path). |
| }, |
| ], |
| "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. |
| }, |
| }, |
| "etag": "A String", # [Output-only] A hash of this resource. |
| "id": "A String", # [Output-only] Opaque ID field of the job |
| "jobReference": { # [Optional] Reference describing the unique-per-user name of the job. |
| "jobId": "A String", # [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters. |
| "location": "A String", # The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location. |
| "projectId": "A String", # [Required] The ID of the project containing this job. |
| }, |
| "kind": "bigquery#job", # [Output-only] The type of the resource. |
| "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again. |
| "statistics": { # [Output-only] Information about the job, including starting time and ending time of the job. |
| "completionRatio": 3.14, # [TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs. |
| "creationTime": "A String", # [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs. |
| "endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state. |
| "extract": { # [Output-only] Statistics for an extract job. |
| "destinationUriFileCounts": [ # [Output-only] Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field. |
| "A String", |
| ], |
| "inputBytes": "A String", # [Output-only] Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes. |
| }, |
| "load": { # [Output-only] Statistics for a load job. |
| "badRecords": "A String", # [Output-only] The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data. |
| "inputFileBytes": "A String", # [Output-only] Number of bytes of source data in a load job. |
| "inputFiles": "A String", # [Output-only] Number of source files in a load job. |
| "outputBytes": "A String", # [Output-only] Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change. |
| "outputRows": "A String", # [Output-only] Number of rows imported in a load job. Note that while an import job is in the running state, this value may change. |
| }, |
| "numChildJobs": "A String", # [Output-only] Number of child jobs executed. |
| "parentJobId": "A String", # [Output-only] If this is a child job, the id of the parent. |
| "query": { # [Output-only] Statistics for a query job. |
| "biEngineStatistics": { # BI Engine specific Statistics. [Output-only] BI Engine specific Statistics. |
| "biEngineMode": "$(stats.bi_engine_mode)", # [Output-only] Specifies which mode of BI Engine acceleration was performed (if any). |
| "biEngineReasons": [ # In case of DISABLED or PARTIAL bi_engine_mode, these contain the explanatory reasons as to why BI Engine could not accelerate. In case the full query was accelerated, this field is not populated. |
| { |
| "code": "$(reason.code)", # [Output-only] High-level BI Engine reason for partial or disabled acceleration. |
| "message": "$(reason.message)", # [Output-only] Free form human-readable reason for partial or disabled acceleration. |
| }, |
| ], |
| }, |
| "billingTier": 42, # [Output-only] Billing tier for the job. |
| "cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache. |
| "ddlAffectedRowAccessPolicyCount": "A String", # [Output-only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries. |
| "ddlDestinationTable": { # [Output-only] The DDL destination table. Present only for ALTER TABLE RENAME TO queries. Note that ddl_target_table is used just for its type information. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "ddlOperationPerformed": "A String", # The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target. |
| "ddlTargetDataset": { # [Output-only] The DDL target dataset. Present only for CREATE/ALTER/DROP SCHEMA queries. |
| "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| "projectId": "A String", # [Optional] The ID of the project containing this dataset. |
| }, |
| "ddlTargetRoutine": { # The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this routine. |
| "projectId": "A String", # [Required] The ID of the project containing this routine. |
| "routineId": "A String", # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. |
| }, |
| "ddlTargetRowAccessPolicy": { # [Output-only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this row access policy. |
| "policyId": "A String", # [Required] The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. |
| "projectId": "A String", # [Required] The ID of the project containing this row access policy. |
| "tableId": "A String", # [Required] The ID of the table containing this row access policy. |
| }, |
| "ddlTargetTable": { # [Output-only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "dmlStats": { # [Output-only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE. |
| "deletedRowCount": "A String", # Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements. |
| "insertedRowCount": "A String", # Number of inserted Rows. Populated by DML INSERT and MERGE statements. |
| "updatedRowCount": "A String", # Number of updated Rows. Populated by DML UPDATE and MERGE statements. |
| }, |
| "estimatedBytesProcessed": "A String", # [Output-only] The original estimate of bytes processed for the job. |
| "mlStatistics": { # [Output-only] Statistics of a BigQuery ML training job. |
| "iterationResults": [ # Results for all completed iterations. |
| { |
| "durationMs": "A String", # Time taken to run the iteration in milliseconds. |
| "evalLoss": 3.14, # Loss computed on the eval data at the end of iteration. |
| "index": 42, # Index of the iteration, 0 based. |
| "learnRate": 3.14, # Learn rate used for this iteration. |
| "trainingLoss": 3.14, # Loss computed on the training data at the end of iteration. |
| }, |
| ], |
| "maxIterations": "A String", # Maximum number of iterations specified as max_iterations in the 'CREATE MODEL' query. The actual number of iterations may be less than this number due to early stop. |
| }, |
| "modelTraining": { # [Output-only, Beta] Information about create model query job progress. |
| "currentIteration": 42, # [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress. |
| "expectedTotalIterations": "A String", # [Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop. |
| }, |
| "modelTrainingCurrentIteration": 42, # [Output-only, Beta] Deprecated; do not use. |
| "modelTrainingExpectedTotalIteration": "A String", # [Output-only, Beta] Deprecated; do not use. |
| "numDmlAffectedRows": "A String", # [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. |
| "queryPlan": [ # [Output-only] Describes execution plan for the query. |
| { |
| "completedParallelInputs": "A String", # Number of parallel input segments completed. |
| "computeMsAvg": "A String", # Milliseconds the average shard spent on CPU-bound tasks. |
| "computeMsMax": "A String", # Milliseconds the slowest shard spent on CPU-bound tasks. |
| "computeRatioAvg": 3.14, # Relative amount of time the average shard spent on CPU-bound tasks. |
| "computeRatioMax": 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks. |
| "endMs": "A String", # Stage end time represented as milliseconds since epoch. |
| "id": "A String", # Unique ID for stage within plan. |
| "inputStages": [ # IDs for stages that are inputs to this stage. |
| "A String", |
| ], |
| "name": "A String", # Human-readable name for stage. |
| "parallelInputs": "A String", # Number of parallel input segments to be processed. |
| "readMsAvg": "A String", # Milliseconds the average shard spent reading input. |
| "readMsMax": "A String", # Milliseconds the slowest shard spent reading input. |
| "readRatioAvg": 3.14, # Relative amount of time the average shard spent reading input. |
| "readRatioMax": 3.14, # Relative amount of time the slowest shard spent reading input. |
| "recordsRead": "A String", # Number of records read into the stage. |
| "recordsWritten": "A String", # Number of records written by the stage. |
| "shuffleOutputBytes": "A String", # Total number of bytes written to shuffle. |
| "shuffleOutputBytesSpilled": "A String", # Total number of bytes written to shuffle and spilled to disk. |
| "slotMs": "A String", # Slot-milliseconds used by the stage. |
| "startMs": "A String", # Stage start time represented as milliseconds since epoch. |
| "status": "A String", # Current status for the stage. |
| "steps": [ # List of operations within the stage in dependency order (approximately chronological). |
| { |
| "kind": "A String", # Machine-readable operation type. |
| "substeps": [ # Human-readable stage descriptions. |
| "A String", |
| ], |
| }, |
| ], |
| "waitMsAvg": "A String", # Milliseconds the average shard spent waiting to be scheduled. |
| "waitMsMax": "A String", # Milliseconds the slowest shard spent waiting to be scheduled. |
| "waitRatioAvg": 3.14, # Relative amount of time the average shard spent waiting to be scheduled. |
| "waitRatioMax": 3.14, # Relative amount of time the slowest shard spent waiting to be scheduled. |
| "writeMsAvg": "A String", # Milliseconds the average shard spent on writing output. |
| "writeMsMax": "A String", # Milliseconds the slowest shard spent on writing output. |
| "writeRatioAvg": 3.14, # Relative amount of time the average shard spent on writing output. |
| "writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output. |
| }, |
| ], |
| "referencedRoutines": [ # [Output-only] Referenced routines (persistent user-defined functions and stored procedures) for the job. |
| { |
| "datasetId": "A String", # [Required] The ID of the dataset containing this routine. |
| "projectId": "A String", # [Required] The ID of the project containing this routine. |
| "routineId": "A String", # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. |
| }, |
| ], |
| "referencedTables": [ # [Output-only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list. |
| { |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| ], |
| "reservationUsage": [ # [Output-only] Job resource usage breakdown by reservation. |
| { |
| "name": "A String", # [Output-only] Reservation name or "unreserved" for on-demand resources usage. |
| "slotMs": "A String", # [Output-only] Slot-milliseconds the job spent in the given reservation. |
| }, |
| ], |
| "schema": { # [Output-only] The schema of the results. Present only for successful dry run of non-legacy SQL queries. |
| "fields": [ # Describes the fields in a table. |
| { |
| "categories": { # [Optional] The categories attached to this field, used for field-level access control. |
| "names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed. |
| "A String", |
| ], |
| }, |
| "collationSpec": "A String", # Optional. Collation specification of the field. It only can be set on string type field. |
| "description": "A String", # [Optional] The field description. The maximum length is 1,024 characters. |
| "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD. |
| # Object with schema name: TableFieldSchema |
| ], |
| "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". |
| "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. |
| "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. |
| "policyTags": { |
| "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. |
| "A String", |
| ], |
| }, |
| "precision": "A String", # [Optional] Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: - Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: - If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. - If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): - If type = "NUMERIC": 1 ≤ precision ≤ 29. - If type = "BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid. |
| "scale": "A String", # [Optional] See documentation for precision. |
| "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, INTERVAL, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD). |
| }, |
| ], |
| }, |
| "statementType": "A String", # The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "ASSERT": ASSERT condition AS 'description'. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query. |
| "timeline": [ # [Output-only] [Beta] Describes a timeline of job execution. |
| { |
| "activeUnits": "A String", # Total number of units currently being processed by workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample. |
| "completedUnits": "A String", # Total parallel units of work completed by this query. |
| "elapsedMs": "A String", # Milliseconds elapsed since the start of query execution. |
| "pendingUnits": "A String", # Total parallel units of work remaining for the active stages. |
| "totalSlotMs": "A String", # Cumulative slot-ms consumed by the query. |
| }, |
| ], |
| "totalBytesBilled": "A String", # [Output-only] Total bytes billed for the job. |
| "totalBytesProcessed": "A String", # [Output-only] Total bytes processed for the job. |
| "totalBytesProcessedAccuracy": "A String", # [Output-only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost. |
| "totalPartitionsProcessed": "A String", # [Output-only] Total number of partitions processed from all partitioned tables referenced in the job. |
| "totalSlotMs": "A String", # [Output-only] Slot-milliseconds for the job. |
| "undeclaredQueryParameters": [ # Standard SQL only: list of undeclared query parameters detected during a dry run validation. |
| { |
| "name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query. |
| "parameterType": { # [Required] The type of this parameter. |
| "arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array. |
| "structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct. |
| { |
| "description": "A String", # [Optional] Human-oriented description of the field. |
| "name": "A String", # [Optional] The name of this field. |
| "type": # Object with schema name: QueryParameterType # [Required] The type of this field. |
| }, |
| ], |
| "type": "A String", # [Required] The top level type of this field. |
| }, |
| "parameterValue": { # [Required] The value of this parameter. |
| "arrayValues": [ # [Optional] The array values, if this is an array type. |
| # Object with schema name: QueryParameterValue |
| ], |
| "structValues": { # [Optional] The struct field values, in order of the struct type's declaration. |
| "a_key": # Object with schema name: QueryParameterValue |
| }, |
| "value": "A String", # [Optional] The value of this value, if a simple scalar type. |
| }, |
| }, |
| ], |
| }, |
| "quotaDeferments": [ # [Output-only] Quotas which delayed this job's start time. |
| "A String", |
| ], |
| "reservationUsage": [ # [Output-only] Job resource usage breakdown by reservation. |
| { |
| "name": "A String", # [Output-only] Reservation name or "unreserved" for on-demand resources usage. |
| "slotMs": "A String", # [Output-only] Slot-milliseconds the job spent in the given reservation. |
| }, |
| ], |
| "reservation_id": "A String", # [Output-only] Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job. |
| "rowLevelSecurityStatistics": { # [Output-only] [Preview] Statistics for row-level security. Present only for query and extract jobs. |
| "rowLevelSecurityApplied": True or False, # [Output-only] [Preview] Whether any accessed data was protected by row access policies. |
| }, |
| "scriptStatistics": { # [Output-only] Statistics for a child job of a script. |
| "evaluationKind": "A String", # [Output-only] Whether this child job was a statement or expression. |
| "stackFrames": [ # Stack trace showing the line/column/procedure name of each frame on the stack at the point where the current evaluation happened. The leaf frame is first, the primary script is last. Never empty. |
| { |
| "endColumn": 42, # [Output-only] One-based end column. |
| "endLine": 42, # [Output-only] One-based end line. |
| "procedureId": "A String", # [Output-only] Name of the active procedure, empty if in a top-level script. |
| "startColumn": 42, # [Output-only] One-based start column. |
| "startLine": 42, # [Output-only] One-based start line. |
| "text": "A String", # [Output-only] Text of the current statement/expression. |
| }, |
| ], |
| }, |
| "sessionInfo": { # [Output-only] [Preview] Information of the session if this job is part of one. |
| "sessionId": "A String", # [Output-only] // [Preview] Id of the session. |
| }, |
| "startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE. |
| "totalBytesProcessed": "A String", # [Output-only] [Deprecated] Use the bytes processed in the query statistics instead. |
| "totalSlotMs": "A String", # [Output-only] Slot-milliseconds for the job. |
| "transactionInfo": { # [Output-only] [Alpha] Information of the multi-statement transaction if this job is part of one. |
| "transactionId": "A String", # [Output-only] // [Alpha] Id of the transaction. |
| }, |
| }, |
| "status": { # [Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete. |
| "errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful. |
| "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used. |
| "location": "A String", # Specifies where the error occurred, if present. |
| "message": "A String", # A human-readable description of the error. |
| "reason": "A String", # A short error code that summarizes the error. |
| }, |
| "errors": [ # [Output-only] The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful. |
| { |
| "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used. |
| "location": "A String", # Specifies where the error occurred, if present. |
| "message": "A String", # A human-readable description of the error. |
| "reason": "A String", # A short error code that summarizes the error. |
| }, |
| ], |
| "state": "A String", # [Output-only] Running state of the job. |
| }, |
| "user_email": "A String", # [Output-only] Email address of the user who ran the job. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="getQueryResults">getQueryResults(projectId, jobId, location=None, maxResults=None, pageToken=None, startIndex=None, timeoutMs=None)</code> |
| <pre>Retrieves the results of a query job. |
| |
| Args: |
| projectId: string, [Required] Project ID of the query job (required) |
| jobId: string, [Required] Job ID of the query job (required) |
| location: string, The geographic location where the job should run. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location. |
| maxResults: integer, Maximum number of results to read |
| pageToken: string, Page token, returned by a previous call, to request the next page of results |
| startIndex: string, Zero-based index of the starting row |
| timeoutMs: integer, How long to wait for the query to complete, in milliseconds, before returning. Default is 10 seconds. If the timeout passes before the job completes, the 'jobComplete' field in the response will be false |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "cacheHit": True or False, # Whether the query result was fetched from the query cache. |
| "errors": [ # [Output-only] The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful. |
| { |
| "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used. |
| "location": "A String", # Specifies where the error occurred, if present. |
| "message": "A String", # A human-readable description of the error. |
| "reason": "A String", # A short error code that summarizes the error. |
| }, |
| ], |
| "etag": "A String", # A hash of this response. |
| "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. |
| "jobReference": { # Reference to the BigQuery 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). |
| "jobId": "A String", # [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters. |
| "location": "A String", # The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location. |
| "projectId": "A String", # [Required] The ID of the project containing this job. |
| }, |
| "kind": "bigquery#getQueryResultsResponse", # The resource type of the response. |
| "numDmlAffectedRows": "A String", # [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. |
| "pageToken": "A String", # A token used for paging results. |
| "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. |
| { |
| "f": [ # Represents a single row in the result set, consisting of one or more fields. |
| { |
| "v": "", |
| }, |
| ], |
| }, |
| ], |
| "schema": { # The schema of the results. Present only when the query completes successfully. |
| "fields": [ # Describes the fields in a table. |
| { |
| "categories": { # [Optional] The categories attached to this field, used for field-level access control. |
| "names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed. |
| "A String", |
| ], |
| }, |
| "collationSpec": "A String", # Optional. Collation specification of the field. It only can be set on string type field. |
| "description": "A String", # [Optional] The field description. The maximum length is 1,024 characters. |
| "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD. |
| # Object with schema name: TableFieldSchema |
| ], |
| "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". |
| "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. |
| "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. |
| "policyTags": { |
| "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. |
| "A String", |
| ], |
| }, |
| "precision": "A String", # [Optional] Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: - Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: - If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. - If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): - If type = "NUMERIC": 1 ≤ precision ≤ 29. - If type = "BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid. |
| "scale": "A String", # [Optional] See documentation for precision. |
| "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, INTERVAL, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD). |
| }, |
| ], |
| }, |
| "totalBytesProcessed": "A String", # The total number of bytes processed for this query. |
| "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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="getQueryResults_next">getQueryResults_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="insert">insert(projectId, body=None, media_body=None, media_mime_type=None)</code> |
| <pre>Starts a new asynchronous job. Requires the Can View project role. |
| |
| Args: |
| projectId: string, Project ID of the project that will be billed for the job (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "configuration": { # [Required] Describes the job configuration. |
| "copy": { # [Pick one] Copies a table. |
| "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. |
| "destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys). |
| "kmsKeyName": "A String", # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. |
| }, |
| "destinationExpirationTime": "", # [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed. |
| "destinationTable": { # [Required] The destination table |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "operationType": "A String", # [Optional] Supported operation types in table copy job. |
| "sourceTable": { # [Pick one] Source table to copy. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "sourceTables": [ # [Pick one] Source tables to copy. |
| { |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| ], |
| "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. |
| }, |
| "dryRun": True or False, # [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined. |
| "extract": { # [Pick one] Configures an extract job. |
| "compression": "A String", # [Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models. |
| "destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL. |
| "destinationUri": "A String", # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written. |
| "destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written. |
| "A String", |
| ], |
| "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models. |
| "printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models. |
| "sourceModel": { # A reference to the model being exported. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this model. |
| "modelId": "A String", # [Required] The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| "projectId": "A String", # [Required] The ID of the project containing this model. |
| }, |
| "sourceTable": { # A reference to the table being exported. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "useAvroLogicalTypes": True or False, # [Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models. |
| }, |
| "jobTimeoutMs": "A String", # [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job. |
| "jobType": "A String", # [Output-only] The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN. |
| "labels": { # The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key. |
| "a_key": "A String", |
| }, |
| "load": { # [Pick one] Configures a load job. |
| "allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats. |
| "allowQuotedNewlines": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. |
| "autodetect": True or False, # [Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources. |
| "clustering": { # [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered. |
| "fields": [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data. |
| "A String", |
| ], |
| }, |
| "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. |
| "decimalTargetTypes": [ # [Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. |
| "A String", |
| ], |
| "destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys). |
| "kmsKeyName": "A String", # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. |
| }, |
| "destinationTable": { # [Required] The destination table to load the data into. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "destinationTableProperties": { # [Beta] [Optional] Properties with which to create the destination table if it is new. |
| "description": "A String", # [Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail. |
| "expirationTime": "A String", # [Internal] This field is for Google internal use only. |
| "friendlyName": "A String", # [Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail. |
| "labels": { # [Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail. |
| "a_key": "A String", |
| }, |
| }, |
| "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. |
| "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). |
| "hivePartitioningOptions": { # [Optional] Options to configure hive partitioning support. |
| "mode": "A String", # [Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet. |
| "requirePartitionFilter": True or False, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail. |
| "sourceUriPrefix": "A String", # [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter). |
| }, |
| "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names |
| "jsonExtension": "A String", # [Optional] If sourceFormat is set to newline-delimited JSON, indicates whether it should be processed as a JSON variant such as GeoJSON. For a sourceFormat other than JSON, omit this field. If the sourceFormat is newline-delimited JSON: - for newline-delimited GeoJSON: set to GEOJSON. |
| "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid. |
| "nullMarker": "A String", # [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value. |
| "parquetOptions": { # [Optional] Options to configure parquet support. |
| "enableListInference": True or False, # [Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type. |
| "enumAsString": True or False, # [Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default. |
| }, |
| "projectionFields": [ # If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result. |
| "A String", |
| ], |
| "quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. |
| "rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified. |
| "field": "A String", # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64. |
| "range": { # [TrustedTester] [Required] Defines the ranges for range partitioning. |
| "end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive. |
| "interval": "A String", # [TrustedTester] [Required] The width of each interval. |
| "start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive. |
| }, |
| }, |
| "schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore. |
| "fields": [ # Describes the fields in a table. |
| { |
| "categories": { # [Optional] The categories attached to this field, used for field-level access control. |
| "names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed. |
| "A String", |
| ], |
| }, |
| "collationSpec": "A String", # Optional. Collation specification of the field. It only can be set on string type field. |
| "description": "A String", # [Optional] The field description. The maximum length is 1,024 characters. |
| "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD. |
| # Object with schema name: TableFieldSchema |
| ], |
| "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". |
| "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. |
| "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. |
| "policyTags": { |
| "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. |
| "A String", |
| ], |
| }, |
| "precision": "A String", # [Optional] Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: - Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: - If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. - If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): - If type = "NUMERIC": 1 ≤ precision ≤ 29. - If type = "BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid. |
| "scale": "A String", # [Optional] See documentation for precision. |
| "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, INTERVAL, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD). |
| }, |
| ], |
| }, |
| "schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT". |
| "schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property. |
| "schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. |
| "A String", |
| ], |
| "skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. |
| "sourceFormat": "A String", # [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV. |
| "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '*' wildcard character is not allowed. |
| "A String", |
| ], |
| "timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. |
| "expirationMs": "A String", # [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value. |
| "field": "A String", # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED. |
| "requirePartitionFilter": True or False, |
| "type": "A String", # [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY. |
| }, |
| "useAvroLogicalTypes": True or False, # [Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER). |
| "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. |
| }, |
| "query": { # [Pick one] Configures a query job. |
| "allowLargeResults": false, # [Optional] If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For standard SQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size. |
| "clustering": { # [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered. |
| "fields": [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data. |
| "A String", |
| ], |
| }, |
| "connectionProperties": [ # Connection properties. |
| { |
| "key": "A String", # [Required] Name of the connection property to set. |
| "value": "A String", # [Required] Value of the connection property. |
| }, |
| ], |
| "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. |
| "createSession": True or False, # If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode. |
| "defaultDataset": { # [Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names. |
| "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| "projectId": "A String", # [Optional] The ID of the project containing this dataset. |
| }, |
| "destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys). |
| "kmsKeyName": "A String", # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. |
| }, |
| "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. This property must be set for large results that exceed the maximum response size. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "flattenResults": true, # [Optional] If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results. allowLargeResults must be true if this is set to false. For standard SQL queries, this flag is ignored and results are never flattened. |
| "maximumBillingTier": 1, # [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default. |
| "maximumBytesBilled": "A String", # [Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default. |
| "parameterMode": "A String", # Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query. |
| "preserveNulls": True or False, # [Deprecated] This property is deprecated. |
| "priority": "A String", # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE. |
| "query": "A String", # [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL. |
| "queryParameters": [ # Query parameters for standard SQL queries. |
| { |
| "name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query. |
| "parameterType": { # [Required] The type of this parameter. |
| "arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array. |
| "structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct. |
| { |
| "description": "A String", # [Optional] Human-oriented description of the field. |
| "name": "A String", # [Optional] The name of this field. |
| "type": # Object with schema name: QueryParameterType # [Required] The type of this field. |
| }, |
| ], |
| "type": "A String", # [Required] The top level type of this field. |
| }, |
| "parameterValue": { # [Required] The value of this parameter. |
| "arrayValues": [ # [Optional] The array values, if this is an array type. |
| # Object with schema name: QueryParameterValue |
| ], |
| "structValues": { # [Optional] The struct field values, in order of the struct type's declaration. |
| "a_key": # Object with schema name: QueryParameterValue |
| }, |
| "value": "A String", # [Optional] The value of this value, if a simple scalar type. |
| }, |
| }, |
| ], |
| "rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified. |
| "field": "A String", # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64. |
| "range": { # [TrustedTester] [Required] Defines the ranges for range partitioning. |
| "end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive. |
| "interval": "A String", # [TrustedTester] [Required] The width of each interval. |
| "start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive. |
| }, |
| }, |
| "schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. |
| "A String", |
| ], |
| "tableDefinitions": { # [Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. |
| "a_key": { |
| "autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored. |
| "avroOptions": { # Additional properties to set if sourceFormat is set to Avro. |
| "useAvroLogicalTypes": True or False, # [Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER). |
| }, |
| "bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE. |
| "columnFamilies": [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable. |
| { |
| "columns": [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field. |
| { |
| "encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels. |
| "fieldName": "A String", # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries. |
| "onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels. |
| "qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name. |
| "qualifierString": "A String", |
| "type": "A String", # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels. |
| }, |
| ], |
| "encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it. |
| "familyId": "A String", # Identifier of the column family. |
| "onlyReadLatest": True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column. |
| "type": "A String", # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it. |
| }, |
| ], |
| "ignoreUnspecifiedColumnFamilies": True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false. |
| "readRowkeyAsString": True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false. |
| }, |
| "compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats. |
| "connectionId": "A String", # [Optional, Trusted Tester] Connection for external data source. |
| "csvOptions": { # Additional properties to set if sourceFormat is set to CSV. |
| "allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. |
| "allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. |
| "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. |
| "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). |
| "null_marker": "A String", # [Optional] An custom string that will represent a NULL value in CSV import data. |
| "quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. |
| "skipLeadingRows": "A String", # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema. |
| }, |
| "decimalTargetTypes": [ # [Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. |
| "A String", |
| ], |
| "googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS. |
| "range": "A String", # [Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20 |
| "skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema. |
| }, |
| "hivePartitioningOptions": { # [Optional] Options to configure hive partitioning support. |
| "mode": "A String", # [Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet. |
| "requirePartitionFilter": True or False, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail. |
| "sourceUriPrefix": "A String", # [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter). |
| }, |
| "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored. |
| "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats. |
| "parquetOptions": { # Additional properties to set if sourceFormat is set to Parquet. |
| "enableListInference": True or False, # [Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type. |
| "enumAsString": True or False, # [Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default. |
| }, |
| "schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats. |
| "fields": [ # Describes the fields in a table. |
| { |
| "categories": { # [Optional] The categories attached to this field, used for field-level access control. |
| "names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed. |
| "A String", |
| ], |
| }, |
| "collationSpec": "A String", # Optional. Collation specification of the field. It only can be set on string type field. |
| "description": "A String", # [Optional] The field description. The maximum length is 1,024 characters. |
| "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD. |
| # Object with schema name: TableFieldSchema |
| ], |
| "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". |
| "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. |
| "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. |
| "policyTags": { |
| "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. |
| "A String", |
| ], |
| }, |
| "precision": "A String", # [Optional] Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: - Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: - If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. - If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): - If type = "NUMERIC": 1 ≤ precision ≤ 29. - If type = "BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid. |
| "scale": "A String", # [Optional] See documentation for precision. |
| "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, INTERVAL, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD). |
| }, |
| ], |
| }, |
| "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE". |
| "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed. |
| "A String", |
| ], |
| }, |
| }, |
| "timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. |
| "expirationMs": "A String", # [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value. |
| "field": "A String", # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED. |
| "requirePartitionFilter": True or False, |
| "type": "A String", # [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY. |
| }, |
| "useLegacySql": true, # Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false. |
| "useQueryCache": true, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true. |
| "userDefinedFunctionResources": [ # Describes user-defined function resources used in the query. |
| { # This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of Standard SQL should leverage either DDL (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions |
| "inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code. |
| "resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path). |
| }, |
| ], |
| "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. |
| }, |
| }, |
| "etag": "A String", # [Output-only] A hash of this resource. |
| "id": "A String", # [Output-only] Opaque ID field of the job |
| "jobReference": { # [Optional] Reference describing the unique-per-user name of the job. |
| "jobId": "A String", # [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters. |
| "location": "A String", # The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location. |
| "projectId": "A String", # [Required] The ID of the project containing this job. |
| }, |
| "kind": "bigquery#job", # [Output-only] The type of the resource. |
| "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again. |
| "statistics": { # [Output-only] Information about the job, including starting time and ending time of the job. |
| "completionRatio": 3.14, # [TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs. |
| "creationTime": "A String", # [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs. |
| "endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state. |
| "extract": { # [Output-only] Statistics for an extract job. |
| "destinationUriFileCounts": [ # [Output-only] Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field. |
| "A String", |
| ], |
| "inputBytes": "A String", # [Output-only] Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes. |
| }, |
| "load": { # [Output-only] Statistics for a load job. |
| "badRecords": "A String", # [Output-only] The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data. |
| "inputFileBytes": "A String", # [Output-only] Number of bytes of source data in a load job. |
| "inputFiles": "A String", # [Output-only] Number of source files in a load job. |
| "outputBytes": "A String", # [Output-only] Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change. |
| "outputRows": "A String", # [Output-only] Number of rows imported in a load job. Note that while an import job is in the running state, this value may change. |
| }, |
| "numChildJobs": "A String", # [Output-only] Number of child jobs executed. |
| "parentJobId": "A String", # [Output-only] If this is a child job, the id of the parent. |
| "query": { # [Output-only] Statistics for a query job. |
| "biEngineStatistics": { # BI Engine specific Statistics. [Output-only] BI Engine specific Statistics. |
| "biEngineMode": "$(stats.bi_engine_mode)", # [Output-only] Specifies which mode of BI Engine acceleration was performed (if any). |
| "biEngineReasons": [ # In case of DISABLED or PARTIAL bi_engine_mode, these contain the explanatory reasons as to why BI Engine could not accelerate. In case the full query was accelerated, this field is not populated. |
| { |
| "code": "$(reason.code)", # [Output-only] High-level BI Engine reason for partial or disabled acceleration. |
| "message": "$(reason.message)", # [Output-only] Free form human-readable reason for partial or disabled acceleration. |
| }, |
| ], |
| }, |
| "billingTier": 42, # [Output-only] Billing tier for the job. |
| "cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache. |
| "ddlAffectedRowAccessPolicyCount": "A String", # [Output-only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries. |
| "ddlDestinationTable": { # [Output-only] The DDL destination table. Present only for ALTER TABLE RENAME TO queries. Note that ddl_target_table is used just for its type information. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "ddlOperationPerformed": "A String", # The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target. |
| "ddlTargetDataset": { # [Output-only] The DDL target dataset. Present only for CREATE/ALTER/DROP SCHEMA queries. |
| "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| "projectId": "A String", # [Optional] The ID of the project containing this dataset. |
| }, |
| "ddlTargetRoutine": { # The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this routine. |
| "projectId": "A String", # [Required] The ID of the project containing this routine. |
| "routineId": "A String", # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. |
| }, |
| "ddlTargetRowAccessPolicy": { # [Output-only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this row access policy. |
| "policyId": "A String", # [Required] The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. |
| "projectId": "A String", # [Required] The ID of the project containing this row access policy. |
| "tableId": "A String", # [Required] The ID of the table containing this row access policy. |
| }, |
| "ddlTargetTable": { # [Output-only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "dmlStats": { # [Output-only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE. |
| "deletedRowCount": "A String", # Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements. |
| "insertedRowCount": "A String", # Number of inserted Rows. Populated by DML INSERT and MERGE statements. |
| "updatedRowCount": "A String", # Number of updated Rows. Populated by DML UPDATE and MERGE statements. |
| }, |
| "estimatedBytesProcessed": "A String", # [Output-only] The original estimate of bytes processed for the job. |
| "mlStatistics": { # [Output-only] Statistics of a BigQuery ML training job. |
| "iterationResults": [ # Results for all completed iterations. |
| { |
| "durationMs": "A String", # Time taken to run the iteration in milliseconds. |
| "evalLoss": 3.14, # Loss computed on the eval data at the end of iteration. |
| "index": 42, # Index of the iteration, 0 based. |
| "learnRate": 3.14, # Learn rate used for this iteration. |
| "trainingLoss": 3.14, # Loss computed on the training data at the end of iteration. |
| }, |
| ], |
| "maxIterations": "A String", # Maximum number of iterations specified as max_iterations in the 'CREATE MODEL' query. The actual number of iterations may be less than this number due to early stop. |
| }, |
| "modelTraining": { # [Output-only, Beta] Information about create model query job progress. |
| "currentIteration": 42, # [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress. |
| "expectedTotalIterations": "A String", # [Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop. |
| }, |
| "modelTrainingCurrentIteration": 42, # [Output-only, Beta] Deprecated; do not use. |
| "modelTrainingExpectedTotalIteration": "A String", # [Output-only, Beta] Deprecated; do not use. |
| "numDmlAffectedRows": "A String", # [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. |
| "queryPlan": [ # [Output-only] Describes execution plan for the query. |
| { |
| "completedParallelInputs": "A String", # Number of parallel input segments completed. |
| "computeMsAvg": "A String", # Milliseconds the average shard spent on CPU-bound tasks. |
| "computeMsMax": "A String", # Milliseconds the slowest shard spent on CPU-bound tasks. |
| "computeRatioAvg": 3.14, # Relative amount of time the average shard spent on CPU-bound tasks. |
| "computeRatioMax": 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks. |
| "endMs": "A String", # Stage end time represented as milliseconds since epoch. |
| "id": "A String", # Unique ID for stage within plan. |
| "inputStages": [ # IDs for stages that are inputs to this stage. |
| "A String", |
| ], |
| "name": "A String", # Human-readable name for stage. |
| "parallelInputs": "A String", # Number of parallel input segments to be processed. |
| "readMsAvg": "A String", # Milliseconds the average shard spent reading input. |
| "readMsMax": "A String", # Milliseconds the slowest shard spent reading input. |
| "readRatioAvg": 3.14, # Relative amount of time the average shard spent reading input. |
| "readRatioMax": 3.14, # Relative amount of time the slowest shard spent reading input. |
| "recordsRead": "A String", # Number of records read into the stage. |
| "recordsWritten": "A String", # Number of records written by the stage. |
| "shuffleOutputBytes": "A String", # Total number of bytes written to shuffle. |
| "shuffleOutputBytesSpilled": "A String", # Total number of bytes written to shuffle and spilled to disk. |
| "slotMs": "A String", # Slot-milliseconds used by the stage. |
| "startMs": "A String", # Stage start time represented as milliseconds since epoch. |
| "status": "A String", # Current status for the stage. |
| "steps": [ # List of operations within the stage in dependency order (approximately chronological). |
| { |
| "kind": "A String", # Machine-readable operation type. |
| "substeps": [ # Human-readable stage descriptions. |
| "A String", |
| ], |
| }, |
| ], |
| "waitMsAvg": "A String", # Milliseconds the average shard spent waiting to be scheduled. |
| "waitMsMax": "A String", # Milliseconds the slowest shard spent waiting to be scheduled. |
| "waitRatioAvg": 3.14, # Relative amount of time the average shard spent waiting to be scheduled. |
| "waitRatioMax": 3.14, # Relative amount of time the slowest shard spent waiting to be scheduled. |
| "writeMsAvg": "A String", # Milliseconds the average shard spent on writing output. |
| "writeMsMax": "A String", # Milliseconds the slowest shard spent on writing output. |
| "writeRatioAvg": 3.14, # Relative amount of time the average shard spent on writing output. |
| "writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output. |
| }, |
| ], |
| "referencedRoutines": [ # [Output-only] Referenced routines (persistent user-defined functions and stored procedures) for the job. |
| { |
| "datasetId": "A String", # [Required] The ID of the dataset containing this routine. |
| "projectId": "A String", # [Required] The ID of the project containing this routine. |
| "routineId": "A String", # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. |
| }, |
| ], |
| "referencedTables": [ # [Output-only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list. |
| { |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| ], |
| "reservationUsage": [ # [Output-only] Job resource usage breakdown by reservation. |
| { |
| "name": "A String", # [Output-only] Reservation name or "unreserved" for on-demand resources usage. |
| "slotMs": "A String", # [Output-only] Slot-milliseconds the job spent in the given reservation. |
| }, |
| ], |
| "schema": { # [Output-only] The schema of the results. Present only for successful dry run of non-legacy SQL queries. |
| "fields": [ # Describes the fields in a table. |
| { |
| "categories": { # [Optional] The categories attached to this field, used for field-level access control. |
| "names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed. |
| "A String", |
| ], |
| }, |
| "collationSpec": "A String", # Optional. Collation specification of the field. It only can be set on string type field. |
| "description": "A String", # [Optional] The field description. The maximum length is 1,024 characters. |
| "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD. |
| # Object with schema name: TableFieldSchema |
| ], |
| "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". |
| "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. |
| "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. |
| "policyTags": { |
| "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. |
| "A String", |
| ], |
| }, |
| "precision": "A String", # [Optional] Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: - Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: - If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. - If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): - If type = "NUMERIC": 1 ≤ precision ≤ 29. - If type = "BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid. |
| "scale": "A String", # [Optional] See documentation for precision. |
| "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, INTERVAL, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD). |
| }, |
| ], |
| }, |
| "statementType": "A String", # The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "ASSERT": ASSERT condition AS 'description'. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query. |
| "timeline": [ # [Output-only] [Beta] Describes a timeline of job execution. |
| { |
| "activeUnits": "A String", # Total number of units currently being processed by workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample. |
| "completedUnits": "A String", # Total parallel units of work completed by this query. |
| "elapsedMs": "A String", # Milliseconds elapsed since the start of query execution. |
| "pendingUnits": "A String", # Total parallel units of work remaining for the active stages. |
| "totalSlotMs": "A String", # Cumulative slot-ms consumed by the query. |
| }, |
| ], |
| "totalBytesBilled": "A String", # [Output-only] Total bytes billed for the job. |
| "totalBytesProcessed": "A String", # [Output-only] Total bytes processed for the job. |
| "totalBytesProcessedAccuracy": "A String", # [Output-only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost. |
| "totalPartitionsProcessed": "A String", # [Output-only] Total number of partitions processed from all partitioned tables referenced in the job. |
| "totalSlotMs": "A String", # [Output-only] Slot-milliseconds for the job. |
| "undeclaredQueryParameters": [ # Standard SQL only: list of undeclared query parameters detected during a dry run validation. |
| { |
| "name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query. |
| "parameterType": { # [Required] The type of this parameter. |
| "arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array. |
| "structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct. |
| { |
| "description": "A String", # [Optional] Human-oriented description of the field. |
| "name": "A String", # [Optional] The name of this field. |
| "type": # Object with schema name: QueryParameterType # [Required] The type of this field. |
| }, |
| ], |
| "type": "A String", # [Required] The top level type of this field. |
| }, |
| "parameterValue": { # [Required] The value of this parameter. |
| "arrayValues": [ # [Optional] The array values, if this is an array type. |
| # Object with schema name: QueryParameterValue |
| ], |
| "structValues": { # [Optional] The struct field values, in order of the struct type's declaration. |
| "a_key": # Object with schema name: QueryParameterValue |
| }, |
| "value": "A String", # [Optional] The value of this value, if a simple scalar type. |
| }, |
| }, |
| ], |
| }, |
| "quotaDeferments": [ # [Output-only] Quotas which delayed this job's start time. |
| "A String", |
| ], |
| "reservationUsage": [ # [Output-only] Job resource usage breakdown by reservation. |
| { |
| "name": "A String", # [Output-only] Reservation name or "unreserved" for on-demand resources usage. |
| "slotMs": "A String", # [Output-only] Slot-milliseconds the job spent in the given reservation. |
| }, |
| ], |
| "reservation_id": "A String", # [Output-only] Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job. |
| "rowLevelSecurityStatistics": { # [Output-only] [Preview] Statistics for row-level security. Present only for query and extract jobs. |
| "rowLevelSecurityApplied": True or False, # [Output-only] [Preview] Whether any accessed data was protected by row access policies. |
| }, |
| "scriptStatistics": { # [Output-only] Statistics for a child job of a script. |
| "evaluationKind": "A String", # [Output-only] Whether this child job was a statement or expression. |
| "stackFrames": [ # Stack trace showing the line/column/procedure name of each frame on the stack at the point where the current evaluation happened. The leaf frame is first, the primary script is last. Never empty. |
| { |
| "endColumn": 42, # [Output-only] One-based end column. |
| "endLine": 42, # [Output-only] One-based end line. |
| "procedureId": "A String", # [Output-only] Name of the active procedure, empty if in a top-level script. |
| "startColumn": 42, # [Output-only] One-based start column. |
| "startLine": 42, # [Output-only] One-based start line. |
| "text": "A String", # [Output-only] Text of the current statement/expression. |
| }, |
| ], |
| }, |
| "sessionInfo": { # [Output-only] [Preview] Information of the session if this job is part of one. |
| "sessionId": "A String", # [Output-only] // [Preview] Id of the session. |
| }, |
| "startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE. |
| "totalBytesProcessed": "A String", # [Output-only] [Deprecated] Use the bytes processed in the query statistics instead. |
| "totalSlotMs": "A String", # [Output-only] Slot-milliseconds for the job. |
| "transactionInfo": { # [Output-only] [Alpha] Information of the multi-statement transaction if this job is part of one. |
| "transactionId": "A String", # [Output-only] // [Alpha] Id of the transaction. |
| }, |
| }, |
| "status": { # [Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete. |
| "errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful. |
| "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used. |
| "location": "A String", # Specifies where the error occurred, if present. |
| "message": "A String", # A human-readable description of the error. |
| "reason": "A String", # A short error code that summarizes the error. |
| }, |
| "errors": [ # [Output-only] The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful. |
| { |
| "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used. |
| "location": "A String", # Specifies where the error occurred, if present. |
| "message": "A String", # A human-readable description of the error. |
| "reason": "A String", # A short error code that summarizes the error. |
| }, |
| ], |
| "state": "A String", # [Output-only] Running state of the job. |
| }, |
| "user_email": "A String", # [Output-only] Email address of the user who ran the job. |
| } |
| |
| media_body: string, The filename of the media request body, or an instance of a MediaUpload object. |
| media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object. |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "configuration": { # [Required] Describes the job configuration. |
| "copy": { # [Pick one] Copies a table. |
| "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. |
| "destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys). |
| "kmsKeyName": "A String", # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. |
| }, |
| "destinationExpirationTime": "", # [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed. |
| "destinationTable": { # [Required] The destination table |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "operationType": "A String", # [Optional] Supported operation types in table copy job. |
| "sourceTable": { # [Pick one] Source table to copy. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "sourceTables": [ # [Pick one] Source tables to copy. |
| { |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| ], |
| "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. |
| }, |
| "dryRun": True or False, # [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined. |
| "extract": { # [Pick one] Configures an extract job. |
| "compression": "A String", # [Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models. |
| "destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL. |
| "destinationUri": "A String", # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written. |
| "destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written. |
| "A String", |
| ], |
| "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models. |
| "printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models. |
| "sourceModel": { # A reference to the model being exported. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this model. |
| "modelId": "A String", # [Required] The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| "projectId": "A String", # [Required] The ID of the project containing this model. |
| }, |
| "sourceTable": { # A reference to the table being exported. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "useAvroLogicalTypes": True or False, # [Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models. |
| }, |
| "jobTimeoutMs": "A String", # [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job. |
| "jobType": "A String", # [Output-only] The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN. |
| "labels": { # The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key. |
| "a_key": "A String", |
| }, |
| "load": { # [Pick one] Configures a load job. |
| "allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats. |
| "allowQuotedNewlines": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. |
| "autodetect": True or False, # [Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources. |
| "clustering": { # [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered. |
| "fields": [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data. |
| "A String", |
| ], |
| }, |
| "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. |
| "decimalTargetTypes": [ # [Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. |
| "A String", |
| ], |
| "destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys). |
| "kmsKeyName": "A String", # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. |
| }, |
| "destinationTable": { # [Required] The destination table to load the data into. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "destinationTableProperties": { # [Beta] [Optional] Properties with which to create the destination table if it is new. |
| "description": "A String", # [Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail. |
| "expirationTime": "A String", # [Internal] This field is for Google internal use only. |
| "friendlyName": "A String", # [Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail. |
| "labels": { # [Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail. |
| "a_key": "A String", |
| }, |
| }, |
| "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. |
| "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). |
| "hivePartitioningOptions": { # [Optional] Options to configure hive partitioning support. |
| "mode": "A String", # [Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet. |
| "requirePartitionFilter": True or False, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail. |
| "sourceUriPrefix": "A String", # [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter). |
| }, |
| "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names |
| "jsonExtension": "A String", # [Optional] If sourceFormat is set to newline-delimited JSON, indicates whether it should be processed as a JSON variant such as GeoJSON. For a sourceFormat other than JSON, omit this field. If the sourceFormat is newline-delimited JSON: - for newline-delimited GeoJSON: set to GEOJSON. |
| "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid. |
| "nullMarker": "A String", # [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value. |
| "parquetOptions": { # [Optional] Options to configure parquet support. |
| "enableListInference": True or False, # [Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type. |
| "enumAsString": True or False, # [Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default. |
| }, |
| "projectionFields": [ # If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result. |
| "A String", |
| ], |
| "quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. |
| "rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified. |
| "field": "A String", # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64. |
| "range": { # [TrustedTester] [Required] Defines the ranges for range partitioning. |
| "end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive. |
| "interval": "A String", # [TrustedTester] [Required] The width of each interval. |
| "start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive. |
| }, |
| }, |
| "schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore. |
| "fields": [ # Describes the fields in a table. |
| { |
| "categories": { # [Optional] The categories attached to this field, used for field-level access control. |
| "names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed. |
| "A String", |
| ], |
| }, |
| "collationSpec": "A String", # Optional. Collation specification of the field. It only can be set on string type field. |
| "description": "A String", # [Optional] The field description. The maximum length is 1,024 characters. |
| "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD. |
| # Object with schema name: TableFieldSchema |
| ], |
| "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". |
| "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. |
| "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. |
| "policyTags": { |
| "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. |
| "A String", |
| ], |
| }, |
| "precision": "A String", # [Optional] Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: - Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: - If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. - If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): - If type = "NUMERIC": 1 ≤ precision ≤ 29. - If type = "BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid. |
| "scale": "A String", # [Optional] See documentation for precision. |
| "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, INTERVAL, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD). |
| }, |
| ], |
| }, |
| "schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT". |
| "schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property. |
| "schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. |
| "A String", |
| ], |
| "skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. |
| "sourceFormat": "A String", # [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV. |
| "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '*' wildcard character is not allowed. |
| "A String", |
| ], |
| "timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. |
| "expirationMs": "A String", # [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value. |
| "field": "A String", # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED. |
| "requirePartitionFilter": True or False, |
| "type": "A String", # [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY. |
| }, |
| "useAvroLogicalTypes": True or False, # [Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER). |
| "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. |
| }, |
| "query": { # [Pick one] Configures a query job. |
| "allowLargeResults": false, # [Optional] If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For standard SQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size. |
| "clustering": { # [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered. |
| "fields": [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data. |
| "A String", |
| ], |
| }, |
| "connectionProperties": [ # Connection properties. |
| { |
| "key": "A String", # [Required] Name of the connection property to set. |
| "value": "A String", # [Required] Value of the connection property. |
| }, |
| ], |
| "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. |
| "createSession": True or False, # If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode. |
| "defaultDataset": { # [Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names. |
| "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| "projectId": "A String", # [Optional] The ID of the project containing this dataset. |
| }, |
| "destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys). |
| "kmsKeyName": "A String", # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. |
| }, |
| "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. This property must be set for large results that exceed the maximum response size. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "flattenResults": true, # [Optional] If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results. allowLargeResults must be true if this is set to false. For standard SQL queries, this flag is ignored and results are never flattened. |
| "maximumBillingTier": 1, # [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default. |
| "maximumBytesBilled": "A String", # [Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default. |
| "parameterMode": "A String", # Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query. |
| "preserveNulls": True or False, # [Deprecated] This property is deprecated. |
| "priority": "A String", # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE. |
| "query": "A String", # [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL. |
| "queryParameters": [ # Query parameters for standard SQL queries. |
| { |
| "name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query. |
| "parameterType": { # [Required] The type of this parameter. |
| "arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array. |
| "structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct. |
| { |
| "description": "A String", # [Optional] Human-oriented description of the field. |
| "name": "A String", # [Optional] The name of this field. |
| "type": # Object with schema name: QueryParameterType # [Required] The type of this field. |
| }, |
| ], |
| "type": "A String", # [Required] The top level type of this field. |
| }, |
| "parameterValue": { # [Required] The value of this parameter. |
| "arrayValues": [ # [Optional] The array values, if this is an array type. |
| # Object with schema name: QueryParameterValue |
| ], |
| "structValues": { # [Optional] The struct field values, in order of the struct type's declaration. |
| "a_key": # Object with schema name: QueryParameterValue |
| }, |
| "value": "A String", # [Optional] The value of this value, if a simple scalar type. |
| }, |
| }, |
| ], |
| "rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified. |
| "field": "A String", # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64. |
| "range": { # [TrustedTester] [Required] Defines the ranges for range partitioning. |
| "end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive. |
| "interval": "A String", # [TrustedTester] [Required] The width of each interval. |
| "start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive. |
| }, |
| }, |
| "schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. |
| "A String", |
| ], |
| "tableDefinitions": { # [Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. |
| "a_key": { |
| "autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored. |
| "avroOptions": { # Additional properties to set if sourceFormat is set to Avro. |
| "useAvroLogicalTypes": True or False, # [Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER). |
| }, |
| "bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE. |
| "columnFamilies": [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable. |
| { |
| "columns": [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field. |
| { |
| "encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels. |
| "fieldName": "A String", # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries. |
| "onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels. |
| "qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name. |
| "qualifierString": "A String", |
| "type": "A String", # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels. |
| }, |
| ], |
| "encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it. |
| "familyId": "A String", # Identifier of the column family. |
| "onlyReadLatest": True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column. |
| "type": "A String", # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it. |
| }, |
| ], |
| "ignoreUnspecifiedColumnFamilies": True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false. |
| "readRowkeyAsString": True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false. |
| }, |
| "compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats. |
| "connectionId": "A String", # [Optional, Trusted Tester] Connection for external data source. |
| "csvOptions": { # Additional properties to set if sourceFormat is set to CSV. |
| "allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. |
| "allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. |
| "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. |
| "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). |
| "null_marker": "A String", # [Optional] An custom string that will represent a NULL value in CSV import data. |
| "quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. |
| "skipLeadingRows": "A String", # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema. |
| }, |
| "decimalTargetTypes": [ # [Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. |
| "A String", |
| ], |
| "googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS. |
| "range": "A String", # [Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20 |
| "skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema. |
| }, |
| "hivePartitioningOptions": { # [Optional] Options to configure hive partitioning support. |
| "mode": "A String", # [Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet. |
| "requirePartitionFilter": True or False, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail. |
| "sourceUriPrefix": "A String", # [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter). |
| }, |
| "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored. |
| "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats. |
| "parquetOptions": { # Additional properties to set if sourceFormat is set to Parquet. |
| "enableListInference": True or False, # [Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type. |
| "enumAsString": True or False, # [Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default. |
| }, |
| "schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats. |
| "fields": [ # Describes the fields in a table. |
| { |
| "categories": { # [Optional] The categories attached to this field, used for field-level access control. |
| "names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed. |
| "A String", |
| ], |
| }, |
| "collationSpec": "A String", # Optional. Collation specification of the field. It only can be set on string type field. |
| "description": "A String", # [Optional] The field description. The maximum length is 1,024 characters. |
| "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD. |
| # Object with schema name: TableFieldSchema |
| ], |
| "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". |
| "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. |
| "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. |
| "policyTags": { |
| "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. |
| "A String", |
| ], |
| }, |
| "precision": "A String", # [Optional] Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: - Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: - If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. - If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): - If type = "NUMERIC": 1 ≤ precision ≤ 29. - If type = "BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid. |
| "scale": "A String", # [Optional] See documentation for precision. |
| "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, INTERVAL, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD). |
| }, |
| ], |
| }, |
| "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE". |
| "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed. |
| "A String", |
| ], |
| }, |
| }, |
| "timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. |
| "expirationMs": "A String", # [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value. |
| "field": "A String", # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED. |
| "requirePartitionFilter": True or False, |
| "type": "A String", # [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY. |
| }, |
| "useLegacySql": true, # Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false. |
| "useQueryCache": true, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true. |
| "userDefinedFunctionResources": [ # Describes user-defined function resources used in the query. |
| { # This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of Standard SQL should leverage either DDL (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions |
| "inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code. |
| "resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path). |
| }, |
| ], |
| "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. |
| }, |
| }, |
| "etag": "A String", # [Output-only] A hash of this resource. |
| "id": "A String", # [Output-only] Opaque ID field of the job |
| "jobReference": { # [Optional] Reference describing the unique-per-user name of the job. |
| "jobId": "A String", # [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters. |
| "location": "A String", # The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location. |
| "projectId": "A String", # [Required] The ID of the project containing this job. |
| }, |
| "kind": "bigquery#job", # [Output-only] The type of the resource. |
| "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again. |
| "statistics": { # [Output-only] Information about the job, including starting time and ending time of the job. |
| "completionRatio": 3.14, # [TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs. |
| "creationTime": "A String", # [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs. |
| "endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state. |
| "extract": { # [Output-only] Statistics for an extract job. |
| "destinationUriFileCounts": [ # [Output-only] Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field. |
| "A String", |
| ], |
| "inputBytes": "A String", # [Output-only] Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes. |
| }, |
| "load": { # [Output-only] Statistics for a load job. |
| "badRecords": "A String", # [Output-only] The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data. |
| "inputFileBytes": "A String", # [Output-only] Number of bytes of source data in a load job. |
| "inputFiles": "A String", # [Output-only] Number of source files in a load job. |
| "outputBytes": "A String", # [Output-only] Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change. |
| "outputRows": "A String", # [Output-only] Number of rows imported in a load job. Note that while an import job is in the running state, this value may change. |
| }, |
| "numChildJobs": "A String", # [Output-only] Number of child jobs executed. |
| "parentJobId": "A String", # [Output-only] If this is a child job, the id of the parent. |
| "query": { # [Output-only] Statistics for a query job. |
| "biEngineStatistics": { # BI Engine specific Statistics. [Output-only] BI Engine specific Statistics. |
| "biEngineMode": "$(stats.bi_engine_mode)", # [Output-only] Specifies which mode of BI Engine acceleration was performed (if any). |
| "biEngineReasons": [ # In case of DISABLED or PARTIAL bi_engine_mode, these contain the explanatory reasons as to why BI Engine could not accelerate. In case the full query was accelerated, this field is not populated. |
| { |
| "code": "$(reason.code)", # [Output-only] High-level BI Engine reason for partial or disabled acceleration. |
| "message": "$(reason.message)", # [Output-only] Free form human-readable reason for partial or disabled acceleration. |
| }, |
| ], |
| }, |
| "billingTier": 42, # [Output-only] Billing tier for the job. |
| "cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache. |
| "ddlAffectedRowAccessPolicyCount": "A String", # [Output-only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries. |
| "ddlDestinationTable": { # [Output-only] The DDL destination table. Present only for ALTER TABLE RENAME TO queries. Note that ddl_target_table is used just for its type information. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "ddlOperationPerformed": "A String", # The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target. |
| "ddlTargetDataset": { # [Output-only] The DDL target dataset. Present only for CREATE/ALTER/DROP SCHEMA queries. |
| "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| "projectId": "A String", # [Optional] The ID of the project containing this dataset. |
| }, |
| "ddlTargetRoutine": { # The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this routine. |
| "projectId": "A String", # [Required] The ID of the project containing this routine. |
| "routineId": "A String", # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. |
| }, |
| "ddlTargetRowAccessPolicy": { # [Output-only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this row access policy. |
| "policyId": "A String", # [Required] The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. |
| "projectId": "A String", # [Required] The ID of the project containing this row access policy. |
| "tableId": "A String", # [Required] The ID of the table containing this row access policy. |
| }, |
| "ddlTargetTable": { # [Output-only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "dmlStats": { # [Output-only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE. |
| "deletedRowCount": "A String", # Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements. |
| "insertedRowCount": "A String", # Number of inserted Rows. Populated by DML INSERT and MERGE statements. |
| "updatedRowCount": "A String", # Number of updated Rows. Populated by DML UPDATE and MERGE statements. |
| }, |
| "estimatedBytesProcessed": "A String", # [Output-only] The original estimate of bytes processed for the job. |
| "mlStatistics": { # [Output-only] Statistics of a BigQuery ML training job. |
| "iterationResults": [ # Results for all completed iterations. |
| { |
| "durationMs": "A String", # Time taken to run the iteration in milliseconds. |
| "evalLoss": 3.14, # Loss computed on the eval data at the end of iteration. |
| "index": 42, # Index of the iteration, 0 based. |
| "learnRate": 3.14, # Learn rate used for this iteration. |
| "trainingLoss": 3.14, # Loss computed on the training data at the end of iteration. |
| }, |
| ], |
| "maxIterations": "A String", # Maximum number of iterations specified as max_iterations in the 'CREATE MODEL' query. The actual number of iterations may be less than this number due to early stop. |
| }, |
| "modelTraining": { # [Output-only, Beta] Information about create model query job progress. |
| "currentIteration": 42, # [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress. |
| "expectedTotalIterations": "A String", # [Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop. |
| }, |
| "modelTrainingCurrentIteration": 42, # [Output-only, Beta] Deprecated; do not use. |
| "modelTrainingExpectedTotalIteration": "A String", # [Output-only, Beta] Deprecated; do not use. |
| "numDmlAffectedRows": "A String", # [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. |
| "queryPlan": [ # [Output-only] Describes execution plan for the query. |
| { |
| "completedParallelInputs": "A String", # Number of parallel input segments completed. |
| "computeMsAvg": "A String", # Milliseconds the average shard spent on CPU-bound tasks. |
| "computeMsMax": "A String", # Milliseconds the slowest shard spent on CPU-bound tasks. |
| "computeRatioAvg": 3.14, # Relative amount of time the average shard spent on CPU-bound tasks. |
| "computeRatioMax": 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks. |
| "endMs": "A String", # Stage end time represented as milliseconds since epoch. |
| "id": "A String", # Unique ID for stage within plan. |
| "inputStages": [ # IDs for stages that are inputs to this stage. |
| "A String", |
| ], |
| "name": "A String", # Human-readable name for stage. |
| "parallelInputs": "A String", # Number of parallel input segments to be processed. |
| "readMsAvg": "A String", # Milliseconds the average shard spent reading input. |
| "readMsMax": "A String", # Milliseconds the slowest shard spent reading input. |
| "readRatioAvg": 3.14, # Relative amount of time the average shard spent reading input. |
| "readRatioMax": 3.14, # Relative amount of time the slowest shard spent reading input. |
| "recordsRead": "A String", # Number of records read into the stage. |
| "recordsWritten": "A String", # Number of records written by the stage. |
| "shuffleOutputBytes": "A String", # Total number of bytes written to shuffle. |
| "shuffleOutputBytesSpilled": "A String", # Total number of bytes written to shuffle and spilled to disk. |
| "slotMs": "A String", # Slot-milliseconds used by the stage. |
| "startMs": "A String", # Stage start time represented as milliseconds since epoch. |
| "status": "A String", # Current status for the stage. |
| "steps": [ # List of operations within the stage in dependency order (approximately chronological). |
| { |
| "kind": "A String", # Machine-readable operation type. |
| "substeps": [ # Human-readable stage descriptions. |
| "A String", |
| ], |
| }, |
| ], |
| "waitMsAvg": "A String", # Milliseconds the average shard spent waiting to be scheduled. |
| "waitMsMax": "A String", # Milliseconds the slowest shard spent waiting to be scheduled. |
| "waitRatioAvg": 3.14, # Relative amount of time the average shard spent waiting to be scheduled. |
| "waitRatioMax": 3.14, # Relative amount of time the slowest shard spent waiting to be scheduled. |
| "writeMsAvg": "A String", # Milliseconds the average shard spent on writing output. |
| "writeMsMax": "A String", # Milliseconds the slowest shard spent on writing output. |
| "writeRatioAvg": 3.14, # Relative amount of time the average shard spent on writing output. |
| "writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output. |
| }, |
| ], |
| "referencedRoutines": [ # [Output-only] Referenced routines (persistent user-defined functions and stored procedures) for the job. |
| { |
| "datasetId": "A String", # [Required] The ID of the dataset containing this routine. |
| "projectId": "A String", # [Required] The ID of the project containing this routine. |
| "routineId": "A String", # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. |
| }, |
| ], |
| "referencedTables": [ # [Output-only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list. |
| { |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| ], |
| "reservationUsage": [ # [Output-only] Job resource usage breakdown by reservation. |
| { |
| "name": "A String", # [Output-only] Reservation name or "unreserved" for on-demand resources usage. |
| "slotMs": "A String", # [Output-only] Slot-milliseconds the job spent in the given reservation. |
| }, |
| ], |
| "schema": { # [Output-only] The schema of the results. Present only for successful dry run of non-legacy SQL queries. |
| "fields": [ # Describes the fields in a table. |
| { |
| "categories": { # [Optional] The categories attached to this field, used for field-level access control. |
| "names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed. |
| "A String", |
| ], |
| }, |
| "collationSpec": "A String", # Optional. Collation specification of the field. It only can be set on string type field. |
| "description": "A String", # [Optional] The field description. The maximum length is 1,024 characters. |
| "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD. |
| # Object with schema name: TableFieldSchema |
| ], |
| "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". |
| "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. |
| "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. |
| "policyTags": { |
| "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. |
| "A String", |
| ], |
| }, |
| "precision": "A String", # [Optional] Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: - Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: - If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. - If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): - If type = "NUMERIC": 1 ≤ precision ≤ 29. - If type = "BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid. |
| "scale": "A String", # [Optional] See documentation for precision. |
| "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, INTERVAL, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD). |
| }, |
| ], |
| }, |
| "statementType": "A String", # The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "ASSERT": ASSERT condition AS 'description'. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query. |
| "timeline": [ # [Output-only] [Beta] Describes a timeline of job execution. |
| { |
| "activeUnits": "A String", # Total number of units currently being processed by workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample. |
| "completedUnits": "A String", # Total parallel units of work completed by this query. |
| "elapsedMs": "A String", # Milliseconds elapsed since the start of query execution. |
| "pendingUnits": "A String", # Total parallel units of work remaining for the active stages. |
| "totalSlotMs": "A String", # Cumulative slot-ms consumed by the query. |
| }, |
| ], |
| "totalBytesBilled": "A String", # [Output-only] Total bytes billed for the job. |
| "totalBytesProcessed": "A String", # [Output-only] Total bytes processed for the job. |
| "totalBytesProcessedAccuracy": "A String", # [Output-only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost. |
| "totalPartitionsProcessed": "A String", # [Output-only] Total number of partitions processed from all partitioned tables referenced in the job. |
| "totalSlotMs": "A String", # [Output-only] Slot-milliseconds for the job. |
| "undeclaredQueryParameters": [ # Standard SQL only: list of undeclared query parameters detected during a dry run validation. |
| { |
| "name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query. |
| "parameterType": { # [Required] The type of this parameter. |
| "arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array. |
| "structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct. |
| { |
| "description": "A String", # [Optional] Human-oriented description of the field. |
| "name": "A String", # [Optional] The name of this field. |
| "type": # Object with schema name: QueryParameterType # [Required] The type of this field. |
| }, |
| ], |
| "type": "A String", # [Required] The top level type of this field. |
| }, |
| "parameterValue": { # [Required] The value of this parameter. |
| "arrayValues": [ # [Optional] The array values, if this is an array type. |
| # Object with schema name: QueryParameterValue |
| ], |
| "structValues": { # [Optional] The struct field values, in order of the struct type's declaration. |
| "a_key": # Object with schema name: QueryParameterValue |
| }, |
| "value": "A String", # [Optional] The value of this value, if a simple scalar type. |
| }, |
| }, |
| ], |
| }, |
| "quotaDeferments": [ # [Output-only] Quotas which delayed this job's start time. |
| "A String", |
| ], |
| "reservationUsage": [ # [Output-only] Job resource usage breakdown by reservation. |
| { |
| "name": "A String", # [Output-only] Reservation name or "unreserved" for on-demand resources usage. |
| "slotMs": "A String", # [Output-only] Slot-milliseconds the job spent in the given reservation. |
| }, |
| ], |
| "reservation_id": "A String", # [Output-only] Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job. |
| "rowLevelSecurityStatistics": { # [Output-only] [Preview] Statistics for row-level security. Present only for query and extract jobs. |
| "rowLevelSecurityApplied": True or False, # [Output-only] [Preview] Whether any accessed data was protected by row access policies. |
| }, |
| "scriptStatistics": { # [Output-only] Statistics for a child job of a script. |
| "evaluationKind": "A String", # [Output-only] Whether this child job was a statement or expression. |
| "stackFrames": [ # Stack trace showing the line/column/procedure name of each frame on the stack at the point where the current evaluation happened. The leaf frame is first, the primary script is last. Never empty. |
| { |
| "endColumn": 42, # [Output-only] One-based end column. |
| "endLine": 42, # [Output-only] One-based end line. |
| "procedureId": "A String", # [Output-only] Name of the active procedure, empty if in a top-level script. |
| "startColumn": 42, # [Output-only] One-based start column. |
| "startLine": 42, # [Output-only] One-based start line. |
| "text": "A String", # [Output-only] Text of the current statement/expression. |
| }, |
| ], |
| }, |
| "sessionInfo": { # [Output-only] [Preview] Information of the session if this job is part of one. |
| "sessionId": "A String", # [Output-only] // [Preview] Id of the session. |
| }, |
| "startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE. |
| "totalBytesProcessed": "A String", # [Output-only] [Deprecated] Use the bytes processed in the query statistics instead. |
| "totalSlotMs": "A String", # [Output-only] Slot-milliseconds for the job. |
| "transactionInfo": { # [Output-only] [Alpha] Information of the multi-statement transaction if this job is part of one. |
| "transactionId": "A String", # [Output-only] // [Alpha] Id of the transaction. |
| }, |
| }, |
| "status": { # [Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete. |
| "errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful. |
| "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used. |
| "location": "A String", # Specifies where the error occurred, if present. |
| "message": "A String", # A human-readable description of the error. |
| "reason": "A String", # A short error code that summarizes the error. |
| }, |
| "errors": [ # [Output-only] The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful. |
| { |
| "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used. |
| "location": "A String", # Specifies where the error occurred, if present. |
| "message": "A String", # A human-readable description of the error. |
| "reason": "A String", # A short error code that summarizes the error. |
| }, |
| ], |
| "state": "A String", # [Output-only] Running state of the job. |
| }, |
| "user_email": "A String", # [Output-only] Email address of the user who ran the job. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(projectId, allUsers=None, maxCreationTime=None, maxResults=None, minCreationTime=None, pageToken=None, parentJobId=None, projection=None, stateFilter=None)</code> |
| <pre>Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property. |
| |
| Args: |
| projectId: string, Project ID of the jobs to list (required) |
| allUsers: boolean, Whether to display jobs owned by all users in the project. Default false |
| maxCreationTime: string, Max value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created before or at this timestamp are returned |
| maxResults: integer, Maximum number of results to return |
| minCreationTime: string, Min value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created after or at this timestamp are returned |
| pageToken: string, Page token, returned by a previous call, to request the next page of results |
| parentJobId: string, If set, retrieves only jobs whose parent is this job. Otherwise, retrieves only jobs which have no parent |
| projection: string, Restrict information returned to a set of selected fields |
| Allowed values |
| full - Includes all job data |
| minimal - Does not include the job configuration |
| stateFilter: string, Filter for job state (repeated) |
| Allowed values |
| done - Finished jobs |
| pending - Pending jobs |
| running - Running jobs |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "etag": "A String", # A hash of this page of results. |
| "jobs": [ # List of jobs that were requested. |
| { |
| "configuration": { # [Full-projection-only] Specifies the job configuration. |
| "copy": { # [Pick one] Copies a table. |
| "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. |
| "destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys). |
| "kmsKeyName": "A String", # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. |
| }, |
| "destinationExpirationTime": "", # [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed. |
| "destinationTable": { # [Required] The destination table |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "operationType": "A String", # [Optional] Supported operation types in table copy job. |
| "sourceTable": { # [Pick one] Source table to copy. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "sourceTables": [ # [Pick one] Source tables to copy. |
| { |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| ], |
| "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. |
| }, |
| "dryRun": True or False, # [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined. |
| "extract": { # [Pick one] Configures an extract job. |
| "compression": "A String", # [Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models. |
| "destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL. |
| "destinationUri": "A String", # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written. |
| "destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written. |
| "A String", |
| ], |
| "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models. |
| "printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models. |
| "sourceModel": { # A reference to the model being exported. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this model. |
| "modelId": "A String", # [Required] The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| "projectId": "A String", # [Required] The ID of the project containing this model. |
| }, |
| "sourceTable": { # A reference to the table being exported. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "useAvroLogicalTypes": True or False, # [Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models. |
| }, |
| "jobTimeoutMs": "A String", # [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job. |
| "jobType": "A String", # [Output-only] The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN. |
| "labels": { # The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key. |
| "a_key": "A String", |
| }, |
| "load": { # [Pick one] Configures a load job. |
| "allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats. |
| "allowQuotedNewlines": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. |
| "autodetect": True or False, # [Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources. |
| "clustering": { # [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered. |
| "fields": [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data. |
| "A String", |
| ], |
| }, |
| "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. |
| "decimalTargetTypes": [ # [Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. |
| "A String", |
| ], |
| "destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys). |
| "kmsKeyName": "A String", # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. |
| }, |
| "destinationTable": { # [Required] The destination table to load the data into. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "destinationTableProperties": { # [Beta] [Optional] Properties with which to create the destination table if it is new. |
| "description": "A String", # [Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail. |
| "expirationTime": "A String", # [Internal] This field is for Google internal use only. |
| "friendlyName": "A String", # [Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail. |
| "labels": { # [Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail. |
| "a_key": "A String", |
| }, |
| }, |
| "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. |
| "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). |
| "hivePartitioningOptions": { # [Optional] Options to configure hive partitioning support. |
| "mode": "A String", # [Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet. |
| "requirePartitionFilter": True or False, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail. |
| "sourceUriPrefix": "A String", # [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter). |
| }, |
| "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names |
| "jsonExtension": "A String", # [Optional] If sourceFormat is set to newline-delimited JSON, indicates whether it should be processed as a JSON variant such as GeoJSON. For a sourceFormat other than JSON, omit this field. If the sourceFormat is newline-delimited JSON: - for newline-delimited GeoJSON: set to GEOJSON. |
| "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid. |
| "nullMarker": "A String", # [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value. |
| "parquetOptions": { # [Optional] Options to configure parquet support. |
| "enableListInference": True or False, # [Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type. |
| "enumAsString": True or False, # [Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default. |
| }, |
| "projectionFields": [ # If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result. |
| "A String", |
| ], |
| "quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. |
| "rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified. |
| "field": "A String", # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64. |
| "range": { # [TrustedTester] [Required] Defines the ranges for range partitioning. |
| "end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive. |
| "interval": "A String", # [TrustedTester] [Required] The width of each interval. |
| "start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive. |
| }, |
| }, |
| "schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore. |
| "fields": [ # Describes the fields in a table. |
| { |
| "categories": { # [Optional] The categories attached to this field, used for field-level access control. |
| "names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed. |
| "A String", |
| ], |
| }, |
| "collationSpec": "A String", # Optional. Collation specification of the field. It only can be set on string type field. |
| "description": "A String", # [Optional] The field description. The maximum length is 1,024 characters. |
| "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD. |
| # Object with schema name: TableFieldSchema |
| ], |
| "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". |
| "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. |
| "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. |
| "policyTags": { |
| "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. |
| "A String", |
| ], |
| }, |
| "precision": "A String", # [Optional] Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: - Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: - If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. - If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): - If type = "NUMERIC": 1 ≤ precision ≤ 29. - If type = "BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid. |
| "scale": "A String", # [Optional] See documentation for precision. |
| "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, INTERVAL, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD). |
| }, |
| ], |
| }, |
| "schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT". |
| "schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property. |
| "schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. |
| "A String", |
| ], |
| "skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. |
| "sourceFormat": "A String", # [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV. |
| "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '*' wildcard character is not allowed. |
| "A String", |
| ], |
| "timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. |
| "expirationMs": "A String", # [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value. |
| "field": "A String", # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED. |
| "requirePartitionFilter": True or False, |
| "type": "A String", # [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY. |
| }, |
| "useAvroLogicalTypes": True or False, # [Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER). |
| "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. |
| }, |
| "query": { # [Pick one] Configures a query job. |
| "allowLargeResults": false, # [Optional] If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For standard SQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size. |
| "clustering": { # [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered. |
| "fields": [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data. |
| "A String", |
| ], |
| }, |
| "connectionProperties": [ # Connection properties. |
| { |
| "key": "A String", # [Required] Name of the connection property to set. |
| "value": "A String", # [Required] Value of the connection property. |
| }, |
| ], |
| "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. |
| "createSession": True or False, # If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode. |
| "defaultDataset": { # [Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names. |
| "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| "projectId": "A String", # [Optional] The ID of the project containing this dataset. |
| }, |
| "destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys). |
| "kmsKeyName": "A String", # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. |
| }, |
| "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. This property must be set for large results that exceed the maximum response size. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "flattenResults": true, # [Optional] If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results. allowLargeResults must be true if this is set to false. For standard SQL queries, this flag is ignored and results are never flattened. |
| "maximumBillingTier": 1, # [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default. |
| "maximumBytesBilled": "A String", # [Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default. |
| "parameterMode": "A String", # Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query. |
| "preserveNulls": True or False, # [Deprecated] This property is deprecated. |
| "priority": "A String", # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE. |
| "query": "A String", # [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL. |
| "queryParameters": [ # Query parameters for standard SQL queries. |
| { |
| "name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query. |
| "parameterType": { # [Required] The type of this parameter. |
| "arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array. |
| "structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct. |
| { |
| "description": "A String", # [Optional] Human-oriented description of the field. |
| "name": "A String", # [Optional] The name of this field. |
| "type": # Object with schema name: QueryParameterType # [Required] The type of this field. |
| }, |
| ], |
| "type": "A String", # [Required] The top level type of this field. |
| }, |
| "parameterValue": { # [Required] The value of this parameter. |
| "arrayValues": [ # [Optional] The array values, if this is an array type. |
| # Object with schema name: QueryParameterValue |
| ], |
| "structValues": { # [Optional] The struct field values, in order of the struct type's declaration. |
| "a_key": # Object with schema name: QueryParameterValue |
| }, |
| "value": "A String", # [Optional] The value of this value, if a simple scalar type. |
| }, |
| }, |
| ], |
| "rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified. |
| "field": "A String", # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64. |
| "range": { # [TrustedTester] [Required] Defines the ranges for range partitioning. |
| "end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive. |
| "interval": "A String", # [TrustedTester] [Required] The width of each interval. |
| "start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive. |
| }, |
| }, |
| "schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. |
| "A String", |
| ], |
| "tableDefinitions": { # [Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. |
| "a_key": { |
| "autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored. |
| "avroOptions": { # Additional properties to set if sourceFormat is set to Avro. |
| "useAvroLogicalTypes": True or False, # [Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER). |
| }, |
| "bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE. |
| "columnFamilies": [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable. |
| { |
| "columns": [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field. |
| { |
| "encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels. |
| "fieldName": "A String", # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries. |
| "onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels. |
| "qualifierEncoded": "A String", # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name. |
| "qualifierString": "A String", |
| "type": "A String", # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels. |
| }, |
| ], |
| "encoding": "A String", # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it. |
| "familyId": "A String", # Identifier of the column family. |
| "onlyReadLatest": True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column. |
| "type": "A String", # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it. |
| }, |
| ], |
| "ignoreUnspecifiedColumnFamilies": True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false. |
| "readRowkeyAsString": True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false. |
| }, |
| "compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats. |
| "connectionId": "A String", # [Optional, Trusted Tester] Connection for external data source. |
| "csvOptions": { # Additional properties to set if sourceFormat is set to CSV. |
| "allowJaggedRows": True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. |
| "allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. |
| "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. |
| "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). |
| "null_marker": "A String", # [Optional] An custom string that will represent a NULL value in CSV import data. |
| "quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. |
| "skipLeadingRows": "A String", # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema. |
| }, |
| "decimalTargetTypes": [ # [Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. |
| "A String", |
| ], |
| "googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS. |
| "range": "A String", # [Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20 |
| "skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema. |
| }, |
| "hivePartitioningOptions": { # [Optional] Options to configure hive partitioning support. |
| "mode": "A String", # [Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet. |
| "requirePartitionFilter": True or False, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail. |
| "sourceUriPrefix": "A String", # [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter). |
| }, |
| "ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored. |
| "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats. |
| "parquetOptions": { # Additional properties to set if sourceFormat is set to Parquet. |
| "enableListInference": True or False, # [Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type. |
| "enumAsString": True or False, # [Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default. |
| }, |
| "schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats. |
| "fields": [ # Describes the fields in a table. |
| { |
| "categories": { # [Optional] The categories attached to this field, used for field-level access control. |
| "names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed. |
| "A String", |
| ], |
| }, |
| "collationSpec": "A String", # Optional. Collation specification of the field. It only can be set on string type field. |
| "description": "A String", # [Optional] The field description. The maximum length is 1,024 characters. |
| "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD. |
| # Object with schema name: TableFieldSchema |
| ], |
| "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". |
| "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. |
| "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. |
| "policyTags": { |
| "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. |
| "A String", |
| ], |
| }, |
| "precision": "A String", # [Optional] Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: - Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: - If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. - If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): - If type = "NUMERIC": 1 ≤ precision ≤ 29. - If type = "BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid. |
| "scale": "A String", # [Optional] See documentation for precision. |
| "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, INTERVAL, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD). |
| }, |
| ], |
| }, |
| "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE". |
| "sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed. |
| "A String", |
| ], |
| }, |
| }, |
| "timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. |
| "expirationMs": "A String", # [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value. |
| "field": "A String", # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED. |
| "requirePartitionFilter": True or False, |
| "type": "A String", # [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY. |
| }, |
| "useLegacySql": true, # Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false. |
| "useQueryCache": true, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true. |
| "userDefinedFunctionResources": [ # Describes user-defined function resources used in the query. |
| { # This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of Standard SQL should leverage either DDL (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions |
| "inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code. |
| "resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path). |
| }, |
| ], |
| "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. |
| }, |
| }, |
| "errorResult": { # A result object that will be present only if the job has failed. |
| "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used. |
| "location": "A String", # Specifies where the error occurred, if present. |
| "message": "A String", # A human-readable description of the error. |
| "reason": "A String", # A short error code that summarizes the error. |
| }, |
| "id": "A String", # Unique opaque ID of the job. |
| "jobReference": { # Job reference uniquely identifying the job. |
| "jobId": "A String", # [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters. |
| "location": "A String", # The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location. |
| "projectId": "A String", # [Required] The ID of the project containing this job. |
| }, |
| "kind": "bigquery#job", # The resource type. |
| "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. |
| "statistics": { # [Output-only] Information about the job, including starting time and ending time of the job. |
| "completionRatio": 3.14, # [TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs. |
| "creationTime": "A String", # [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs. |
| "endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state. |
| "extract": { # [Output-only] Statistics for an extract job. |
| "destinationUriFileCounts": [ # [Output-only] Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field. |
| "A String", |
| ], |
| "inputBytes": "A String", # [Output-only] Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes. |
| }, |
| "load": { # [Output-only] Statistics for a load job. |
| "badRecords": "A String", # [Output-only] The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data. |
| "inputFileBytes": "A String", # [Output-only] Number of bytes of source data in a load job. |
| "inputFiles": "A String", # [Output-only] Number of source files in a load job. |
| "outputBytes": "A String", # [Output-only] Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change. |
| "outputRows": "A String", # [Output-only] Number of rows imported in a load job. Note that while an import job is in the running state, this value may change. |
| }, |
| "numChildJobs": "A String", # [Output-only] Number of child jobs executed. |
| "parentJobId": "A String", # [Output-only] If this is a child job, the id of the parent. |
| "query": { # [Output-only] Statistics for a query job. |
| "biEngineStatistics": { # BI Engine specific Statistics. [Output-only] BI Engine specific Statistics. |
| "biEngineMode": "$(stats.bi_engine_mode)", # [Output-only] Specifies which mode of BI Engine acceleration was performed (if any). |
| "biEngineReasons": [ # In case of DISABLED or PARTIAL bi_engine_mode, these contain the explanatory reasons as to why BI Engine could not accelerate. In case the full query was accelerated, this field is not populated. |
| { |
| "code": "$(reason.code)", # [Output-only] High-level BI Engine reason for partial or disabled acceleration. |
| "message": "$(reason.message)", # [Output-only] Free form human-readable reason for partial or disabled acceleration. |
| }, |
| ], |
| }, |
| "billingTier": 42, # [Output-only] Billing tier for the job. |
| "cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache. |
| "ddlAffectedRowAccessPolicyCount": "A String", # [Output-only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries. |
| "ddlDestinationTable": { # [Output-only] The DDL destination table. Present only for ALTER TABLE RENAME TO queries. Note that ddl_target_table is used just for its type information. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "ddlOperationPerformed": "A String", # The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target. |
| "ddlTargetDataset": { # [Output-only] The DDL target dataset. Present only for CREATE/ALTER/DROP SCHEMA queries. |
| "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| "projectId": "A String", # [Optional] The ID of the project containing this dataset. |
| }, |
| "ddlTargetRoutine": { # The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this routine. |
| "projectId": "A String", # [Required] The ID of the project containing this routine. |
| "routineId": "A String", # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. |
| }, |
| "ddlTargetRowAccessPolicy": { # [Output-only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this row access policy. |
| "policyId": "A String", # [Required] The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. |
| "projectId": "A String", # [Required] The ID of the project containing this row access policy. |
| "tableId": "A String", # [Required] The ID of the table containing this row access policy. |
| }, |
| "ddlTargetTable": { # [Output-only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries. |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| "dmlStats": { # [Output-only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE. |
| "deletedRowCount": "A String", # Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements. |
| "insertedRowCount": "A String", # Number of inserted Rows. Populated by DML INSERT and MERGE statements. |
| "updatedRowCount": "A String", # Number of updated Rows. Populated by DML UPDATE and MERGE statements. |
| }, |
| "estimatedBytesProcessed": "A String", # [Output-only] The original estimate of bytes processed for the job. |
| "mlStatistics": { # [Output-only] Statistics of a BigQuery ML training job. |
| "iterationResults": [ # Results for all completed iterations. |
| { |
| "durationMs": "A String", # Time taken to run the iteration in milliseconds. |
| "evalLoss": 3.14, # Loss computed on the eval data at the end of iteration. |
| "index": 42, # Index of the iteration, 0 based. |
| "learnRate": 3.14, # Learn rate used for this iteration. |
| "trainingLoss": 3.14, # Loss computed on the training data at the end of iteration. |
| }, |
| ], |
| "maxIterations": "A String", # Maximum number of iterations specified as max_iterations in the 'CREATE MODEL' query. The actual number of iterations may be less than this number due to early stop. |
| }, |
| "modelTraining": { # [Output-only, Beta] Information about create model query job progress. |
| "currentIteration": 42, # [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress. |
| "expectedTotalIterations": "A String", # [Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop. |
| }, |
| "modelTrainingCurrentIteration": 42, # [Output-only, Beta] Deprecated; do not use. |
| "modelTrainingExpectedTotalIteration": "A String", # [Output-only, Beta] Deprecated; do not use. |
| "numDmlAffectedRows": "A String", # [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. |
| "queryPlan": [ # [Output-only] Describes execution plan for the query. |
| { |
| "completedParallelInputs": "A String", # Number of parallel input segments completed. |
| "computeMsAvg": "A String", # Milliseconds the average shard spent on CPU-bound tasks. |
| "computeMsMax": "A String", # Milliseconds the slowest shard spent on CPU-bound tasks. |
| "computeRatioAvg": 3.14, # Relative amount of time the average shard spent on CPU-bound tasks. |
| "computeRatioMax": 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks. |
| "endMs": "A String", # Stage end time represented as milliseconds since epoch. |
| "id": "A String", # Unique ID for stage within plan. |
| "inputStages": [ # IDs for stages that are inputs to this stage. |
| "A String", |
| ], |
| "name": "A String", # Human-readable name for stage. |
| "parallelInputs": "A String", # Number of parallel input segments to be processed. |
| "readMsAvg": "A String", # Milliseconds the average shard spent reading input. |
| "readMsMax": "A String", # Milliseconds the slowest shard spent reading input. |
| "readRatioAvg": 3.14, # Relative amount of time the average shard spent reading input. |
| "readRatioMax": 3.14, # Relative amount of time the slowest shard spent reading input. |
| "recordsRead": "A String", # Number of records read into the stage. |
| "recordsWritten": "A String", # Number of records written by the stage. |
| "shuffleOutputBytes": "A String", # Total number of bytes written to shuffle. |
| "shuffleOutputBytesSpilled": "A String", # Total number of bytes written to shuffle and spilled to disk. |
| "slotMs": "A String", # Slot-milliseconds used by the stage. |
| "startMs": "A String", # Stage start time represented as milliseconds since epoch. |
| "status": "A String", # Current status for the stage. |
| "steps": [ # List of operations within the stage in dependency order (approximately chronological). |
| { |
| "kind": "A String", # Machine-readable operation type. |
| "substeps": [ # Human-readable stage descriptions. |
| "A String", |
| ], |
| }, |
| ], |
| "waitMsAvg": "A String", # Milliseconds the average shard spent waiting to be scheduled. |
| "waitMsMax": "A String", # Milliseconds the slowest shard spent waiting to be scheduled. |
| "waitRatioAvg": 3.14, # Relative amount of time the average shard spent waiting to be scheduled. |
| "waitRatioMax": 3.14, # Relative amount of time the slowest shard spent waiting to be scheduled. |
| "writeMsAvg": "A String", # Milliseconds the average shard spent on writing output. |
| "writeMsMax": "A String", # Milliseconds the slowest shard spent on writing output. |
| "writeRatioAvg": 3.14, # Relative amount of time the average shard spent on writing output. |
| "writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output. |
| }, |
| ], |
| "referencedRoutines": [ # [Output-only] Referenced routines (persistent user-defined functions and stored procedures) for the job. |
| { |
| "datasetId": "A String", # [Required] The ID of the dataset containing this routine. |
| "projectId": "A String", # [Required] The ID of the project containing this routine. |
| "routineId": "A String", # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. |
| }, |
| ], |
| "referencedTables": [ # [Output-only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list. |
| { |
| "datasetId": "A String", # [Required] The ID of the dataset containing this table. |
| "projectId": "A String", # [Required] The ID of the project containing this table. |
| "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| }, |
| ], |
| "reservationUsage": [ # [Output-only] Job resource usage breakdown by reservation. |
| { |
| "name": "A String", # [Output-only] Reservation name or "unreserved" for on-demand resources usage. |
| "slotMs": "A String", # [Output-only] Slot-milliseconds the job spent in the given reservation. |
| }, |
| ], |
| "schema": { # [Output-only] The schema of the results. Present only for successful dry run of non-legacy SQL queries. |
| "fields": [ # Describes the fields in a table. |
| { |
| "categories": { # [Optional] The categories attached to this field, used for field-level access control. |
| "names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed. |
| "A String", |
| ], |
| }, |
| "collationSpec": "A String", # Optional. Collation specification of the field. It only can be set on string type field. |
| "description": "A String", # [Optional] The field description. The maximum length is 1,024 characters. |
| "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD. |
| # Object with schema name: TableFieldSchema |
| ], |
| "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". |
| "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. |
| "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. |
| "policyTags": { |
| "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. |
| "A String", |
| ], |
| }, |
| "precision": "A String", # [Optional] Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: - Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: - If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. - If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): - If type = "NUMERIC": 1 ≤ precision ≤ 29. - If type = "BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid. |
| "scale": "A String", # [Optional] See documentation for precision. |
| "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, INTERVAL, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD). |
| }, |
| ], |
| }, |
| "statementType": "A String", # The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "ASSERT": ASSERT condition AS 'description'. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query. |
| "timeline": [ # [Output-only] [Beta] Describes a timeline of job execution. |
| { |
| "activeUnits": "A String", # Total number of units currently being processed by workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample. |
| "completedUnits": "A String", # Total parallel units of work completed by this query. |
| "elapsedMs": "A String", # Milliseconds elapsed since the start of query execution. |
| "pendingUnits": "A String", # Total parallel units of work remaining for the active stages. |
| "totalSlotMs": "A String", # Cumulative slot-ms consumed by the query. |
| }, |
| ], |
| "totalBytesBilled": "A String", # [Output-only] Total bytes billed for the job. |
| "totalBytesProcessed": "A String", # [Output-only] Total bytes processed for the job. |
| "totalBytesProcessedAccuracy": "A String", # [Output-only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost. |
| "totalPartitionsProcessed": "A String", # [Output-only] Total number of partitions processed from all partitioned tables referenced in the job. |
| "totalSlotMs": "A String", # [Output-only] Slot-milliseconds for the job. |
| "undeclaredQueryParameters": [ # Standard SQL only: list of undeclared query parameters detected during a dry run validation. |
| { |
| "name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query. |
| "parameterType": { # [Required] The type of this parameter. |
| "arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array. |
| "structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct. |
| { |
| "description": "A String", # [Optional] Human-oriented description of the field. |
| "name": "A String", # [Optional] The name of this field. |
| "type": # Object with schema name: QueryParameterType # [Required] The type of this field. |
| }, |
| ], |
| "type": "A String", # [Required] The top level type of this field. |
| }, |
| "parameterValue": { # [Required] The value of this parameter. |
| "arrayValues": [ # [Optional] The array values, if this is an array type. |
| # Object with schema name: QueryParameterValue |
| ], |
| "structValues": { # [Optional] The struct field values, in order of the struct type's declaration. |
| "a_key": # Object with schema name: QueryParameterValue |
| }, |
| "value": "A String", # [Optional] The value of this value, if a simple scalar type. |
| }, |
| }, |
| ], |
| }, |
| "quotaDeferments": [ # [Output-only] Quotas which delayed this job's start time. |
| "A String", |
| ], |
| "reservationUsage": [ # [Output-only] Job resource usage breakdown by reservation. |
| { |
| "name": "A String", # [Output-only] Reservation name or "unreserved" for on-demand resources usage. |
| "slotMs": "A String", # [Output-only] Slot-milliseconds the job spent in the given reservation. |
| }, |
| ], |
| "reservation_id": "A String", # [Output-only] Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job. |
| "rowLevelSecurityStatistics": { # [Output-only] [Preview] Statistics for row-level security. Present only for query and extract jobs. |
| "rowLevelSecurityApplied": True or False, # [Output-only] [Preview] Whether any accessed data was protected by row access policies. |
| }, |
| "scriptStatistics": { # [Output-only] Statistics for a child job of a script. |
| "evaluationKind": "A String", # [Output-only] Whether this child job was a statement or expression. |
| "stackFrames": [ # Stack trace showing the line/column/procedure name of each frame on the stack at the point where the current evaluation happened. The leaf frame is first, the primary script is last. Never empty. |
| { |
| "endColumn": 42, # [Output-only] One-based end column. |
| "endLine": 42, # [Output-only] One-based end line. |
| "procedureId": "A String", # [Output-only] Name of the active procedure, empty if in a top-level script. |
| "startColumn": 42, # [Output-only] One-based start column. |
| "startLine": 42, # [Output-only] One-based start line. |
| "text": "A String", # [Output-only] Text of the current statement/expression. |
| }, |
| ], |
| }, |
| "sessionInfo": { # [Output-only] [Preview] Information of the session if this job is part of one. |
| "sessionId": "A String", # [Output-only] // [Preview] Id of the session. |
| }, |
| "startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE. |
| "totalBytesProcessed": "A String", # [Output-only] [Deprecated] Use the bytes processed in the query statistics instead. |
| "totalSlotMs": "A String", # [Output-only] Slot-milliseconds for the job. |
| "transactionInfo": { # [Output-only] [Alpha] Information of the multi-statement transaction if this job is part of one. |
| "transactionId": "A String", # [Output-only] // [Alpha] Id of the transaction. |
| }, |
| }, |
| "status": { # [Full-projection-only] Describes the state of the job. |
| "errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful. |
| "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used. |
| "location": "A String", # Specifies where the error occurred, if present. |
| "message": "A String", # A human-readable description of the error. |
| "reason": "A String", # A short error code that summarizes the error. |
| }, |
| "errors": [ # [Output-only] The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful. |
| { |
| "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used. |
| "location": "A String", # Specifies where the error occurred, if present. |
| "message": "A String", # A human-readable description of the error. |
| "reason": "A String", # A short error code that summarizes the error. |
| }, |
| ], |
| "state": "A String", # [Output-only] Running state of the job. |
| }, |
| "user_email": "A String", # [Full-projection-only] Email address of the user who ran the job. |
| }, |
| ], |
| "kind": "bigquery#jobList", # The resource type of the response. |
| "nextPageToken": "A String", # A token to request the next page of results. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="query">query(projectId, body=None)</code> |
| <pre>Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout. |
| |
| Args: |
| projectId: string, Project ID of the project billed for the query (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "connectionProperties": [ # Connection properties. |
| { |
| "key": "A String", # [Required] Name of the connection property to set. |
| "value": "A String", # [Required] Value of the connection property. |
| }, |
| ], |
| "createSession": True or False, # If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode. |
| "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 qualified in the format 'datasetId.tableId'. |
| "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. |
| "projectId": "A String", # [Optional] The ID of the project containing this dataset. |
| }, |
| "dryRun": True or False, # [Optional] If set to true, BigQuery doesn't run the job. Instead, if the query is valid, BigQuery returns statistics about the job such as how many bytes would be processed. If the query is invalid, an error returns. The default value is false. |
| "kind": "bigquery#queryRequest", # The resource type of the request. |
| "labels": { # The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key. |
| "a_key": "A String", |
| }, |
| "location": "A String", # The geographic location where the job should run. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location. |
| "maxResults": 42, # [Optional] The maximum number of rows of data to return per page of results. Setting this flag to a small value such as 1000 and then paging through results might improve reliability when the query result set is large. In addition to this limit, responses are also limited to 10 MB. By default, there is no maximum row count, and only the byte limit applies. |
| "maximumBytesBilled": "A String", # [Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default. |
| "parameterMode": "A String", # Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query. |
| "preserveNulls": True or False, # [Deprecated] This property is deprecated. |
| "query": "A String", # [Required] A query string, following the BigQuery query syntax, of the query to execute. Example: "SELECT count(f1) FROM [myProjectId:myDatasetId.myTableId]". |
| "queryParameters": [ # Query parameters for Standard SQL queries. |
| { |
| "name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query. |
| "parameterType": { # [Required] The type of this parameter. |
| "arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array. |
| "structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct. |
| { |
| "description": "A String", # [Optional] Human-oriented description of the field. |
| "name": "A String", # [Optional] The name of this field. |
| "type": # Object with schema name: QueryParameterType # [Required] The type of this field. |
| }, |
| ], |
| "type": "A String", # [Required] The top level type of this field. |
| }, |
| "parameterValue": { # [Required] The value of this parameter. |
| "arrayValues": [ # [Optional] The array values, if this is an array type. |
| # Object with schema name: QueryParameterValue |
| ], |
| "structValues": { # [Optional] The struct field values, in order of the struct type's declaration. |
| "a_key": # Object with schema name: QueryParameterValue |
| }, |
| "value": "A String", # [Optional] The value of this value, if a simple scalar type. |
| }, |
| }, |
| ], |
| "requestId": "A String", # A unique user provided identifier to ensure idempotent behavior for queries. Note that this is different from the job_id. It has the following properties: 1. It is case-sensitive, limited to up to 36 ASCII characters. A UUID is recommended. 2. Read only queries can ignore this token since they are nullipotent by definition. 3. For the purposes of idempotency ensured by the request_id, a request is considered duplicate of another only if they have the same request_id and are actually duplicates. When determining whether a request is a duplicate of the previous request, all parameters in the request that may affect the behavior are considered. For example, query, connection_properties, query_parameters, use_legacy_sql are parameters that affect the result and are considered when determining whether a request is a duplicate, but properties like timeout_ms don't affect the result and are thus not considered. Dry run query requests are never considered duplicate of another request. 4. When a duplicate mutating query request is detected, it returns: a. the results of the mutation if it completes successfully within the timeout. b. the running operation if it is still in progress at the end of the timeout. 5. Its lifetime is limited to 15 minutes. In other words, if two requests are sent with the same request_id, but more than 15 minutes apart, idempotency is not guaranteed. |
| "timeoutMs": 42, # [Optional] How long to wait for the query to complete, in milliseconds, before the request times out and returns. Note that this is only a timeout for the request, not the query. If the query takes longer to run than the timeout value, the call returns without any results and with the 'jobComplete' flag set to false. You can call GetQueryResults() to wait for the query to complete and read the results. The default value is 10000 milliseconds (10 seconds). |
| "useLegacySql": true, # Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false. |
| "useQueryCache": true, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. The default value is true. |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "cacheHit": True or False, # Whether the query result was fetched from the query cache. |
| "dmlStats": { # [Output-only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE. |
| "deletedRowCount": "A String", # Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements. |
| "insertedRowCount": "A String", # Number of inserted Rows. Populated by DML INSERT and MERGE statements. |
| "updatedRowCount": "A String", # Number of updated Rows. Populated by DML UPDATE and MERGE statements. |
| }, |
| "errors": [ # [Output-only] The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful. |
| { |
| "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used. |
| "location": "A String", # Specifies where the error occurred, if present. |
| "message": "A String", # A human-readable description of the error. |
| "reason": "A String", # A short error code that summarizes the error. |
| }, |
| ], |
| "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. |
| "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). |
| "jobId": "A String", # [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters. |
| "location": "A String", # The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location. |
| "projectId": "A String", # [Required] The ID of the project containing this job. |
| }, |
| "kind": "bigquery#queryResponse", # The resource type. |
| "numDmlAffectedRows": "A String", # [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. |
| "pageToken": "A String", # A token used for paging results. |
| "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. |
| { |
| "f": [ # Represents a single row in the result set, consisting of one or more fields. |
| { |
| "v": "", |
| }, |
| ], |
| }, |
| ], |
| "schema": { # The schema of the results. Present only when the query completes successfully. |
| "fields": [ # Describes the fields in a table. |
| { |
| "categories": { # [Optional] The categories attached to this field, used for field-level access control. |
| "names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed. |
| "A String", |
| ], |
| }, |
| "collationSpec": "A String", # Optional. Collation specification of the field. It only can be set on string type field. |
| "description": "A String", # [Optional] The field description. The maximum length is 1,024 characters. |
| "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD. |
| # Object with schema name: TableFieldSchema |
| ], |
| "maxLength": "A String", # [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". |
| "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. |
| "name": "A String", # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. |
| "policyTags": { |
| "names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed. |
| "A String", |
| ], |
| }, |
| "precision": "A String", # [Optional] Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: - Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: - If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. - If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): - If type = "NUMERIC": 1 ≤ precision ≤ 29. - If type = "BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid. |
| "scale": "A String", # [Optional] See documentation for precision. |
| "type": "A String", # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, INTERVAL, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD). |
| }, |
| ], |
| }, |
| "sessionInfo": { # [Output-only] [Preview] Information of the session if this job is part of one. |
| "sessionId": "A String", # [Output-only] // [Preview] Id of the session. |
| }, |
| "totalBytesProcessed": "A String", # The total number of bytes processed for this query. If this query was a dry run, this is the number of bytes that would be processed if the query were run. |
| "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. |
| }</pre> |
| </div> |
| |
| </body></html> |
