Show / Hide Table of Contents

Class JobConfigurationExtract

JobConfigurationExtract configures a job that exports data from a BigQuery table into Google Cloud Storage.

Inheritance
object
JobConfigurationExtract
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Bigquery.v2.Data
Assembly: Google.Apis.Bigquery.v2.dll
Syntax
public class JobConfigurationExtract : IDirectResponseSchema

Properties

Compression

Optional. The compression type to use for exported files. Possible values include DEFLATE, GZIP, NONE, SNAPPY, and ZSTD. The default value is NONE. Not all compression formats are support for all file formats. DEFLATE is only supported for Avro. ZSTD is only supported for Parquet. Not applicable when extracting models.

Declaration
[JsonProperty("compression")]
public virtual string Compression { get; set; }
Property Value
Type Description
string

DestinationFormat

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.

Declaration
[JsonProperty("destinationFormat")]
public virtual string DestinationFormat { get; set; }
Property Value
Type Description
string

DestinationUri

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

Declaration
[JsonProperty("destinationUri")]
public virtual string DestinationUri { get; set; }
Property Value
Type Description
string

DestinationUris

[Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.

Declaration
[JsonProperty("destinationUris")]
public virtual IList<string> DestinationUris { get; set; }
Property Value
Type Description
IList<string>

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

FieldDelimiter

Optional. When extracting data in CSV format, this defines the delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.

Declaration
[JsonProperty("fieldDelimiter")]
public virtual string FieldDelimiter { get; set; }
Property Value
Type Description
string

ModelExtractOptions

Optional. Model extract options only applicable when extracting models.

Declaration
[JsonProperty("modelExtractOptions")]
public virtual ModelExtractOptions ModelExtractOptions { get; set; }
Property Value
Type Description
ModelExtractOptions

PrintHeader

Optional. Whether to print out a header row in the results. Default is true. Not applicable when extracting models.

Declaration
[JsonProperty("printHeader")]
public virtual bool? PrintHeader { get; set; }
Property Value
Type Description
bool?

SourceModel

A reference to the model being exported.

Declaration
[JsonProperty("sourceModel")]
public virtual ModelReference SourceModel { get; set; }
Property Value
Type Description
ModelReference

SourceTable

A reference to the table being exported.

Declaration
[JsonProperty("sourceTable")]
public virtual TableReference SourceTable { get; set; }
Property Value
Type Description
TableReference

UseAvroLogicalTypes

Whether to use logical types when extracting to AVRO format. Not applicable when extracting models.

Declaration
[JsonProperty("useAvroLogicalTypes")]
public virtual bool? UseAvroLogicalTypes { get; set; }
Property Value
Type Description
bool?

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX