Skip to main content

ActionPhase

Represents the execution phase of a Flyte action (run).

Attributes

AttributeTypeDescription
QUEUEDstr = queuedAction is waiting to be scheduled.
WAITING_FOR_RESOURCESstr = waiting_for_resourcesAction is waiting for compute resources to become available.
INITIALIZINGstr = initializingAction is being initialized and prepared for execution.
RUNNINGstr = runningAction is currently executing.
SUCCEEDEDstr = succeededAction completed successfully.
FAILEDstr = failedAction failed during execution.
ABORTEDstr = abortedAction was manually aborted by a user.
TIMED_OUTstr = timed_outAction exceeded its timeout limit and was terminated.

Methods


is_terminal()

@classmethod
def is_terminal() - > bool

Check if this phase represents a terminal (final) state. Terminal phases are: SUCCEEDED, FAILED, ABORTED, TIMED_OUT. Once an action reaches a terminal phase, it will not transition to any other phase.

Returns

TypeDescription
boolTrue if this is a terminal phase, False otherwise

to_protobuf_name()

@classmethod
def to_protobuf_name() - > str

Convert to protobuf enum name format.

Returns

TypeDescription
strProtobuf enum name (e.g., "ACTION_PHASE_QUEUED")

to_protobuf_value()

@classmethod
def to_protobuf_value() - > int

Convert to protobuf enum integer value.

Returns

TypeDescription
intProtobuf enum integer value

from_protobuf()

@classmethod
def from_protobuf(
pb_phase: Any
) - > [ActionPhase](actionphase.md?sid=flyte_models_actionphase)

Create ActionPhase from protobuf phase value.

Parameters

NameTypeDescription
pb_phaseAnyProtobuf ActionPhase enum value to be converted

Returns

TypeDescription
[ActionPhase](actionphase.md?sid=flyte_models_actionphase)Corresponding ActionPhase enum member