1.16.16

flytekit.interfaces.cli_identifiers

Directory

Classes

Class Description
Identifier
TaskExecutionIdentifier
WorkflowExecutionIdentifier

flytekit.interfaces.cli_identifiers.Identifier

Parameters

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

Properties

Property Type Description
domain None
is_empty None
name None
project None
resource_type None enum value from ResourceType
version None

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()
to_flyte_idl()

from_flyte_idl()

def from_flyte_idl(
    pb2_object,
)
Parameter Type Description
pb2_object

Returns: Identifier

from_python_std()

def from_python_std(
    string,
)

Parses a string in the correct format into an identifier

Parameter Type Description
string

Returns: Identifier

promote_from_model()

def promote_from_model(
    base_model,
)
Parameter Type Description
base_model

Returns: Identifier

resource_type_name()

def resource_type_name()

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

Returns: Text

to_flyte_idl()

def to_flyte_idl()

Returns: flyteidl.core.identifier_pb2.Identifier

flytekit.interfaces.cli_identifiers.TaskExecutionIdentifier

Parameters

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

Properties

Property Type Description
is_empty None
node_execution_id None
retry_attempt None
task_id None

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()
to_flyte_idl()

from_flyte_idl()

def from_flyte_idl(
    pb2_object,
)
Parameter Type Description
pb2_object

Returns: TaskExecutionIdentifier

from_python_std()

def from_python_std(
    string,
)

Parses a string in the correct format into an identifier

Parameter Type Description
string

Returns: TaskExecutionIdentifier

promote_from_model()

def promote_from_model(
    base_model,
)
Parameter Type Description
base_model

Returns: TaskExecutionIdentifier

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

Returns: Text

to_flyte_idl()

def to_flyte_idl()

Returns: flyteidl.core.identifier_pb2.TaskExecutionIdentifier

flytekit.interfaces.cli_identifiers.WorkflowExecutionIdentifier

Parameters

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

Properties

Property Type Description
domain None
is_empty None
name None
project None

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()
to_flyte_idl()

from_flyte_idl()

def from_flyte_idl(
    pb2_object,
)
Parameter Type Description
pb2_object

Returns: WorkflowExecutionIdentifier

from_python_std()

def from_python_std(
    string,
)

Parses a string in the correct format into an identifier

Parameter Type Description
string

Returns: WorkflowExecutionIdentifier

promote_from_model()

def promote_from_model(
    base_model,
)
Parameter Type Description
base_model

Returns: WorkflowExecutionIdentifier

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

Returns: Text

to_flyte_idl()

def to_flyte_idl()

Returns: flyteidl.core.identifier_pb2.WorkflowExecutionIdentifier