flytekit.models.execution
Directory
Classes
| 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 |
|---|---|
cause |
str |
principal |
str |
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(
pb2_object: flyteidl.admin.execution_pb2.AbortMetadata,
) -> AbortMetadata| Parameter | Type |
|---|---|
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()verbose_string()
def verbose_string():rtype: Text
Properties
| Property | Type | Description |
|---|---|---|
cause |
||
is_empty |
||
principal |
flytekit.models.execution.ClusterAssignment
class ClusterAssignment(
cluster_pool,
)| Parameter | Type |
|---|---|
cluster_pool |
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: flyteidl.admin.ClusterAssignment| 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.admin._cluster_assignment_pb2.ClusterAssignment
verbose_string()
def verbose_string():rtype: Text
Properties
| Property | Type | Description |
|---|---|---|
cluster_pool |
:rtype: Text |
|
is_empty |
flytekit.models.execution.Execution
class Execution(
id,
spec,
closure,
)| Parameter | Type |
|---|---|
id |
|
spec |
|
closure |
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(
pb,
) -> e: Execution| Parameter | Type |
|---|---|
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
verbose_string()
def verbose_string():rtype: Text
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 |
|---|---|
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] |
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: ExecutionClosure| 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.execution_pb2.ExecutionClosure
verbose_string()
def verbose_string():rtype: Text
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 |
|---|---|
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] |
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,
) -> n: ExecutionMetadata| 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.execution_pb2.ExecutionMetadata
verbose_string()
def verbose_string():rtype: Text
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 |
|---|---|
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] |
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,
) -> n: ExecutionSpec| 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.admin.execution_pb2.ExecutionSpec
verbose_string()
def verbose_string():rtype: Text
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 |
|---|---|
values |
|
uri |
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(
pb,
) -> e: LiteralMapBlob| Parameter | Type |
|---|---|
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
verbose_string()
def verbose_string():rtype: Text
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 |
|---|---|
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. |
verbose_string() |
:rtype: Text. |
from_flyte_idl()
def from_flyte_idl(
pb2_object,
) -> e: NodeExecutionGetDataResponse| 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: _node_execution_pb2.NodeExecutionGetDataResponse
verbose_string()
def verbose_string():rtype: Text
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 |
|---|---|
notifications |
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: NotificationList| 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.execution_pb2.NotificationList
verbose_string()
def verbose_string():rtype: Text
Properties
| Property | Type | Description |
|---|---|---|
is_empty |
||
notifications |
:rtype: list[flytekit.models.common.Notification] |
flytekit.models.execution.SystemMetadata
class SystemMetadata(
execution_cluster: str,
)| Parameter | Type |
|---|---|
execution_cluster |
str |
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(
pb2_object: flyteidl.admin.execution_pb2.SystemMetadata,
) -> SystemMetadata| Parameter | Type |
|---|---|
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()verbose_string()
def verbose_string():rtype: Text
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 |
|---|---|
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. |
verbose_string() |
:rtype: Text. |
from_flyte_idl()
def from_flyte_idl(
pb2_object,
) -> e: TaskExecutionGetDataResponse| 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: _task_execution_pb2.TaskExecutionGetDataResponse
verbose_string()
def verbose_string():rtype: Text
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 |
|---|---|
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. |
verbose_string() |
:rtype: Text. |
from_flyte_idl()
def from_flyte_idl(
pb2_object,
) -> e: WorkflowExecutionGetDataResponse| 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: _execution_pb2.WorkflowExecutionGetDataResponse
verbose_string()
def verbose_string():rtype: Text
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 |