Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace TimeClusterCommandDescriptor

Command descriptor for querylanguage TIMECLUSTER command.

Properties

Optional category

category: undefined | string

querylanguage command designation for example; reporting vs filtering

Optional declaredFields

declaredFields: Array<AbstractField>

Fields declared in command fragment from user specified query string.

displayQueryString

displayQueryString: string

Command fragment display string from user specified query string formatted by query builder.

Optional functions

functions: Array<FunctionField>

Statistical functions specified in the query string. Atleast 1 is required for a TIMECLUSTER command.

Optional groupByFields

groupByFields: Array<AbstractField>

Group by fields specified in the query string.

internalQueryString

internalQueryString: string

Command fragment internal string from user specified query string formatted by query builder.

Optional isHidden

isHidden: undefined | false | true

Field denoting if this is a hidden command that is not shown in the query string.

Const name

name: string = "TIME_CLUSTER"

Optional referencedFields

referencedFields: Array<AbstractField>

Fields referenced in command fragment from user specified query string.

Optional span

span: undefined | string

Option to control the size of buckets in the timeseries. Will be adjusted to a larger span if time range is very large.

Optional time

Optional timestamp datatype field if specified. Default field is 'Start Time'.

Methods

getDeserializedJsonObj

getJsonObj