Package org.opensearch.client.opensearch.ingest

Class Pipeline.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ingest.Pipeline.Builder

All Implemented Interfaces:

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

Enclosing class:

Pipeline

public static class Pipeline.Builder
extends ObjectBuilderBase
implements CopyableBuilder<Pipeline.Builder,Pipeline>

Builder for Pipeline.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Pipeline	build()	Builds a Pipeline.
Pipeline.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final Pipeline.Builder	description(String value)	Description of the ingest pipeline.
final Pipeline.Builder	meta(String key, JsonData value)	API name: _meta
final Pipeline.Builder	meta(Map<String,JsonData> map)	API name: _meta
final Pipeline.Builder	onFailure(Function<Processor.Builder,ObjectBuilder<Processor>> fn)	Processors to run immediately after a processor failure.
final Pipeline.Builder	onFailure(List<Processor> list)	Processors to run immediately after a processor failure.
final Pipeline.Builder	onFailure(Processor value, Processor... values)	Processors to run immediately after a processor failure.
final Pipeline.Builder	processors(Function<Processor.Builder,ObjectBuilder<Processor>> fn)	Processors used to perform transformations on documents before indexing.
final Pipeline.Builder	processors(List<Processor> list)	Processors used to perform transformations on documents before indexing.
final Pipeline.Builder	processors(Processor value, Processor... values)	Processors used to perform transformations on documents before indexing.
final Pipeline.Builder	version(Long value)	API name: version

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

Returns:

a new builder instance.

description

@Nonnull
public final Pipeline.Builder description(@Nullable
 String value)

Description of the ingest pipeline.

API name: description

meta

@Nonnull
public final Pipeline.Builder meta(Map<String,JsonData> map)

API name: _meta

Adds all elements of map to meta.

meta

@Nonnull
public final Pipeline.Builder meta(String key,
 JsonData value)

API name: _meta

Adds an entry to meta.

onFailure

@Nonnull
public final Pipeline.Builder onFailure(List<Processor> list)

Processors to run immediately after a processor failure.

API name: on_failure

Adds all elements of list to onFailure.

onFailure

@Nonnull
public final Pipeline.Builder onFailure(Processor value,
 Processor... values)

Processors to run immediately after a processor failure.

API name: on_failure

Adds one or more values to onFailure.

onFailure

@Nonnull
public final Pipeline.Builder onFailure(Function<Processor.Builder,ObjectBuilder<Processor>> fn)

Processors to run immediately after a processor failure.

API name: on_failure

Adds a value to onFailure using a builder lambda.

processors

@Nonnull
public final Pipeline.Builder processors(List<Processor> list)

Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified.

API name: processors

Adds all elements of list to processors.

processors

@Nonnull
public final Pipeline.Builder processors(Processor value,
 Processor... values)

Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified.

API name: processors

Adds one or more values to processors.

processors

@Nonnull
public final Pipeline.Builder processors(Function<Processor.Builder,ObjectBuilder<Processor>> fn)

Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified.

API name: processors

Adds a value to processors using a builder lambda.

version

@Nonnull
public final Pipeline.Builder version(@Nullable
 Long value)

API name: version

build

@Nonnull
public Pipeline build()

Builds a Pipeline.

Specified by:

build in interface ObjectBuilder<Pipeline>

Throws:

NullPointerException - if some of the required fields are null.