Package org.opensearch.client.opensearch.ingest

Class Pipeline

java.lang.Object

org.opensearch.client.opensearch.ingest.Pipeline

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<Pipeline.Builder,Pipeline>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class Pipeline
extends Object
implements PlainJsonSerializable, ToCopyableBuilder<Pipeline.Builder,Pipeline>

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
static Pipeline.Builder	builder()
final String	description()	Description of the ingest pipeline.
boolean	equals(Object o)
int	hashCode()
final Map<String,JsonData>	meta()	API name: _meta
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)
Pipeline.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final Long	version()	API name: version

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

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

meta

@Nonnull
public final Map<String,JsonData> meta()

API name: _meta

onFailure

@Nonnull
public final List<Processor> onFailure()

Processors to run immediately after a processor failure.

API name: on_failure

processors

@Nonnull
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()

API name: version

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)

toBuilder

@Nonnull
public Pipeline.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<Pipeline.Builder,Pipeline>

Returns:

a new builder instance.

builder

@Nonnull
public static Pipeline.Builder builder()

setupPipelineDeserializer

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object