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.
Attributes
| Attribute | Type | Description |
|---|---|---|
| pb2 | run_definition_pb2.RunDetails | The underlying protobuf definition object storing the specification and action data for the run. |
| action_details | [ActionDetails](../action/actiondetails.md?sid=flyte_remote__action_actiondetails) | The execution details and state of the action associated with this run. |
Constructor
Signature
def RunDetails(
pb2: run_definition_pb2.RunDetails,
_preserve_original_types: bool = False
) -> None
Parameters
| Name | Type | Description |
|---|---|---|
| pb2 | run_definition_pb2.RunDetails | The protocol buffer object containing run definition details. |
| _preserve_original_types | bool = False | Whether to preserve original types when initializing action details. |
Methods
get_details()
@syncify
@classmethod
async def get_details(cls, run_id: identifier_pb2.RunIdentifier) -> RunDetails: ...
Get the details of the run. This is a placeholder for getting the run details.
Parameters
| Name | Type | Description |
|---|---|---|
| run_id | identifier_pb2.RunIdentifier | The unique identifier object specifying the target run. |
Returns
| Type | Description |
|---|---|
[RunDetails](rundetails.md?sid=flyte_remote__run_rundetails) | A new RunDetails instance populated with details from the remote service. |
get()
@syncify
@classmethod
async def get(cls, name: str | None = None) -> RunDetails: ...
Get a run by its ID or name. If both are provided, the ID will take precedence.
Parameters
| Name | Type | Description |
|---|---|---|
| name | `str | None` = None |
Returns
| Type | Description |
|---|---|
[RunDetails](rundetails.md?sid=flyte_remote__run_rundetails) | The RunDetails instance corresponding to the given run name within current configuration context. |
name()
@property
def name(self) -> str: ...
Get the name of the action.
Returns
| Type | Description |
|---|---|
str | The run name of the underlying action. |
task_name()
@property
def task_name(self) -> str | None: ...
Get the name of the task.
Returns
| Type | Description |
|---|---|
| `str | None` |
action_id()
@property
def action_id(self) -> identifier_pb2.ActionIdentifier: ...
Get the action ID.
Returns
| Type | Description |
|---|---|
identifier_pb2.ActionIdentifier | The ActionIdentifier protobuf object for the run action. |
done()
def done(self) -> bool: ...
Check if the run is in a terminal state (completed or failed). This is a placeholder for checking the run state.
Returns
| Type | Description |
|---|---|
bool | True if the run is in a terminal state (completed or failed), False otherwise. |
inputs()
async def inputs(self) -> ActionInputs: ...
Placeholder for inputs. This can be extended to handle inputs from the run context.
Returns
| Type | Description |
|---|---|
[ActionInputs](../action/actioninputs.md?sid=flyte_remote__action_actioninputs) | The inputs provided to the run action. |
outputs()
async def outputs(self) -> ActionOutputs: ...
Placeholder for outputs. This can be extended to handle outputs from the run context.
Returns
| Type | Description |
|---|---|
[ActionOutputs](../action/actionoutputs.md?sid=flyte_remote__action_actionoutputs) | The outputs produced by the run action. |