Package org.opensearch.client.opensearch.ingest

Class DotExpanderProcessor.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.ingest.DotExpanderProcessor.Builder

All Implemented Interfaces:

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

Enclosing class:

DotExpanderProcessor

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

Builder for DotExpanderProcessor.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DotExpanderProcessor	build()	Builds a DotExpanderProcessor.
DotExpanderProcessor.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final DotExpanderProcessor.Builder	field(String value)	Required - API name: field
final DotExpanderProcessor.Builder	path(String value)	The field that contains the field to expand.
protected DotExpanderProcessor.Builder	self()

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

Returns:

a new builder instance.

self

@Nonnull
protected DotExpanderProcessor.Builder self()

Specified by:

self in class ProcessorBase.AbstractBuilder<DotExpanderProcessor.Builder>

field

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

Required - API name: field

path

@Nonnull
public final DotExpanderProcessor.Builder path(@Nullable
 String value)

The field that contains the field to expand. Only required if the field to expand is part another object field, because the field option can only understand leaf fields.

API name: path

build

@Nonnull
public DotExpanderProcessor build()

Builds a DotExpanderProcessor.

Specified by:

build in interface ObjectBuilder<DotExpanderProcessor>

Throws:

NullPointerException - if some of the required fields are null.