Package org.opensearch.client.opensearch.ingest

Class SetProcessor

java.lang.Object

org.opensearch.client.opensearch.ingest.ProcessorBase

org.opensearch.client.opensearch.ingest.SetProcessor

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ProcessorVariant, ToCopyableBuilder<SetProcessor.Builder,SetProcessor>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class SetProcessor
extends ProcessorBase
implements ProcessorVariant, ToCopyableBuilder<SetProcessor.Builder,SetProcessor>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SetProcessor.Builder	Builder for SetProcessor.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch.ingest.ProcessorBase

ProcessorBase.AbstractBuilder<BuilderT extends ProcessorBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<SetProcessor>	_DESERIALIZER	Json deserializer for SetProcessor

Method Summary

Modifier and Type	Method	Description
Processor.Kind	_processorKind()	Processor variant kind.
static SetProcessor.Builder	builder()
final String	copyFrom()	API name: copy_from
boolean	equals(Object o)
final String	field()	Required - API name: field
int	hashCode()
final Boolean	ignoreEmptyValue()	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 String	mediaType()	The media type for encoding value.
static SetProcessor	of(Function<SetProcessor.Builder,ObjectBuilder<SetProcessor>> fn)
final Boolean	override()	If true processor will update fields with pre-existing non-null-valued field.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupSetProcessorDeserializer(ObjectDeserializer<SetProcessor.Builder> op)
SetProcessor.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final JsonData	value()	The value to be set for the field.

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

description, if_, ignoreFailure, onFailure, serialize, setupProcessorBaseDeserializer, tag

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.opensearch.ingest.ProcessorVariant

toProcessor

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

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<SetProcessor> _DESERIALIZER

Json deserializer for SetProcessor

Method Details

of

public static SetProcessor of(Function<SetProcessor.Builder,ObjectBuilder<SetProcessor>> fn)

_processorKind

public Processor.Kind _processorKind()

Processor variant kind.

Specified by:

_processorKind in interface ProcessorVariant

copyFrom

@Nullable
public final String copyFrom()

API name: copy_from

field

@Nonnull
public final String field()

Required - API name: field

ignoreEmptyValue

@Nullable
public final Boolean ignoreEmptyValue()

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

@Nullable
public final String mediaType()

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

@Nullable
public final Boolean override()

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

@Nullable
public final 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

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Overrides:

serializeInternal in class ProcessorBase

toBuilder

@Nonnull
public SetProcessor.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<SetProcessor.Builder,SetProcessor>

Returns:

a new builder instance.

builder

@Nonnull
public static SetProcessor.Builder builder()

setupSetProcessorDeserializer

protected static void setupSetProcessorDeserializer(ObjectDeserializer<SetProcessor.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class ProcessorBase

equals

public boolean equals(Object o)

Overrides:

equals in class ProcessorBase