Package co.elastic.clients.elasticsearch.ingest

Class Pipeline.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<Pipeline.Builder>

co.elastic.clients.elasticsearch.ingest.Pipeline.Builder

All Implemented Interfaces:

WithJson<Pipeline.Builder>, ObjectBuilder<Pipeline>

Enclosing class:

Pipeline

public static class Pipeline.Builder
extends WithJsonObjectBuilderBase<Pipeline.Builder>
implements ObjectBuilder<Pipeline>

Builder for Pipeline.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Pipeline	build()	Builds a Pipeline.
final Pipeline.Builder	description(String value)	Description of the ingest pipeline.
final Pipeline.Builder	onFailure(Processor value, Processor... values)	Processors to run immediately after a processor failure.
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	processors(Processor value, Processor... values)	Processors used to perform transformations on documents before indexing.
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.
protected Pipeline.Builder	self()
final Pipeline.Builder	version(Long value)	Version number used by external systems to track ingest pipelines.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

description

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

Description of the ingest pipeline.

API name: description

onFailure

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

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

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

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

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

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

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

Version number used by external systems to track ingest pipelines.

API name: version

self

protected Pipeline.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<Pipeline.Builder>

build

public Pipeline build()

Builds a Pipeline.

Specified by:

build in interface ObjectBuilder<Pipeline>

Throws:

NullPointerException - if some of the required fields are null.