Sync Resume

async AsyncCogniteClient.data_modeling.records.sync_resume(
stream_id: str,
*,
cursor: str,
filter: Filter | None = None,
sources: Sequence[RecordSourceSelector] | None = None,
target_units: RecordTargetUnits | Sequence[RecordTargetUnit] | None = None,
limit: int = 10,
include_typing: bool = False,
) → SyncRecordList

Resume syncing records from a stream using a cursor from sync() or sync_resume().

Parameters:

  • stream_id (str) – External ID of the stream to sync.

  • cursor (str) – Resume from a cursor returned by a previous sync call.

  • filter (Filter | None) – Filter expression (see cognite.client.data_classes.filters).

  • sources (Sequence[RecordSourceSelector] | None) – Which container properties to return.

  • target_units (RecordTargetUnits | Sequence[RecordTargetUnit] | None) – Properties to convert to another unit.

  • limit (int) – Maximum number of records to return in this page (1-1000). Defaults to 10.

  • include_typing (bool) – If True, include property type information on the returned list’s typing attribute.

Returns:

One page of change records, with cursor and has_next set.

Return type:

SyncRecordList