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

Class ShapeProperty

java.lang.Object

org.opensearch.client.opensearch._types.mapping.PropertyBase

org.opensearch.client.opensearch._types.mapping.CorePropertyBase

org.opensearch.client.opensearch._types.mapping.DocValuesPropertyBase

org.opensearch.client.opensearch._types.mapping.ShapeProperty

All Implemented Interfaces:

JsonpSerializable, PropertyVariant

@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.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.mapping.DocValuesPropertyBase

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
Property.Kind	_propertyKind()	Property variant kind.
java.lang.Boolean	coerce()	API name: coerce
java.lang.Boolean	ignoreMalformed()	API name: ignore_malformed
java.lang.Boolean	ignoreZValue()	API name: ignore_z_value
static ShapeProperty	of(java.util.function.Function<ShapeProperty.Builder,ObjectBuilder<ShapeProperty>> fn)
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 org.opensearch.client.opensearch._types.mapping.DocValuesPropertyBase

docValues, setupDocValuesPropertyBaseDeserializer

Methods inherited from class org.opensearch.client.opensearch._types.mapping.CorePropertyBase

copyTo, setupCorePropertyBaseDeserializer, similarity, store

Methods inherited from class org.opensearch.client.opensearch._types.mapping.PropertyBase

dynamic, fields, ignoreAbove, localMetadata, meta, name, properties, serialize, setupPropertyBaseDeserializer

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.JsonpSerializable

serialize

Methods inherited from interface org.opensearch.client.opensearch._types.mapping.PropertyVariant

_toProperty

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<ShapeProperty> _DESERIALIZER

Json deserializer for ShapeProperty

Method Detail

of

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

_propertyKind

public Property.Kind _propertyKind()

Property variant kind.

Specified by:

_propertyKind in interface PropertyVariant

coerce

@Nullable
public final java.lang.Boolean coerce()

API name: coerce

ignoreMalformed

@Nullable
public final java.lang.Boolean ignoreMalformed()

API name: ignore_malformed

ignoreZValue

@Nullable
public final java.lang.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)