flytekit.core.notification

Notifications are primarily used when defining Launch Plans (also can be used when launching executions) and will trigger the Flyte platform to send emails when a workflow run reaches certain stages (fails or succeeds, etc.).

Each notification type takes a list of :py:class:flytekit.models.core.execution.WorkflowExecutionPhase and a list of emails. Even though there are different notification classes in this module, they all just send email. The differentiation offers semantic meaning to the end-user but do not functionally behave differently. Successful integration with Slack and Pagerduty is incumbent on those email API being set-up correctly.

.. autoclass:: flytekit.core.notification.Notification

Directory

Classes

flytekit.core.notification.Email

This notification should be used when sending regular emails to people.

from flytekit.models.core.execution import WorkflowExecutionPhase

Email(phases=[WorkflowExecutionPhase.SUCCEEDED], recipients_email=["my-team@email.com"])

class Email(
    phases: typing.List[int],
    recipients_email: typing.List[str],
)

Methods

from_flyte_idl()

def from_flyte_idl(
    p,
) -> e: Notification

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

:rtype: Text

to_flyte_idl()

def to_flyte_idl()

:rtype: flyteidl.admin.common_pb2.Notification

verbose_string()

def verbose_string()

:rtype: Text

Properties

flytekit.core.notification.Notification

class Notification(
    phases: typing.List[int],
    email: flytekit.models.common.EmailNotification,
    pager_duty: flytekit.models.common.PagerDutyNotification,
    slack: flytekit.models.common.SlackNotification,
)

Methods

from_flyte_idl()

def from_flyte_idl(
    p,
) -> e: Notification

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

:rtype: Text

to_flyte_idl()

def to_flyte_idl()

:rtype: flyteidl.admin.common_pb2.Notification

verbose_string()

def verbose_string()

:rtype: Text

Properties

flytekit.core.notification.PagerDuty

This notification should be used when sending emails to the PagerDuty service.

from flytekit.models.core.execution import WorkflowExecutionPhase

PagerDuty(phases=[WorkflowExecutionPhase.SUCCEEDED], recipients_email=["my-team@email.com"])

class PagerDuty(
    phases: typing.List[int],
    recipients_email: typing.List[str],
)

Methods

from_flyte_idl()

def from_flyte_idl(
    p,
) -> e: Notification

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

:rtype: Text

to_flyte_idl()

def to_flyte_idl()

:rtype: flyteidl.admin.common_pb2.Notification

verbose_string()

def verbose_string()

:rtype: Text

Properties

flytekit.core.notification.Slack

This notification should be used when sending emails to the Slack.

from flytekit.models.core.execution import WorkflowExecutionPhase

Slack(phases=[WorkflowExecutionPhase.SUCCEEDED], recipients_email=["my-team@email.com"])

class Slack(
    phases: typing.List[int],
    recipients_email: typing.List[str],
)

Methods

from_flyte_idl()

def from_flyte_idl(
    p,
) -> e: Notification

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

:rtype: Text

to_flyte_idl()

def to_flyte_idl()

:rtype: flyteidl.admin.common_pb2.Notification

verbose_string()

def verbose_string()

:rtype: Text

Properties