Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace LogAnalyticsFieldSummary

A summary of a field.

Properties

Optional ceeAlias

ceeAlias: undefined | string

The name this field is given in the common event expression standard from mitre.org. This is used for reference when exporting content conforming to CEE standard

Optional dataType

dataType: undefined | string

The field data type.

Optional description

description: undefined | string

The field description.

Optional displayName

displayName: undefined | string

The field display name.

Optional editVersion

editVersion: undefined | number

The field edit version. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional facetPriority

facetPriority: undefined | number

The facet priority. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional isFacetEligible

isFacetEligible: undefined | false | true

A flag inidcating whether or not the facet is elibigle for use.

Optional isHighCardinality

isHighCardinality: undefined | false | true

A flag inidcating whether or not the cardinality of the field is high.

Optional isLargeData

isLargeData: undefined | false | true

A flag inidcating whether or not the field is a large data field.

Optional isMetricKeyEligible

isMetricKeyEligible: undefined | false | true

A flag inidcating whether or not the field is metric key eligible.

Optional isMetricValueEligible

isMetricValueEligible: undefined | false | true

A flag inidcating whether or not the field is metric value eligible.

Optional isMultiValued

isMultiValued: undefined | false | true

A flag indicating whether or not the field is multi-valued.

Optional isPrimary

isPrimary: undefined | false | true

A flag inidcating whether or not this is a primary field.

Optional isSummarizable

isSummarizable: undefined | false | true

A flag inidcating whether or not the field can be summarized.

Optional isSystem

isSystem: undefined | false | true

The system flag. A value of false denotes a custom, or user defined object. A value of true denotes a built in object.

Optional isTableEligible

isTableEligible: undefined | false | true

A flag inidcating whether or not the field is table eligible.

Optional mappedValue

mappedValue: undefined | string

The mapped value.

Optional name

name: undefined | string

The field internal name.

Optional rangeFacetEligible

rangeFacetEligible: undefined | number

A flag inidcating whether or not the field is range facet eligible. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional regularExpression

regularExpression: undefined | string

The field default regular expression.

Optional unitType

unitType: undefined | string

The field unit type.

Functions

getDeserializedJsonObj

getJsonObj