Class PreviewTransformRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<PreviewTransformRequest.Builder>
co.elastic.clients.elasticsearch.transform.PreviewTransformRequest.Builder
- All Implemented Interfaces:
WithJson<PreviewTransformRequest.Builder>
,ObjectBuilder<PreviewTransformRequest>
- Enclosing class:
- PreviewTransformRequest
public static class PreviewTransformRequest.Builder
extends RequestBase.AbstractBuilder<PreviewTransformRequest.Builder>
implements ObjectBuilder<PreviewTransformRequest>
Builder for
PreviewTransformRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aPreviewTransformRequest
.description
(String value) Free text description of the transform.dest
(Destination value) The destination for the transform.The destination for the transform.The interval between checks for changes in the source indices when the transform is running continuously.The interval between checks for changes in the source indices when the transform is running continuously.The latest method transforms the data by finding the latest document for each unique key.The latest method transforms the data by finding the latest document for each unique key.The pivot method transforms the data by aggregating and grouping it.The pivot method transforms the data by aggregating and grouping it.retentionPolicy
(RetentionPolicy value) Defines a retention policy for the transform.Defines a retention policy for the transform.protected PreviewTransformRequest.Builder
self()
Defines optional transform settings.Defines optional transform settings.The source of the data for the transform.The source of the data for the transform.Defines the properties transforms require to run continuously.Defines the properties transforms require to run continuously.Period to wait for a response.Period to wait for a response.transformId
(String value) Identifier for the transform to preview.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
description
Free text description of the transform.API name:
description
-
dest
The destination for the transform.API name:
dest
-
dest
public final PreviewTransformRequest.Builder dest(Function<Destination.Builder, ObjectBuilder<Destination>> fn) 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
-
frequency
public final PreviewTransformRequest.Builder frequency(Function<Time.Builder, ObjectBuilder<Time>> fn) 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
-
latest
public final PreviewTransformRequest.Builder latest(Function<Latest.Builder, ObjectBuilder<Latest>> fn) 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
-
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
-
retentionPolicy
public final PreviewTransformRequest.Builder retentionPolicy(Function<RetentionPolicy.Builder, ObjectBuilder<RetentionPolicy>> fn) 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
-
settings
public final PreviewTransformRequest.Builder settings(Function<Settings.Builder, ObjectBuilder<Settings>> fn) Defines optional transform settings.API name:
settings
-
source
The source of the data for the transform.API name:
source
-
source
public final PreviewTransformRequest.Builder source(Function<Source.Builder, ObjectBuilder<Source>> fn) The source of the data for the transform.API name:
source
-
sync
Defines the properties transforms require to run continuously.API name:
sync
-
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
-
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
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<PreviewTransformRequest.Builder>
-
build
Builds aPreviewTransformRequest
.- Specified by:
build
in interfaceObjectBuilder<PreviewTransformRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-