StreamDataQueryOptions
Namespace: Meshmakers.Octo.Runtime.Contracts.StreamData
Options for a simple stream data query. Use StreamDataQueryOptions.Create() to start building.
public class StreamDataQueryOptions : StreamDataQueryOptionsBase
Inheritance Object → StreamDataQueryOptionsBase → StreamDataQueryOptions
Properties
CkTypeId
public RtCkId<CkTypeId> CkTypeId { get; protected set; }
Property Value
RtCkId<CkTypeId>
Columns
public IReadOnlyList<string> Columns { get; protected set; }
Property Value
RtIds
public IReadOnlyList<OctoObjectId> RtIds { get; protected set; }
Property Value
From
public Nullable<DateTime> From { get; protected set; }
Property Value
To
public Nullable<DateTime> To { get; protected set; }
Property Value
Limit
public Nullable<int> Limit { get; protected set; }
Property Value
SortOrders
public IReadOnlyList<SortOrderItem> SortOrders { get; protected set; }
Property Value
FieldFilters
public IReadOnlyList<FieldFilter> FieldFilters { get; protected set; }
Property Value
Offset
public Nullable<int> Offset { get; protected set; }
Property Value
PageSize
public Nullable<int> PageSize { get; protected set; }
Property Value
Constructors
StreamDataQueryOptions()
public StreamDataQueryOptions()
Methods
Create()
public static StreamDataQueryOptions Create()
Returns
WithCkTypeId(RtCkId<CkTypeId>)
public StreamDataQueryOptions WithCkTypeId(RtCkId<CkTypeId> id)
Parameters
id RtCkId<CkTypeId>
Returns
WithColumns(IReadOnlyList<String>)
public StreamDataQueryOptions WithColumns(IReadOnlyList<string> columns)
Parameters
columns IReadOnlyList<String>
Returns
WithRtIds(IReadOnlyList<OctoObjectId>)
public StreamDataQueryOptions WithRtIds(IReadOnlyList<OctoObjectId> ids)
Parameters
ids IReadOnlyList<OctoObjectId>
Returns
WithTimeRange(Nullable<DateTime>, Nullable<DateTime>)
public StreamDataQueryOptions WithTimeRange(Nullable<DateTime> from, Nullable<DateTime> to)
Parameters
from Nullable<DateTime>
Returns
WithLimit(Nullable<Int32>)
public StreamDataQueryOptions WithLimit(Nullable<int> limit)
Parameters
limit Nullable<Int32>
Returns
WithSortOrders(IReadOnlyList<SortOrderItem>)
public StreamDataQueryOptions WithSortOrders(IReadOnlyList<SortOrderItem> sortOrders)
Parameters
sortOrders IReadOnlyList<SortOrderItem>
Returns
WithFieldFilters(IReadOnlyList<FieldFilter>)
public StreamDataQueryOptions WithFieldFilters(IReadOnlyList<FieldFilter> fieldFilters)
Parameters
fieldFilters IReadOnlyList<FieldFilter>
Returns
WithPagination(Nullable<Int32>, Nullable<Int32>)
public StreamDataQueryOptions WithPagination(Nullable<int> offset, Nullable<int> pageSize)
Parameters
offset Nullable<Int32>
pageSize Nullable<Int32>