• Home
• airflow.providers.standard
• airflow.providers.standard.sensors
• airflow.providers.standard.sensors.time

airflow.providers.standard.sensors.time

Classes

StartTriggerArgs	Arguments required for start task execution from triggerer.
TimeSensor	Waits until the specified time of the day.
TimeSensorAsync	Deprecated. Use TimeSensor with deferrable=True instead.

Module Contents

class airflow.providers.standard.sensors.time.StartTriggerArgs

Arguments required for start task execution from triggerer.

trigger_cls: str

next_method: str

trigger_kwargs: dict[str, Any] | None = None

next_kwargs: dict[str, Any] | None = None

timeout: datetime.timedelta | None = None

class airflow.providers.standard.sensors.time.TimeSensor(*, target_time, deferrable=conf.getboolean('operators', 'default_deferrable', fallback=False), start_from_trigger=False, end_from_trigger=False, trigger_kwargs=None, **kwargs)

Bases: airflow.providers.standard.version_compat.BaseSensorOperator

Waits until the specified time of the day.

Parameters:

• target_time (datetime.time) – time after which the job succeeds

• deferrable (bool) – whether to defer execution

See also

For more information on how to use this sensor, take a look at the guide: TimeSensor

start_trigger_args

start_from_trigger = False

target_datetime = None

deferrable = True

end_from_trigger = False

execute(context)

Derive when creating an operator.

The main method to execute the task. Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

execute_complete(context, event=None)

poke(context)

Override when deriving this class.

class airflow.providers.standard.sensors.time.TimeSensorAsync(**kwargs)

Bases: TimeSensor

Deprecated. Use TimeSensor with deferrable=True instead.

Sphinx-autoapi-skip:

Previous Next

Was this entry helpful?