Class PutTransformRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<PutTransformRequest.Builder>
co.elastic.clients.elasticsearch.transform.PutTransformRequest.Builder
- All Implemented Interfaces:
WithJson<PutTransformRequest.Builder>
,ObjectBuilder<PutTransformRequest>
- Enclosing class:
- PutTransformRequest
public static class PutTransformRequest.Builder
extends RequestBase.AbstractBuilder<PutTransformRequest.Builder>
implements ObjectBuilder<PutTransformRequest>
Builder for
PutTransformRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aPutTransformRequest
.deferValidation
(Boolean value) When the transform is created, a series of validations occur to ensure its success.description
(String value) Free text description of the transform.dest
(Destination value) Required - The destination for the transform.Required - 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.Defines optional transform metadata.Defines optional transform metadata.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 PutTransformRequest.Builder
self()
Defines optional transform settings.Defines optional transform settings.Required - The source of the data for the transform.Required - 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) Required - Identifier for the transform.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
-
meta
Defines optional transform metadata.API name:
_meta
Adds all entries of
map
tometa
. -
meta
Defines optional transform metadata.API name:
_meta
Adds an entry to
meta
. -
deferValidation
When the transform is created, a series of validations occur to ensure its success. For example, there is a check for the existence of the source indices and a check that the destination index is not part of the source index pattern. You can use this parameter to skip the checks, for example when the source index does not exist until after the transform is created. The validations are always run when you start the transform, however, with the exception of privilege checks.API name:
defer_validation
-
description
Free text description of the transform.API name:
description
-
dest
Required - The destination for the transform.API name:
dest
-
dest
public final PutTransformRequest.Builder dest(Function<Destination.Builder, ObjectBuilder<Destination>> fn) Required - 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 is1s
and the maximum is1h
.API name:
frequency
-
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 is1s
and the maximum is1h
.API name:
frequency
-
latest
The latest method transforms the data by finding the latest document for each unique key.API name:
latest
-
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
-
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 PutTransformRequest.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 PutTransformRequest.Builder settings(Function<Settings.Builder, ObjectBuilder<Settings>> fn) Defines optional transform settings.API name:
settings
-
source
Required - The source of the data for the transform.API name:
source
-
source
Required - 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
Required - Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters.API name:
transform_id
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<PutTransformRequest.Builder>
-
build
Builds aPutTransformRequest
.- Specified by:
build
in interfaceObjectBuilder<PutTransformRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-