flytekit.CronSchedule#

class flytekit.CronSchedule(cron_expression=None, schedule=None, offset=None, kickoff_time_input_arg=None)[source]#

Use this when you have a launch plan that you want to run on a cron expression. This uses standard cron format in case where you are using default native scheduler using the schedule attribute.

CronSchedule(
    schedule="*/1 * * * *",  # Following schedule runs every min
)

See the User Guide for further examples.

Methods

Parameters:

  • cron_expression (str | None)

  • schedule (str | None)

  • offset (str | None)

  • kickoff_time_input_arg (str | None)

classmethod from_flyte_idl(pb2_object)[source]#
Parameters:

pb2_object (flyteidl.admin.schedule_pb2.Schedule)

Return type:

Schedule

serialize_to_string()[source]#
Return type:

str

short_string()[source]#
Return type:

Text

to_flyte_idl()[source]#
Return type:

flyteidl.admin.schedule_pb2.Schedule

verbose_string()[source]#
Return type:

Text

Attributes

cron_expression

Text

Type:

rtype

cron_schedule

Schedule.CronSchedule

Type:

rtype

is_empty
kickoff_time_input_arg
rate

Schedule.FixedRate

Type:

rtype

schedule_expression