Package org.opensearch.client.opensearch.core.search

Class Context

java.lang.Object

org.opensearch.client.opensearch.core.search.Context

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, TaggedUnion<Context.Kind,Object>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class Context
extends Object
implements TaggedUnion<Context.Kind,Object>, PlainJsonSerializable

Text or location that we want similar documents for or a lookup to a document's field for the text.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Context.Builder
static enum	Context.Kind	Context variant kinds.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<Context>	_DESERIALIZER

Method Summary

Modifier and Type	Method	Description
final Object	_get()
final Context.Kind	_kind()	Get the of the kind of variant held by this object.
static Context.Builder	builder()
String	category()	Get the category variant value.
boolean	equals(Object o)
int	hashCode()
boolean	isCategory()	Is this variant instance of kind category?
boolean	isLocation()	Is this variant instance of kind location?
GeoLocation	location()	Get the location variant value.
static Context	of(Function<Context.Builder,ObjectBuilder<Context>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
Context.Builder	toBuilder()

Methods inherited from class java.lang.Object

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

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

toJsonString

Field Details

_DESERIALIZER

public static final JsonpDeserializer<Context> _DESERIALIZER

Method Details

_kind

public final Context.Kind _kind()

Description copied from interface: TaggedUnion

Get the of the kind of variant held by this object.

Specified by:

_kind in interface TaggedUnion<Context.Kind,Object>

Returns:

the variant kind

_get

public final Object _get()

Specified by:

_get in interface TaggedUnion<Context.Kind,Object>

of

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

isCategory

public boolean isCategory()

Is this variant instance of kind category?

category

public String category()

Get the category variant value.

Throws:

IllegalStateException - if the current variant is not the category kind.

isLocation

public boolean isLocation()

Is this variant instance of kind location?

location

public GeoLocation location()

Get the location variant value.

Throws:

IllegalStateException - if the current variant is not the location kind.

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Specified by:

serialize in interface JsonpSerializable

toBuilder

@Nonnull
public Context.Builder toBuilder()

builder

@Nonnull
public static Context.Builder builder()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object