Package org.opensearch.client.opensearch._types.mapping

Class Property

java.lang.Object
org.opensearch.client.opensearch._types.mapping.Property
All Implemented Interfaces:
JsonpSerializable, PlainJsonSerializable, TaggedUnion<Property.Kind,PropertyVariant>
@JsonpDeserializable @Generated("org.opensearch.client.codegen.CodeGenerator") public class Property extends Object implements TaggedUnion<Property.Kind,PropertyVariant>, PlainJsonSerializable

  • Field Details

  • Constructor Details

  • 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(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:
      IllegalStateException - if the current variant is not the aggregate_metric_double kind.

    • isAlias

      public boolean isAlias()
      Is this variant instance of kind alias?

    • alias

      public FieldAliasProperty alias()
      Get the alias variant value.
      Throws:
      IllegalStateException - if the current variant is not the alias kind.

    • isBinary

      public boolean isBinary()
      Is this variant instance of kind binary?

    • binary

      public BinaryProperty binary()
      Get the binary variant value.
      Throws:
      IllegalStateException - if the current variant is not the binary kind.

    • isBoolean

      public boolean isBoolean()
      Is this variant instance of kind boolean?

    • boolean_

      public BooleanProperty boolean_()
      Get the boolean variant value.
      Throws:
      IllegalStateException - if the current variant is not the boolean kind.

    • isByte

      public boolean isByte()
      Is this variant instance of kind byte?

    • byte_

      public ByteNumberProperty byte_()
      Get the byte variant value.
      Throws:
      IllegalStateException - if the current variant is not the byte kind.

    • isCompletion

      public boolean isCompletion()
      Is this variant instance of kind completion?

    • completion

      public CompletionProperty completion()
      Get the completion variant value.
      Throws:
      IllegalStateException - if the current variant is not 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:
      IllegalStateException - if the current variant is not the constant_keyword kind.

    • isDate

      public boolean isDate()
      Is this variant instance of kind date?

    • date

      public DateProperty date()
      Get the date variant value.
      Throws:
      IllegalStateException - if the current variant is not the date kind.

    • isDateNanos

      public boolean isDateNanos()
      Is this variant instance of kind date_nanos?

    • dateNanos

      public DateNanosProperty dateNanos()
      Get the date_nanos variant value.
      Throws:
      IllegalStateException - if the current variant is not the date_nanos kind.

    • isDateRange

      public boolean isDateRange()
      Is this variant instance of kind date_range?

    • dateRange

      public DateRangeProperty dateRange()
      Get the date_range variant value.
      Throws:
      IllegalStateException - if the current variant is not the date_range kind.

    • isDouble

      public boolean isDouble()
      Is this variant instance of kind double?

    • double_

      public DoubleNumberProperty double_()
      Get the double variant value.
      Throws:
      IllegalStateException - if the current variant is not 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:
      IllegalStateException - if the current variant is not the double_range kind.

    • isFlatObject

      public boolean isFlatObject()
      Is this variant instance of kind flat_object?

    • flatObject

      public FlatObjectProperty flatObject()
      Get the flat_object variant value.
      Throws:
      IllegalStateException - if the current variant is not the flat_object kind.

    • isFloat

      public boolean isFloat()
      Is this variant instance of kind float?

    • float_

      public FloatNumberProperty float_()
      Get the float variant value.
      Throws:
      IllegalStateException - if the current variant is not 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:
      IllegalStateException - if the current variant is not 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:
      IllegalStateException - if the current variant is not 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:
      IllegalStateException - if the current variant is not 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:
      IllegalStateException - if the current variant is not 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:
      IllegalStateException - if the current variant is not the histogram kind.

    • isIcuCollationKeyword

      public boolean isIcuCollationKeyword()
      Is this variant instance of kind icu_collation_keyword?

    • icuCollationKeyword

      public IcuCollationKeywordProperty icuCollationKeyword()
      Get the icu_collation_keyword variant value.
      Throws:
      IllegalStateException - if the current variant is not the icu_collation_keyword kind.

    • isInteger

      public boolean isInteger()
      Is this variant instance of kind integer?

    • integer

      public IntegerNumberProperty integer()
      Get the integer variant value.
      Throws:
      IllegalStateException - if the current variant is not 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:
      IllegalStateException - if the current variant is not 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:
      IllegalStateException - if the current variant is not 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:
      IllegalStateException - if the current variant is not 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:
      IllegalStateException - if the current variant is not the join kind.

    • isKeyword

      public boolean isKeyword()
      Is this variant instance of kind keyword?

    • keyword

      public KeywordProperty keyword()
      Get the keyword variant value.
      Throws:
      IllegalStateException - if the current variant is not the keyword kind.

    • isKnnVector

      public boolean isKnnVector()
      Is this variant instance of kind knn_vector?

    • knnVector

      public KnnVectorProperty knnVector()
      Get the knn_vector variant value.
      Throws:
      IllegalStateException - if the current variant is not the knn_vector kind.

    • isLong

      public boolean isLong()
      Is this variant instance of kind long?

    • long_

      public LongNumberProperty long_()
      Get the long variant value.
      Throws:
      IllegalStateException - if the current variant is not 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:
      IllegalStateException - if the current variant is not the long_range kind.

    • isMatchOnlyText

      public boolean isMatchOnlyText()
      Is this variant instance of kind match_only_text?

    • matchOnlyText

      public MatchOnlyTextProperty matchOnlyText()
      Get the match_only_text variant value.
      Throws:
      IllegalStateException - if the current variant is not the match_only_text kind.

    • isMurmur3

      public boolean isMurmur3()
      Is this variant instance of kind murmur3?

    • murmur3

      public Murmur3HashProperty murmur3()
      Get the murmur3 variant value.
      Throws:
      IllegalStateException - if the current variant is not the murmur3 kind.

    • isNested

      public boolean isNested()
      Is this variant instance of kind nested?

    • nested

      public NestedProperty nested()
      Get the nested variant value.
      Throws:
      IllegalStateException - if the current variant is not the nested kind.

    • isObject

      public boolean isObject()
      Is this variant instance of kind object?

    • object

      public ObjectProperty object()
      Get the object variant value.
      Throws:
      IllegalStateException - if the current variant is not the object kind.

    • isPercolator

      public boolean isPercolator()
      Is this variant instance of kind percolator?

    • percolator

      public PercolatorProperty percolator()
      Get the percolator variant value.
      Throws:
      IllegalStateException - if the current variant is not the percolator kind.

    • isRankFeature

      public boolean isRankFeature()
      Is this variant instance of kind rank_feature?

    • rankFeature

      public RankFeatureProperty rankFeature()
      Get the rank_feature variant value.
      Throws:
      IllegalStateException - if the current variant is not 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:
      IllegalStateException - if the current variant is not 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:
      IllegalStateException - if the current variant is not 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:
      IllegalStateException - if the current variant is not the search_as_you_type kind.

    • isShort

      public boolean isShort()
      Is this variant instance of kind short?

    • short_

      public ShortNumberProperty short_()
      Get the short variant value.
      Throws:
      IllegalStateException - if the current variant is not the short kind.

    • isText

      public boolean isText()
      Is this variant instance of kind text?

    • text

      public TextProperty text()
      Get the text variant value.
      Throws:
      IllegalStateException - if the current variant is not 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:
      IllegalStateException - if the current variant is not 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:
      IllegalStateException - if the current variant is not 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:
      IllegalStateException - if the current variant is not the version kind.

    • isWildcard

      public boolean isWildcard()
      Is this variant instance of kind wildcard?

    • wildcard

      public WildcardProperty wildcard()
      Get the wildcard variant value.
      Throws:
      IllegalStateException - if the current variant is not the wildcard kind.

    • isXyPoint

      public boolean isXyPoint()
      Is this variant instance of kind xy_point?

    • xyPoint

      public XyPointProperty xyPoint()
      Get the xy_point variant value.
      Throws:
      IllegalStateException - if the current variant is not the xy_point kind.

    • isXyShape

      public boolean isXyShape()
      Is this variant instance of kind xy_shape?

    • xyShape

      public XyShapeProperty xyShape()
      Get the xy_shape variant value.
      Throws:
      IllegalStateException - if the current variant is not the xy_shape kind.

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Specified by:
      serialize in interface JsonpSerializable

    • toBuilder

      @Nonnull public Property.Builder toBuilder()

    • builder

      @Nonnull public static Property.Builder builder()

    • setupPropertyDeserializer

      protected static void setupPropertyDeserializer(ObjectDeserializer<Property.Builder> op)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object