Package org.opensearch.client.opensearch.ingest

Class ProcessorBase.AbstractBuilder<BuilderT extends ProcessorBase.AbstractBuilder<BuilderT>>

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ingest.ProcessorBase.AbstractBuilder<BuilderT>

Direct Known Subclasses:

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

Enclosing class:

ProcessorBase

public abstract static class ProcessorBase.AbstractBuilder<BuilderT extends ProcessorBase.AbstractBuilder<BuilderT>>
extends ObjectBuilderBase

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBuilder()
protected	AbstractBuilder(ProcessorBase o)
protected	AbstractBuilder(ProcessorBase.AbstractBuilder<BuilderT> o)

Method Summary

Modifier and Type	Method	Description
final BuilderT	description(String value)	Description of the processor.
final BuilderT	if_(String value)	Conditionally execute the processor.
final BuilderT	ignoreFailure(Boolean value)	Ignore failures for the processor.
final BuilderT	onFailure(Function<Processor.Builder,ObjectBuilder<Processor>> fn)	Handle failures for the processor.
final BuilderT	onFailure(List<Processor> list)	Handle failures for the processor.
final BuilderT	onFailure(Processor value, Processor... values)	Handle failures for the processor.
protected abstract BuilderT	self()
final BuilderT	tag(String value)	Identifier for the processor.

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractBuilder

protected AbstractBuilder()

AbstractBuilder

protected AbstractBuilder(ProcessorBase o)

AbstractBuilder

protected AbstractBuilder(ProcessorBase.AbstractBuilder<BuilderT> o)

Method Details

self

@Nonnull
protected abstract BuilderT self()

description

@Nonnull
public final BuilderT description(@Nullable
 String value)

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

API name: description

if_

@Nonnull
public final BuilderT if_(@Nullable
 String value)

Conditionally execute the processor.

API name: if

ignoreFailure

@Nonnull
public final BuilderT ignoreFailure(@Nullable
 Boolean value)

Ignore failures for the processor.

API name: ignore_failure

onFailure

@Nonnull
public final BuilderT onFailure(List<Processor> list)

Handle failures for the processor.

API name: on_failure

Adds all elements of list to onFailure.

onFailure

@Nonnull
public final BuilderT onFailure(Processor value,
 Processor... values)

Handle failures for the processor.

API name: on_failure

Adds one or more values to onFailure.

onFailure

@Nonnull
public final BuilderT onFailure(Function<Processor.Builder,ObjectBuilder<Processor>> fn)

Handle failures for the processor.

API name: on_failure

Adds a value to onFailure using a builder lambda.

tag

@Nonnull
public final BuilderT tag(@Nullable
 String value)

Identifier for the processor. Useful for debugging and metrics.

API name: tag