Class ExtractJobConfig (3.4.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

destination_format

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
TypeDescription
ValueErrorIf value type is invalid.

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
NameDescription
resource Dict

A job configuration in the same representation as is returned from the API.

Returns
TypeDescription
google.cloud.bigquery.job._JobConfigConfiguration parsed from resource.

to_api_repr

to_api_repr()

Build an API representation of the job config.

Returns
TypeDescription
DictA 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.