Iterate over simulation runs

async AsyncCogniteClient.simulators.runs.__call__(
chunk_size: int | None = None,
limit: int | None = None,
status: Literal['queued', 'ready', 'running', 'success', 'failure'] | None = None,
run_type: Literal['external', 'manual', 'scheduled'] | None = None,
model_external_ids: SequenceNotStr[str] | None = None,
simulator_integration_external_ids: SequenceNotStr[str] | None = None,
simulator_external_ids: SequenceNotStr[str] | None = None,
routine_external_ids: SequenceNotStr[str] | None = None,
routine_revision_external_ids: SequenceNotStr[str] | None = None,
model_revision_external_ids: SequenceNotStr[str] | None = None,
created_time: TimestampRange | None = None,
simulation_time: TimestampRange | None = None,
sort: SimulationRunsSort | None = None,
) → AsyncIterator[SimulationRun] | AsyncIterator[SimulationRunList]

Iterate over simulation runs

Fetches simulation runs as they are iterated over, so you keep a limited number of simulation runs in memory.

Parameters:

  • chunk_size (int | None) – Number of simulation runs to return in each chunk. Defaults to yielding one simulation run a time.

  • limit (int | None) – The maximum number of simulation runs to return, pass None to return all.

  • status (SimulatorRunStatus | None) – Filter by simulation run status

  • run_type (SimulatorRunType | None) – Filter by simulation run type

  • model_external_ids (SequenceNotStr[str] | None) – Filter by simulator model external ids

  • simulator_integration_external_ids (SequenceNotStr[str] | None) – Filter by simulator integration external ids

  • simulator_external_ids (SequenceNotStr[str] | None) – Filter by simulator external ids

  • routine_external_ids (SequenceNotStr[str] | None) – Filter by routine external ids

  • routine_revision_external_ids (SequenceNotStr[str] | None) – Filter by routine revision external ids

  • model_revision_external_ids (SequenceNotStr[str] | None) – Filter by model revision external ids

  • created_time (TimestampRange | None) – Filter by created time

  • simulation_time (TimestampRange | None) – Filter by simulation time

  • sort (SimulationRunsSort | None) – The criteria to sort by.

Yields:

SimulationRun | SimulationRunList – yields Simulation Run one by one if chunk is not specified, else SimulatorRunsList objects.