Class UpdateTransformRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<UpdateTransformRequest.Builder>
co.elastic.clients.elasticsearch.transform.UpdateTransformRequest.Builder
- All Implemented Interfaces:
WithJson<UpdateTransformRequest.Builder>
,ObjectBuilder<UpdateTransformRequest>
- Enclosing class:
- UpdateTransformRequest
public static class UpdateTransformRequest.Builder
extends RequestBase.AbstractBuilder<UpdateTransformRequest.Builder>
implements ObjectBuilder<UpdateTransformRequest>
Builder for
UpdateTransformRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aUpdateTransformRequest
.deferValidation
(Boolean value) When true, deferrable validations are not run.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.Defines optional transform metadata.Defines optional transform metadata.retentionPolicy
(RetentionPolicy value) Defines a retention policy for the transform.Defines a retention policy for the transform.protected UpdateTransformRequest.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) 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 true, deferrable validations are not run. This behavior may be desired if the source index does not exist until after the transform is created.API name:
defer_validation
-
description
Free text description of the transform.API name:
description
-
dest
The destination for the transform.API name:
dest
-
dest
public final UpdateTransformRequest.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 UpdateTransformRequest.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
-
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 UpdateTransformRequest.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 UpdateTransformRequest.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 UpdateTransformRequest.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
Required - Identifier for the transform.API name:
transform_id
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<UpdateTransformRequest.Builder>
-
build
Builds aUpdateTransformRequest
.- Specified by:
build
in interfaceObjectBuilder<UpdateTransformRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-