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

Class SourceConfig

java.lang.Object

org.opensearch.client.opensearch.core.search.SourceConfig

All Implemented Interfaces:

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

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

Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final Object	_get()
final SourceConfig.Kind	_kind()	Get the of the kind of variant held by this object.
static SourceConfig.Builder	builder()
boolean	equals(Object o)
Boolean	fetch()	Get the fetch variant value.
SourceFilter	filter()	Get the filter variant value.
int	hashCode()
boolean	isFetch()	Is this variant instance of kind fetch?
boolean	isFilter()	Is this variant instance of kind filter?
static SourceConfig	of(Function<SourceConfig.Builder,ObjectBuilder<SourceConfig>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
SourceConfig.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<SourceConfig> _DESERIALIZER

Method Details

_kind

public final SourceConfig.Kind _kind()

Description copied from interface: TaggedUnion

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

Specified by:

_kind in interface TaggedUnion<SourceConfig.Kind,Object>

Returns:

the variant kind

_get

public final Object _get()

Specified by:

_get in interface TaggedUnion<SourceConfig.Kind,Object>

of

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

isFetch

public boolean isFetch()

Is this variant instance of kind fetch?

fetch

public Boolean fetch()

Get the fetch variant value.

Throws:

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

isFilter

public boolean isFilter()

Is this variant instance of kind filter?

filter

public SourceFilter filter()

Get the filter variant value.

Throws:

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

serialize

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

Specified by:

serialize in interface JsonpSerializable

toBuilder

@Nonnull
public SourceConfig.Builder toBuilder()

builder

@Nonnull
public static SourceConfig.Builder builder()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object