Package org.opensearch.client.opensearch.ingest

Class GsubProcessor.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.ingest.GsubProcessor.Builder

All Implemented Interfaces:

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

Enclosing class:

GsubProcessor

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

Builder for GsubProcessor.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GsubProcessor	build()	Builds a GsubProcessor.
GsubProcessor.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final GsubProcessor.Builder	field(String value)	Required - API name: field
final GsubProcessor.Builder	ignoreMissing(Boolean value)	If true and field does not exist or is null, the processor quietly exits without modifying the document.
final GsubProcessor.Builder	pattern(String value)	Required - The pattern to be replaced.
final GsubProcessor.Builder	replacement(String value)	Required - The string to replace the matching patterns with.
protected GsubProcessor.Builder	self()
final GsubProcessor.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 GsubProcessor.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<GsubProcessor.Builder,GsubProcessor>

Returns:

a new builder instance.

self

@Nonnull
protected GsubProcessor.Builder self()

Specified by:

self in class ProcessorBase.AbstractBuilder<GsubProcessor.Builder>

field

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

Required - API name: field

ignoreMissing

@Nonnull
public final GsubProcessor.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

pattern

@Nonnull
public final GsubProcessor.Builder pattern(String value)

Required - The pattern to be replaced.

API name: pattern

replacement

@Nonnull
public final GsubProcessor.Builder replacement(String value)

Required - The string to replace the matching patterns with.

API name: replacement

targetField

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

API name: target_field

build

@Nonnull
public GsubProcessor build()

Builds a GsubProcessor.

Specified by:

build in interface ObjectBuilder<GsubProcessor>

Throws:

NullPointerException - if some of the required fields are null.