Package co.elastic.clients.elasticsearch.transform

Class PutTransformRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.transform.PutTransformRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class PutTransformRequest
extends RequestBase
implements JsonpSerializable
Instantiates a transform.
See Also:
API specification

  • Field Details

  • Method Details

    • of

      public static PutTransformRequest of​(java.util.function.Function<PutTransformRequest.Builder,​ObjectBuilder<PutTransformRequest>> fn)

    • deferValidation

      @Nullable public final java.lang.Boolean deferValidation()
      When true, deferrable validations are not run. This behavior may be desired if the source index does not exist until after the transform is created.

      API name: defer_validation

    • description

      @Nullable public final java.lang.String description()
      Free text description of the transform.

      API name: description

    • dest

      public final Destination dest()
      Required - The destination for the transform.

      API name: dest

    • frequency

      @Nullable public final Time frequency()
      The interval between checks for changes in the source indices when the transform is running continuously. Also determines the retry interval in the event of transient failures while the transform is searching or indexing. The minimum value is 1s and the maximum is 1h.

      API name: frequency

    • latest

      @Nullable public final Latest latest()
      The latest method transforms the data by finding the latest document for each unique key.

      API name: latest

    • pivot

      @Nullable public final Pivot pivot()
      The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields and the aggregation to reduce the data.

      API name: pivot

    • retentionPolicy

      @Nullable public final RetentionPolicy retentionPolicy()
      Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the destination index.

      API name: retention_policy

    • settings

      @Nullable public final Settings settings()
      Defines optional transform settings.

      API name: settings

    • source

      public final Source source()
      Required - The source of the data for the transform.

      API name: source

    • sync

      @Nullable public final Sync sync()
      Defines the properties transforms require to run continuously.

      API name: sync

    • transformId

      public final java.lang.String transformId()
      Required - Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.

      API name: transform_id

    • 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)

    • setupPutTransformRequestDeserializer

      protected static void setupPutTransformRequestDeserializer​(ObjectDeserializer<PutTransformRequest.Builder> op)