Source code for airflow.contrib.sensors.gcp_transfer_sensor

# -*- coding: utf-8 -*-
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.
import six

from airflow.contrib.hooks.gcp_transfer_hook import GCPTransferServiceHook
from airflow.sensors.base_sensor_operator import BaseSensorOperator
from airflow.utils.decorators import apply_defaults

[docs]class GCPTransferServiceWaitForJobStatusSensor(BaseSensorOperator): """ Waits for at least one operation belonging to the job to have the expected status. :param job_name: The name of the transfer job :type job_name: str :param expected_statuses: The expected state of the operation. See: :type expected_statuses: set[str] or string :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 GCP connection is used. :type project_id: str :param gcp_conn_id: The connection ID used to connect to Google Cloud Platform. :type gcp_conn_id: str """ # [START gcp_transfer_job_sensor_template_fields]
[docs] template_fields = ('job_name',)
# [END gcp_transfer_job_sensor_template_fields] @apply_defaults def __init__( self, job_name, expected_statuses, project_id=None, gcp_conn_id='google_cloud_default', *args, **kwargs ): super(GCPTransferServiceWaitForJobStatusSensor, self).__init__(*args, **kwargs) self.job_name = job_name self.expected_statuses = ( {expected_statuses} if isinstance(expected_statuses, six.string_types) else expected_statuses ) self.project_id = project_id self.gcp_cloud_conn_id = gcp_conn_id
[docs] def poke(self, context): hook = GCPTransferServiceHook(gcp_conn_id=self.gcp_cloud_conn_id) operations = hook.list_transfer_operations( filter={'project_id': self.project_id, 'job_names': [self.job_name]} ) check = GCPTransferServiceHook.operations_contain_expected_statuses( operations=operations, expected_statuses=self.expected_statuses ) if check: self.xcom_push(key="sensed_operations", value=operations, context=context) return check

Was this entry helpful?