flytekit.models.execution
Directory
Classes
flytekit.models.execution.AbortMetadata
Parameters
class AbortMetadata(
cause: str,
principal: str,
)| Parameter | Type | Description |
|---|---|---|
cause |
str |
|
principal |
str |
Properties
| Property | Type | Description |
|---|---|---|
cause |
str |
|
is_empty |
None |
|
principal |
str |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
|
serialize_to_string() |
|
short_string() |
|
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()Returns: Text
to_flyte_idl()
def to_flyte_idl()flytekit.models.execution.ClusterAssignment
Parameters
class ClusterAssignment(
cluster_pool = None,
)| Parameter | Type | Description |
|---|---|---|
cluster_pool |
Properties
| Property | Type | Description |
|---|---|---|
cluster_pool |
None |
|
is_empty |
None |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
|
serialize_to_string() |
|
short_string() |
|
to_flyte_idl() |
from_flyte_idl()
def from_flyte_idl(
p,
)| Parameter | Type | Description |
|---|---|---|
p |
Returns: flyteidl.admin.ClusterAssignment
serialize_to_string()
def serialize_to_string()short_string()
def short_string()Returns: Text
to_flyte_idl()
def to_flyte_idl()Returns: flyteidl.admin._cluster_assignment_pb2.ClusterAssignment
flytekit.models.execution.Execution
Parameters
class Execution(
id,
spec,
closure,
)| Parameter | Type | Description |
|---|---|---|
id |
||
spec |
||
closure |
Properties
| Property | Type | Description |
|---|---|---|
closure |
None |
|
id |
_identifier.WorkflowExecutionIdentifier |
|
is_empty |
None |
|
spec |
None |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
|
serialize_to_string() |
|
short_string() |
|
to_flyte_idl() |
from_flyte_idl()
def from_flyte_idl(
pb,
)| Parameter | Type | Description |
|---|---|---|
pb |
Returns: Execution
serialize_to_string()
def serialize_to_string()short_string()
def short_string()Returns: Text
to_flyte_idl()
def to_flyte_idl()Returns: flyteidl.admin.execution_pb2.Execution
flytekit.models.execution.ExecutionClosure
Parameters
class ExecutionClosure(
phase: int,
started_at: datetime.datetime,
duration: datetime.timedelta,
error: typing.Optional[_core_execution.ExecutionError] = None,
outputs: typing.Optional[LiteralMapBlob] = None,
abort_metadata: typing.Optional[AbortMetadata] = None,
created_at: typing.Optional[datetime.datetime] = None,
updated_at: typing.Optional[datetime.datetime] = None,
)| 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[_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] |
Properties
| Property | Type | Description |
|---|---|---|
abort_metadata |
AbortMetadata |
|
created_at |
typing.Optional[datetime.datetime] |
|
duration |
datetime.timedelta |
|
error |
_core_execution.ExecutionError |
|
is_empty |
None |
|
outputs |
LiteralMapBlob |
|
phase |
int |
From the flytekit.models.core.execution.WorkflowExecutionPhase enum |
started_at |
datetime.datetime |
|
updated_at |
typing.Optional[datetime.datetime] |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
|
serialize_to_string() |
|
short_string() |
|
to_flyte_idl() |
from_flyte_idl()
def from_flyte_idl(
pb2_object,
)| Parameter | Type | Description |
|---|---|---|
pb2_object |
Returns: ExecutionClosure
serialize_to_string()
def serialize_to_string()short_string()
def short_string()Returns: Text
to_flyte_idl()
def to_flyte_idl()Returns: flyteidl.admin.execution_pb2.ExecutionClosure
flytekit.models.execution.ExecutionMetadata
Parameters
class ExecutionMetadata(
mode: int,
principal: str,
nesting: int,
scheduled_at: Optional[datetime.datetime] = None,
parent_node_execution: Optional[_identifier.NodeExecutionIdentifier] = None,
reference_execution: Optional[_identifier.WorkflowExecutionIdentifier] = None,
system_metadata: Optional[SystemMetadata] = None,
)| 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. |
Properties
| Property | Type | Description |
|---|---|---|
is_empty |
None |
|
mode |
int |
An enum value from ExecutionMetadata.ExecutionMode which specifies how the job started. |
nesting |
int |
An integer representing how deeply nested the workflow is (i.e. was it triggered by a parent workflow) |
parent_node_execution |
_identifier.NodeExecutionIdentifier |
Which subworkflow node (if any) launched this execution |
principal |
str |
The entity that triggered the execution |
reference_execution |
_identifier.WorkflowExecutionIdentifier |
Optional, reference workflow execution related to this execution |
scheduled_at |
datetime.datetime |
For scheduled executions, the requested time for execution for this specific schedule invocation. |
system_metadata |
SystemMetadata |
Optional, platform-specific metadata about the execution. |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
|
serialize_to_string() |
|
short_string() |
|
to_flyte_idl() |
from_flyte_idl()
def from_flyte_idl(
pb2_object,
)| Parameter | Type | Description |
|---|---|---|
pb2_object |
Returns: ExecutionMetadata
serialize_to_string()
def serialize_to_string()short_string()
def short_string()Returns: Text
to_flyte_idl()
def to_flyte_idl()Returns: flyteidl.admin.execution_pb2.ExecutionMetadata
flytekit.models.execution.ExecutionSpec
Parameters
class ExecutionSpec(
launch_plan,
metadata,
notifications = None,
disable_all = None,
labels = None,
annotations = None,
auth_role = None,
raw_output_data_config = None,
max_parallelism: Optional[int] = None,
security_context: Optional[security.SecurityContext] = None,
overwrite_cache: Optional[bool] = None,
interruptible: Optional[bool] = None,
envs: Optional[_common_models.Envs] = None,
tags: Optional[typing.List[str]] = None,
cluster_assignment: Optional[ClusterAssignment] = None,
execution_cluster_label: Optional[ExecutionClusterLabel] = None,
)| 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. |
Properties
| Property | Type | Description |
|---|---|---|
annotations |
None |
|
auth_role |
None |
|
cluster_assignment |
Optional[ClusterAssignment] |
|
disable_all |
None |
|
envs |
Optional[_common_models.Envs] |
|
execution_cluster_label |
Optional[ExecutionClusterLabel] |
|
interruptible |
Optional[bool] |
|
is_empty |
None |
|
labels |
None |
|
launch_plan |
None |
If the values were too large, this is the URI where the values were offloaded. |
max_parallelism |
int |
|
metadata |
None |
|
notifications |
None |
|
overwrite_cache |
Optional[bool] |
|
raw_output_data_config |
None |
|
security_context |
typing.Optional[security.SecurityContext] |
|
tags |
Optional[typing.List[str]] |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
|
serialize_to_string() |
|
short_string() |
|
to_flyte_idl() |
from_flyte_idl()
def from_flyte_idl(
p,
)| Parameter | Type | Description |
|---|---|---|
p |
Returns: ExecutionSpec
serialize_to_string()
def serialize_to_string()short_string()
def short_string()Returns: Text
to_flyte_idl()
def to_flyte_idl()Returns: flyteidl.admin.execution_pb2.ExecutionSpec
flytekit.models.execution.LiteralMapBlob
Parameters
class LiteralMapBlob(
values = None,
uri = None,
)| Parameter | Type | Description |
|---|---|---|
values |
||
uri |
Properties
| Property | Type | Description |
|---|---|---|
is_empty |
None |
|
uri |
None |
|
values |
None |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
|
serialize_to_string() |
|
short_string() |
|
to_flyte_idl() |
from_flyte_idl()
def from_flyte_idl(
pb,
)| Parameter | Type | Description |
|---|---|---|
pb |
Returns: LiteralMapBlob
serialize_to_string()
def serialize_to_string()short_string()
def short_string()Returns: Text
to_flyte_idl()
def to_flyte_idl()Returns: flyteidl.admin.execution_pb2.LiteralMapBlob
flytekit.models.execution.NodeExecutionGetDataResponse
Parameters
class NodeExecutionGetDataResponse(
*args,
dynamic_workflow: typing.Optional[DynamicWorkflowNodeMetadata] = None,
**kwargs,
)| Parameter | Type | Description |
|---|---|---|
*args |
||
dynamic_workflow |
typing.Optional[DynamicWorkflowNodeMetadata] |
|
**kwargs |
Properties
| Property | Type | Description |
|---|---|---|
dynamic_workflow |
typing.Optional[DynamicWorkflowNodeMetadata] |
|
full_inputs |
None |
|
full_outputs |
None |
|
inputs |
None |
|
is_empty |
None |
|
outputs |
None |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
|
serialize_to_string() |
|
short_string() |
|
to_flyte_idl() |
from_flyte_idl()
def from_flyte_idl(
pb2_object,
)| Parameter | Type | Description |
|---|---|---|
pb2_object |
Returns: NodeExecutionGetDataResponse
serialize_to_string()
def serialize_to_string()short_string()
def short_string()Returns: Text
to_flyte_idl()
def to_flyte_idl()Returns: _node_execution_pb2.NodeExecutionGetDataResponse
flytekit.models.execution.NotificationList
Parameters
class NotificationList(
notifications,
)| Parameter | Type | Description |
|---|---|---|
notifications |
Properties
| Property | Type | Description |
|---|---|---|
is_empty |
None |
|
notifications |
None |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
|
serialize_to_string() |
|
short_string() |
|
to_flyte_idl() |
from_flyte_idl()
def from_flyte_idl(
pb2_object,
)| Parameter | Type | Description |
|---|---|---|
pb2_object |
Returns: NotificationList
serialize_to_string()
def serialize_to_string()short_string()
def short_string()Returns: Text
to_flyte_idl()
def to_flyte_idl()Returns: flyteidl.admin.execution_pb2.NotificationList
flytekit.models.execution.SystemMetadata
Parameters
class SystemMetadata(
execution_cluster: str,
)| Parameter | Type | Description |
|---|---|---|
execution_cluster |
str |
Properties
| Property | Type | Description |
|---|---|---|
execution_cluster |
str |
|
is_empty |
None |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
|
serialize_to_string() |
|
short_string() |
|
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()Returns: Text
to_flyte_idl()
def to_flyte_idl()flytekit.models.execution.TaskExecutionGetDataResponse
Parameters
class TaskExecutionGetDataResponse(
inputs,
outputs,
full_inputs,
full_outputs,
)| Parameter | Type | Description |
|---|---|---|
inputs |
||
outputs |
||
full_inputs |
||
full_outputs |
Properties
| Property | Type | Description |
|---|---|---|
full_inputs |
None |
|
full_outputs |
None |
|
inputs |
None |
|
is_empty |
None |
|
outputs |
None |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
|
serialize_to_string() |
|
short_string() |
|
to_flyte_idl() |
from_flyte_idl()
def from_flyte_idl(
pb2_object,
)| Parameter | Type | Description |
|---|---|---|
pb2_object |
Returns: TaskExecutionGetDataResponse
serialize_to_string()
def serialize_to_string()short_string()
def short_string()Returns: Text
to_flyte_idl()
def to_flyte_idl()Returns: _task_execution_pb2.TaskExecutionGetDataResponse
flytekit.models.execution.WorkflowExecutionGetDataResponse
Parameters
class WorkflowExecutionGetDataResponse(
inputs,
outputs,
full_inputs,
full_outputs,
)| Parameter | Type | Description |
|---|---|---|
inputs |
||
outputs |
||
full_inputs |
||
full_outputs |
Properties
| Property | Type | Description |
|---|---|---|
full_inputs |
None |
|
full_outputs |
None |
|
inputs |
None |
|
is_empty |
None |
|
outputs |
None |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
|
serialize_to_string() |
|
short_string() |
|
to_flyte_idl() |
from_flyte_idl()
def from_flyte_idl(
pb2_object,
)| Parameter | Type | Description |
|---|---|---|
pb2_object |
Returns: WorkflowExecutionGetDataResponse
serialize_to_string()
def serialize_to_string()short_string()
def short_string()Returns: Text
to_flyte_idl()
def to_flyte_idl()Returns: _execution_pb2.WorkflowExecutionGetDataResponse