Iterate over simulator routines

async AsyncCogniteClient.simulators.routines.__call__(
chunk_size: int | None = None,
model_external_ids: Sequence[str] | None = None,
simulator_integration_external_ids: Sequence[str] | None = None,
sort: PropertySort | None = None,
limit: int | None = None,
) AsyncIterator[SimulatorRoutine] | AsyncIterator[SimulatorRoutineList]

Iterate over simulator routines

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

Parameters:
  • chunk_size (int | None) – Number of simulator routines to return in each chunk. Defaults to yielding one simulator routine a time.

  • model_external_ids (Sequence[str] | None) – Filter on model external ids.

  • simulator_integration_external_ids (Sequence[str] | None) – Filter on simulator integration external ids.

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

  • limit (int | None) – Maximum number of simulator routines to return. Defaults to return all items.

Yields:

SimulatorRoutine | SimulatorRoutineList – yields SimulatorRoutine one by one if chunk is not specified, else SimulatorRoutineList objects.