Class PreviewTransformRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<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 WithJsonObjectBuilderBase<PreviewTransformRequest.Builder> implements ObjectBuilder<PreviewTransformRequest>
Builder for
PreviewTransformRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description PreviewTransformRequest
build()
Builds aPreviewTransformRequest
.PreviewTransformRequest.Builder
description(java.lang.String value)
Free text description of the transform.PreviewTransformRequest.Builder
dest(Destination value)
The destination for the transform.PreviewTransformRequest.Builder
dest(java.util.function.Function<Destination.Builder,ObjectBuilder<Destination>> fn)
The destination for the transform.PreviewTransformRequest.Builder
frequency(Time value)
The interval between checks for changes in the source indices when the transform is running continuously.PreviewTransformRequest.Builder
frequency(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
The interval between checks for changes in the source indices when the transform is running continuously.PreviewTransformRequest.Builder
latest(Latest value)
The latest method transforms the data by finding the latest document for each unique key.PreviewTransformRequest.Builder
latest(java.util.function.Function<Latest.Builder,ObjectBuilder<Latest>> fn)
The latest method transforms the data by finding the latest document for each unique key.PreviewTransformRequest.Builder
pivot(Pivot value)
The pivot method transforms the data by aggregating and grouping it.PreviewTransformRequest.Builder
pivot(java.util.function.Function<Pivot.Builder,ObjectBuilder<Pivot>> fn)
The pivot method transforms the data by aggregating and grouping it.PreviewTransformRequest.Builder
retentionPolicy(RetentionPolicy value)
Defines a retention policy for the transform.PreviewTransformRequest.Builder
retentionPolicy(java.util.function.Function<RetentionPolicy.Builder,ObjectBuilder<RetentionPolicy>> fn)
Defines a retention policy for the transform.protected PreviewTransformRequest.Builder
self()
PreviewTransformRequest.Builder
settings(Settings value)
Defines optional transform settings.PreviewTransformRequest.Builder
settings(java.util.function.Function<Settings.Builder,ObjectBuilder<Settings>> fn)
Defines optional transform settings.PreviewTransformRequest.Builder
source(Source value)
The source of the data for the transform.PreviewTransformRequest.Builder
source(java.util.function.Function<Source.Builder,ObjectBuilder<Source>> fn)
The source of the data for the transform.PreviewTransformRequest.Builder
sync(Sync value)
Defines the properties transforms require to run continuously.PreviewTransformRequest.Builder
sync(java.util.function.Function<Sync.Builder,ObjectBuilder<Sync>> fn)
Defines the properties transforms require to run continuously.PreviewTransformRequest.Builder
timeout(Time value)
Period to wait for a response.PreviewTransformRequest.Builder
timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Period to wait for a response.PreviewTransformRequest.Builder
transformId(java.lang.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
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
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(java.util.function.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(java.util.function.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(java.util.function.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
public final PreviewTransformRequest.Builder pivot(java.util.function.Function<Pivot.Builder,ObjectBuilder<Pivot>> fn)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(java.util.function.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(java.util.function.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(java.util.function.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
public final PreviewTransformRequest.Builder sync(java.util.function.Function<Sync.Builder,ObjectBuilder<Sync>> fn)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
public final PreviewTransformRequest.Builder timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)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 classWithJsonObjectBuilderBase<PreviewTransformRequest.Builder>
-
build
Builds aPreviewTransformRequest
.- Specified by:
build
in interfaceObjectBuilder<PreviewTransformRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-