Package org.opensearch.client.opensearch.ingest

Class AppendProcessor.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.ingest.AppendProcessor.Builder

All Implemented Interfaces:

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

Enclosing class:

AppendProcessor

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

Builder for AppendProcessor.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final AppendProcessor.Builder	allowDuplicates(Boolean value)	If false, the processor does not append values already present in the field.
AppendProcessor	build()	Builds a AppendProcessor.
AppendProcessor.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final AppendProcessor.Builder	field(String value)	Required - API name: field
protected AppendProcessor.Builder	self()
final AppendProcessor.Builder	value(List<JsonData> list)	Required - The value to be appended.
final AppendProcessor.Builder	value(JsonData value, JsonData... values)	Required - The value to be appended.

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 AppendProcessor.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<AppendProcessor.Builder,AppendProcessor>

Returns:

a new builder instance.

self

@Nonnull
protected AppendProcessor.Builder self()

Specified by:

self in class ProcessorBase.AbstractBuilder<AppendProcessor.Builder>

allowDuplicates

@Nonnull
public final AppendProcessor.Builder allowDuplicates(@Nullable
 Boolean value)

If false, the processor does not append values already present in the field.

API name: allow_duplicates

field

@Nonnull
public final AppendProcessor.Builder field(String value)

Required - API name: field

value

@Nonnull
public final AppendProcessor.Builder value(List<JsonData> list)

Required - The value to be appended. Supports template snippets.

API name: value

Adds all elements of list to value.

value

@Nonnull
public final AppendProcessor.Builder value(JsonData value,
 JsonData... values)

Required - The value to be appended. Supports template snippets.

API name: value

Adds one or more values to value.

build

@Nonnull
public AppendProcessor build()

Builds a AppendProcessor.

Specified by:

build in interface ObjectBuilder<AppendProcessor>

Throws:

NullPointerException - if some of the required fields are null.