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

Class SourceConfigParam

java.lang.Object

org.opensearch.client.opensearch.core.search.SourceConfigParam

All Implemented Interfaces:

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

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

Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered. Use this setting with the _source_includes and _source_excludes parameters.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

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

Method Details

_kind

public final SourceConfigParam.Kind _kind()

Description copied from interface: TaggedUnion

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

Specified by:

_kind in interface TaggedUnion<SourceConfigParam.Kind,Object>

Returns:

the variant kind

_get

public final Object _get()

Specified by:

_get in interface TaggedUnion<SourceConfigParam.Kind,Object>

of

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

_toJsonString

public String _toJsonString()

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.

isFields

public boolean isFields()

Is this variant instance of kind fields?

fields

public List<String> fields()

Get the fields variant value.

Throws:

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

serialize

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

Specified by:

serialize in interface JsonpSerializable

toBuilder

@Nonnull
public SourceConfigParam.Builder toBuilder()

builder

@Nonnull
public static SourceConfigParam.Builder builder()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object