Package org.opensearch.client.opensearch._types

Enum Class GeoShapeRelation

java.lang.Object

java.lang.Enum<GeoShapeRelation>

org.opensearch.client.opensearch._types.GeoShapeRelation

All Implemented Interfaces:

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

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public enum GeoShapeRelation
extends Enum<GeoShapeRelation>
implements JsonEnum

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface org.opensearch.client.json.JsonEnum

JsonEnum.Deserializer<T extends JsonEnum>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Contains	The shape contains the query shape.
Disjoint	The shape has no points in common with the query shape.
Intersects	The shape shares any points in common with the query shape.
Within	The shape is within the query shape.

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 org.opensearch.client.json.JsonEnum

aliases, serialize

Enum Constant Details

Contains

public static final GeoShapeRelation Contains

The shape contains the query shape.

Disjoint

public static final GeoShapeRelation Disjoint

The shape has no points in common with the query shape.

Intersects

public static final GeoShapeRelation Intersects

The shape shares any points in common with the query shape.

Within

public static final GeoShapeRelation Within

The shape is within the query shape.

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