Iterate over simulator routine revisions
- async AsyncCogniteClient.simulators.routines.revisions.__call__(
- chunk_size: int | None = None,
- routine_external_ids: SequenceNotStr[str] | None = None,
- model_external_ids: SequenceNotStr[str] | None = None,
- simulator_integration_external_ids: SequenceNotStr[str] | None = None,
- simulator_external_ids: SequenceNotStr[str] | None = None,
- kind: Literal['long'] | None = None,
- created_time: TimestampRange | None = None,
- all_versions: bool = False,
- include_all_fields: bool = False,
- limit: int | None = None,
- sort: PropertySort | None = None,
Iterate over simulator routine revisions
Fetches simulator routine revisions as they are iterated over, so you keep a limited number of simulator routine revisions in memory.
- Parameters:
chunk_size (int | None) – Number of simulator routine revisions to return in each chunk. Defaults to yielding one simulator routine revision a time.
routine_external_ids (SequenceNotStr[str] | None) – Filter on routine external ids.
model_external_ids (SequenceNotStr[str] | None) – Filter on model external ids.
simulator_integration_external_ids (SequenceNotStr[str] | None) – Filter on simulator integration external ids.
simulator_external_ids (SequenceNotStr[str] | None) – Filter on simulator external ids.
kind (Literal['long'] | None) – Filter by routine kind. Note that this filter cannot be applied when ‘include_all_fields’ set to ‘True’ in the same query.
created_time (TimestampRange | None) – Filter on created time.
all_versions (bool) – If all versions of the routine should be returned. Defaults to false which only returns the latest version.
include_all_fields (bool) – If all fields should be included in the response. Defaults to false which does not include script, configuration.inputs and configuration.outputs in the response.
limit (int | None) – Maximum number of simulator routine revisions to return. Defaults to return all items.
sort (PropertySort | None) – The criteria to sort by.
- Yields:
SimulatorRoutineRevision | SimulatorRoutineRevisionList – yields SimulatorRoutineRevision one by one if chunk is not specified, else SimulatorRoutineRevisionList objects.