Interface RecordFilterRequest

Filter request for retrieving records from a stream

interface RecordFilterRequest {
    filter?: RecordFilter;
    includeTyping?: boolean;
    lastUpdatedTime?: LastUpdatedTimeFilter;
    limit?: number;
    sort?: RecordSort[];
    sources?: SourceSelector[];
    targetUnits?: RecordTargetUnits;
}

Properties

filter? includeTyping? lastUpdatedTime? limit? sort? sources? targetUnits?

Properties

Optionalfilter

filter?: RecordFilter

Filter specification

OptionalincludeTyping

includeTyping?: boolean

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

OptionallastUpdatedTime

lastUpdatedTime?: LastUpdatedTimeFilter

Filter on last updated time. Required for immutable streams.

Optionallimit

limit?: number

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

Optionalsort

sort?: RecordSort[]

Sorting specifications

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