Class ExtractJobConfig (2.29.0)

Version 2.29.0

• 3.21.0 (latest)
• 3.20.1
• 3.19.0
• 3.18.0
• 3.17.2
• 3.16.0
• 3.15.0
• 3.14.1
• 3.13.0
• 3.12.0
• 3.11.4
• 3.4.0
• 3.3.6
• 3.2.0
• 3.1.0
• 3.0.1
• 2.34.4
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.1
• 2.29.0
• 2.28.1
• 2.27.1
• 2.26.0
• 2.25.2
• 2.24.1
• 2.23.3
• 2.22.1
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.1
• 2.15.0
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.2
• 2.5.0
• 2.4.0
• 2.3.1
• 2.2.0
• 2.1.0
• 2.0.0
• 1.28.2
• 1.27.2
• 1.26.1
• 1.25.0
• 1.24.0
• 1.23.1
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0

ExtractJobConfig(**kwargs)

Configuration options for extract jobs.

All properties in this class are optional. Values which are :data:None -> server defaults. Set properties on the constructed configuration by using the property name as the name of a keyword argument.

Inheritance

builtins.object > google.cloud.bigquery.job.base._JobConfig > ExtractJobConfig

Properties

compression

google.cloud.bigquery.job.Compression: Compression type to use for exported files.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobConfigurationExtract.FIELDS.compression

destination_format

google.cloud.bigquery.job.DestinationFormat: Exported file format.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobConfigurationExtract.FIELDS.destination_format

field_delimiter

str: Delimiter to use between fields in the exported data.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobConfigurationExtract.FIELDS.field_delimiter

labels

Dict[str, str]: Labels for the job.

This method always returns a dict. Once a job has been created on the server, its labels cannot be modified anymore.

Exceptions

Type	Description
ValueError	If ``value`` type is invalid.

print_header

bool: Print a header row in the exported data.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobConfigurationExtract.FIELDS.print_header

use_avro_logical_types

bool: For loads of Avro data, governs whether Avro logical types are converted to their corresponding BigQuery types (e.g. TIMESTAMP) rather than raw types (e.g. INTEGER).

Methods

__setattr__

__setattr__(name, value)

Override to be able to raise error if an unknown property is being set

from_api_repr

from_api_repr(resource: dict)

Factory: construct a job configuration given its API representation

Parameter

Name	Description
resource	Dict A job configuration in the same representation as is returned from the API.

Returns

Type	Description
google.cloud.bigquery.job._JobConfig	Configuration parsed from ``resource``.

to_api_repr

to_api_repr()

Build an API representation of the job config.

Returns

Type	Description
Dict	A dictionary in the format used by the BigQuery API.

__init__

__init__(**kwargs)

Initialize self. See help(type(self)) for accurate signature.

ExtractJobConfig

ExtractJobConfig(**kwargs)

Configuration options for extract jobs.

All properties in this class are optional. Values which are :data:None -> server defaults. Set properties on the constructed configuration by using the property name as the name of a keyword argument.