Package org.opensearch.client.opensearch.ingest

Class BytesProcessor.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.ingest.BytesProcessor.Builder

All Implemented Interfaces:

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

Enclosing class:

BytesProcessor

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

Builder for BytesProcessor.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BytesProcessor	build()	Builds a BytesProcessor.
BytesProcessor.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final BytesProcessor.Builder	field(String value)	Required - API name: field
final BytesProcessor.Builder	ignoreMissing(Boolean value)	If true and field does not exist or is null, the processor quietly exits without modifying the document.
protected BytesProcessor.Builder	self()
final BytesProcessor.Builder	targetField(String value)	API name: target_field

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

Returns:

a new builder instance.

self

@Nonnull
protected BytesProcessor.Builder self()

Specified by:

self in class ProcessorBase.AbstractBuilder<BytesProcessor.Builder>

field

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

Required - API name: field

ignoreMissing

@Nonnull
public final BytesProcessor.Builder ignoreMissing(@Nullable
 Boolean value)

If true and field does not exist or is null, the processor quietly exits without modifying the document.

API name: ignore_missing

targetField

@Nonnull
public final BytesProcessor.Builder targetField(@Nullable
 String value)

API name: target_field

build

@Nonnull
public BytesProcessor build()

Builds a BytesProcessor.

Specified by:

build in interface ObjectBuilder<BytesProcessor>

Throws:

NullPointerException - if some of the required fields are null.