Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ClassifyCommandDescriptor

Command descriptor for querylanguage CLASSIFY command.

Properties

Methods

Properties

Optional bottomCount

bottomCount: undefined | number

Value specified in CLASSIFY command in queryString if set limits the results returned to bottom N. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional category

category: undefined | string

querylanguage command designation for example; reporting vs filtering

Optional correlate

correlate: Array<FieldsAddRemoveField>

Fields specified in CLASSIFY command in queryString if set include / exclude fields in correlate results.

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

Optional referencedFields

referencedFields: Array<AbstractField>

Fields referenced in command fragment from user specified query string.

Optional topCount

topCount: undefined | number

Value specified in CLASSIFY command in queryString if set limits the results returned to top N. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Methods

getDeserializedJsonObj

getJsonObj