Package co.elastic.clients.elasticsearch.transform

Class PreviewTransformRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.transform.PreviewTransformRequest
All Implemented Interfaces:
ElasticsearchCommonRequest, JsonpSerializable
Direct Known Subclasses:
PutTransformRequest
@JsonpDeserializable
public class PreviewTransformRequest
extends RequestBase
implements JsonpSerializable

  • Field Details

  • Constructor Details

  • Method Details

    • transformId

      @Nullable public java.lang.String transformId()
      The id of the transform to preview.

      API name: transform_id

    • dest

      @Nullable public Destination dest()
      The destination for the transform.

      API name: dest

    • description

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

      API name: description

    • frequency

      @Nullable public java.lang.String 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

    • pivot

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

    • source

      @Nullable public Source source()
      The source of the data for the transform.

      API name: source

    • settings

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

      API name: settings

    • sync

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

      API name: sync

    • retentionPolicy

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

    • latest

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

      API name: latest

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

    • setupPreviewTransformRequestDeserializer

      protected static <BuilderT extends PreviewTransformRequest.AbstractBuilder<BuilderT>> void setupPreviewTransformRequestDeserializer​(DelegatingDeserializer<BuilderT> op)

    • createPreviewTransformEndpoint

      public static <TTransform> Endpoint<PreviewTransformRequest,​PreviewTransformResponse<TTransform>,​ElasticsearchError> createPreviewTransformEndpoint​(JsonpDeserializer<TTransform> tTransformDeserializer)
      Create an "transform.preview_transform" endpoint.