flytekit.remote.executions.FlyteWorkflowExecution#

class flytekit.remote.executions.FlyteWorkflowExecution(type_hints=None, remote=None, *args, **kwargs)[source]#

A class encapsulating a workflow execution being run on a Flyte remote backend.

Methods

Parameters:

  • type_hints (Optional[Dict[str, Type]])

  • remote (Optional['FlyteRemote'])

classmethod from_flyte_idl(pb)[source]#
Parameters:

pb (flyteidl.admin.execution_pb2.Execution)

Return type:

Execution

classmethod promote_from_model(base_model, remote=None, type_hints=None)[source]#
Parameters:

  • base_model (execution_models.Execution)

  • remote (Optional['FlyteRemote'])

  • type_hints (Optional[Dict[str, Type]])

Return type:

FlyteWorkflowExecution

serialize_to_string()[source]#
Return type:

str

short_string()[source]#
Return type:

Text

sync(sync_nodes=False)[source]#

Sync the state of the current execution and returns a new object with the updated state.

Parameters:

sync_nodes (bool)

Return type:

FlyteWorkflowExecution

to_flyte_idl()[source]#
Return type:

flyteidl.admin.execution_pb2.Execution

verbose_string()[source]#
Return type:

Text

wait(timeout=None, poll_interval=None, sync_nodes=True)[source]#

Wait for the execution to complete. This is a blocking call.

Parameters:

  • timeout (int | timedelta | None) – The maximum amount of time to wait for the execution to complete. It can be a timedelta or a duration in seconds as int.

  • poll_interval (int | timedelta | None) – The amount of time to wait between polling the state of the execution. It can be a timedelta or a duration in seconds as int.

  • sync_nodes (bool) – Whether to sync the state of the nodes as well.

Return type:

FlyteWorkflowExecution

Attributes

closure

ExecutionClosure

Type:

rtype

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

flytekit.models.core.identifier.WorkflowExecutionIdentifier

Type:

rtype

inputs
is_done

Whether or not the execution is complete.

is_empty
node_executions

Get a dictionary of node executions that are a part of this workflow execution.

outputs
spec

ExecutionSpec

Type:

rtype