Package co.elastic.clients.elasticsearch.ingest

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 Details

    • Builder

      public Builder()

  • Method Details

    • meta

      public final PutPipelineRequest.Builder meta(Map<String,JsonData> map)
      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 to meta.

    • meta

      public final PutPipelineRequest.Builder meta(String key, JsonData value)
      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.

    • deprecated

      public final PutPipelineRequest.Builder deprecated(@Nullable Boolean value)
      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

    • description

      public final PutPipelineRequest.Builder description(@Nullable String value)
      Description of the ingest pipeline.

      API name: description

    • id

      public final PutPipelineRequest.Builder id(String value)
      Required - ID of the ingest pipeline to create or update.

      API name: id

    • ifVersion

      public final PutPipelineRequest.Builder ifVersion(@Nullable Long value)
      Required version for optimistic concurrency control for pipeline updates

      API name: if_version

    • masterTimeout

      public final PutPipelineRequest.Builder masterTimeout(@Nullable Time value)
      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

      public final PutPipelineRequest.Builder onFailure(List<Processor> list)
      Processors to run immediately after a processor failure. Each processor supports a processor-level on_failure value. If a processor without an on_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 to onFailure.

    • onFailure

      public final PutPipelineRequest.Builder onFailure(Processor value, Processor... values)
      Processors to run immediately after a processor failure. Each processor supports a processor-level on_failure value. If a processor without an on_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(ProcessorVariant value, ProcessorVariant... values)
      Processors to run immediately after a processor failure. Each processor supports a processor-level on_failure value. If a processor without an on_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-level on_failure value. If a processor without an on_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

      public final PutPipelineRequest.Builder processors(List<Processor> list)
      Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified.

      API name: processors

      Adds all elements of list to processors.

    • processors

      public final PutPipelineRequest.Builder processors(Processor value, Processor... values)
      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(ProcessorVariant value, ProcessorVariant... values)
      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

      public final PutPipelineRequest.Builder timeout(@Nullable Time value)
      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

      public final PutPipelineRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      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

      public final PutPipelineRequest.Builder version(@Nullable Long value)
      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

      protected PutPipelineRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<PutPipelineRequest.Builder>

    • build

      public PutPipelineRequest build()
      Builds a PutPipelineRequest.
      Specified by:
      build in interface ObjectBuilder<PutPipelineRequest>
      Throws:
      NullPointerException - if some of the required fields are null.