airflow.providers.google.cloud.operators.bigquery_dts

This module contains Google BigQuery Data Transfer Service operators.

Module Contents

Classes

BigQueryCreateDataTransferOperator

Creates a new data transfer configuration.

BigQueryDeleteDataTransferConfigOperator

Deletes transfer configuration.

BigQueryDataTransferServiceStartTransferRunsOperator

Start manual transfer runs to be executed now with schedule_time equal to current time.
class airflow.providers.google.cloud.operators.bigquery_dts.BigQueryCreateDataTransferOperator(*, transfer_config, project_id=None, location=None, authorization_code=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

Creates a new data transfer configuration.

See also

For more information on how to use this operator, take a look at the guide: Creating transfer configuration

Parameters

  • transfer_config (dict) – Data transfer configuration to create.

  • project_id (str | None) – The 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.

  • location (str | None) – BigQuery Transfer Service location for regional transfers.

  • authorization_code (str | None) – authorization code to use with this transfer configuration. This is required if new credentials are needed.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – 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.

  • metadata (Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

  • gcp_conn_id – The connection ID used to connect to Google Cloud.

  • impersonation_chain (str | Sequence[str] | None) – 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).

template_fields: Sequence[str] = ('transfer_config', 'project_id', 'authorization_code', 'gcp_conn_id', 'impersonation_chain')[source]
execute(context)[source]

This is the main method to derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.bigquery_dts.BigQueryDeleteDataTransferConfigOperator(*, transfer_config_id, project_id=None, location=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

Deletes transfer configuration.

See also

For more information on how to use this operator, take a look at the guide: Deleting transfer configuration

Parameters

  • transfer_config_id (str) – Id of transfer config to be used.

  • project_id (str | None) – The 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.

  • location (str | None) – BigQuery Transfer Service location for regional transfers.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – 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.

  • metadata (Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

  • gcp_conn_id – The connection ID used to connect to Google Cloud.

  • impersonation_chain (str | Sequence[str] | None) – 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).

template_fields: Sequence[str] = ('transfer_config_id', 'project_id', 'gcp_conn_id', 'impersonation_chain')[source]
execute(context)[source]

This is the main method to derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.bigquery_dts.BigQueryDataTransferServiceStartTransferRunsOperator(*, transfer_config_id, project_id=None, location=None, requested_time_range=None, requested_run_time=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, deferrable=conf.getboolean('operators', 'default_deferrable', fallback=False), **kwargs)[source]

Bases: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

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

Parameters

  • transfer_config_id (str) – Id of transfer config to be used.

  • requested_time_range (dict | None) – 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_time (dict | None) – 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_id (str | None) – The BigQuery project id where the transfer configuration should be created.

  • location (str | None) – BigQuery Transfer Service location for regional transfers.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – 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.

  • metadata (Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

  • gcp_conn_id – The connection ID used to connect to Google Cloud.

  • impersonation_chain (str | Sequence[str] | None) – 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).

  • deferrable (bool) – Run operator in the deferrable mode.

template_fields: Sequence[str] = ('transfer_config_id', 'project_id', 'requested_time_range', 'requested_run_time',...[source]
hook()[source]
execute(context)[source]

This is the main method to derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

execute_completed(context, event)[source]

Method to be executed after invoked trigger in defer method finishes its job.

Was this entry helpful?