flytekit.models.common

Directory

Classes

flytekit.models.common.Annotations

def Annotations(
    values,
):

Annotation values to be applied to a workflow execution resource.

Methods

from_flyte_idl()

def from_flyte_idl(
    pb2_object,
):

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

to_flyte_idl()

def to_flyte_idl()

verbose_string()

def verbose_string()

Properties

flytekit.models.common.AuthRole

def AuthRole(
    assumable_iam_role,
    kubernetes_service_account,
):

Auth configuration for IAM or K8s service account.

Either one or both of the assumable IAM role and/or the K8s service account can be set.

Methods

from_flyte_idl()

def from_flyte_idl(
    pb2_object,
):

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

to_flyte_idl()

def to_flyte_idl()

verbose_string()

def verbose_string()

Properties

flytekit.models.common.EmailNotification

def EmailNotification(
    recipients_email,
):

Methods

from_flyte_idl()

def from_flyte_idl(
    pb2_object,
):

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

to_flyte_idl()

def to_flyte_idl()

verbose_string()

def verbose_string()

Properties

flytekit.models.common.Envs

def Envs(
    envs: typing.Dict[str, str],
):

Methods

from_flyte_idl()

def from_flyte_idl(
    pb2: flyteidl.admin.common_pb2.Envs,
):

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

to_flyte_idl()

def to_flyte_idl()

verbose_string()

def verbose_string()

Properties

flytekit.models.common.FlyteABCMeta

Metaclass for defining Abstract Base Classes (ABCs).

Use this metaclass to create an ABC. An ABC can be subclassed directly, and then acts as a mix-in class. You can also register unrelated concrete classes (even built-in classes) and unrelated ABCs as ‘virtual subclasses’ – these and their descendants will be considered subclasses of the registering ABC by the built-in issubclass() function, but the registering ABC won’t show up in their MRO (Method Resolution Order) nor will method implementations defined by the registering ABC be callable (not even via super()).

Methods

register()

def register(
    cls,
    subclass,
):

Register a virtual subclass of an ABC.

Returns the subclass, to allow usage as a class decorator.

flytekit.models.common.FlyteCustomIdlEntity

Methods

from_dict()

def from_dict(
    idl_dict,
):

from_flyte_idl()

def from_flyte_idl(
    idl_object,
):

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

to_dict()

def to_dict()

Converts self to a dictionary.

to_flyte_idl()

def to_flyte_idl()

verbose_string()

def verbose_string()

Properties

flytekit.models.common.FlyteIdlEntity

Methods

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

to_flyte_idl()

def to_flyte_idl()

verbose_string()

def verbose_string()

Properties

flytekit.models.common.FlyteType

Metaclass for defining Abstract Base Classes (ABCs).

Use this metaclass to create an ABC. An ABC can be subclassed directly, and then acts as a mix-in class. You can also register unrelated concrete classes (even built-in classes) and unrelated ABCs as ‘virtual subclasses’ – these and their descendants will be considered subclasses of the registering ABC by the built-in issubclass() function, but the registering ABC won’t show up in their MRO (Method Resolution Order) nor will method implementations defined by the registering ABC be callable (not even via super()).

Methods

from_flyte_idl()

def from_flyte_idl(
    cls,
    idl_object,
):

register()

def register(
    cls,
    subclass,
):

Register a virtual subclass of an ABC.

Returns the subclass, to allow usage as a class decorator.

short_class_string()

def short_class_string(
    cls,
):

verbose_class_string()

def verbose_class_string(
    cls,
):

flytekit.models.common.Labels

def Labels(
    values,
):

Label values to be applied to a workflow execution resource.

Methods

from_flyte_idl()

def from_flyte_idl(
    pb2_object,
):

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

to_flyte_idl()

def to_flyte_idl()

verbose_string()

def verbose_string()

Properties

flytekit.models.common.NamedEntityIdentifier

def NamedEntityIdentifier(
    project,
    domain,
    name,
):

Methods

from_flyte_idl()

def from_flyte_idl(
    idl_object,
):

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

to_flyte_idl()

def to_flyte_idl()

Stores object to a Flyte-IDL defined protobuf.

verbose_string()

def verbose_string()

Properties

flytekit.models.common.Notification

def Notification(
    phases,
    email: flytekit.models.common.EmailNotification,
    pager_duty: flytekit.models.common.PagerDutyNotification,
    slack: flytekit.models.common.SlackNotification,
):

Represents a structure for notifications based on execution status.

Methods

from_flyte_idl()

def from_flyte_idl(
    p,
):

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

to_flyte_idl()

def to_flyte_idl()

verbose_string()

def verbose_string()

Properties

flytekit.models.common.PagerDutyNotification

def PagerDutyNotification(
    recipients_email,
):

Methods

from_flyte_idl()

def from_flyte_idl(
    pb2_object,
):

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

to_flyte_idl()

def to_flyte_idl()

verbose_string()

def verbose_string()

Properties

flytekit.models.common.RawOutputDataConfig

def RawOutputDataConfig(
    output_location_prefix,
):

Methods

from_flyte_idl()

def from_flyte_idl(
    pb2,
):

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

to_flyte_idl()

def to_flyte_idl()

verbose_string()

def verbose_string()

Properties

flytekit.models.common.SlackNotification

def SlackNotification(
    recipients_email,
):

Methods

from_flyte_idl()

def from_flyte_idl(
    pb2_object,
):

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

to_flyte_idl()

def to_flyte_idl()

verbose_string()

def verbose_string()

Properties

flytekit.models.common.StringIO

Text I/O implementation using an in-memory buffer.

The initial_value argument sets the value of object. The newline argument is like the one of TextIOWrapper’s constructor.

flytekit.models.common.UrlBlob

def UrlBlob(
    url,
    bytes,
):

Methods

from_flyte_idl()

def from_flyte_idl(
    pb,
):

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

to_flyte_idl()

def to_flyte_idl()

verbose_string()

def verbose_string()

Properties