flytekit.core.schedule

.. autoclass:: flytekit.core.schedule.CronSchedule :noindex:

Directory

Classes

flytekit.core.schedule.CronSchedule

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 :std:ref:User Guide <cookbook:cron schedules> for further examples.

class CronSchedule(
    cron_expression: typing.Optional[str],
    schedule: typing.Optional[str],
    offset: typing.Optional[str],
    kickoff_time_input_arg: typing.Optional[str],
)

Methods

from_flyte_idl()

def from_flyte_idl(
    pb2_object,
) -> e: Schedule

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

:rtype: Text

to_flyte_idl()

def to_flyte_idl()

:rtype: flyteidl.admin.schedule_pb2.Schedule

verbose_string()

def verbose_string()

:rtype: Text

Properties

flytekit.core.schedule.FixedRate

Use this class to schedule a fixed-rate interval for a launch plan.

    from datetime import timedelta

    FixedRate(duration=timedelta(minutes=10))

See the :std:ref:fixed rate intervals chapter in the cookbook for additional usage examples.

class FixedRate(
    duration: datetime.timedelta,
    kickoff_time_input_arg: typing.Optional[str],
)

Methods

from_flyte_idl()

def from_flyte_idl(
    pb2_object,
) -> e: Schedule

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

:rtype: Text

to_flyte_idl()

def to_flyte_idl()

:rtype: flyteidl.admin.schedule_pb2.Schedule

verbose_string()

def verbose_string()

:rtype: Text

Properties

flytekit.core.schedule.LaunchPlanTriggerBase

Base class for protocol classes.

Protocol classes are defined as::

class Proto(Protocol):
    def meth(self) -> int:
        ...

Such classes are primarily used with static type checkers that recognize structural subtyping (static duck-typing).

For example::

class C:
    def meth(self) -> int:
        return 0

def func(x: Proto) -> int:
    return x.meth()

func(C())  # Passes static type check

See PEP 544 for details. Protocol classes decorated with @typing.runtime_checkable act as simple-minded runtime protocols that check only the presence of given attributes, ignoring their type signatures. Protocol classes can be generic, they are defined as::

class GenProto[T](Protocol):
    def meth(self) -> T:
        ...

class LaunchPlanTriggerBase(
    args,
    kwargs,
)

Methods

to_flyte_idl()

def to_flyte_idl(
    args,
    kwargs,
) -> google.protobuf.message.Message

flytekit.core.schedule.OnSchedule

Base class for protocol classes.

Protocol classes are defined as::

class Proto(Protocol):
    def meth(self) -> int:
        ...

Such classes are primarily used with static type checkers that recognize structural subtyping (static duck-typing).

For example::

class C:
    def meth(self) -> int:
        return 0

def func(x: Proto) -> int:
    return x.meth()

func(C())  # Passes static type check

See PEP 544 for details. Protocol classes decorated with @typing.runtime_checkable act as simple-minded runtime protocols that check only the presence of given attributes, ignoring their type signatures. Protocol classes can be generic, they are defined as::

class GenProto[T](Protocol):
    def meth(self) -> T:
        ...

class OnSchedule(
    schedule: typing.Union[flytekit.core.schedule.CronSchedule, flytekit.core.schedule.FixedRate],
)

Methods

to_flyte_idl()

def to_flyte_idl()