flytekit.models.execution

Class	Description
`AbortMetadata`
`ClusterAssignment`
`Execution`
`ExecutionClosure`
`ExecutionMetadata`
`ExecutionSpec`
`LiteralMapBlob`
`NodeExecutionGetDataResponse`	Currently, node, task, and workflow execution all have the same get data response.
`NotificationList`
`SystemMetadata`
`TaskExecutionGetDataResponse`	Currently, node, task, and workflow execution all have the same get data response.
`WorkflowExecutionGetDataResponse`	Currently, node, task, and workflow execution all have the same get data response.

flytekit.models.execution.AbortMetadata

        
    
class AbortMetadata(
    cause: str,
    principal: str,
)

Parameter	Type	Description
`cause`	`str`
`principal`	`str`

Methods

Method	Description
`from_flyte_idl()`
`serialize_to_string()`
`short_string()`	:rtype: Text.
`to_flyte_idl()`

from_flyte_idl()

        
    
def from_flyte_idl(
    pb2_object: flyteidl.admin.execution_pb2.AbortMetadata,
) -> AbortMetadata

Parameter	Type	Description
`pb2_object`	`flyteidl.admin.execution_pb2.AbortMetadata`

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

:rtype: Text

to_flyte_idl()

def to_flyte_idl()

Properties

Property	Type	Description
`cause`
`is_empty`
`principal`

flytekit.models.execution.ClusterAssignment

        
    
class ClusterAssignment(
    cluster_pool,
)

Parameter	Type	Description
`cluster_pool`

Methods

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

from_flyte_idl()

        
    
def from_flyte_idl(
    p,
)

Parameter	Type	Description
`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._cluster_assignment_pb2.ClusterAssignment

Properties

Property	Type	Description
`cluster_pool`		:rtype: Text
`is_empty`

flytekit.models.execution.Execution

        
    
class Execution(
    id,
    spec,
    closure,
)

Parameter	Type	Description
`id`
`spec`
`closure`

Methods

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

from_flyte_idl()

        
    
def from_flyte_idl(
    pb,
)

Parameter	Type	Description
`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.execution_pb2.Execution

Properties

Property	Type	Description
`closure`		:rtype: ExecutionClosure
`id`		:rtype: flytekit.models.core.identifier.WorkflowExecutionIdentifier
`is_empty`
`spec`		:rtype: ExecutionSpec

flytekit.models.execution.ExecutionClosure

        
    
class ExecutionClosure(
    phase: int,
    started_at: datetime.datetime,
    duration: datetime.timedelta,
    error: typing.Optional[flytekit.models.core.execution.ExecutionError],
    outputs: typing.Optional[LiteralMapBlob],
    abort_metadata: typing.Optional[AbortMetadata],
    created_at: typing.Optional[datetime.datetime],
    updated_at: typing.Optional[datetime.datetime],
)

Parameter	Type	Description
`phase`	`int`	From the flytekit.models.core.execution.WorkflowExecutionPhase enum
`started_at`	`datetime.datetime`
`duration`	`datetime.timedelta`	Duration for which the execution has been running.
`error`	`typing.Optional[flytekit.models.core.execution.ExecutionError]`
`outputs`	`typing.Optional[LiteralMapBlob]`
`abort_metadata`	`typing.Optional[AbortMetadata]`	Specifies metadata around an aborted workflow execution.
`created_at`	`typing.Optional[datetime.datetime]`
`updated_at`	`typing.Optional[datetime.datetime]`

Methods

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

from_flyte_idl()

        
    
def from_flyte_idl(
    pb2_object,
)

Parameter	Type	Description
`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.execution_pb2.ExecutionClosure

Properties

Property	Type	Description
`abort_metadata`
`created_at`
`duration`
`error`
`is_empty`
`outputs`
`phase`		From the flytekit.models.core.execution.WorkflowExecutionPhase enum
`started_at`
`updated_at`

flytekit.models.execution.ExecutionMetadata

        
    
class ExecutionMetadata(
    mode: int,
    principal: str,
    nesting: int,
    scheduled_at: Optional[datetime.datetime],
    parent_node_execution: Optional[_identifier.NodeExecutionIdentifier],
    reference_execution: Optional[_identifier.WorkflowExecutionIdentifier],
    system_metadata: Optional[SystemMetadata],
)

Parameter	Type	Description
`mode`	`int`	An enum value from ExecutionMetadata.ExecutionMode which specifies how the job started.
`principal`	`str`	The entity that triggered the execution
`nesting`	`int`	An integer representing how deeply nested the workflow is (i.e. was it triggered by a parent workflow)
`scheduled_at`	`Optional[datetime.datetime]`	For scheduled executions, the requested time for execution for this specific schedule invocation.
`parent_node_execution`	`Optional[_identifier.NodeExecutionIdentifier]`	Which subworkflow node (if any) launched this execution
`reference_execution`	`Optional[_identifier.WorkflowExecutionIdentifier]`	Optional, reference workflow execution related to this execution
`system_metadata`	`Optional[SystemMetadata]`	Optional, platform-specific metadata about the execution.

Methods

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

from_flyte_idl()

        
    
def from_flyte_idl(
    pb2_object,
)

Parameter	Type	Description
`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.execution_pb2.ExecutionMetadata

Properties

Property	Type	Description
`is_empty`
`mode`		An enum value from ExecutionMetadata.ExecutionMode which specifies how the job started.
`nesting`		An integer representing how deeply nested the workflow is (i.e. was it triggered by a parent workflow)
`parent_node_execution`		Which subworkflow node (if any) launched this execution
`principal`		The entity that triggered the execution
`reference_execution`		Optional, reference workflow execution related to this execution
`scheduled_at`		For scheduled executions, the requested time for execution for this specific schedule invocation.
`system_metadata`		Optional, platform-specific metadata about the execution.

flytekit.models.execution.ExecutionSpec

        
    
class ExecutionSpec(
    launch_plan,
    metadata,
    notifications,
    disable_all,
    labels,
    annotations,
    auth_role,
    raw_output_data_config,
    max_parallelism: Optional[int],
    security_context: Optional[security.SecurityContext],
    overwrite_cache: Optional[bool],
    interruptible: Optional[bool],
    envs: Optional[_common_models.Envs],
    tags: Optional[typing.List[str]],
    cluster_assignment: Optional[ClusterAssignment],
    execution_cluster_label: Optional[ExecutionClusterLabel],
)

Parameter	Type	Description
`launch_plan`
`metadata`
`notifications`
`disable_all`
`labels`
`annotations`
`auth_role`
`raw_output_data_config`		Optional location of offloaded data for things like S3, etc.
`max_parallelism`	`Optional[int]`
`security_context`	`Optional[security.SecurityContext]`	Optional security context to use for this execution.
`overwrite_cache`	`Optional[bool]`	Optional flag to overwrite the cache for this execution.
`interruptible`	`Optional[bool]`	Optional flag to override the default interruptible flag of the executed entity.
`envs`	`Optional[_common_models.Envs]`	flytekit.models.common.Envs environment variables to set for this execution.
`tags`	`Optional[typing.List[str]]`	Optional list of tags to apply to the execution.
`cluster_assignment`	`Optional[ClusterAssignment]`
`execution_cluster_label`	`Optional[ExecutionClusterLabel]`	Optional execution cluster label to use for this execution.

Methods

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

from_flyte_idl()

        
    
def from_flyte_idl(
    p,
)

Parameter	Type	Description
`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.execution_pb2.ExecutionSpec

Properties

Property	Type	Description
`annotations`		:rtype: flytekit.models.common.Annotations
`auth_role`		:rtype: flytekit.models.common.AuthRole
`cluster_assignment`
`disable_all`		:rtype: Optional[bool]
`envs`
`execution_cluster_label`
`interruptible`
`is_empty`
`labels`		:rtype: flytekit.models.common.Labels
`launch_plan`		If the values were too large, this is the URI where the values were offloaded. :rtype: flytekit.models.core.identifier.Identifier
`max_parallelism`
`metadata`		:rtype: ExecutionMetadata
`notifications`		:rtype: Optional[NotificationList]
`overwrite_cache`
`raw_output_data_config`		:rtype: flytekit.models.common.RawOutputDataConfig
`security_context`
`tags`

flytekit.models.execution.LiteralMapBlob

        
    
class LiteralMapBlob(
    values,
    uri,
)

Parameter	Type	Description
`values`
`uri`

Methods

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

from_flyte_idl()

        
    
def from_flyte_idl(
    pb,
)

Parameter	Type	Description
`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.execution_pb2.LiteralMapBlob

Properties

Property	Type	Description
`is_empty`
`uri`		:rtype: Text
`values`		:rtype: flytekit.models.literals.LiteralMap

flytekit.models.execution.NodeExecutionGetDataResponse

Currently, node, task, and workflow execution all have the same get data response. So we’ll create this common superclass to reduce code duplication until things diverge in the future.

        
    
class NodeExecutionGetDataResponse(
    args,
    dynamic_workflow: typing.Optional[DynamicWorkflowNodeMetadata],
    kwargs,
)

Parameter	Type	Description
`args`	`*args`
`dynamic_workflow`	`typing.Optional[DynamicWorkflowNodeMetadata]`
`kwargs`	`**kwargs`

Methods

Method	Description
`from_flyte_idl()`
`serialize_to_string()`
`short_string()`	:rtype: Text.
`to_flyte_idl()`	:rtype: _node_execution_pb2.

from_flyte_idl()

        
    
def from_flyte_idl(
    pb2_object,
)

Parameter	Type	Description
`pb2_object`

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

:rtype: Text

to_flyte_idl()

def to_flyte_idl()

:rtype: _node_execution_pb2.NodeExecutionGetDataResponse

Properties

Property	Type	Description
`dynamic_workflow`
`full_inputs`		:rtype: _literals_models.LiteralMap
`full_outputs`		:rtype: _literals_models.LiteralMap
`inputs`		:rtype: _common_models.UrlBlob
`is_empty`
`outputs`		:rtype: _common_models.UrlBlob

flytekit.models.execution.NotificationList

        
    
class NotificationList(
    notifications,
)

Parameter	Type	Description
`notifications`

Methods

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

from_flyte_idl()

        
    
def from_flyte_idl(
    pb2_object,
)

Parameter	Type	Description
`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.execution_pb2.NotificationList

Properties

Property	Type	Description
`is_empty`
`notifications`		:rtype: list[flytekit.models.common.Notification]

flytekit.models.execution.SystemMetadata

        
    
class SystemMetadata(
    execution_cluster: str,
)

Parameter	Type	Description
`execution_cluster`	`str`

Methods

Method	Description
`from_flyte_idl()`
`serialize_to_string()`
`short_string()`	:rtype: Text.
`to_flyte_idl()`

from_flyte_idl()

        
    
def from_flyte_idl(
    pb2_object: flyteidl.admin.execution_pb2.SystemMetadata,
) -> SystemMetadata

Parameter	Type	Description
`pb2_object`	`flyteidl.admin.execution_pb2.SystemMetadata`

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

:rtype: Text

to_flyte_idl()

def to_flyte_idl()

Properties

Property	Type	Description
`execution_cluster`
`is_empty`

flytekit.models.execution.TaskExecutionGetDataResponse

Currently, node, task, and workflow execution all have the same get data response. So we’ll create this common superclass to reduce code duplication until things diverge in the future.

        
    
class TaskExecutionGetDataResponse(
    inputs,
    outputs,
    full_inputs,
    full_outputs,
)

Parameter	Type	Description
`inputs`
`outputs`
`full_inputs`
`full_outputs`

Methods

Method	Description
`from_flyte_idl()`
`serialize_to_string()`
`short_string()`	:rtype: Text.
`to_flyte_idl()`	:rtype: _task_execution_pb2.

from_flyte_idl()

        
    
def from_flyte_idl(
    pb2_object,
)

Parameter	Type	Description
`pb2_object`

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

:rtype: Text

to_flyte_idl()

def to_flyte_idl()

:rtype: _task_execution_pb2.TaskExecutionGetDataResponse

Properties

Property	Type	Description
`full_inputs`		:rtype: _literals_models.LiteralMap
`full_outputs`		:rtype: _literals_models.LiteralMap
`inputs`		:rtype: _common_models.UrlBlob
`is_empty`
`outputs`		:rtype: _common_models.UrlBlob

flytekit.models.execution.WorkflowExecutionGetDataResponse

Currently, node, task, and workflow execution all have the same get data response. So we’ll create this common superclass to reduce code duplication until things diverge in the future.

        
    
class WorkflowExecutionGetDataResponse(
    inputs,
    outputs,
    full_inputs,
    full_outputs,
)

Parameter	Type	Description
`inputs`
`outputs`
`full_inputs`
`full_outputs`

Methods

Method	Description
`from_flyte_idl()`
`serialize_to_string()`
`short_string()`	:rtype: Text.
`to_flyte_idl()`	:rtype: _execution_pb2.

from_flyte_idl()

        
    
def from_flyte_idl(
    pb2_object,
)

Parameter	Type	Description
`pb2_object`

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

:rtype: Text

to_flyte_idl()

def to_flyte_idl()

:rtype: _execution_pb2.WorkflowExecutionGetDataResponse

Properties

Property	Type	Description
`full_inputs`		:rtype: _literals_models.LiteralMap
`full_outputs`		:rtype: _literals_models.LiteralMap
`inputs`		:rtype: _common_models.UrlBlob
`is_empty`
`outputs`		:rtype: _common_models.UrlBlob

On this page