Skip to main content

GetQueryByIdNodeConfiguration

Namespace: Meshmakers.Octo.MeshAdapter.Nodes.Extract

Configuration for node get query by id

public record GetQueryByIdNodeConfiguration : TargetPathNodeConfiguration, INodeConfiguration, IEquatable<NodeConfiguration>, ITargetPathNodeConfiguration, IEquatable<TargetPathNodeConfiguration>, IEquatable<GetQueryByIdNodeConfiguration>

Inheritance Object → NodeConfiguration → TargetPathNodeConfiguration → GetQueryByIdNodeConfiguration
Implements INodeConfiguration, IEquatable<NodeConfiguration>, ITargetPathNodeConfiguration, IEquatable<TargetPathNodeConfiguration>, IEquatable<GetQueryByIdNodeConfiguration>

Properties​

QueryRtId​

Gets or sets the query rt id

public OctoObjectId QueryRtId { get; set; }

Property Value​

OctoObjectId

Skip​

Number of rows to skip

public Nullable<int> Skip { get; set; }

Property Value​

Nullable<Int32>

Take​

Number of rows to take

public Nullable<int> Take { get; set; }

Property Value​

Nullable<Int32>

FieldFilters​

A list of field filters

public ICollection<FieldFilterWithPathDto> FieldFilters { get; set; }

Property Value​

ICollection<FieldFilterWithPathDto>

From​

Optional start of the time range (UTC), only applied to stream-data queries. When set it overrides the value persisted on the query entity; otherwise the persisted value is used. A value written without a time-zone offset ("2026-06-01T00:00:00") is read as UTC, not as the adapter host's local time.

public Nullable<DateTime> From { get; set; }

Property Value​

Nullable<DateTime>

To​

Optional end of the time range (UTC), only applied to stream-data queries. When set it overrides the value persisted on the query entity; otherwise the persisted value is used. A value written without a time-zone offset ("2026-06-02T00:00:00") is read as UTC, not as the adapter host's local time.

public Nullable<DateTime> To { get; set; }

Property Value​

Nullable<DateTime>

Limit​

Optional row cap, only applied to stream-data queries. When set it overrides the limit persisted on the query entity; otherwise the persisted value is used. For a downsampling query this is the number of time buckets rather than a row cap, and it doubles as the target point count of the archive selection.

public Nullable<int> Limit { get; set; }

Property Value​

Nullable<Int32>

FromPath​

Optional JSONPath to read the start of the time range from the pipeline data, for cases where the range is computed upstream (HTTP trigger, previous node) instead of being configured. Only applied to stream-data queries. Precedence: GetQueryByIdNodeConfiguration.From (literal) wins over this path, which wins over the value persisted on the query entity. The value may be an ISO-8601 timestamp string or a date/time value; values without an offset are read as UTC. When the path resolves to nothing the persisted value is used and a warning is logged.

public string FromPath { get; set; }

Property Value​

String

ToPath​

Optional JSONPath to read the end of the time range from the pipeline data. Same semantics as GetQueryByIdNodeConfiguration.FromPath; GetQueryByIdNodeConfiguration.To takes precedence over it.

public string ToPath { get; set; }

Property Value​

String

LimitPath​

Optional JSONPath to read the row cap from the pipeline data. Same semantics as GetQueryByIdNodeConfiguration.FromPath; GetQueryByIdNodeConfiguration.Limit takes precedence over it.

public string LimitPath { get; set; }

Property Value​

String

Aggregation​

Optional aggregation override for a downsampling stream-data query. When set it replaces the aggregation type persisted on every column of the query — the same set the query definition offers (Count, Minimum, Maximum, Average, Sum) — and is also the function the archive selection matches a rollup against. Not set means each column keeps its persisted aggregation and the first column's aggregation drives the archive selection.

public Nullable<AggregationTypesDto> Aggregation { get; set; }

Property Value​

Nullable<AggregationTypesDto>

TargetPath​

public string TargetPath { get; set; }

Property Value​

String

TargetValueWriteMode​

public TargetValueWriteModes TargetValueWriteMode { get; set; }

Property Value​

TargetValueWriteModes

TargetValueKind​

public ValueKinds TargetValueKind { get; set; }

Property Value​

ValueKinds

DocumentMode​

public DocumentModes DocumentMode { get; set; }

Property Value​

DocumentModes

Description​

public string Description { get; set; }

Property Value​

String

Constructors​

GetQueryByIdNodeConfiguration()​

Caution​

Constructors of types with required members are not supported in this version of your compiler.

public GetQueryByIdNodeConfiguration()