google.cloud.bigquery.job.CopyJob#
Methods
Add a callback to be executed when the operation is complete. |
|
|
API call: cancel job via a POST request |
Check if the job has been cancelled. |
|
|
Refresh the job and checks if it is complete. |
|
Get the exception from the operation, blocking if necessary. |
|
API call: test for the existence of the job via a GET request |
|
Factory: construct a job given its API representation |
|
API call: refresh job properties via a GET request. |
|
Start the job and wait for it to complete and get the result. |
|
True if the operation is currently running. |
|
Set the Future’s exception. |
|
Set the Future’s result. |
Generate a resource for |
Attributes
See |
|
Datetime at which the job was created. |
|
Custom encryption configuration for the destination table. |
|
Datetime at which the job finished. |
|
Error information about the job as a whole. |
|
Information about individual errors generated by the job. |
|
ETag for the job resource. |
|
ID of the job. |
|
Type of job |
|
Labels for the job. |
|
Location where the job runs. |
|
URL path for the job’s APIs. |
|
Project bound to the job. |
|
URL for the job resource. |
|
Datetime at which the job was started. |
|
Status of the job. |
|
E-mail address of user who submitted the job. |
|
See |
-
class
google.cloud.bigquery.job.
CopyJob
(job_id, sources, destination, client, job_config=None)[source]# Bases:
google.cloud.bigquery.job._AsyncJob
Asynchronous job: copy data into a table from other tables.
- Parameters
job_id (str) – the job’s ID, within the project belonging to
client
.sources (list of
google.cloud.bigquery.table.TableReference
) – Table from which data is to be loaded.destination (
google.cloud.bigquery.table.TableReference
) – Table into which data is to be loaded.client (
google.cloud.bigquery.client.Client
) – A client which holds credentials and project configuration for the dataset (which requires a project).job_config (
CopyJobConfig
) – (Optional) Extra configuration options for the copy job.
-
add_done_callback
(fn)# Add a callback to be executed when the operation is complete.
If the operation is not already complete, this will start a helper thread to poll for the status of the operation in the background.
- Parameters
fn (Callable[Future]) – The callback to execute when the operation is complete.
-
cancel
(client=None)# API call: cancel job via a POST request
See https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/cancel
-
cancelled
()# Check if the job has been cancelled.
This always returns False. It’s not possible to check if a job was cancelled in the API. This method is here to satisfy the interface for
google.api_core.future.Future
.- Return type
- Returns
False
-
property
create_disposition
# See
google.cloud.bigquery.job.CopyJobConfig.create_disposition
.
-
property
created
# Datetime at which the job was created.
- Return type
datetime.datetime
, orNoneType
- Returns
the creation time (None until set from the server).
-
property
destination_encryption_configuration
# Custom encryption configuration for the destination table.
Custom encryption configuration (e.g., Cloud KMS keys) or
None
if using default encryption.See
google.cloud.bigquery.job.CopyJobConfig.destination_encryption_configuration
.
-
done
(retry=<google.api_core.retry.Retry object>)# Refresh the job and checks if it is complete.
- Parameters
retry (
google.api_core.retry.Retry
) – (Optional) How to retry the RPC.- Return type
- Returns
True if the job is complete, False otherwise.
-
property
ended
# Datetime at which the job finished.
- Return type
datetime.datetime
, orNoneType
- Returns
the end time (None until set from the server).
-
property
error_result
# Error information about the job as a whole.
- Return type
mapping, or
NoneType
- Returns
the error information (None until set from the server).
-
property
errors
# Information about individual errors generated by the job.
- Return type
list of mappings, or
NoneType
- Returns
the error information (None until set from the server).
-
property
etag
# ETag for the job resource.
- Return type
str, or
NoneType
- Returns
the ETag (None until set from the server).
-
exception
(timeout=None)# Get the exception from the operation, blocking if necessary.
- Parameters
timeout (int) – How long to wait for the operation to complete. If None, wait indefinitely.
- Returns
- The operation’s
error.
- Return type
Optional[google.api_core.GoogleAPICallError]
-
exists
(client=None, retry=<google.api_core.retry.Retry object>)# API call: test for the existence of the job via a GET request
See https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/get
- Parameters
client (
Client
orNoneType
) – the client to use. If not passed, falls back to theclient
stored on the current dataset.retry (
google.api_core.retry.Retry
) – (Optional) How to retry the RPC.
- Return type
- Returns
Boolean indicating existence of the job.
-
classmethod
from_api_repr
(resource, client)[source]# Factory: construct a job given its API representation
- Parameters
resource (dict) – dataset job representation returned from the API
client (
google.cloud.bigquery.client.Client
) – Client which holds credentials and project configuration for the dataset.
- Return type
- Returns
Job parsed from
resource
.
-
property
path
# URL path for the job’s APIs.
- Return type
- Returns
the path based on project and job ID.
-
property
project
# Project bound to the job.
- Return type
- Returns
the project (derived from the client).
-
reload
(client=None, retry=<google.api_core.retry.Retry object>)# API call: refresh job properties via a GET request.
See https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/get
- Parameters
client (
Client
orNoneType
) – the client to use. If not passed, falls back to theclient
stored on the current dataset.retry (
google.api_core.retry.Retry
) – (Optional) How to retry the RPC.
-
result
(timeout=None, retry=<google.api_core.retry.Retry object>)# Start the job and wait for it to complete and get the result.
- Parameters
timeout (float) – How long (in seconds) to wait for job to complete before raising a
concurrent.futures.TimeoutError
.retry (
google.api_core.retry.Retry
) – (Optional) How to retry the RPC.
- Return type
_AsyncJob
- Returns
This instance.
- Raises
GoogleCloudError
if the job failed orconcurrent.futures.TimeoutError
if the job did not complete in the given timeout.
-
running
()# True if the operation is currently running.
-
property
self_link
# URL for the job resource.
- Return type
str, or
NoneType
- Returns
the URL (None until set from the server).
-
set_exception
(exception)# Set the Future’s exception.
-
set_result
(result)# Set the Future’s result.
-
property
started
# Datetime at which the job was started.
- Return type
datetime.datetime
, orNoneType
- Returns
the start time (None until set from the server).
-
property
state
# Status of the job.
- Return type
str, or
NoneType
- Returns
the state (None until set from the server).
-
property
user_email
# E-mail address of user who submitted the job.
- Return type
str, or
NoneType
- Returns
the URL (None until set from the server).
-
property
write_disposition
# See
google.cloud.bigquery.job.CopyJobConfig.write_disposition
.