Package org.opensearch.search.pipeline.common

Class RenameFieldResponseProcessor

java.lang.Object

org.opensearch.search.pipeline.AbstractProcessor

org.opensearch.search.pipeline.common.RenameFieldResponseProcessor

All Implemented Interfaces:

Processor, SearchResponseProcessor

public class RenameFieldResponseProcessor
extends AbstractProcessor
implements SearchResponseProcessor

This is a SearchRequestProcessor that renames a field before returning the search response

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RenameFieldResponseProcessor.Factory	This is a factor that creates the RenameResponseProcessor

Nested classes/interfaces inherited from interface org.opensearch.search.pipeline.Processor

Processor.PipelineContext, Processor.PipelineSource

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE	Key to reference this processor type from a search pipeline.

Fields inherited from interface org.opensearch.search.pipeline.Processor

PIPELINE_SOURCE

Constructor Summary

Constructors

Constructor	Description
RenameFieldResponseProcessor(String tag, String description, boolean ignoreFailure, String oldField, String newField, boolean ignoreMissing)	Constructor that takes a target field to rename and the new name

Method Summary

Modifier and Type	Method	Description
String	getNewField()	Getter function for newField
String	getOldField()	Getter function for oldField
String	getType()
boolean	isIgnoreMissing()	Getter function for ignoreMissing
SearchResponse	processResponse(SearchRequest request, SearchResponse response)

Methods inherited from class org.opensearch.search.pipeline.AbstractProcessor

getDescription, getTag, isIgnoreFailure

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.search.pipeline.Processor

getDescription, getTag, isIgnoreFailure

Field Details

TYPE

public static final String TYPE

Key to reference this processor type from a search pipeline.

See Also:

• Constant Field Values

Constructor Details

RenameFieldResponseProcessor

public RenameFieldResponseProcessor(String tag,
 String description,
 boolean ignoreFailure,
 String oldField,
 String newField,
 boolean ignoreMissing)

Constructor that takes a target field to rename and the new name

Parameters:

tag - processor tag

description - processor description

ignoreFailure - option to ignore failure

oldField - name of field to be renamed

newField - name of field that will replace the old field

ignoreMissing - if true, do not throw error if oldField does not exist within search response

Method Details

getType

public String getType()

Specified by:

getType in interface Processor

getOldField

public String getOldField()

Getter function for oldField

Returns:

oldField

getNewField

public String getNewField()

Getter function for newField

Returns:

newField

isIgnoreMissing

public boolean isIgnoreMissing()

Getter function for ignoreMissing

Returns:

ignoreMissing

processResponse

public SearchResponse processResponse(SearchRequest request,
 SearchResponse response)
                               throws Exception

Specified by:

processResponse in interface SearchResponseProcessor

Throws:

Exception