Package org.opensearch.client.opensearch.ingest

Class JsonProcessor.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.ingest.JsonProcessor.Builder

All Implemented Interfaces:

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

Enclosing class:

JsonProcessor

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

Builder for JsonProcessor.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final JsonProcessor.Builder	addToRoot(Boolean value)	Flag that forces the parsed JSON to be added at the top level of the document.
final JsonProcessor.Builder	addToRootConflictStrategy(JsonProcessorConflictStrategy value)	API name: add_to_root_conflict_strategy
final JsonProcessor.Builder	allowDuplicateKeys(Boolean value)	When set to true, the JSON parser will not fail if the JSON contains duplicate keys.
JsonProcessor	build()	Builds a JsonProcessor.
JsonProcessor.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final JsonProcessor.Builder	field(String value)	Required - API name: field
protected JsonProcessor.Builder	self()
final JsonProcessor.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 JsonProcessor.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<JsonProcessor.Builder,JsonProcessor>

Returns:

a new builder instance.

self

@Nonnull
protected JsonProcessor.Builder self()

Specified by:

self in class ProcessorBase.AbstractBuilder<JsonProcessor.Builder>

addToRoot

@Nonnull
public final JsonProcessor.Builder addToRoot(@Nullable
 Boolean value)

Flag that forces the parsed JSON to be added at the top level of the document. target_field must not be set when this option is chosen.

API name: add_to_root

addToRootConflictStrategy

@Nonnull
public final JsonProcessor.Builder addToRootConflictStrategy(@Nullable
 JsonProcessorConflictStrategy value)

API name: add_to_root_conflict_strategy

allowDuplicateKeys

@Nonnull
public final JsonProcessor.Builder allowDuplicateKeys(@Nullable
 Boolean value)

When set to true, the JSON parser will not fail if the JSON contains duplicate keys. Instead, the last encountered value for any duplicate key wins.

API name: allow_duplicate_keys

field

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

Required - API name: field

targetField

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

API name: target_field

build

@Nonnull
public JsonProcessor build()

Builds a JsonProcessor.

Specified by:

build in interface ObjectBuilder<JsonProcessor>

Throws:

NullPointerException - if some of the required fields are null.