A single field value within a ProcessedHit, equivalent to a KSearchHitField. Carries the raw or joined value along with metadata about where a joined value was resolved from.


Properties

PropertyReturnsDescription
destFieldStringThe name of the field on the joined index that this value was resolved from. Only meaningful when this field was populated via a join.
destFieldMetaESFieldMetaThe field metadata describing the joined index field this value was resolved from, if this field was populated via a join.
destIndexerAppIndexerThe indexer for the related index this value was joined from, if this field was populated via a join.
numericbooleanWhether this value should be treated as numeric when displayed, as opposed to formatted text.
valueObjectThe raw value for this field, or the value resolved from a joined index if this field was populated via a join. May be null.

Methods

getValue()

Returns: Object

The raw value for this field, or the value resolved from a joined index if this field was populated via a join. May be null.

getDestIndexer()

Returns: AppIndexer

The indexer for the related index this value was joined from, if this field was populated via a join.

getDestField()

Returns: String

The name of the field on the joined index that this value was resolved from. Only meaningful when this field was populated via a join.

getDestFieldMeta()

Returns: ESFieldMeta

The field metadata describing the joined index field this value was resolved from, if this field was populated via a join.

isNumeric()

Returns: boolean

Whether this value should be treated as numeric when displayed, as opposed to formatted text.

To get full access to the Kademi Hub existing customers can login here, or new customers can register here.