| :py:mod:`airflow.providers.google.cloud.sensors.cloud_storage_transfer_service` |
| =============================================================================== |
| |
| .. py:module:: airflow.providers.google.cloud.sensors.cloud_storage_transfer_service |
| |
| .. autoapi-nested-parse:: |
| |
| This module contains a Google Cloud Transfer sensor. |
| |
| |
| |
| Module Contents |
| --------------- |
| |
| Classes |
| ~~~~~~~ |
| |
| .. autoapisummary:: |
| |
| airflow.providers.google.cloud.sensors.cloud_storage_transfer_service.CloudDataTransferServiceJobStatusSensor |
| |
| |
| |
| |
| .. py:class:: CloudDataTransferServiceJobStatusSensor(*, job_name, expected_statuses, project_id = None, gcp_conn_id = 'google_cloud_default', impersonation_chain = None, **kwargs) |
| |
| Bases: :py:obj:`airflow.sensors.base.BaseSensorOperator` |
| |
| Waits for at least one operation belonging to the job to have the |
| expected status. |
| |
| .. seealso:: |
| For more information on how to use this operator, take a look at the guide: |
| :ref:`howto/operator:CloudDataTransferServiceJobStatusSensor` |
| |
| :param job_name: The name of the transfer job |
| :param expected_statuses: The expected state of the operation. |
| See: |
| https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferOperations#Status |
| :param project_id: (Optional) the ID of the project that owns the Transfer |
| Job. If set to None or missing, the default project_id from the Google Cloud |
| connection is used. |
| :param gcp_conn_id: The connection ID used to connect to Google Cloud. |
| :param impersonation_chain: 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). |
| |
| .. py:attribute:: template_fields |
| :annotation: :Sequence[str] = ['job_name', 'impersonation_chain'] |
| |
| |
| |
| .. py:method:: poke(self, context) |
| |
| Function that the sensors defined while deriving this class should |
| override. |
| |
| |
| |