Class PutPipelineRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<PutPipelineRequest.Builder>
co.elastic.clients.elasticsearch.ingest.PutPipelineRequest.Builder
- All Implemented Interfaces:
WithJson<PutPipelineRequest.Builder>
,ObjectBuilder<PutPipelineRequest>
- Enclosing class:
- PutPipelineRequest
public static class PutPipelineRequest.Builder
extends RequestBase.AbstractBuilder<PutPipelineRequest.Builder>
implements ObjectBuilder<PutPipelineRequest>
Builder for
PutPipelineRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aPutPipelineRequest
.description
(String value) Description of the ingest pipeline.Required - ID of the ingest pipeline to create or update.Required version for optimistic concurrency control for pipeline updatesmasterTimeout
(Time value) Period to wait for a connection to the master node.Period to wait for a connection to the master node.Optional metadata about the ingest pipeline.Optional metadata about the ingest pipeline.Processors to run immediately after a processor failure.Processors to run immediately after a processor failure.Processors to run immediately after a processor failure.processors
(Processor value, Processor... values) Processors used to perform transformations on documents before indexing.Processors used to perform transformations on documents before indexing.processors
(List<Processor> list) Processors used to perform transformations on documents before indexing.protected PutPipelineRequest.Builder
self()
Period to wait for a response.Period to wait for a response.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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
meta
Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch.API name:
_meta
Adds all entries of
map
tometa
. -
meta
Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch.API name:
_meta
Adds an entry to
meta
. -
description
Description of the ingest pipeline.API name:
description
-
id
Required - ID of the ingest pipeline to create or update.API name:
id
-
ifVersion
Required version for optimistic concurrency control for pipeline updatesAPI name:
if_version
-
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
-
masterTimeout
public final PutPipelineRequest.Builder masterTimeout(Function<Time.Builder, ObjectBuilder<Time>> fn) 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
Adds all elements of
list
toonFailure
. -
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
Adds one or more values to
onFailure
. -
onFailure
public final PutPipelineRequest.Builder onFailure(Function<Processor.Builder, ObjectBuilder<Processor>> fn) 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
Adds a value to
onFailure
using a builder lambda. -
processors
Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified.API name:
processors
Adds all elements of
list
toprocessors
. -
processors
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 PutPipelineRequest.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. -
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
-
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
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
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<PutPipelineRequest.Builder>
-
build
Builds aPutPipelineRequest
.- Specified by:
build
in interfaceObjectBuilder<PutPipelineRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-