0.1.dev2192+g7c539c3.d20250403

flytekit.models.core.identifier

Directory

Classes

Class Description
Identifier
NodeExecutionIdentifier
ResourceType
SignalIdentifier
TaskExecutionIdentifier
WorkflowExecutionIdentifier

flytekit.models.core.identifier.Identifier

class Identifier(
    resource_type,
    project,
    domain,
    name,
    version,
)
Parameter Type
resource_type
project
domain
name
version

Methods

Method Description
from_flyte_idl() .
resource_type_name()
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: Identifier
Parameter Type
p

resource_type_name()

def resource_type_name()

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

:rtype: Text

to_flyte_idl()

def to_flyte_idl()

:rtype: flyteidl.core.identifier_pb2.Identifier

verbose_string()

def verbose_string()

:rtype: Text

Properties

Property Type Description
domain
:rtype: Text
is_empty
name
:rtype: Text
project
:rtype: Text
resource_type
enum value from ResourceType
:rtype: int
version
:rtype: Text

flytekit.models.core.identifier.NodeExecutionIdentifier

class NodeExecutionIdentifier(
    node_id,
    execution_id,
)
Parameter Type
node_id
execution_id

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: NodeExecutionIdentifier
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.core.identifier_pb2.NodeExecutionIdentifier

verbose_string()

def verbose_string()

:rtype: Text

Properties

Property Type Description
execution_id
:rtype: WorkflowExecutionIdentifier
is_empty
node_id
:rtype: Text

flytekit.models.core.identifier.ResourceType

flytekit.models.core.identifier.SignalIdentifier

class SignalIdentifier(
    signal_id: str,
    execution_id: flytekit.models.core.identifier.WorkflowExecutionIdentifier,
)
Parameter Type
signal_id str
execution_id flytekit.models.core.identifier.WorkflowExecutionIdentifier

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(
    proto: flyteidl.core.identifier_pb2.SignalIdentifier,
) -> SignalIdentifier
Parameter Type
proto flyteidl.core.identifier_pb2.SignalIdentifier

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
execution_id
is_empty
signal_id

flytekit.models.core.identifier.TaskExecutionIdentifier

class TaskExecutionIdentifier(
    task_id,
    node_execution_id,
    retry_attempt,
)
Parameter Type
task_id
node_execution_id
retry_attempt

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(
    proto,
) -> e: TaskExecutionIdentifier
Parameter Type
proto

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

:rtype: Text

to_flyte_idl()

def to_flyte_idl()

:rtype: flyteidl.core.identifier_pb2.TaskExecutionIdentifier

verbose_string()

def verbose_string()

:rtype: Text

Properties

Property Type Description
is_empty
node_execution_id
:rtype: NodeExecutionIdentifier
retry_attempt
:rtype: int
task_id
:rtype: Identifier

flytekit.models.core.identifier.WorkflowExecutionIdentifier

class WorkflowExecutionIdentifier(
    project,
    domain,
    name,
)
Parameter Type
project
domain
name

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: WorkflowExecutionIdentifier
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.core.identifier_pb2.WorkflowExecutionIdentifier

verbose_string()

def verbose_string()

:rtype: Text

Properties

Property Type Description
domain
:rtype: Text
is_empty
name
:rtype: Text
project
:rtype: Text