exists() function

Check if an entity with the specified identifier exists.

This function checks if an entity with the given identifier exists. It supports various types of entity identifiers, including TaskId, DataNodeId, SequenceId, ScenarioId, JobId, CycleId, SubmissionId, and string representations.

Parameters:

Name Type Description Default
entity_id Union[DataNodeId, TaskId, SequenceId, ScenarioId, JobId, CycleId, SubmissionId, str]

The identifier of the entity to check for existence.

required

Returns:

Type Description
ReasonCollection

A ReasonCollection object that can function as a Boolean value,

ReasonCollection

which is True if the given entity exists. False otherwise.

Raises:

Type Description
ModelNotFound

If the entity's type cannot be determined.

Note

The function performs checks for various entity types (Job, Cycle, Scenario, Sequence, Task, DataNode, Submission) based on their respective identifier prefixes.