Skip to main content

StreamDataGroupedAggregationQueryOptions

Namespace: Meshmakers.Octo.Runtime.Contracts.StreamData

Options for a grouped aggregation stream data query.

public class StreamDataGroupedAggregationQueryOptions : StreamDataQueryOptionsBase

Inheritance Object → StreamDataQueryOptionsBase → StreamDataGroupedAggregationQueryOptions

Properties​

AggregationColumns​

public IReadOnlyList<AggregationColumn> AggregationColumns { get; private set; }

Property Value​

IReadOnlyList<AggregationColumn>

GroupByColumns​

public IReadOnlyList<string> GroupByColumns { get; private set; }

Property Value​

IReadOnlyList<String>

CkTypeId​

public RtCkId<CkTypeId> CkTypeId { get; protected set; }

Property Value​

RtCkId<CkTypeId>

Columns​

public IReadOnlyList<string> Columns { get; protected set; }

Property Value​

IReadOnlyList<String>

RtIds​

public IReadOnlyList<OctoObjectId> RtIds { get; protected set; }

Property Value​

IReadOnlyList<OctoObjectId>

From​

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

Property Value​

Nullable<DateTime>

To​

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

Property Value​

Nullable<DateTime>

Limit​

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

Property Value​

Nullable<Int32>

SortOrders​

public IReadOnlyList<SortOrderItem> SortOrders { get; protected set; }

Property Value​

IReadOnlyList<SortOrderItem>

FieldFilters​

public IReadOnlyList<FieldFilter> FieldFilters { get; protected set; }

Property Value​

IReadOnlyList<FieldFilter>

Offset​

public Nullable<int> Offset { get; protected set; }

Property Value​

Nullable<Int32>

PageSize​

public Nullable<int> PageSize { get; protected set; }

Property Value​

Nullable<Int32>

Constructors​

StreamDataGroupedAggregationQueryOptions()​

public StreamDataGroupedAggregationQueryOptions()

Methods​

Create()​

public static StreamDataGroupedAggregationQueryOptions Create()

Returns​

StreamDataGroupedAggregationQueryOptions

WithCkTypeId(RtCkId<CkTypeId>)​

public StreamDataGroupedAggregationQueryOptions WithCkTypeId(RtCkId<CkTypeId> id)

Parameters​

id RtCkId<CkTypeId>

Returns​

StreamDataGroupedAggregationQueryOptions

WithAggregationColumns(IReadOnlyList<AggregationColumn>)​

public StreamDataGroupedAggregationQueryOptions WithAggregationColumns(IReadOnlyList<AggregationColumn> columns)

Parameters​

columns IReadOnlyList<AggregationColumn>

Returns​

StreamDataGroupedAggregationQueryOptions

WithGroupByColumns(IReadOnlyList<String>)​

public StreamDataGroupedAggregationQueryOptions WithGroupByColumns(IReadOnlyList<string> columns)

Parameters​

columns IReadOnlyList<String>

Returns​

StreamDataGroupedAggregationQueryOptions

WithTimeRange(Nullable<DateTime>, Nullable<DateTime>)​

public StreamDataGroupedAggregationQueryOptions WithTimeRange(Nullable<DateTime> from, Nullable<DateTime> to)

Parameters​

from Nullable<DateTime>

to Nullable<DateTime>

Returns​

StreamDataGroupedAggregationQueryOptions

WithLimit(Nullable<Int32>)​

public StreamDataGroupedAggregationQueryOptions WithLimit(Nullable<int> limit)

Parameters​

limit Nullable<Int32>

Returns​

StreamDataGroupedAggregationQueryOptions

WithFieldFilters(IReadOnlyList<FieldFilter>)​

public StreamDataGroupedAggregationQueryOptions WithFieldFilters(IReadOnlyList<FieldFilter> fieldFilters)

Parameters​

fieldFilters IReadOnlyList<FieldFilter>

Returns​

StreamDataGroupedAggregationQueryOptions

WithRtIds(IReadOnlyList<OctoObjectId>)​

public StreamDataGroupedAggregationQueryOptions WithRtIds(IReadOnlyList<OctoObjectId> ids)

Parameters​

ids IReadOnlyList<OctoObjectId>

Returns​

StreamDataGroupedAggregationQueryOptions

WithPagination(Nullable<Int32>, Nullable<Int32>)​

public StreamDataGroupedAggregationQueryOptions WithPagination(Nullable<int> offset, Nullable<int> pageSize)

Parameters​

offset Nullable<Int32>

pageSize Nullable<Int32>

Returns​

StreamDataGroupedAggregationQueryOptions