Class PutPipelineRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ingest.PutPipelineRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class PutPipelineRequest extends RequestBase implements JsonpSerializable
Creates or updates a pipeline.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PutPipelineRequest.Builder
Builder forPutPipelineRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<PutPipelineRequest>
_DESERIALIZER
Json deserializer forPutPipelineRequest
static Endpoint<PutPipelineRequest,PutPipelineResponse,ErrorResponse>
_ENDPOINT
Endpoint "ingest.put_pipeline
". -
Method Summary
Modifier and Type Method Description java.lang.String
description()
Description of the ingest pipeline.java.lang.String
id()
Required - ID of the ingest pipeline to create or update.Time
masterTimeout()
Period to wait for a connection to the master node.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()
Processors to run immediately after a processor failure.java.util.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
setupPutPipelineRequestDeserializer(ObjectDeserializer<PutPipelineRequest.Builder> op)
Time
timeout()
Period to wait for a response.java.lang.Long
version()
Version number used by external systems to track ingest pipelines.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forPutPipelineRequest
-
_ENDPOINT
Endpoint "ingest.put_pipeline
".
-
-
Method Details
-
of
public static PutPipelineRequest of(java.util.function.Function<PutPipelineRequest.Builder,ObjectBuilder<PutPipelineRequest>> fn) -
meta
Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch.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 - ID of the ingest pipeline to create or update.API name:
id
-
masterTimeout
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
-
onFailure
Processors to run immediately after a processor failure. Each processor supports a processor-levelon_failure
value. If a processor without anon_failure
value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors.API name:
on_failure
-
processors
Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified.API name:
processors
-
timeout
Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.API name:
timeout
-
version
@Nullable public final java.lang.Long version()Version number used by external systems to track ingest pipelines. This parameter is intended for external systems only. Elasticsearch does not use or validate pipeline version numbers.API name:
version
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupPutPipelineRequestDeserializer
protected static void setupPutPipelineRequestDeserializer(ObjectDeserializer<PutPipelineRequest.Builder> op)
-