0.1.dev2184+g1e0cbe7.d20250401

flytekit.interfaces.cli_identifiers

Directory

Classes

Class Description
Identifier
TaskExecutionIdentifier
WorkflowExecutionIdentifier

flytekit.interfaces.cli_identifiers.Identifier

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

Methods

Method Description
from_flyte_idl() .
from_python_std() Parses a string in the correct format into an identifier.
promote_from_model() .
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(
    pb2_object,
) -> e: Identifier
Parameter Type
pb2_object

from_python_std()

def from_python_std(
    string,
) -> e: Identifier

Parses a string in the correct format into an identifier

Parameter Type
string

promote_from_model()

def promote_from_model(
    base_model,
) -> e: Identifier
Parameter Type
base_model

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.interfaces.cli_identifiers.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() .
from_python_std() Parses a string in the correct format into an identifier.
promote_from_model() .
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: TaskExecutionIdentifier
Parameter Type
pb2_object

from_python_std()

def from_python_std(
    string,
) -> e: TaskExecutionIdentifier

Parses a string in the correct format into an identifier

Parameter Type
string

promote_from_model()

def promote_from_model(
    base_model,
) -> e: TaskExecutionIdentifier
Parameter Type
base_model

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.interfaces.cli_identifiers.WorkflowExecutionIdentifier

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

Methods

Method Description
from_flyte_idl() .
from_python_std() Parses a string in the correct format into an identifier.
promote_from_model() .
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: WorkflowExecutionIdentifier
Parameter Type
pb2_object

from_python_std()

def from_python_std(
    string,
) -> e: WorkflowExecutionIdentifier

Parses a string in the correct format into an identifier

Parameter Type
string

promote_from_model()

def promote_from_model(
    base_model,
) -> e: WorkflowExecutionIdentifier
Parameter Type
base_model

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