get() function
Retrieve an entity by its unique identifier.
This function allows you to retrieve an entity by specifying its identifier.
The identifier must match the pattern of one of the supported entity types:
Task
, DataNode
, Sequence
, Job
, Cycle
, Submission
, or Scenario
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
entity_id |
Union[TaskId, DataNodeId, SequenceId, ScenarioId, JobId, CycleId, str]
|
required |
Returns:
Type | Description |
---|---|
Union[Task, DataNode, Sequence, Scenario, Job, Cycle, Submission]
|
The entity that corresponds to the provided identifier. Returns None if no matching entity is found. |
Raises:
Type | Description |
---|---|
ModelNotFound
|
If the provided entity_id does not match any known entity pattern. |