flytekit.models.common
Directory
Classes
| Class | Description |
|---|---|
Annotations |
|
AuthRole |
|
EmailNotification |
|
Envs |
|
FlyteABCMeta |
Metaclass for defining Abstract Base Classes (ABCs). |
FlyteCustomIdlEntity |
|
FlyteIdlEntity |
|
FlyteType |
Metaclass for defining Abstract Base Classes (ABCs). |
Labels |
|
NamedEntityIdentifier |
|
Notification |
|
PagerDutyNotification |
|
RawOutputDataConfig |
|
SlackNotification |
|
UrlBlob |
flytekit.models.common.Annotations
class Annotations(
values,
)Annotation values to be applied to a workflow execution resource.
| Parameter | Type |
|---|---|
values |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
. |
serialize_to_string() |
|
short_string() |
:rtype: Text. |
to_flyte_idl() |
:rtype: _common_pb2. |
verbose_string() |
:rtype: Text. |
from_flyte_idl()
def from_flyte_idl(
pb2_object,
) -> e: Annotations| Parameter | Type |
|---|---|
pb2_object |
serialize_to_string()
def serialize_to_string()short_string()
def short_string():rtype: Text
to_flyte_idl()
def to_flyte_idl():rtype: _common_pb2.Annotations
verbose_string()
def verbose_string():rtype: Text
Properties
| Property | Type | Description |
|---|---|---|
is_empty |
||
values |
flytekit.models.common.AuthRole
class 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.
| Parameter | Type |
|---|---|
assumable_iam_role |
|
kubernetes_service_account |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
. |
serialize_to_string() |
|
short_string() |
:rtype: Text. |
to_flyte_idl() |
:rtype: flyteidl. |
verbose_string() |
:rtype: Text. |
from_flyte_idl()
def from_flyte_idl(
pb2_object,
) -> e: Auth| Parameter | Type |
|---|---|
pb2_object |
serialize_to_string()
def serialize_to_string()short_string()
def short_string():rtype: Text
to_flyte_idl()
def to_flyte_idl():rtype: flyteidl.admin.launch_plan_pb2.Auth
verbose_string()
def verbose_string():rtype: Text
Properties
| Property | Type | Description |
|---|---|---|
assumable_iam_role |
The IAM role to execute the workflow with :rtype: Text |
|
is_empty |
||
kubernetes_service_account |
The kubernetes service account to execute the workflow with :rtype: Text |
flytekit.models.common.EmailNotification
class EmailNotification(
recipients_email,
)| Parameter | Type |
|---|---|
recipients_email |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
. |
serialize_to_string() |
|
short_string() |
:rtype: Text. |
to_flyte_idl() |
:rtype: flyteidl. |
verbose_string() |
:rtype: Text. |
from_flyte_idl()
def from_flyte_idl(
pb2_object,
) -> e: EmailNotification| Parameter | Type |
|---|---|
pb2_object |
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.EmailNotification
verbose_string()
def verbose_string():rtype: Text
Properties
| Property | Type | Description |
|---|---|---|
is_empty |
||
recipients_email |
:rtype: list[Text] |
flytekit.models.common.Envs
class Envs(
envs: typing.Dict[str, str],
)| Parameter | Type |
|---|---|
envs |
typing.Dict[str, str] |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
|
serialize_to_string() |
|
short_string() |
:rtype: Text. |
to_flyte_idl() |
|
verbose_string() |
:rtype: Text. |
from_flyte_idl()
def from_flyte_idl(
pb2: flyteidl.admin.common_pb2.Envs,
) -> flyteidl.admin.common_pb2.Envs| Parameter | Type |
|---|---|
pb2 |
flyteidl.admin.common_pb2.Envs |
serialize_to_string()
def serialize_to_string()short_string()
def short_string():rtype: Text
to_flyte_idl()
def to_flyte_idl()verbose_string()
def verbose_string():rtype: Text
Properties
| Property | Type | Description |
|---|---|---|
envs |
||
is_empty |
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
| Method | Description |
|---|---|
register() |
Register a virtual subclass of an ABC. |
register()
def register(
cls,
subclass,
)Register a virtual subclass of an ABC.
Returns the subclass, to allow usage as a class decorator.
| Parameter | Type |
|---|---|
cls |
|
subclass |
flytekit.models.common.FlyteCustomIdlEntity
Methods
| Method | Description |
|---|---|
from_dict() |
|
from_flyte_idl() |
. |
serialize_to_string() |
|
short_string() |
:rtype: Text. |
to_dict() |
Converts self to a dictionary. |
to_flyte_idl() |
|
verbose_string() |
:rtype: Text. |
from_dict()
def from_dict(
idl_dict,
)| Parameter | Type |
|---|---|
idl_dict |
from_flyte_idl()
def from_flyte_idl(
idl_object,
) -> n: FlyteCustomIdlEntity| Parameter | Type |
|---|---|
idl_object |
serialize_to_string()
def serialize_to_string()short_string()
def short_string():rtype: Text
to_dict()
def to_dict()Converts self to a dictionary. :rtype: dict[Text, T]
to_flyte_idl()
def to_flyte_idl()verbose_string()
def verbose_string():rtype: Text
Properties
| Property | Type | Description |
|---|---|---|
is_empty |
flytekit.models.common.FlyteIdlEntity
Methods
| Method | Description |
|---|---|
serialize_to_string() |
|
short_string() |
:rtype: Text. |
to_flyte_idl() |
|
verbose_string() |
:rtype: Text. |
serialize_to_string()
def serialize_to_string()short_string()
def short_string():rtype: Text
to_flyte_idl()
def to_flyte_idl()verbose_string()
def verbose_string():rtype: Text
Properties
| Property | Type | Description |
|---|---|---|
is_empty |
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
| Method | Description |
|---|---|
from_flyte_idl() |
|
register() |
Register a virtual subclass of an ABC. |
short_class_string() |
:rtype: Text. |
verbose_class_string() |
:rtype: Text. |
from_flyte_idl()
def from_flyte_idl(
cls,
idl_object,
)| Parameter | Type |
|---|---|
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.
| Parameter | Type |
|---|---|
cls |
|
subclass |
short_class_string()
def short_class_string(
cls,
) -> e: Text:rtype: Text
| Parameter | Type |
|---|---|
cls |
verbose_class_string()
def verbose_class_string(
cls,
) -> e: Text:rtype: Text
| Parameter | Type |
|---|---|
cls |
flytekit.models.common.Labels
class Labels(
values,
)Label values to be applied to a workflow execution resource.
| Parameter | Type |
|---|---|
values |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
. |
serialize_to_string() |
|
short_string() |
:rtype: Text. |
to_flyte_idl() |
:rtype: dict[Text, Text]. |
verbose_string() |
:rtype: Text. |
from_flyte_idl()
def from_flyte_idl(
pb2_object,
) -> e: Labels| Parameter | Type |
|---|---|
pb2_object |
serialize_to_string()
def serialize_to_string()short_string()
def short_string():rtype: Text
to_flyte_idl()
def to_flyte_idl():rtype: dict[Text, Text]
verbose_string()
def verbose_string():rtype: Text
Properties
| Property | Type | Description |
|---|---|---|
is_empty |
||
values |
flytekit.models.common.NamedEntityIdentifier
class NamedEntityIdentifier(
project,
domain,
name,
)| Parameter | Type |
|---|---|
project |
|
domain |
|
name |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
. |
serialize_to_string() |
|
short_string() |
:rtype: Text. |
to_flyte_idl() |
Stores object to a Flyte-IDL defined protobuf. |
verbose_string() |
:rtype: Text. |
from_flyte_idl()
def from_flyte_idl(
idl_object,
) -> e: NamedEntityIdentifier| Parameter | Type |
|---|---|
idl_object |
serialize_to_string()
def serialize_to_string()short_string()
def short_string():rtype: Text
to_flyte_idl()
def to_flyte_idl()Stores object to a Flyte-IDL defined protobuf. :rtype: flyteidl.admin.common_pb2.NamedEntityIdentifier
verbose_string()
def verbose_string():rtype: Text
Properties
| Property | Type | Description |
|---|---|---|
domain |
The name of the domain within the project. :rtype: Text |
|
is_empty |
||
name |
The name of the entity within the namespace of the project and domain. :rtype: Text |
|
project |
The name of the project in which this entity lives. :rtype: Text |
flytekit.models.common.Notification
class 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.
| Parameter | Type |
|---|---|
phases |
|
email |
flytekit.models.common.EmailNotification |
pager_duty |
flytekit.models.common.PagerDutyNotification |
slack |
flytekit.models.common.SlackNotification |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
. |
serialize_to_string() |
|
short_string() |
:rtype: Text. |
to_flyte_idl() |
:rtype: flyteidl. |
verbose_string() |
:rtype: Text. |
from_flyte_idl()
def from_flyte_idl(
p,
) -> e: Notification| Parameter | Type |
|---|---|
p |
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
| Property | Type | Description |
|---|---|---|
email |
:rtype: EmailNotification |
|
is_empty |
||
pager_duty |
:rtype: PagerDutyNotification |
|
phases |
A list of phases to which users can associate the notifications. :rtype: list[int] |
|
slack |
:rtype: SlackNotification |
flytekit.models.common.PagerDutyNotification
class PagerDutyNotification(
recipients_email,
)| Parameter | Type |
|---|---|
recipients_email |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
. |
serialize_to_string() |
|
short_string() |
:rtype: Text. |
to_flyte_idl() |
:rtype: flyteidl. |
verbose_string() |
:rtype: Text. |
from_flyte_idl()
def from_flyte_idl(
pb2_object,
) -> e: EmailNotification| Parameter | Type |
|---|---|
pb2_object |
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.PagerDutyNotification
verbose_string()
def verbose_string():rtype: Text
Properties
| Property | Type | Description |
|---|---|---|
is_empty |
||
recipients_email |
:rtype: list[Text] |
flytekit.models.common.RawOutputDataConfig
class RawOutputDataConfig(
output_location_prefix,
)| Parameter | Type |
|---|---|
output_location_prefix |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
|
serialize_to_string() |
|
short_string() |
:rtype: Text. |
to_flyte_idl() |
:rtype: flyteidl. |
verbose_string() |
:rtype: Text. |
from_flyte_idl()
def from_flyte_idl(
pb2,
)| Parameter | Type |
|---|---|
pb2 |
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.Auth
verbose_string()
def verbose_string():rtype: Text
Properties
| Property | Type | Description |
|---|---|---|
is_empty |
||
output_location_prefix |
flytekit.models.common.SlackNotification
class SlackNotification(
recipients_email,
)| Parameter | Type |
|---|---|
recipients_email |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
. |
serialize_to_string() |
|
short_string() |
:rtype: Text. |
to_flyte_idl() |
:rtype: flyteidl. |
verbose_string() |
:rtype: Text. |
from_flyte_idl()
def from_flyte_idl(
pb2_object,
) -> e: EmailNotification| Parameter | Type |
|---|---|
pb2_object |
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.SlackNotification
verbose_string()
def verbose_string():rtype: Text
Properties
| Property | Type | Description |
|---|---|---|
is_empty |
||
recipients_email |
:rtype: list[Text] |
flytekit.models.common.UrlBlob
class UrlBlob(
url,
bytes,
)| Parameter | Type |
|---|---|
url |
|
bytes |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
. |
serialize_to_string() |
|
short_string() |
:rtype: Text. |
to_flyte_idl() |
:rtype: flyteidl. |
verbose_string() |
:rtype: Text. |
from_flyte_idl()
def from_flyte_idl(
pb,
) -> e: UrlBlob| Parameter | Type |
|---|---|
pb |
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.UrlBlob
verbose_string()
def verbose_string():rtype: Text
Properties
| Property | Type | Description |
|---|---|---|
bytes |
:rtype: int |
|
is_empty |
||
url |
:rtype: Text |