RunDetails
A class representing a run of a task. It is used to manage the run of a task and its state on the remote< br > Union API.
Attributes
-
pb2: run_definition_pb2.RunDetails
- A class representing a run of a task. It is used to manage the run of a task and its state on the remote Union API.
-
action_details: ActionDetails = field(init=False)
- A class representing a run of a task. It is used to manage the run of a task and its state on the remote Union API.
Constructors
-
Initialize the RunDetails object with the given run definition.
-
Parameters
- pb2: run_definition_pb2.RunDetails
- The run definition protocol buffer.
- pb2: run_definition_pb2.RunDetails
Methods
def get_details(run_id: identifier_pb2.RunIdentifier) - > [RunDetails](src_flyte_remote__run_rundetails)
-
Get the details of the run. This is a placeholder for getting the run details.
-
Parameters
- run_id: identifier_pb2.RunIdentifier
- The identifier of the run.
- run_id: identifier_pb2.RunIdentifier
-
Return Value: RunDetails
def get(name: str | None = None) - > [RunDetails](src_flyte_remote__run_rundetails)
-
Get a run by its ID or name. If both are provided, the ID will take precedence.
-
Parameters
- name: str | None
- The name of the run.
- name: str | None
-
Return Value: RunDetails
def name()
-
Get the name of the action.
-
Return Value: str
def task_name()
-
Get the name of the task.
-
Return Value: str | None
def action_id()
-
Get the action ID.
-
Return Value: identifier_pb2.ActionIdentifier
def done()
-
Check if the run is in a terminal state (completed or failed). This is a placeholder for checking the run state.
-
Return Value: bool
def inputs()
-
Placeholder for inputs. This can be extended to handle inputs from the run context.
-
Return Value: ActionInputs
def outputs()
-
Placeholder for outputs. This can be extended to handle outputs from the run context.
-
Return Value: ActionOutputs