Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ClusterCompareCommandDescriptor

Command descriptor for querylanguage CLUSTERCOMPARE command.

Properties

Methods

Properties

Optional baselineQuery

baselineQuery: undefined | string

Query to use to compute base line to compare top level query results against to identify differences if specified.

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.

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 = "CLUSTER_COMPARE"

Optional referencedFields

referencedFields: Array<AbstractField>

Fields referenced in command fragment from user specified query string.

Optional shouldIncludeTrends

shouldIncludeTrends: undefined | false | true

Option to calculate trends of each cluster if specified.

Optional span

span: undefined | string

Option to control the size of buckets in the histogram e.g 8hrs - each bar other than first and last should represent 8hr time span. Will be adjusted to a larger span if time range is very large.

Optional timeEnd

timeEnd: undefined | number

End time to apply to base line query if specified. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional timeShift

timeShift: undefined | string

To shift time range of main query backwards using a relative time expression e.g -24hrs. E.g compare against the previous 24 hrs.

Optional timeStart

timeStart: undefined | number

Start time to apply to base line query if specified. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Methods

getDeserializedJsonObj

getJsonObj