0.1.dev2192+g7c539c3.d20250403
flytekit.remote.executions
Directory
Classes
| Class | Description |
|---|---|
FlyteNodeExecution |
A class encapsulating a node execution being run on a Flyte remote backend. |
FlyteTaskExecution |
A class encapsulating a task execution being run on a Flyte remote backend. |
FlyteWorkflowExecution |
A class encapsulating a workflow execution being run on a Flyte remote backend. |
RemoteExecutionBase |
flytekit.remote.executions.FlyteNodeExecution
A class encapsulating a node execution being run on a Flyte remote backend.
class FlyteNodeExecution(
args,
kwargs,
)| Parameter | Type |
|---|---|
args |
*args |
kwargs |
**kwargs |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
|
promote_from_model() |
|
serialize_to_string() |
|
short_string() |
:rtype: Text. |
to_flyte_idl() |
|
verbose_string() |
:rtype: Text. |
from_flyte_idl()
def from_flyte_idl(
p: flyteidl.admin.node_execution_pb2.NodeExecution,
) -> NodeExecution| Parameter | Type |
|---|---|
p |
flyteidl.admin.node_execution_pb2.NodeExecution |
promote_from_model()
def promote_from_model(
base_model: node_execution_models.NodeExecution,
) -> 'FlyteNodeExecution'| Parameter | Type |
|---|---|
base_model |
node_execution_models.NodeExecution |
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 |
|---|---|---|
closure |
:rtype: NodeExecutionClosure |
|
error |
If execution is in progress, raise an exception. Otherwise, return None if no error was present upon reaching completion. |
|
executions |
||
id |
:rtype: flytekit.models.core.identifier.NodeExecutionIdentifier |
|
input_uri |
:rtype: Text |
|
inputs |
||
interface |
Return the interface of the task or subworkflow associated with this node execution. |
|
is_done |
Whether or not the execution is complete. |
|
is_empty |
||
metadata |
||
outputs |
:return: Returns the outputs LiteralsResolver to the execution :raises: FlyteAssertion error if execution is in progress or execution ended in error. |
|
subworkflow_node_executions |
This returns underlying node executions in instances where the current node execution is a parent node. This happens when it’s either a static or dynamic subworkflow. |
|
task_executions |
||
workflow_executions |
flytekit.remote.executions.FlyteTaskExecution
A class encapsulating a task execution being run on a Flyte remote backend.
class FlyteTaskExecution(
args,
kwargs,
)| Parameter | Type |
|---|---|
args |
*args |
kwargs |
**kwargs |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
|
promote_from_model() |
|
serialize_to_string() |
|
short_string() |
:rtype: Text. |
to_flyte_idl() |
:rtype: flyteidl. |
verbose_string() |
:rtype: Text. |
from_flyte_idl()
def from_flyte_idl(
proto,
) -> e: TaskExecution| Parameter | Type |
|---|---|
proto |
promote_from_model()
def promote_from_model(
base_model: admin_task_execution_models.TaskExecution,
) -> 'FlyteTaskExecution'| Parameter | Type |
|---|---|
base_model |
admin_task_execution_models.TaskExecution |
serialize_to_string()
def serialize_to_string()short_string()
def short_string():rtype: Text
to_flyte_idl()
def to_flyte_idl():rtype: flyteidl.admin.task_execution_pb2.TaskExecution
verbose_string()
def verbose_string():rtype: Text
Properties
| Property | Type | Description |
|---|---|---|
closure |
:rtype: TaskExecutionClosure |
|
error |
If execution is in progress, raise an exception. Otherwise, return None if no error was present upon reaching completion. |
|
id |
:rtype: flytekit.models.core.identifier.TaskExecutionIdentifier |
|
input_uri |
:rtype: Text |
|
inputs |
||
is_done |
Whether or not the execution is complete. |
|
is_empty |
||
is_parent |
:rtype: bool |
|
outputs |
:return: Returns the outputs LiteralsResolver to the execution :raises: FlyteAssertion error if execution is in progress or execution ended in error. |
|
task |
flytekit.remote.executions.FlyteWorkflowExecution
A class encapsulating a workflow execution being run on a Flyte remote backend.
class FlyteWorkflowExecution(
type_hints: Optional[Dict[str, typing.Type]],
remote: Optional['FlyteRemote'],
args,
kwargs,
)| Parameter | Type |
|---|---|
type_hints |
Optional[Dict[str, typing.Type]] |
remote |
Optional['FlyteRemote'] |
args |
*args |
kwargs |
**kwargs |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
|
promote_from_model() |
|
serialize_to_string() |
|
short_string() |
:rtype: Text. |
sync() |
Sync the state of the current execution and returns a new object with the updated state. |
to_flyte_idl() |
:rtype: flyteidl. |
verbose_string() |
:rtype: Text. |
wait() |
Wait for the execution to complete. |
from_flyte_idl()
def from_flyte_idl(
pb,
) -> e: Execution| Parameter | Type |
|---|---|
pb |
promote_from_model()
def promote_from_model(
base_model: execution_models.Execution,
remote: Optional['FlyteRemote'],
type_hints: Optional[Dict[str, typing.Type]],
) -> 'FlyteWorkflowExecution'| Parameter | Type |
|---|---|
base_model |
execution_models.Execution |
remote |
Optional['FlyteRemote'] |
type_hints |
Optional[Dict[str, typing.Type]] |
serialize_to_string()
def serialize_to_string()short_string()
def short_string():rtype: Text
sync()
def sync(
sync_nodes: bool,
) -> 'FlyteWorkflowExecution'Sync the state of the current execution and returns a new object with the updated state.
| Parameter | Type |
|---|---|
sync_nodes |
bool |
to_flyte_idl()
def to_flyte_idl():rtype: flyteidl.admin.execution_pb2.Execution
verbose_string()
def verbose_string():rtype: Text
wait()
def wait(
timeout: Optional[Union[timedelta, int]],
poll_interval: Optional[Union[timedelta, int]],
sync_nodes: bool,
) -> 'FlyteWorkflowExecution'Wait for the execution to complete. This is a blocking call.
| Parameter | Type |
|---|---|
timeout |
Optional[Union[timedelta, int]] |
poll_interval |
Optional[Union[timedelta, int]] |
sync_nodes |
bool |
Properties
| Property | Type | Description |
|---|---|---|
closure |
:rtype: ExecutionClosure |
|
error |
If execution is in progress, raise an exception. Otherwise, return None if no error was present upon reaching completion. |
|
execution_url |
||
flyte_workflow |
||
id |
:rtype: flytekit.models.core.identifier.WorkflowExecutionIdentifier |
|
inputs |
||
is_done |
Whether or not the execution is complete. |
|
is_empty |
||
is_successful |
Whether or not the execution is successful. |
|
node_executions |
Get a dictionary of node executions that are a part of this workflow execution. |
|
outputs |
:return: Returns the outputs LiteralsResolver to the execution :raises: FlyteAssertion error if execution is in progress or execution ended in error. |
|
spec |
:rtype: ExecutionSpec |
flytekit.remote.executions.RemoteExecutionBase
class RemoteExecutionBase(
args,
kwargs,
)| Parameter | Type |
|---|---|
args |
*args |
kwargs |
**kwargs |
Properties
| Property | Type | Description |
|---|---|---|
error |
||
inputs |
||
is_done |
||
outputs |
:return: Returns the outputs LiteralsResolver to the execution :raises: FlyteAssertion error if execution is in progress or execution ended in error. |