Interface RecordSyncRequest

Request for syncing records from a stream

interface RecordSyncRequest {
    cursor?: string;
    filter?: RecordFilter;
    includeTyping?: boolean;
    initializeCursor?: string;
    limit?: number;
    sources?: SourceSelector[];
    targetUnits?: RecordTargetUnits;
}

Properties

cursor? filter? includeTyping? initializeCursor? limit? sources? targetUnits?

Properties

Optionalcursor

cursor?: string

Cursor from a previous sync request

Optionalfilter

filter?: RecordFilter

Filter specification

OptionalincludeTyping

includeTyping?: boolean

When true, include property type information (and resolved units when combined with targetUnits).

OptionalinitializeCursor

initializeCursor?: string

Initialize cursor with a time offset (e.g., "2d-ago", "1h-ago")

Optionallimit

limit?: number

Maximum number of results to return (default: 10, max: 1000)

Optionalsources

sources?: SourceSelector[]

List of containers and their properties to return

OptionaltargetUnits

targetUnits?: RecordTargetUnits

Convert float properties to another unit or unit system (response and filter values).

Settings

Member Visibility

On This Page

Properties