2.0.0b35

Trigger

Package: flyte

This class defines specification of a Trigger, that can be associated with any Flyte V2 task. The trigger then is deployed to the Flyte Platform.

Triggers can be used to run tasks on a schedule, in response to events, or based on other conditions. The Trigger class encapsulates the metadata and configuration needed to define a trigger.

You can associate the same Trigger object with multiple tasks.

Example usage:

        
    
from flyte.trigger import Trigger
my_trigger = Trigger(
    name="my_trigger",
    description="A trigger that runs every hour",
)

        
    
class Trigger(
    name: str,
    automation: Union[Cron, FixedRate],
    description: str,
    auto_activate: bool,
    inputs: Dict[str, Any] | None,
    env_vars: Dict[str, str] | None,
    interruptible: bool | None,
    overwrite_cache: bool,
    queue: str | None,
    labels: Mapping[str, str] | None,
    annotations: Mapping[str, str] | None,
)

Parameter	Type	Description
`name`	`str`	The name of the trigger.
`automation`	`Union[Cron, FixedRate]`	The automation type, currently only supports Cron.
`description`	`str`	A description of the trigger, default is an empty string.
`auto_activate`	`bool`	Whether the trigger should be automatically activated, default is True.
`inputs`	`Dict[str, Any] \| None`	Optional inputs for the trigger, default is None. If provided, will replace the values for inputs to these defaults.
`env_vars`	`Dict[str, str] \| None`	Optional environment variables for the trigger, default is None. If provided, will replace the environment variables set in the config of the task.
`interruptible`	`bool \| None`	Whether the trigger run is interruptible, default is None (maintains the configured behavior). If provided, it overrides whatever is set in the config of the task.
`overwrite_cache`	`bool`	Whether to overwrite the cache, default is False.
`queue`	`str \| None`	Optional queue to run the trigger in, default is None.
`labels`	`Mapping[str, str] \| None`	Optional labels to attach to the trigger, default is None.
`annotations`	`Mapping[str, str] \| None`	Optional annotations to attach to the trigger, default is None.

Methods

Method	Description
`daily()`	Creates a Cron trigger that runs daily at midnight.
`hourly()`	Creates a Cron trigger that runs every hour.
`minutely()`	Creates a Cron trigger that runs every minute.
`monthly()`	Creates a Cron trigger that runs monthly on the 1st at midnight.
`weekly()`	Creates a Cron trigger that runs weekly on Sundays at midnight.

daily()

        
    
def daily(
    trigger_time_input_key: str | None,
    name: str,
    description: str,
    auto_activate: bool,
    inputs: Dict[str, Any] | None,
    env_vars: Dict[str, str] | None,
    interruptible: bool | None,
    overwrite_cache: bool,
    queue: str | None,
    labels: Mapping[str, str] | None,
    annotations: Mapping[str, str] | None,
) -> Trigger

Creates a Cron trigger that runs daily at midnight.

Parameter	Type	Description
`trigger_time_input_key`	`str \| None`	The input key for the trigger time. If None, no trigger time input is added.
`name`	`str`	The name of the trigger, default is “daily”.
`description`	`str`	A description of the trigger.
`auto_activate`	`bool`	Whether the trigger should be automatically activated.
`inputs`	`Dict[str, Any] \| None`	Optional inputs for the trigger.
`env_vars`	`Dict[str, str] \| None`	Optional environment variables.
`interruptible`	`bool \| None`	Whether the triggered run is interruptible.
`overwrite_cache`	`bool`	Whether to overwrite the cache.
`queue`	`str \| None`	Optional queue to run the trigger in.
`labels`	`Mapping[str, str] \| None`	Optional labels to attach to the trigger.
`annotations`	`Mapping[str, str] \| None`	Optional annotations to attach to the trigger.

hourly()

        
    
def hourly(
    trigger_time_input_key: str | None,
    name: str,
    description: str,
    auto_activate: bool,
    inputs: Dict[str, Any] | None,
    env_vars: Dict[str, str] | None,
    interruptible: bool | None,
    overwrite_cache: bool,
    queue: str | None,
    labels: Mapping[str, str] | None,
    annotations: Mapping[str, str] | None,
) -> Trigger

Creates a Cron trigger that runs every hour.

Parameter	Type	Description
`trigger_time_input_key`	`str \| None`	The input parameter for the trigger time. If None, no trigger time input is added.
`name`	`str`	The name of the trigger, default is “hourly”.
`description`	`str`	A description of the trigger.
`auto_activate`	`bool`	Whether the trigger should be automatically activated.
`inputs`	`Dict[str, Any] \| None`	Optional inputs for the trigger.
`env_vars`	`Dict[str, str] \| None`	Optional environment variables.
`interruptible`	`bool \| None`	Whether the trigger is interruptible.
`overwrite_cache`	`bool`	Whether to overwrite the cache.
`queue`	`str \| None`	Optional queue to run the trigger in.
`labels`	`Mapping[str, str] \| None`	Optional labels to attach to the trigger.
`annotations`	`Mapping[str, str] \| None`	Optional annotations to attach to the trigger.

minutely()

        
    
def minutely(
    trigger_time_input_key: str | None,
    name: str,
    description: str,
    auto_activate: bool,
    inputs: Dict[str, Any] | None,
    env_vars: Dict[str, str] | None,
    interruptible: bool | None,
    overwrite_cache: bool,
    queue: str | None,
    labels: Mapping[str, str] | None,
    annotations: Mapping[str, str] | None,
) -> Trigger

Creates a Cron trigger that runs every minute.

Parameter	Type	Description
`trigger_time_input_key`	`str \| None`	The input parameter for the trigger time. If None, no trigger time input is added.
`name`	`str`	The name of the trigger, default is “every_minute”.
`description`	`str`	A description of the trigger.
`auto_activate`	`bool`	Whether the trigger should be automatically activated.
`inputs`	`Dict[str, Any] \| None`	Optional inputs for the trigger.
`env_vars`	`Dict[str, str] \| None`	Optional environment variables.
`interruptible`	`bool \| None`	Whether the trigger is interruptible.
`overwrite_cache`	`bool`	Whether to overwrite the cache.
`queue`	`str \| None`	Optional queue to run the trigger in.
`labels`	`Mapping[str, str] \| None`	Optional labels to attach to the trigger.
`annotations`	`Mapping[str, str] \| None`	Optional annotations to attach to the trigger.

monthly()

        
    
def monthly(
    trigger_time_input_key: str | None,
    name: str,
    description: str,
    auto_activate: bool,
    inputs: Dict[str, Any] | None,
    env_vars: Dict[str, str] | None,
    interruptible: bool | None,
    overwrite_cache: bool,
    queue: str | None,
    labels: Mapping[str, str] | None,
    annotations: Mapping[str, str] | None,
) -> Trigger

Creates a Cron trigger that runs monthly on the 1st at midnight.

Parameter	Type	Description
`trigger_time_input_key`	`str \| None`	The input parameter for the trigger time. If None, no trigger time input is added.
`name`	`str`	The name of the trigger, default is “monthly”.
`description`	`str`	A description of the trigger.
`auto_activate`	`bool`	Whether the trigger should be automatically activated.
`inputs`	`Dict[str, Any] \| None`	Optional inputs for the trigger.
`env_vars`	`Dict[str, str] \| None`	Optional environment variables.
`interruptible`	`bool \| None`	Whether the trigger is interruptible.
`overwrite_cache`	`bool`	Whether to overwrite the cache.
`queue`	`str \| None`	Optional queue to run the trigger in.
`labels`	`Mapping[str, str] \| None`	Optional labels to attach to the trigger.
`annotations`	`Mapping[str, str] \| None`	Optional annotations to attach to the trigger.

weekly()

        
    
def weekly(
    trigger_time_input_key: str | None,
    name: str,
    description: str,
    auto_activate: bool,
    inputs: Dict[str, Any] | None,
    env_vars: Dict[str, str] | None,
    interruptible: bool | None,
    overwrite_cache: bool,
    queue: str | None,
    labels: Mapping[str, str] | None,
    annotations: Mapping[str, str] | None,
) -> Trigger

Creates a Cron trigger that runs weekly on Sundays at midnight.

Parameter	Type	Description
`trigger_time_input_key`	`str \| None`	The input parameter for the trigger time. If None, no trigger time input is added.
`name`	`str`	The name of the trigger, default is “weekly”.
`description`	`str`	A description of the trigger.
`auto_activate`	`bool`	Whether the trigger should be automatically activated.
`inputs`	`Dict[str, Any] \| None`	Optional inputs for the trigger.
`env_vars`	`Dict[str, str] \| None`	Optional environment variables.
`interruptible`	`bool \| None`	Whether the trigger is interruptible.
`overwrite_cache`	`bool`	Whether to overwrite the cache.
`queue`	`str \| None`	Optional queue to run the trigger in.
`labels`	`Mapping[str, str] \| None`	Optional labels to attach to the trigger.
`annotations`	`Mapping[str, str] \| None`	Optional annotations to attach to the trigger.