bigquery  v2
Properties | List of all members
Google.Apis.Bigquery.v2.Data.JobConfigurationLoad Class Reference
Inheritance diagram for Google.Apis.Bigquery.v2.Data.JobConfigurationLoad:
Google::Apis::Requests::IDirectResponseSchema

Properties

virtual System.Nullable< bool > AllowJaggedRows [get, set]
 [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. More...
 
virtual System.Nullable< bool > AllowQuotedNewlines [get, set]
 Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. More...
 
virtual System.Nullable< bool > Autodetect [get, set]
 [Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources. More...
 
virtual Clustering Clustering [get, set]
 [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. More...
 
virtual string CreateDisposition [get, set]
 [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. More...
 
virtual EncryptionConfiguration DestinationEncryptionConfiguration [get, set]
 Custom encryption configuration (e.g., Cloud KMS keys). More...
 
virtual TableReference DestinationTable [get, set]
 [Required] The destination table to load the data into. More...
 
virtual DestinationTableProperties DestinationTableProperties [get, set]
 [Beta] [Optional] Properties with which to create the destination table if it is new. More...
 
virtual string Encoding [get, set]
 [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. More...
 
virtual string FieldDelimiter [get, set]
 [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 (','). More...
 
virtual string HivePartitioningMode [get, set]
 [Optional, Trusted Tester] Deprecated, do not use. Please set hivePartitioningOptions instead. More...
 
virtual HivePartitioningOptions HivePartitioningOptions [get, set]
 [Optional, Trusted Tester] Options to configure hive partitioning support. More...
 
virtual System.Nullable< bool > IgnoreUnknownValues [get, set]
 [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 More...
 
virtual System.Nullable< int > MaxBadRecords [get, set]
 [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. More...
 
virtual string NullMarker [get, set]
 [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. More...
 
virtual System.Collections.Generic.IList< string > ProjectionFields [get, set]
 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. More...
 
virtual string Quote [get, set]
 [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. More...
 
virtual RangePartitioning RangePartitioning [get, set]
 [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified. More...
 
virtual TableSchema Schema [get, set]
 [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. More...
 
virtual string SchemaInline [get, set]
 [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT". More...
 
virtual string SchemaInlineFormat [get, set]
 [Deprecated] The format of the schemaInline property. More...
 
virtual System.Collections.Generic.IList< string > SchemaUpdateOptions [get, set]
 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. More...
 
virtual System.Nullable< int > SkipLeadingRows [get, set]
 [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. More...
 
virtual string SourceFormat [get, set]
 [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. More...
 
virtual System.Collections.Generic.IList< string > SourceUris [get, set]
 [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. More...
 
virtual TimePartitioning TimePartitioning [get, set]
 Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. More...
 
virtual System.Nullable< bool > UseAvroLogicalTypes [get, set]
 [Optional] If sourceFormat is set to "AVRO", indicates whether to enable interpreting logical types into their corresponding types (ie. TIMESTAMP), instead of only using their raw types (ie. INTEGER). More...
 
virtual string WriteDisposition [get, set]
 [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. More...
 
virtual string ETag [get, set]
 The ETag of the item. More...
 
- Properties inherited from Google::Apis::Requests::IDirectResponseSchema
string ETag
 

Property Documentation

◆ AllowJaggedRows

virtual System.Nullable<bool> Google.Apis.Bigquery.v2.Data.JobConfigurationLoad.AllowJaggedRows
getset

[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

virtual System.Nullable<bool> Google.Apis.Bigquery.v2.Data.JobConfigurationLoad.AllowQuotedNewlines
getset

Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

◆ Autodetect

virtual System.Nullable<bool> Google.Apis.Bigquery.v2.Data.JobConfigurationLoad.Autodetect
getset

[Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.

◆ Clustering

virtual Clustering Google.Apis.Bigquery.v2.Data.JobConfigurationLoad.Clustering
getset

[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.

◆ CreateDisposition

virtual string Google.Apis.Bigquery.v2.Data.JobConfigurationLoad.CreateDisposition
getset

[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

virtual EncryptionConfiguration Google.Apis.Bigquery.v2.Data.JobConfigurationLoad.DestinationEncryptionConfiguration
getset

Custom encryption configuration (e.g., Cloud KMS keys).

◆ DestinationTable

virtual TableReference Google.Apis.Bigquery.v2.Data.JobConfigurationLoad.DestinationTable
getset

[Required] The destination table to load the data into.

◆ DestinationTableProperties

virtual DestinationTableProperties Google.Apis.Bigquery.v2.Data.JobConfigurationLoad.DestinationTableProperties
getset

[Beta] [Optional] Properties with which to create the destination table if it is new.

◆ Encoding

virtual string Google.Apis.Bigquery.v2.Data.JobConfigurationLoad.Encoding
getset

[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.

◆ ETag

virtual string Google.Apis.Bigquery.v2.Data.JobConfigurationLoad.ETag
getset

The ETag of the item.

◆ FieldDelimiter

virtual string Google.Apis.Bigquery.v2.Data.JobConfigurationLoad.FieldDelimiter
getset

[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 (',').

◆ HivePartitioningMode

virtual string Google.Apis.Bigquery.v2.Data.JobConfigurationLoad.HivePartitioningMode
getset

[Optional, Trusted Tester] Deprecated, do not use. Please set hivePartitioningOptions instead.

◆ HivePartitioningOptions

virtual HivePartitioningOptions Google.Apis.Bigquery.v2.Data.JobConfigurationLoad.HivePartitioningOptions
getset

[Optional, Trusted Tester] Options to configure hive partitioning support.

◆ IgnoreUnknownValues

virtual System.Nullable<bool> Google.Apis.Bigquery.v2.Data.JobConfigurationLoad.IgnoreUnknownValues
getset

[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

◆ MaxBadRecords

virtual System.Nullable<int> Google.Apis.Bigquery.v2.Data.JobConfigurationLoad.MaxBadRecords
getset

[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

virtual string Google.Apis.Bigquery.v2.Data.JobConfigurationLoad.NullMarker
getset

[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.

◆ ProjectionFields

virtual System.Collections.Generic.IList<string> Google.Apis.Bigquery.v2.Data.JobConfigurationLoad.ProjectionFields
getset

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.

◆ Quote

virtual string Google.Apis.Bigquery.v2.Data.JobConfigurationLoad.Quote
getset

[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

virtual RangePartitioning Google.Apis.Bigquery.v2.Data.JobConfigurationLoad.RangePartitioning
getset

[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

◆ Schema

virtual TableSchema Google.Apis.Bigquery.v2.Data.JobConfigurationLoad.Schema
getset

[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.

◆ SchemaInline

virtual string Google.Apis.Bigquery.v2.Data.JobConfigurationLoad.SchemaInline
getset

[Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".

◆ SchemaInlineFormat

virtual string Google.Apis.Bigquery.v2.Data.JobConfigurationLoad.SchemaInlineFormat
getset

[Deprecated] The format of the schemaInline property.

◆ SchemaUpdateOptions

virtual System.Collections.Generic.IList<string> Google.Apis.Bigquery.v2.Data.JobConfigurationLoad.SchemaUpdateOptions
getset

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.

◆ SkipLeadingRows

virtual System.Nullable<int> Google.Apis.Bigquery.v2.Data.JobConfigurationLoad.SkipLeadingRows
getset

[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

virtual string Google.Apis.Bigquery.v2.Data.JobConfigurationLoad.SourceFormat
getset

[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

virtual System.Collections.Generic.IList<string> Google.Apis.Bigquery.v2.Data.JobConfigurationLoad.SourceUris
getset

[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.

◆ TimePartitioning

virtual TimePartitioning Google.Apis.Bigquery.v2.Data.JobConfigurationLoad.TimePartitioning
getset

Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.

◆ UseAvroLogicalTypes

virtual System.Nullable<bool> Google.Apis.Bigquery.v2.Data.JobConfigurationLoad.UseAvroLogicalTypes
getset

[Optional] If sourceFormat is set to "AVRO", indicates whether to enable interpreting logical types into their corresponding types (ie. TIMESTAMP), instead of only using their raw types (ie. INTEGER).

◆ WriteDisposition

virtual string Google.Apis.Bigquery.v2.Data.JobConfigurationLoad.WriteDisposition
getset

[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.


The documentation for this class was generated from the following file: