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, ToCopyableBuilder<PutPipelineRequest.Builder,PutPipelineRequest>
@JsonpDeserializable @Generated("org.opensearch.client.codegen.CodeGenerator") public final class PutPipelineRequest extends RequestBase implements PlainJsonSerializable, ToCopyableBuilder<PutPipelineRequest.Builder,PutPipelineRequest>
Creates or updates an ingest pipeline.

  • Field Details

  • Method Details

    • of

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

    • clusterManagerTimeout

      @Nullable public final Time clusterManagerTimeout()
      The amount of time allowed to establish a connection to the cluster manager node.

      API name: cluster_manager_timeout

    • description

      @Nullable public final String description()
      The description for the ingest pipeline.

      API name: description

    • id

      @Nonnull public final String id()
      Required - The ID of the ingest pipeline.

      API name: id

    • masterTimeout

      @Deprecated @Nullable public final Time masterTimeout()
      Deprecated.
      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: master_timeout

    • meta

      @Nonnull public final Map<String,JsonData> meta()
      API name: _meta

    • onFailure

      @Nonnull public final List<Processor> onFailure()
      The new processor to run immediately after another processor fails. The processors specified in the on_failure parameter run sequentially in the order specified. If no pipeline are specified in on_failure array is specified, OpenSearch will not attempt to run the pipeline's remaining processors.

      API name: on_failure

    • processors

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

      API name: processors

    • timeout

      @Nullable public final Time timeout()
      The amount of time to wait for a response.

      API name: timeout

    • version

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

    • toBuilder

      @Nonnull public PutPipelineRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PutPipelineRequest.Builder,PutPipelineRequest>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static PutPipelineRequest.Builder builder()

    • setupPutPipelineRequestDeserializer

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

    • applyQueryParameters

      protected void applyQueryParameters(@Nonnull Map<String,String> params)
      Overrides:
      applyQueryParameters in class RequestBase

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object