0.1.dev2192+g7c539c3.d20250403

flytekit.models.matchable_resource

Directory

Classes

Class Description
ClusterResourceAttributes
ExecutionClusterLabel
ExecutionQueueAttributes
MatchableResource
MatchingAttributes
PluginOverride
PluginOverrides

flytekit.models.matchable_resource.ClusterResourceAttributes

class ClusterResourceAttributes(
    attributes,
)

Custom resource attributes which will be applied in cluster resource creation (e.g. quotas). Dict keys are the case-sensitive names of variables in templatized resource files. Dict values should be the custom values which get substituted during resource creation.

Parameter Type
attributes

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: ClusterResourceAttributes
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.matchable_resource_pb2.ClusterResourceAttributes

verbose_string()

def verbose_string()

:rtype: Text

Properties

Property Type Description
attributes
Custom resource attributes which will be applied in cluster resource management
:rtype: dict[Text, Text]
is_empty

flytekit.models.matchable_resource.ExecutionClusterLabel

class ExecutionClusterLabel(
    value,
)

Label value to determine where the execution will be run

Parameter Type
value

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: ExecutionClusterLabel
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.matchable_resource_pb2.ExecutionClusterLabel

verbose_string()

def verbose_string()

:rtype: Text

Properties

Property Type Description
is_empty
value
:rtype: Text

flytekit.models.matchable_resource.ExecutionQueueAttributes

class ExecutionQueueAttributes(
    tags,
)

Tags used for assigning execution queues for tasks matching a project, domain and optionally, workflow.

Parameter Type
tags

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: ExecutionQueueAttributes
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.matchable_resource_pb2.ExecutionQueueAttributes

verbose_string()

def verbose_string()

:rtype: Text

Properties

Property Type Description
is_empty
tags
:rtype: list[Text]

flytekit.models.matchable_resource.MatchableResource

Methods

Method Description
enum_to_string()
string_to_enum()

enum_to_string()

def enum_to_string(
    val,
) -> e: Text
Parameter Type
val

string_to_enum()

def string_to_enum(
    val,
) -> e: int
Parameter Type
val

flytekit.models.matchable_resource.MatchingAttributes

class MatchingAttributes(
    cluster_resource_attributes,
    execution_queue_attributes,
    execution_cluster_label,
    plugin_overrides,
)

At most one target from cluster_resource_attributes, execution_queue_attributes or execution_cluster_label can be set.

Parameter Type
cluster_resource_attributes
execution_queue_attributes
execution_cluster_label
plugin_overrides

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: MatchingAttributes
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.matchable_resource_pb2.MatchingAttributes

verbose_string()

def verbose_string()

:rtype: Text

Properties

Property Type Description
cluster_resource_attributes
Custom resource attributes which will be applied in cluster resource creation (e.g. quotas).
:rtype: ClusterResourceAttributes
execution_cluster_label
Label value to determine where the execution will be run.
:rtype: ExecutionClusterLabel
execution_queue_attributes
Tags used for assigning execution queues for tasks.
:rtype: ExecutionQueueAttributes
is_empty
plugin_overrides
Plugin implementation overrides for specific task types.
:rtype: PluginOverrides

flytekit.models.matchable_resource.PluginOverride

class PluginOverride(
    task_type,
    plugin_id,
    missing_plugin_behavior,
)

Alternate plugin implementations requested for a specific task type.

Parameter Type
task_type
plugin_id
missing_plugin_behavior

Methods

Method Description
from_flyte_idl()
serialize_to_string()
short_string() :rtype: Text.
string_to_enum()
to_flyte_idl() :rtype: flyteidl.
verbose_string() :rtype: Text.

from_flyte_idl()

def from_flyte_idl(
    pb2_object,
) -> e: PluginOverride
Parameter Type
pb2_object

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

:rtype: Text

string_to_enum()

def string_to_enum(
    val,
) -> e: int
Parameter Type
val

to_flyte_idl()

def to_flyte_idl()

:rtype: flyteidl.admin.matchable_resource_pb2.PluginOverride

verbose_string()

def verbose_string()

:rtype: Text

Properties

Property Type Description
is_empty
missing_plugin_behavior
:rtype: int
plugin_id
:rtype: list[Text]
task_type
:rtype: Text

flytekit.models.matchable_resource.PluginOverrides

class PluginOverrides(
    overrides,
)

Alternate plugin implementations for designated task types.

Parameter Type
overrides

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: PluginOverrides
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.matchable_resource_pb2.PluginOverrides

verbose_string()

def verbose_string()

:rtype: Text

Properties

Property Type Description
is_empty
overrides
:rtype: list[PluginOverride]