BigQueryDataTransferServiceStartTransferRunsOperator

Google

Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time.

View Source

Last Updated: Dec. 31, 2020

Access Instructions

Install the Google provider package into your Airflow environment.

Import the module into your DAG file and instantiate it with your desired params.

Parameters

transfer_config_idstrId of transfer config to be used.
requested_time_rangeUnion[dict, ~google.cloud.bigquery_datatransfer_v1.types.TimeRange]Time range for the transfer runs that should be started. If a dict is provided, it must be of the same form as the protobuf message ~google.cloud.bigquery_datatransfer_v1.types.TimeRange
requested_run_timeUnion[dict, ~google.cloud.bigquery_datatransfer_v1.types.Timestamp]Specific run_time for a transfer run to be started. The requested_run_time must not be in the future. If a dict is provided, it must be of the same form as the protobuf message ~google.cloud.bigquery_datatransfer_v1.types.Timestamp
project_idstrThe BigQuery project id where the transfer configuration should be created. If set to None or missing, the default project_id from the Google Cloud connection is used.
retryOptional[google.api_core.retry.Retry]A retry object used to retry requests. If None is specified, requests will not be retried.
timeoutOptional[float]The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadataOptional[Sequence[Tuple[str, str]]]Additional metadata that is provided to the method.
gcp_conn_idstrThe connection ID used to connect to Google Cloud.
impersonation_chainUnion[str, Sequence[str]]Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

Documentation

Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time.

See also

For more information on how to use this operator, take a look at the guide: Manually starting transfer runs

Was this page helpful?