Iterate over simulator models

async AsyncCogniteClient.simulators.models.__call__(
chunk_size: int | None = None,
simulator_external_ids: str | SequenceNotStr[str] | None = None,
sort: PropertySort | None = None,
limit: int | None = None,
) → AsyncIterator[SimulatorModel] | AsyncIterator[SimulatorModelList]

Iterate over simulator simulator models

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

Parameters:

  • chunk_size (int | None) – Number of simulator models to return in each chunk. Defaults to yielding one simulator model a time.

  • simulator_external_ids (str | SequenceNotStr[str] | None) – Filter by simulator external id(s).

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

  • limit (int | None) – Maximum number of results to return. Defaults to 25. Set to -1, float(“inf”) or None to return all items.

Yields:

SimulatorModel | SimulatorModelList – yields SimulatorModel one by one if chunk is not specified, else SimulatorModelList objects.