Class UpdateTransformRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.transform.UpdateTransformRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class UpdateTransformRequest
extends RequestBase
implements JsonpSerializable
Updates certain properties of a transform.
All updated properties except description
do not take effect
until after the transform starts the next checkpoint, thus there is data
consistency in each checkpoint. To use this API, you must have
read
and view_index_metadata
privileges for the
source indices. You must also have index
and read
privileges for the destination index. When Elasticsearch security features
are enabled, the transform remembers which roles the user who updated it had
at the time of update and runs with those privileges.
- 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<UpdateTransformRequest>
Json deserializer forUpdateTransformRequest
static final Endpoint<UpdateTransformRequest,
UpdateTransformResponse, ErrorResponse> Endpoint "transform.update_transform
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
When true, deferrable validations are not run.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.meta()
Defines optional transform metadata.static UpdateTransformRequest
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
Required - Identifier for the transform.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forUpdateTransformRequest
-
_ENDPOINT
public static final Endpoint<UpdateTransformRequest,UpdateTransformResponse, _ENDPOINTErrorResponse> Endpoint "transform.update_transform
".
-
-
Method Details
-
of
public static UpdateTransformRequest of(Function<UpdateTransformRequest.Builder, ObjectBuilder<UpdateTransformRequest>> fn) -
meta
Defines optional transform metadata.API name:
_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
-
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
-
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
Required - Identifier for the transform.API name:
transform_id
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupUpdateTransformRequestDeserializer
protected static void setupUpdateTransformRequestDeserializer(ObjectDeserializer<UpdateTransformRequest.Builder> op)
-