unionml.schedule.Schedule#

class unionml.schedule.Schedule(type, name, expression=None, offset=None, fixed_rate=None, time_arg=None, inputs=None, activate_on_deploy=True, launchplan_kwargs=None)#

Data model for cron expression and fixed-rate schedules.

Attributes

activate_on_deploy

Whether or not to automatically activate this schedule on app deployment.

expression

A cron expression) or valid croniter schedule for e.g.

fixed_rate

A timedelta object representing fixed rate with which to run the workflow.

inputs

Inputs to be passed into the scheduled launchplan.

launchplan_kwargs

Additional keyword arguments to pass to flytekit.LaunchPlan

offset

Duration to offset the schedule, must be a valid ISO 8601 duration .

time_arg

The name of the argument in the workflow that will receive the kickoff time of the scheduled launchplan.

type

'trainer' or 'predictor' schedule type.

name

Name of the schedule.

activate_on_deploy: bool = True#

Whether or not to automatically activate this schedule on app deployment.

expression: Optional[str] = None#

A cron expression) or valid croniter schedule for e.g. "@daily", "@hourly", "@weekly", "@yearly".

fixed_rate: Optional[timedelta] = None#

A timedelta object representing fixed rate with which to run the workflow.

inputs: Optional[dict] = None#

Inputs to be passed into the scheduled launchplan.

launchplan_kwargs: Optional[dict] = None#

Additional keyword arguments to pass to flytekit.LaunchPlan

name: str#

Name of the schedule. Must be unique in the context of a Model definiton.

offset: Optional[str] = None#

Duration to offset the schedule, must be a valid ISO 8601 duration . Only used if expression is specified.

time_arg: Optional[str] = None#

The name of the argument in the workflow that will receive the kickoff time of the scheduled launchplan.

type: Union[str, ScheduleType]#

‘trainer’ or ‘predictor’ schedule type.