Package org.opensearch.client.opensearch.ingest

Class PutPipelineRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.ingest.PutPipelineRequest

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable

@JsonpDeserializable
public class PutPipelineRequest
extends RequestBase
implements PlainJsonSerializable

Creates or updates a pipeline.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<PutPipelineRequest>	_DESERIALIZER	Json deserializer for PutPipelineRequest
static Endpoint<PutPipelineRequest,PutPipelineResponse,ErrorResponse>	_ENDPOINT	Endpoint "ingest.put_pipeline".

Method Summary

Modifier and Type	Method	Description
Time	clusterManagerTimeout()	Period to wait for a connection to the cluster-manager node.
java.lang.String	description()	Description of the ingest pipeline.
java.lang.String	id()	Required - Pipeline ID
Time	masterTimeout()	Deprecated.
java.util.Map<java.lang.String,JsonData>	meta()	Optional metadata about the ingest pipeline.
static PutPipelineRequest	of(java.util.function.Function<PutPipelineRequest.Builder,ObjectBuilder<PutPipelineRequest>> fn)
java.util.List<Processor>	onFailure()	API name: on_failure
java.util.List<Processor>	processors()	API name: processors
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	setupPutPipelineRequestDeserializer(ObjectDeserializer<PutPipelineRequest.Builder> op)
Time	timeout()	Explicit operation timeout
java.lang.Long	version()	API name: version

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.json.PlainJsonSerializable

toJsonString

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<PutPipelineRequest> _DESERIALIZER

Json deserializer for PutPipelineRequest

_ENDPOINT

public static final Endpoint<PutPipelineRequest,PutPipelineResponse,ErrorResponse> _ENDPOINT

Endpoint "ingest.put_pipeline".

Method Detail

of

public static PutPipelineRequest of(java.util.function.Function<PutPipelineRequest.Builder,ObjectBuilder<PutPipelineRequest>> fn)

meta

public final java.util.Map<java.lang.String,JsonData> meta()

Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by OpenSearch.

API name: _meta

description

@Nullable
public final java.lang.String description()

Description of the ingest pipeline.

API name: description

id

public final java.lang.String id()

Required - Pipeline ID

API name: id

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

API name: cluster_manager_timeout

onFailure

public final java.util.List<Processor> onFailure()

API name: on_failure

processors

public final java.util.List<Processor> processors()

API name: processors

timeout

@Nullable
public final Time timeout()

Explicit operation timeout

API name: timeout

version

@Nullable
public final java.lang.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)

setupPutPipelineRequestDeserializer

protected static void setupPutPipelineRequestDeserializer(ObjectDeserializer<PutPipelineRequest.Builder> op)