Package org.opensearch.client.opensearch.search_pipeline

Class ResponseProcessor

java.lang.Object

org.opensearch.client.opensearch.search_pipeline.ResponseProcessor

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, TaggedUnion<ResponseProcessor.Kind,ResponseProcessorVariant>

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
ResponseProcessor(ResponseProcessorVariant value)

Method Summary

Modifier and Type	Method	Description
final ResponseProcessorVariant	_get()
final ResponseProcessor.Kind	_kind()	Get the of the kind of variant held by this object.
static ResponseProcessor.Builder	builder()
CollapseResponseProcessor	collapse()	Get the collapse variant value.
boolean	equals(Object o)
int	hashCode()
boolean	isCollapse()	Is this variant instance of kind collapse?
boolean	isPersonalizeSearchRanking()	Is this variant instance of kind personalize_search_ranking?
boolean	isRenameField()	Is this variant instance of kind rename_field?
boolean	isRerank()	Is this variant instance of kind rerank?
boolean	isRetrievalAugmentedGeneration()	Is this variant instance of kind retrieval_augmented_generation?
boolean	isSort()	Is this variant instance of kind sort?
boolean	isSplit()	Is this variant instance of kind split?
boolean	isTruncateHits()	Is this variant instance of kind truncate_hits?
static ResponseProcessor	of(Function<ResponseProcessor.Builder,ObjectBuilder<ResponseProcessor>> fn)
PersonalizeSearchRankingResponseProcessor	personalizeSearchRanking()	Get the personalize_search_ranking variant value.
RenameFieldResponseProcessor	renameField()	Get the rename_field variant value.
RerankResponseProcessor	rerank()	Get the rerank variant value.
RetrievalAugmentedGenerationResponseProcessor	retrievalAugmentedGeneration()	Get the retrieval_augmented_generation variant value.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupResponseProcessorDeserializer(ObjectDeserializer<ResponseProcessor.Builder> op)
SortResponseProcessor	sort()	Get the sort variant value.
SplitResponseProcessor	split()	Get the split variant value.
ResponseProcessor.Builder	toBuilder()
TruncateHitsResponseProcessor	truncateHits()	Get the truncate_hits variant value.

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<ResponseProcessor> _DESERIALIZER

Constructor Details

ResponseProcessor

public ResponseProcessor(ResponseProcessorVariant value)

Method Details

_kind

public final ResponseProcessor.Kind _kind()

Description copied from interface: TaggedUnion

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

Specified by:

_kind in interface TaggedUnion<ResponseProcessor.Kind,ResponseProcessorVariant>

Returns:

the variant kind

_get

public final ResponseProcessorVariant _get()

Specified by:

_get in interface TaggedUnion<ResponseProcessor.Kind,ResponseProcessorVariant>

of

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

isCollapse

public boolean isCollapse()

Is this variant instance of kind collapse?

collapse

public CollapseResponseProcessor collapse()

Get the collapse variant value.

Throws:

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

isPersonalizeSearchRanking

public boolean isPersonalizeSearchRanking()

Is this variant instance of kind personalize_search_ranking?

personalizeSearchRanking

public PersonalizeSearchRankingResponseProcessor personalizeSearchRanking()

Get the personalize_search_ranking variant value.

Throws:

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

isRenameField

public boolean isRenameField()

Is this variant instance of kind rename_field?

renameField

public RenameFieldResponseProcessor renameField()

Get the rename_field variant value.

Throws:

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

isRerank

public boolean isRerank()

Is this variant instance of kind rerank?

rerank

public RerankResponseProcessor rerank()

Get the rerank variant value.

Throws:

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

isRetrievalAugmentedGeneration

public boolean isRetrievalAugmentedGeneration()

Is this variant instance of kind retrieval_augmented_generation?

retrievalAugmentedGeneration

public RetrievalAugmentedGenerationResponseProcessor retrievalAugmentedGeneration()

Get the retrieval_augmented_generation variant value.

Throws:

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

isSort

public boolean isSort()

Is this variant instance of kind sort?

sort

public SortResponseProcessor sort()

Get the sort variant value.

Throws:

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

isSplit

public boolean isSplit()

Is this variant instance of kind split?

split

public SplitResponseProcessor split()

Get the split variant value.

Throws:

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

isTruncateHits

public boolean isTruncateHits()

Is this variant instance of kind truncate_hits?

truncateHits

public TruncateHitsResponseProcessor truncateHits()

Get the truncate_hits variant value.

Throws:

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

serialize

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

Specified by:

serialize in interface JsonpSerializable

toBuilder

@Nonnull
public ResponseProcessor.Builder toBuilder()

builder

@Nonnull
public static ResponseProcessor.Builder builder()

setupResponseProcessorDeserializer

protected static void setupResponseProcessorDeserializer(ObjectDeserializer<ResponseProcessor.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object