flytekit.models.execution
class AbortMetadata(
cause: str,
principal: str,
)
| Parameter |
Type |
Description |
cause |
str |
|
principal |
str |
|
| Property |
Type |
Description |
cause |
str |
|
is_empty |
None |
|
principal |
str |
|
def from_flyte_idl(
pb2_object: flyteidl.admin.execution_pb2.AbortMetadata,
) -> AbortMetadata
| Parameter |
Type |
Description |
pb2_object |
flyteidl.admin.execution_pb2.AbortMetadata |
|
def serialize_to_string()
Returns: Text
class ClusterAssignment(
cluster_pool,
)
| Parameter |
Type |
Description |
cluster_pool |
|
|
| Property |
Type |
Description |
cluster_pool |
None |
|
is_empty |
None |
|
| Parameter |
Type |
Description |
p |
|
|
Returns: flyteidl.admin.ClusterAssignment
def serialize_to_string()
Returns: Text
Returns: flyteidl.admin._cluster_assignment_pb2.ClusterAssignment
class Execution(
id,
spec,
closure,
)
| Parameter |
Type |
Description |
id |
|
|
spec |
|
|
closure |
|
|
| Property |
Type |
Description |
closure |
None |
|
id |
_identifier.WorkflowExecutionIdentifier |
|
is_empty |
None |
|
spec |
None |
|
def from_flyte_idl(
pb,
)
| Parameter |
Type |
Description |
pb |
|
|
Returns: Execution
def serialize_to_string()
Returns: Text
Returns: flyteidl.admin.execution_pb2.Execution
class ExecutionClosure(
phase: int,
started_at: datetime.datetime,
duration: datetime.timedelta,
error: typing.Optional[_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[_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] |
|
| 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] |
|
def from_flyte_idl(
pb2_object,
)
| Parameter |
Type |
Description |
pb2_object |
|
|
Returns: ExecutionClosure
def serialize_to_string()
Returns: Text
Returns: flyteidl.admin.execution_pb2.ExecutionClosure
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. |
| 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. |
def from_flyte_idl(
pb2_object,
)
| Parameter |
Type |
Description |
pb2_object |
|
|
Returns: ExecutionMetadata
def serialize_to_string()
Returns: Text
Returns: flyteidl.admin.execution_pb2.ExecutionMetadata
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. |
| 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]] |
|
| Parameter |
Type |
Description |
p |
|
|
Returns: ExecutionSpec
def serialize_to_string()
Returns: Text
Returns: flyteidl.admin.execution_pb2.ExecutionSpec
class LiteralMapBlob(
values,
uri,
)
| Parameter |
Type |
Description |
values |
|
|
uri |
|
|
| Property |
Type |
Description |
is_empty |
None |
|
uri |
None |
|
values |
None |
|
def from_flyte_idl(
pb,
)
| Parameter |
Type |
Description |
pb |
|
|
Returns: LiteralMapBlob
def serialize_to_string()
Returns: Text
Returns: flyteidl.admin.execution_pb2.LiteralMapBlob
class NodeExecutionGetDataResponse(
args,
dynamic_workflow: typing.Optional[DynamicWorkflowNodeMetadata],
kwargs,
)
| Parameter |
Type |
Description |
args |
*args |
|
dynamic_workflow |
typing.Optional[DynamicWorkflowNodeMetadata] |
|
kwargs |
**kwargs |
|
| Property |
Type |
Description |
dynamic_workflow |
typing.Optional[DynamicWorkflowNodeMetadata] |
|
full_inputs |
None |
|
full_outputs |
None |
|
inputs |
None |
|
is_empty |
None |
|
outputs |
None |
|
def from_flyte_idl(
pb2_object,
)
| Parameter |
Type |
Description |
pb2_object |
|
|
Returns: NodeExecutionGetDataResponse
def serialize_to_string()
Returns: Text
Returns: _node_execution_pb2.NodeExecutionGetDataResponse
class NotificationList(
notifications,
)
| Parameter |
Type |
Description |
notifications |
|
|
| Property |
Type |
Description |
is_empty |
None |
|
notifications |
None |
|
def from_flyte_idl(
pb2_object,
)
| Parameter |
Type |
Description |
pb2_object |
|
|
Returns: NotificationList
def serialize_to_string()
Returns: Text
Returns: flyteidl.admin.execution_pb2.NotificationList
class SystemMetadata(
execution_cluster: str,
)
| Parameter |
Type |
Description |
execution_cluster |
str |
|
| Property |
Type |
Description |
execution_cluster |
str |
|
is_empty |
None |
|
def from_flyte_idl(
pb2_object: flyteidl.admin.execution_pb2.SystemMetadata,
) -> SystemMetadata
| Parameter |
Type |
Description |
pb2_object |
flyteidl.admin.execution_pb2.SystemMetadata |
|
def serialize_to_string()
Returns: Text
class TaskExecutionGetDataResponse(
inputs,
outputs,
full_inputs,
full_outputs,
)
| Parameter |
Type |
Description |
inputs |
|
|
outputs |
|
|
full_inputs |
|
|
full_outputs |
|
|
| Property |
Type |
Description |
full_inputs |
None |
|
full_outputs |
None |
|
inputs |
None |
|
is_empty |
None |
|
outputs |
None |
|
def from_flyte_idl(
pb2_object,
)
| Parameter |
Type |
Description |
pb2_object |
|
|
Returns: TaskExecutionGetDataResponse
def serialize_to_string()
Returns: Text
Returns: _task_execution_pb2.TaskExecutionGetDataResponse
class WorkflowExecutionGetDataResponse(
inputs,
outputs,
full_inputs,
full_outputs,
)
| Parameter |
Type |
Description |
inputs |
|
|
outputs |
|
|
full_inputs |
|
|
full_outputs |
|
|
| Property |
Type |
Description |
full_inputs |
None |
|
full_outputs |
None |
|
inputs |
None |
|
is_empty |
None |
|
outputs |
None |
|
def from_flyte_idl(
pb2_object,
)
| Parameter |
Type |
Description |
pb2_object |
|
|
Returns: WorkflowExecutionGetDataResponse
def serialize_to_string()
Returns: Text
Returns: _execution_pb2.WorkflowExecutionGetDataResponse