Skip to main content

ActionID

A class representing the ID of an Action, nested within a Run. This is used to identify a specific action on a task.

Attributes​

  • name: string

    • The name of the action.

  • run_name: string | None = None

    • The name of the run this action belongs to. Defaults to the action's name if not provided.

  • project: string | None = None

    • The project this action belongs to. Optional.

  • domain: string | None = None

    • The domain this action belongs to. Optional.

  • org: string | None = None

    • The organization this action belongs to. Optional.

Constructors​

  • Initializes an ActionID object.

  • Parameters

    • name: str
      • The name of the Action.
    • run_name: str | None
      • The name of the Run this Action belongs to. Defaults to the Action's name if not provided.
    • project: str | None
      • The project this Action belongs to.
    • domain: str | None
      • The domain this Action belongs to.
    • org: str | None
      • The organization this Action belongs to.

Methods​

def create_random()

  • Creates a new ActionID with a randomly generated name.

  • Return Value: ActionID

    • A new ActionID instance with a random name.
def new_sub_action(name: string | None) - > [ActionID](src_flyte_models_actionid)

  • Creates a new sub-action with a given name. If no name is provided, a random name is generated.

  • Parameters

    • name: string | None
      • The name for the new sub-action. If None, a random name will be generated.

  • Return Value: ActionID

    • A new ActionID representing the sub-action.
def new_sub_action_from(task_call_seq: int, task_hash: string, input_hash: string, group: string | None) - > [ActionID](src_flyte_models_actionid)

  • Creates a new sub-action with a deterministic name based on provided task details.

  • Parameters

    • task_call_seq: int
      • The sequence number of the task call.
    • task_hash: string
      • The hash of the task.
    • input_hash: string
      • The hash of the task input.
    • group: string | None
      • An optional group identifier.

  • Return Value: ActionID

    • A new ActionID representing the sub-action with a deterministic name.