Package org.opensearch.client.opensearch.ingest

Class SetProcessor.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.ingest.SetProcessor.Builder

All Implemented Interfaces:

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

Enclosing class:

SetProcessor

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

Builder for SetProcessor.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SetProcessor	build()	Builds a SetProcessor.
SetProcessor.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final SetProcessor.Builder	copyFrom(String value)	API name: copy_from
final SetProcessor.Builder	field(String value)	Required - API name: field
final SetProcessor.Builder	ignoreEmptyValue(Boolean value)	If true and value is a template snippet that evaluates to null or the empty string, the processor quietly exits without modifying the document.
final SetProcessor.Builder	mediaType(String value)	The media type for encoding value.
final SetProcessor.Builder	override(Boolean value)	If true processor will update fields with pre-existing non-null-valued field.
protected SetProcessor.Builder	self()
final SetProcessor.Builder	value(JsonData value)	The value to be set for the 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 SetProcessor.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<SetProcessor.Builder,SetProcessor>

Returns:

a new builder instance.

self

@Nonnull
protected SetProcessor.Builder self()

Specified by:

self in class ProcessorBase.AbstractBuilder<SetProcessor.Builder>

copyFrom

@Nonnull
public final SetProcessor.Builder copyFrom(@Nullable
 String value)

API name: copy_from

field

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

Required - API name: field

ignoreEmptyValue

@Nonnull
public final SetProcessor.Builder ignoreEmptyValue(@Nullable
 Boolean value)

If true and value is a template snippet that evaluates to null or the empty string, the processor quietly exits without modifying the document.

API name: ignore_empty_value

mediaType

@Nonnull
public final SetProcessor.Builder mediaType(@Nullable
 String value)

The media type for encoding value. Applies only when value is a template snippet. Must be one of application/json, text/plain, or application/x-www-form-urlencoded.

API name: media_type

override

@Nonnull
public final SetProcessor.Builder override(@Nullable
 Boolean value)

If true processor will update fields with pre-existing non-null-valued field. When set to false, such fields will not be touched.

API name: override

value

@Nonnull
public final SetProcessor.Builder value(@Nullable
 JsonData value)

The value to be set for the field. Supports template snippets. May specify only one of value or copy_from.

API name: value

build

@Nonnull
public SetProcessor build()

Builds a SetProcessor.

Specified by:

build in interface ObjectBuilder<SetProcessor>

Throws:

NullPointerException - if some of the required fields are null.