Class PreviewTransformRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.transform.PreviewTransformRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class PreviewTransformRequest
extends RequestBase
implements JsonpSerializable
Previews a transform.
It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also generates a list of mappings and settings for the destination index. These values are determined based on the field types of the source index and the transform aggregations.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<PreviewTransformRequest>
Json deserializer forPreviewTransformRequest
static final SimpleEndpoint<PreviewTransformRequest,
?> Endpoint "transform.preview_transform
". -
Method Summary
Modifier and TypeMethodDescriptionstatic <TTransform>
Endpoint<PreviewTransformRequest,PreviewTransformResponse<TTransform>, ErrorResponse> createPreviewTransformEndpoint
(JsonpDeserializer<TTransform> tTransformDeserializer) Create an "transform.preview_transform
" endpoint.final String
Free text description of the transform.final Destination
dest()
The destination for the transform.final Time
The interval between checks for changes in the source indices when the transform is running continuously.final Latest
latest()
The latest method transforms the data by finding the latest document for each unique key.static PreviewTransformRequest
final Pivot
pivot()
The pivot method transforms the data by aggregating and grouping it.final RetentionPolicy
Defines a retention policy for the transform.void
serialize
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this object to JSON.protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) final Settings
settings()
Defines optional transform settings.protected static void
final Source
source()
The source of the data for the transform.final Sync
sync()
Defines the properties transforms require to run continuously.final Time
timeout()
Period to wait for a response.final String
Identifier for the transform to preview.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forPreviewTransformRequest
-
_ENDPOINT
Endpoint "transform.preview_transform
".
-
-
Method Details
-
of
public static PreviewTransformRequest of(Function<PreviewTransformRequest.Builder, ObjectBuilder<PreviewTransformRequest>> fn) -
description
Free text description of the transform.API name:
description
-
dest
The destination for the transform.API name:
dest
-
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
The latest method transforms the data by finding the latest document for each unique key.API name:
latest
-
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
Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the destination index.API name:
retention_policy
-
settings
Defines optional transform settings.API name:
settings
-
source
The source of the data for the transform.API name:
source
-
sync
Defines the properties transforms require to run continuously.API name:
sync
-
timeout
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
-
transformId
Identifier for the transform to preview. If you specify this path parameter, you cannot provide transform configuration details in the request body.API name:
transform_id
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupPreviewTransformRequestDeserializer
protected static void setupPreviewTransformRequestDeserializer(ObjectDeserializer<PreviewTransformRequest.Builder> op) -
createPreviewTransformEndpoint
public static <TTransform> Endpoint<PreviewTransformRequest,PreviewTransformResponse<TTransform>, createPreviewTransformEndpointErrorResponse> (JsonpDeserializer<TTransform> tTransformDeserializer) Create an "transform.preview_transform
" endpoint.
-