Package co.elastic.clients.elasticsearch.ingest

Class Pipeline

java.lang.Object

co.elastic.clients.elasticsearch.ingest.Pipeline

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class Pipeline
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final Boolean	deprecated()	Marks this ingest pipeline as deprecated.
final String	description()	Description of the ingest pipeline.
final Map<String,JsonData>	meta()	Arbitrary metadata about the ingest pipeline.
static Pipeline	of(Function<Pipeline.Builder,ObjectBuilder<Pipeline>> fn)
final List<Processor>	onFailure()	Processors to run immediately after a processor failure.
final List<Processor>	processors()	Processors used to perform transformations on documents before indexing.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupPipelineDeserializer(ObjectDeserializer<Pipeline.Builder> op)
String	toString()
final Long	version()	Version number used by external systems to track ingest pipelines.

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<Pipeline> _DESERIALIZER

Json deserializer for Pipeline

Method Details

of

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

description

@Nullable
public final String description()

Description of the ingest pipeline.

API name: description

onFailure

public final List<Processor> onFailure()

Processors to run immediately after a processor failure.

API name: on_failure

processors

public final List<Processor> processors()

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

API name: processors

version

@Nullable
public final Long version()

Version number used by external systems to track ingest pipelines.

API name: version

deprecated

@Nullable
public final Boolean deprecated()

Marks this ingest pipeline as deprecated. When a deprecated ingest pipeline is referenced as the default or final pipeline when creating or updating a non-deprecated index template, Elasticsearch will emit a deprecation warning.

API name: deprecated

meta

public final Map<String,JsonData> meta()

Arbitrary metadata about the ingest pipeline. This map is not automatically generated by Elasticsearch.

API name: _meta

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

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

toString

public String toString()

Overrides:

toString in class Object

setupPipelineDeserializer

protected static void setupPipelineDeserializer(ObjectDeserializer<Pipeline.Builder> op)