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 message containing the raw run definition data from the Union API. |
| action_details | [ActionDetails](../action/actiondetails.md?sid=flyte_remote__action_actiondetails) | An object providing high-level access to the specific action and execution state associated with this run. |
Constructor
Signature
def RunDetails(
pb2: run_definition_pb2.RunDetails
)
Parameters
| Name | Type | Description |
|---|---|---|
| pb2 | run_definition_pb2.RunDetails | The protocol buffer representation of the run details. |
Methods
get_details()
@classmethod
def get_details(
run_id: identifier_pb2.RunIdentifier
) - > [RunDetails](rundetails.md?sid=flyte_remote__run_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 containing the organization, project, domain, and name of the run to retrieve. |
Returns
| Type | Description |
|---|---|
[RunDetails](rundetails.md?sid=flyte_remote__run_rundetails) | A RunDetails instance populated with data from the remote Union API. |
get()
@classmethod
def get(
name: str | null = null
) - > [RunDetails](rundetails.md?sid=flyte_remote__run_rundetails)
Get a run by its ID or name. If both are provided, the ID will take precedence.
Parameters
| Name | Type | Description |
|---|---|---|
| name | `str | null` = null |
Returns
| Type | Description |
|---|---|
[RunDetails](rundetails.md?sid=flyte_remote__run_rundetails) | The RunDetails object corresponding to the specified name and current configuration context. |
name()
@classmethod
def name() - > str
Get the name of the action.
Returns
| Type | Description |
|---|---|
str | The specific run name associated with this action. |
task_name()
@classmethod
def task_name() - > str | null
Get the name of the task.
Returns
| Type | Description |
|---|---|
| `str | null` |
action_id()
@classmethod
def action_id() - > identifier_pb2.ActionIdentifier
Get the action ID.
Returns
| Type | Description |
|---|---|
identifier_pb2.ActionIdentifier | The unique identifier for the underlying action. |
done()
@classmethod
def done() - > 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 has finished executing or failed; False otherwise. |
inputs()
@classmethod
def inputs() - > [ActionInputs](../action/actioninputs.md?sid=flyte_remote__action_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 input parameters and values provided to the run. |
outputs()
@classmethod
def outputs() - > [ActionOutputs](../action/actionoutputs.md?sid=flyte_remote__action_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 output results produced by the run execution. |