Package org.opensearch.client.opensearch.ingest

Class ProcessorBase

java.lang.Object

org.opensearch.client.opensearch.ingest.ProcessorBase

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable

Direct Known Subclasses:

AppendProcessor, AttachmentProcessor, BytesProcessor, CircleProcessor, ConvertProcessor, CsvProcessor, DateIndexNameProcessor, DateProcessor, DissectProcessor, DotExpanderProcessor, DropProcessor, FailProcessor, ForeachProcessor, GeoIpProcessor, GrokProcessor, GsubProcessor, JoinProcessor, JsonProcessor, KeyValueProcessor, LowercaseProcessor, PipelineProcessor, RemoveProcessor, RenameProcessor, SetProcessor, SetSecurityUserProcessor, SortProcessor, SplitProcessor, TextEmbeddingProcessor, TrimProcessor, UppercaseProcessor, UrlDecodeProcessor, UserAgentProcessor

@Generated("org.opensearch.client.codegen.CodeGenerator")
public abstract class ProcessorBase
extends Object
implements PlainJsonSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProcessorBase.AbstractBuilder<BuilderT extends ProcessorBase.AbstractBuilder<BuilderT>>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ProcessorBase(ProcessorBase.AbstractBuilder<?> builder)

Method Summary

Modifier and Type	Method	Description
final String	description()	Description of the processor.
boolean	equals(Object o)
int	hashCode()
final String	if_()	Conditionally execute the processor.
final Boolean	ignoreFailure()	Ignore failures for the processor.
final List<Processor>	onFailure()	Handle failures for the processor.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static <BuilderT extends ProcessorBase.AbstractBuilder<BuilderT>> void	setupProcessorBaseDeserializer(ObjectDeserializer<BuilderT> op)
final String	tag()	Identifier for the processor.

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

Constructor Details

ProcessorBase

protected ProcessorBase(ProcessorBase.AbstractBuilder<?> builder)

Method Details

description

@Nullable
public final String description()

Description of the processor. Useful for describing the purpose of the processor or its configuration.

API name: description

if_

@Nullable
public final String if_()

Conditionally execute the processor.

API name: if

ignoreFailure

@Nullable
public final Boolean ignoreFailure()

Ignore failures for the processor.

API name: ignore_failure

onFailure

@Nonnull
public final List<Processor> onFailure()

Handle failures for the processor.

API name: on_failure

tag

@Nullable
public final String tag()

Identifier for the processor. Useful for debugging and metrics.

API name: tag

serialize

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

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

setupProcessorBaseDeserializer

protected static <BuilderT extends ProcessorBase.AbstractBuilder<BuilderT>>
void setupProcessorBaseDeserializer(ObjectDeserializer<BuilderT> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object