Package co.elastic.clients.elasticsearch._types.mapping

Class ShapeProperty

java.lang.Object

co.elastic.clients.elasticsearch._types.mapping.PropertyBase

co.elastic.clients.elasticsearch._types.mapping.CorePropertyBase

co.elastic.clients.elasticsearch._types.mapping.DocValuesPropertyBase

co.elastic.clients.elasticsearch._types.mapping.ShapeProperty

All Implemented Interfaces:

PropertyVariant, JsonpSerializable

@JsonpDeserializable
public class ShapeProperty
extends DocValuesPropertyBase
implements PropertyVariant

The shape data type facilitates the indexing of and searching with arbitrary x, y cartesian shapes such as rectangles and polygons.

See Also:

• Documentation on elastic.co
• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ShapeProperty.Builder	Builder for ShapeProperty.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.mapping.DocValuesPropertyBase

DocValuesPropertyBase.AbstractBuilder<BuilderT extends DocValuesPropertyBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<ShapeProperty>	_DESERIALIZER	Json deserializer for ShapeProperty

Method Summary

Modifier and Type	Method	Description
Property.Kind	_propertyKind()	Property variant kind.
final Boolean	coerce()	API name: coerce
final Boolean	ignoreMalformed()	API name: ignore_malformed
final Boolean	ignoreZValue()	API name: ignore_z_value
static ShapeProperty	of(Function<ShapeProperty.Builder,ObjectBuilder<ShapeProperty>> fn)
final GeoOrientation	orientation()	API name: orientation
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupShapePropertyDeserializer(ObjectDeserializer<ShapeProperty.Builder> op)

Methods inherited from class co.elastic.clients.elasticsearch._types.mapping.DocValuesPropertyBase

docValues, setupDocValuesPropertyBaseDeserializer

Methods inherited from class co.elastic.clients.elasticsearch._types.mapping.CorePropertyBase

copyTo, setupCorePropertyBaseDeserializer, similarity, store

Methods inherited from class co.elastic.clients.elasticsearch._types.mapping.PropertyBase

dynamic, fields, ignoreAbove, meta, properties, serialize, setupPropertyBaseDeserializer, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.JsonpSerializable

serialize

Methods inherited from interface co.elastic.clients.elasticsearch._types.mapping.PropertyVariant

_toProperty

Field Details

_DESERIALIZER

public static final JsonpDeserializer<ShapeProperty> _DESERIALIZER

Json deserializer for ShapeProperty

Method Details

of

public static ShapeProperty of(Function<ShapeProperty.Builder,ObjectBuilder<ShapeProperty>> fn)

_propertyKind

public Property.Kind _propertyKind()

Property variant kind.

Specified by:

_propertyKind in interface PropertyVariant

coerce

@Nullable
public final Boolean coerce()

API name: coerce

ignoreMalformed

@Nullable
public final Boolean ignoreMalformed()

API name: ignore_malformed

ignoreZValue

@Nullable
public final Boolean ignoreZValue()

API name: ignore_z_value

orientation

@Nullable
public final GeoOrientation orientation()

API name: orientation

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Overrides:

serializeInternal in class DocValuesPropertyBase

setupShapePropertyDeserializer

protected static void setupShapePropertyDeserializer(ObjectDeserializer<ShapeProperty.Builder> op)