Package co.elastic.clients.elasticsearch._types

Enum Class GeoShapeRelation

java.lang.Object

java.lang.Enum<GeoShapeRelation>

co.elastic.clients.elasticsearch._types.GeoShapeRelation

All Implemented Interfaces:

JsonEnum, JsonpSerializable, Serializable, Comparable<GeoShapeRelation>, Constable

@JsonpDeserializable
public enum GeoShapeRelation
extends Enum<GeoShapeRelation>
implements JsonEnum

See Also:

• API specification

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface co.elastic.clients.json.JsonEnum

JsonEnum.Deserializer<T extends JsonEnum>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Contains	Return all documents whose geo_shape or geo_point field contains the query geometry.
Disjoint	Return all documents whose geo_shape or geo_point field has nothing in common with the query geometry.
Intersects	Return all documents whose geo_shape or geo_point field intersects the query geometry.
Within	Return all documents whose geo_shape or geo_point field is within the query geometry.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonEnum.Deserializer<GeoShapeRelation>	_DESERIALIZER

Method Summary

Modifier and Type	Method	Description
String	jsonValue()
static GeoShapeRelation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GeoShapeRelation[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

aliases, serialize

Enum Constant Details

Intersects

public static final GeoShapeRelation Intersects

Return all documents whose geo_shape or geo_point field intersects the query geometry.

Disjoint

public static final GeoShapeRelation Disjoint

Return all documents whose geo_shape or geo_point field has nothing in common with the query geometry.

Within

public static final GeoShapeRelation Within

Return all documents whose geo_shape or geo_point field is within the query geometry. Line geometries are not supported.

Contains

public static final GeoShapeRelation Contains

Return all documents whose geo_shape or geo_point field contains the query geometry.

Field Details

_DESERIALIZER

public static final JsonEnum.Deserializer<GeoShapeRelation> _DESERIALIZER

Method Details

values

public static GeoShapeRelation[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static GeoShapeRelation valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

jsonValue

public String jsonValue()

Specified by:

jsonValue in interface JsonEnum