google.cloud.bigquery.job.ExtractJobConfig#

Methods

from_api_repr(resource)

Factory: construct a job configuration given its API representation

to_api_repr()

Build an API representation of the job config.

Attributes

compression

Compression type to use for exported files.

destination_format

Exported file format.

field_delimiter

Delimiter to use between fields in the exported data.

labels

Labels for the job.

print_header

Print a header row in the exported data.


class google.cloud.bigquery.job.ExtractJobConfig(**kwargs)[source]#

Bases: google.cloud.bigquery.job._JobConfig

Configuration options for extract jobs.

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

property compression#

Compression type to use for exported files.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.extract.compression

Type

google.cloud.bigquery.job.Compression

property destination_format#

Exported file format.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.extract.destinationFormat

Type

google.cloud.bigquery.job.DestinationFormat

property field_delimiter#

Delimiter to use between fields in the exported data.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.extract.fieldDelimiter

Type

str

classmethod from_api_repr(resource)#

Factory: construct a job configuration given its API representation

Parameters

resource (dict) – An extract job configuration in the same representation as is returned from the API.

Return type

google.cloud.bigquery.job._JobConfig

Returns

Configuration parsed from resource.

property labels#

Labels for the job.

This method always returns a dict. To change a job’s labels, modify the dict, then call Client.update_job. To delete a label, set its value to None before updating.

Raises

ValueError – If value type is invalid.

Type

Dict[str, str]

property print_header#

Print a header row in the exported data.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.extract.printHeader

Type

bool

to_api_repr()#

Build an API representation of the job config.

Return type

dict

Returns

A dictionary in the format used by the BigQuery API.