Class CopyJobConfig (2.29.0)

CopyJobConfig(**kwargs)

Configuration options for copy 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 > CopyJobConfig

Properties

create_disposition

google.cloud.bigquery.job.CreateDisposition: Specifies behavior for creating tables.

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

destination_encryption_configuration

google.cloud.bigquery.encryption_configuration.EncryptionConfiguration: Custom encryption configuration for the destination table.

Custom encryption configuration (e.g., Cloud KMS keys) or :data:None if using default encryption.

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

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.

operation_type

The operation to perform with this copy job.

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

write_disposition

google.cloud.bigquery.job.WriteDisposition: Action that occurs if the destination table already exists.

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

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.

CopyJobConfig

CopyJobConfig(**kwargs)

Configuration options for copy jobs.