Package co.elastic.clients.elasticsearch.ingest

Class Pipeline.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<Pipeline.Builder>
co.elastic.clients.elasticsearch.ingest.Pipeline.Builder
All Implemented Interfaces:
WithJson<Pipeline.Builder>, ObjectBuilder<Pipeline>
Enclosing class:
Pipeline
public static class Pipeline.Builder extends WithJsonObjectBuilderBase<Pipeline.Builder> implements ObjectBuilder<Pipeline>
Builder for Pipeline.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • description

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

      API name: description

    • onFailure

      public final Pipeline.Builder onFailure(List<Processor> list)
      Processors to run immediately after a processor failure.

      API name: on_failure

      Adds all elements of list to onFailure.

    • onFailure

      public final Pipeline.Builder onFailure(Processor value, Processor... values)
      Processors to run immediately after a processor failure.

      API name: on_failure

      Adds one or more values to onFailure.

    • onFailure

      public final Pipeline.Builder onFailure(ProcessorVariant value, ProcessorVariant... values)
      Processors to run immediately after a processor failure.

      API name: on_failure

      Adds one or more values to onFailure.

    • onFailure

      public final Pipeline.Builder onFailure(Function<Processor.Builder,ObjectBuilder<Processor>> fn)
      Processors to run immediately after a processor failure.

      API name: on_failure

      Adds a value to onFailure using a builder lambda.

    • processors

      public final Pipeline.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 Pipeline.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 Pipeline.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 Pipeline.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.

    • version

      public final Pipeline.Builder version(@Nullable Long value)
      Version number used by external systems to track ingest pipelines.

      API name: version

    • deprecated

      public final Pipeline.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

    • meta

      public final Pipeline.Builder meta(Map<String,JsonData> map)
      Arbitrary metadata about the ingest pipeline. This map is not automatically generated by Elasticsearch.

      API name: _meta

      Adds all entries of map to meta.

    • meta

      public final Pipeline.Builder meta(String key, JsonData value)
      Arbitrary metadata about the ingest pipeline. This map is not automatically generated by Elasticsearch.

      API name: _meta

      Adds an entry to meta.

    • createdDate

      public final Pipeline.Builder createdDate(@Nullable DateTime value)
      Date and time when the pipeline was created. Only returned if the human query parameter is true.

      API name: created_date

    • createdDateMillis

      public final Pipeline.Builder createdDateMillis(@Nullable Long value)
      Date and time when the pipeline was created, in milliseconds since the epoch.

      API name: created_date_millis

    • modifiedDate

      public final Pipeline.Builder modifiedDate(@Nullable DateTime value)
      Date and time when the pipeline was last modified. Only returned if the human query parameter is true.

      API name: modified_date

    • modifiedDateMillis

      public final Pipeline.Builder modifiedDateMillis(@Nullable Long value)
      Date and time when the pipeline was last modified, in milliseconds since the epoch.

      API name: modified_date_millis

    • fieldAccessPattern

      public final Pipeline.Builder fieldAccessPattern(@Nullable FieldAccessPattern value)
      Controls how processors in this pipeline should read and write data on a document's source.

      API name: field_access_pattern

    • self

      protected Pipeline.Builder self()
      Specified by:
      self in class WithJsonObjectBuilderBase<Pipeline.Builder>

    • build

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