java.lang.Object

co.elastic.clients.elasticsearch._types.mapping.Property

All Implemented Interfaces:: JsonpSerializable, TaggedUnion<Property.Kind,PropertyVariant>

@JsonpDeserializable
public class Property
extends java.lang.Object
implements TaggedUnion<Property.Kind,PropertyVariant>, JsonpSerializable

See Also:: API specification

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class Property.Builder

static class Property.Kind
Property variant kinds.
Field Summary

Fields

Modifier and Type Field Description

static JsonpDeserializer<Property> _DESERIALIZER
Constructor Summary

Constructors

Constructor Description

Property(PropertyVariant value)

Method Summary

Modifier and Type	Method	Description
`PropertyVariant`	`_get()`
`Property.Kind`	`_kind()`	Get the of the kind of variant held by this object.
`AggregateMetricDoubleProperty`	`aggregateMetricDouble()`	Get the `aggregate_metric_double` variant value.
`FieldAliasProperty`	`alias()`	Get the `alias` variant value.
`BinaryProperty`	`binary()`	Get the `binary` variant value.
`BooleanProperty`	`boolean_()`	Get the `boolean` variant value.
`ByteNumberProperty`	`byte_()`	Get the `byte` variant value.
`CompletionProperty`	`completion()`	Get the `completion` variant value.
`ConstantKeywordProperty`	`constantKeyword()`	Get the `constant_keyword` variant value.
`DateProperty`	`date()`	Get the `date` variant value.
`DateNanosProperty`	`dateNanos()`	Get the `date_nanos` variant value.
`DateRangeProperty`	`dateRange()`	Get the `date_range` variant value.
`DenseVectorProperty`	`denseVector()`	Get the `dense_vector` variant value.
`DoubleNumberProperty`	`double_()`	Get the `double` variant value.
`DoubleRangeProperty`	`doubleRange()`	Get the `double_range` variant value.
`FlattenedProperty`	`flattened()`	Get the `flattened` variant value.
`FloatNumberProperty`	`float_()`	Get the `float` variant value.
`FloatRangeProperty`	`floatRange()`	Get the `float_range` variant value.
`GeoPointProperty`	`geoPoint()`	Get the `geo_point` variant value.
`GeoShapeProperty`	`geoShape()`	Get the `geo_shape` variant value.
`HalfFloatNumberProperty`	`halfFloat()`	Get the `half_float` variant value.
`HistogramProperty`	`histogram()`	Get the `histogram` variant value.
`IntegerNumberProperty`	`integer()`	Get the `integer` variant value.
`IntegerRangeProperty`	`integerRange()`	Get the `integer_range` variant value.
`IpProperty`	`ip()`	Get the `ip` variant value.
`IpRangeProperty`	`ipRange()`	Get the `ip_range` variant value.
`boolean`	`isAggregateMetricDouble()`	Is this variant instance of kind `aggregate_metric_double`?
`boolean`	`isAlias()`	Is this variant instance of kind `alias`?
`boolean`	`isBinary()`	Is this variant instance of kind `binary`?
`boolean`	`isBoolean()`	Is this variant instance of kind `boolean`?
`boolean`	`isByte()`	Is this variant instance of kind `byte`?
`boolean`	`isCompletion()`	Is this variant instance of kind `completion`?
`boolean`	`isConstantKeyword()`	Is this variant instance of kind `constant_keyword`?
`boolean`	`isDate()`	Is this variant instance of kind `date`?
`boolean`	`isDateNanos()`	Is this variant instance of kind `date_nanos`?
`boolean`	`isDateRange()`	Is this variant instance of kind `date_range`?
`boolean`	`isDenseVector()`	Is this variant instance of kind `dense_vector`?
`boolean`	`isDouble()`	Is this variant instance of kind `double`?
`boolean`	`isDoubleRange()`	Is this variant instance of kind `double_range`?
`boolean`	`isFlattened()`	Is this variant instance of kind `flattened`?
`boolean`	`isFloat()`	Is this variant instance of kind `float`?
`boolean`	`isFloatRange()`	Is this variant instance of kind `float_range`?
`boolean`	`isGeoPoint()`	Is this variant instance of kind `geo_point`?
`boolean`	`isGeoShape()`	Is this variant instance of kind `geo_shape`?
`boolean`	`isHalfFloat()`	Is this variant instance of kind `half_float`?
`boolean`	`isHistogram()`	Is this variant instance of kind `histogram`?
`boolean`	`isInteger()`	Is this variant instance of kind `integer`?
`boolean`	`isIntegerRange()`	Is this variant instance of kind `integer_range`?
`boolean`	`isIp()`	Is this variant instance of kind `ip`?
`boolean`	`isIpRange()`	Is this variant instance of kind `ip_range`?
`boolean`	`isJoin()`	Is this variant instance of kind `join`?
`boolean`	`isKeyword()`	Is this variant instance of kind `keyword`?
`boolean`	`isLong()`	Is this variant instance of kind `long`?
`boolean`	`isLongRange()`	Is this variant instance of kind `long_range`?
`boolean`	`isMurmur3()`	Is this variant instance of kind `murmur3`?
`boolean`	`isNested()`	Is this variant instance of kind `nested`?
`boolean`	`isObject()`	Is this variant instance of kind `object`?
`boolean`	`isPercolator()`	Is this variant instance of kind `percolator`?
`boolean`	`isPoint()`	Is this variant instance of kind `point`?
`boolean`	`isRankFeature()`	Is this variant instance of kind `rank_feature`?
`boolean`	`isRankFeatures()`	Is this variant instance of kind `rank_features`?
`boolean`	`isScaledFloat()`	Is this variant instance of kind `scaled_float`?
`boolean`	`isSearchAsYouType()`	Is this variant instance of kind `search_as_you_type`?
`boolean`	`isShape()`	Is this variant instance of kind `shape`?
`boolean`	`isShort()`	Is this variant instance of kind `short`?
`boolean`	`isText()`	Is this variant instance of kind `text`?
`boolean`	`isTokenCount()`	Is this variant instance of kind `token_count`?
`boolean`	`isUnsignedLong()`	Is this variant instance of kind `unsigned_long`?
`boolean`	`isVersion()`	Is this variant instance of kind `version`?
`boolean`	`isWildcard()`	Is this variant instance of kind `wildcard`?
`JoinProperty`	`join()`	Get the `join` variant value.
`KeywordProperty`	`keyword()`	Get the `keyword` variant value.
`LongNumberProperty`	`long_()`	Get the `long` variant value.
`LongRangeProperty`	`longRange()`	Get the `long_range` variant value.
`Murmur3HashProperty`	`murmur3()`	Get the `murmur3` variant value.
`NestedProperty`	`nested()`	Get the `nested` variant value.
`ObjectProperty`	`object()`	Get the `object` variant value.
`static Property`	`of(java.util.function.Function<Property.Builder,ObjectBuilder<Property>> fn)`
`PercolatorProperty`	`percolator()`	Get the `percolator` variant value.
`PointProperty`	`point()`	Get the `point` variant value.
`RankFeatureProperty`	`rankFeature()`	Get the `rank_feature` variant value.
`RankFeaturesProperty`	`rankFeatures()`	Get the `rank_features` variant value.
`ScaledFloatNumberProperty`	`scaledFloat()`	Get the `scaled_float` variant value.
`SearchAsYouTypeProperty`	`searchAsYouType()`	Get the `search_as_you_type` variant value.
`void`	`serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)`
`protected static void`	`setupPropertyDeserializer(ObjectDeserializer<Property.Builder> op)`
`ShapeProperty`	`shape()`	Get the `shape` variant value.
`ShortNumberProperty`	`short_()`	Get the `short` variant value.
`TextProperty`	`text()`	Get the `text` variant value.
`TokenCountProperty`	`tokenCount()`	Get the `token_count` variant value.
`UnsignedLongNumberProperty`	`unsignedLong()`	Get the `unsigned_long` variant value.
`VersionProperty`	`version()`	Get the `version` variant value.
`WildcardProperty`	`wildcard()`	Get the `wildcard` variant value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- _DESERIALIZER
  
  public static final JsonpDeserializer<Property> _DESERIALIZER
Constructor Details
- Property
  
  public Property(PropertyVariant value)
Method Details
- _kind
  
  public final Property.Kind _kind()
  
  Description copied from interface: TaggedUnion
  
  Get the of the kind of variant held by this object.
  
  Specified by:
  
  _kind in interface TaggedUnion<Property.Kind,PropertyVariant>
  
  Returns:
  
  the variant kind
- _get
  
  public final PropertyVariant _get()
  
  Specified by:
  
  _get in interface TaggedUnion<Property.Kind,PropertyVariant>
- of
  
  public static Property of(java.util.function.Function<Property.Builder,ObjectBuilder<Property>> fn)
- isAggregateMetricDouble
  
  public boolean isAggregateMetricDouble()
  
  Is this variant instance of kind aggregate_metric_double?
- aggregateMetricDouble
  
  public AggregateMetricDoubleProperty aggregateMetricDouble()
  
  Get the aggregate_metric_double variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the aggregate_metric_double kind.
- isBinary
  
  public boolean isBinary()
  
  Is this variant instance of kind binary?
- binary
  
  public BinaryProperty binary()
  
  Get the binary variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the binary kind.
- isBoolean
  
  public boolean isBoolean()
  
  Is this variant instance of kind boolean?
- boolean_
  
  public BooleanProperty boolean_()
  
  Get the boolean variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the boolean kind.
- isByte
  
  public boolean isByte()
  
  Is this variant instance of kind byte?
- byte_
  
  public ByteNumberProperty byte_()
  
  Get the byte variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the byte kind.
- isCompletion
  
  public boolean isCompletion()
  
  Is this variant instance of kind completion?
- completion
  
  public CompletionProperty completion()
  
  Get the completion variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the completion kind.
- isConstantKeyword
  
  public boolean isConstantKeyword()
  
  Is this variant instance of kind constant_keyword?
- constantKeyword
  
  public ConstantKeywordProperty constantKeyword()
  
  Get the constant_keyword variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the constant_keyword kind.
- isDateNanos
  
  public boolean isDateNanos()
  
  Is this variant instance of kind date_nanos?
- dateNanos
  
  public DateNanosProperty dateNanos()
  
  Get the date_nanos variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the date_nanos kind.
- isDate
  
  public boolean isDate()
  
  Is this variant instance of kind date?
- date
  
  public DateProperty date()
  
  Get the date variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the date kind.
- isDateRange
  
  public boolean isDateRange()
  
  Is this variant instance of kind date_range?
- dateRange
  
  public DateRangeProperty dateRange()
  
  Get the date_range variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the date_range kind.
- isDenseVector
  
  public boolean isDenseVector()
  
  Is this variant instance of kind dense_vector?
- denseVector
  
  public DenseVectorProperty denseVector()
  
  Get the dense_vector variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the dense_vector kind.
- isDouble
  
  public boolean isDouble()
  
  Is this variant instance of kind double?
- double_
  
  public DoubleNumberProperty double_()
  
  Get the double variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the double kind.
- isDoubleRange
  
  public boolean isDoubleRange()
  
  Is this variant instance of kind double_range?
- doubleRange
  
  public DoubleRangeProperty doubleRange()
  
  Get the double_range variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the double_range kind.
- isAlias
  
  public boolean isAlias()
  
  Is this variant instance of kind alias?
- alias
  
  public FieldAliasProperty alias()
  
  Get the alias variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the alias kind.
- isFlattened
  
  public boolean isFlattened()
  
  Is this variant instance of kind flattened?
- flattened
  
  public FlattenedProperty flattened()
  
  Get the flattened variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the flattened kind.
- isFloat
  
  public boolean isFloat()
  
  Is this variant instance of kind float?
- float_
  
  public FloatNumberProperty float_()
  
  Get the float variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the float kind.
- isFloatRange
  
  public boolean isFloatRange()
  
  Is this variant instance of kind float_range?
- floatRange
  
  public FloatRangeProperty floatRange()
  
  Get the float_range variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the float_range kind.
- isGeoPoint
  
  public boolean isGeoPoint()
  
  Is this variant instance of kind geo_point?
- geoPoint
  
  public GeoPointProperty geoPoint()
  
  Get the geo_point variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the geo_point kind.
- isGeoShape
  
  public boolean isGeoShape()
  
  Is this variant instance of kind geo_shape?
- geoShape
  
  public GeoShapeProperty geoShape()
  
  Get the geo_shape variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the geo_shape kind.
- isHalfFloat
  
  public boolean isHalfFloat()
  
  Is this variant instance of kind half_float?
- halfFloat
  
  public HalfFloatNumberProperty halfFloat()
  
  Get the half_float variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the half_float kind.
- isHistogram
  
  public boolean isHistogram()
  
  Is this variant instance of kind histogram?
- histogram
  
  public HistogramProperty histogram()
  
  Get the histogram variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the histogram kind.
- isInteger
  
  public boolean isInteger()
  
  Is this variant instance of kind integer?
- integer
  
  public IntegerNumberProperty integer()
  
  Get the integer variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the integer kind.
- isIntegerRange
  
  public boolean isIntegerRange()
  
  Is this variant instance of kind integer_range?
- integerRange
  
  public IntegerRangeProperty integerRange()
  
  Get the integer_range variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the integer_range kind.
- isIp
  
  public boolean isIp()
  
  Is this variant instance of kind ip?
- ip
  
  public IpProperty ip()
  
  Get the ip variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the ip kind.
- isIpRange
  
  public boolean isIpRange()
  
  Is this variant instance of kind ip_range?
- ipRange
  
  public IpRangeProperty ipRange()
  
  Get the ip_range variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the ip_range kind.
- isJoin
  
  public boolean isJoin()
  
  Is this variant instance of kind join?
- join
  
  public JoinProperty join()
  
  Get the join variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the join kind.
- isKeyword
  
  public boolean isKeyword()
  
  Is this variant instance of kind keyword?
- keyword
  
  public KeywordProperty keyword()
  
  Get the keyword variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the keyword kind.
- isLong
  
  public boolean isLong()
  
  Is this variant instance of kind long?
- long_
  
  public LongNumberProperty long_()
  
  Get the long variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the long kind.
- isLongRange
  
  public boolean isLongRange()
  
  Is this variant instance of kind long_range?
- longRange
  
  public LongRangeProperty longRange()
  
  Get the long_range variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the long_range kind.
- isMurmur3
  
  public boolean isMurmur3()
  
  Is this variant instance of kind murmur3?
- murmur3
  
  public Murmur3HashProperty murmur3()
  
  Get the murmur3 variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the murmur3 kind.
- isNested
  
  public boolean isNested()
  
  Is this variant instance of kind nested?
- nested
  
  public NestedProperty nested()
  
  Get the nested variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the nested kind.
- isObject
  
  public boolean isObject()
  
  Is this variant instance of kind object?
- object
  
  public ObjectProperty object()
  
  Get the object variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the object kind.
- isPercolator
  
  public boolean isPercolator()
  
  Is this variant instance of kind percolator?
- percolator
  
  public PercolatorProperty percolator()
  
  Get the percolator variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the percolator kind.
- isPoint
  
  public boolean isPoint()
  
  Is this variant instance of kind point?
- point
  
  public PointProperty point()
  
  Get the point variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the point kind.
- isRankFeature
  
  public boolean isRankFeature()
  
  Is this variant instance of kind rank_feature?
- rankFeature
  
  public RankFeatureProperty rankFeature()
  
  Get the rank_feature variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the rank_feature kind.
- isRankFeatures
  
  public boolean isRankFeatures()
  
  Is this variant instance of kind rank_features?
- rankFeatures
  
  public RankFeaturesProperty rankFeatures()
  
  Get the rank_features variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the rank_features kind.
- isScaledFloat
  
  public boolean isScaledFloat()
  
  Is this variant instance of kind scaled_float?
- scaledFloat
  
  public ScaledFloatNumberProperty scaledFloat()
  
  Get the scaled_float variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the scaled_float kind.
- isSearchAsYouType
  
  public boolean isSearchAsYouType()
  
  Is this variant instance of kind search_as_you_type?
- searchAsYouType
  
  public SearchAsYouTypeProperty searchAsYouType()
  
  Get the search_as_you_type variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the search_as_you_type kind.
- isShape
  
  public boolean isShape()
  
  Is this variant instance of kind shape?
- shape
  
  public ShapeProperty shape()
  
  Get the shape variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the shape kind.
- isShort
  
  public boolean isShort()
  
  Is this variant instance of kind short?
- short_
  
  public ShortNumberProperty short_()
  
  Get the short variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the short kind.
- isText
  
  public boolean isText()
  
  Is this variant instance of kind text?
- text
  
  public TextProperty text()
  
  Get the text variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the text kind.
- isTokenCount
  
  public boolean isTokenCount()
  
  Is this variant instance of kind token_count?
- tokenCount
  
  public TokenCountProperty tokenCount()
  
  Get the token_count variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the token_count kind.
- isUnsignedLong
  
  public boolean isUnsignedLong()
  
  Is this variant instance of kind unsigned_long?
- unsignedLong
  
  public UnsignedLongNumberProperty unsignedLong()
  
  Get the unsigned_long variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the unsigned_long kind.
- isVersion
  
  public boolean isVersion()
  
  Is this variant instance of kind version?
- version
  
  public VersionProperty version()
  
  Get the version variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the version kind.
- isWildcard
  
  public boolean isWildcard()
  
  Is this variant instance of kind wildcard?
- wildcard
  
  public WildcardProperty wildcard()
  
  Get the wildcard variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the wildcard kind.
- serialize
  
  public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
  
  Specified by:
  
  serialize in interface JsonpSerializable
- setupPropertyDeserializer
  
  protected static void setupPropertyDeserializer(ObjectDeserializer<Property.Builder> op)

Modifier and Type	Class	Description
`static class`	`Property.Builder`
`static class`	`Property.Kind`	`Property` variant kinds.

Class Property

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

_DESERIALIZER

Constructor Details

Property

Method Details

_kind

_get

of

isAggregateMetricDouble

aggregateMetricDouble

isBinary

binary

isBoolean

boolean_

isByte

byte_

isCompletion

completion

isConstantKeyword

constantKeyword

isDateNanos

dateNanos

isDate

date

isDateRange

dateRange

isDenseVector

denseVector

isDouble

double_

isDoubleRange

doubleRange

isAlias

alias

isFlattened

flattened

isFloat

float_

isFloatRange

floatRange

isGeoPoint

geoPoint

isGeoShape

geoShape

isHalfFloat

halfFloat

isHistogram

histogram

isInteger

integer

isIntegerRange

integerRange

isIp

ip

isIpRange

ipRange

isJoin

join

isKeyword

keyword

isLong

long_

isLongRange

longRange

isMurmur3

murmur3

isNested

nested

isObject

object

isPercolator

percolator

isPoint

point