Package org.opensearch.client.opensearch.ingest

Class FailProcessor.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ingest.ProcessorBase.AbstractBuilder<FailProcessor.Builder>

org.opensearch.client.opensearch.ingest.FailProcessor.Builder

All Implemented Interfaces:

CopyableBuilder<FailProcessor.Builder,FailProcessor>, MutableBuilder<FailProcessor.Builder,FailProcessor>, ObjectBuilder<FailProcessor>

Enclosing class:

FailProcessor

public static class FailProcessor.Builder
extends ProcessorBase.AbstractBuilder<FailProcessor.Builder>
implements CopyableBuilder<FailProcessor.Builder,FailProcessor>

Builder for FailProcessor.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
FailProcessor	build()	Builds a FailProcessor.
FailProcessor.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final FailProcessor.Builder	message(String value)	Required - The error message thrown by the processor.
protected FailProcessor.Builder	self()

Methods inherited from class org.opensearch.client.opensearch.ingest.ProcessorBase.AbstractBuilder

description, if_, ignoreFailure, onFailure, onFailure, onFailure, tag

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public FailProcessor.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<FailProcessor.Builder,FailProcessor>

Returns:

a new builder instance.

self

@Nonnull
protected FailProcessor.Builder self()

Specified by:

self in class ProcessorBase.AbstractBuilder<FailProcessor.Builder>

message

@Nonnull
public final FailProcessor.Builder message(String value)

Required - The error message thrown by the processor. Supports template snippets.

API name: message

build

@Nonnull
public FailProcessor build()

Builds a FailProcessor.

Specified by:

build in interface ObjectBuilder<FailProcessor>

Throws:

NullPointerException - if some of the required fields are null.