Class UpdateDataFrameAnalyticsRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.UpdateDataFrameAnalyticsRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class UpdateDataFrameAnalyticsRequest
extends RequestBase
implements JsonpSerializable
Updates an existing data frame analytics job.
- 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<UpdateDataFrameAnalyticsRequest>
Json deserializer forUpdateDataFrameAnalyticsRequest
static final Endpoint<UpdateDataFrameAnalyticsRequest,
UpdateDataFrameAnalyticsResponse, ErrorResponse> Endpoint "ml.update_data_frame_analytics
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Specifies whether this job can start when there is insufficient machine learning node capacity for it to be immediately assigned to a node.final String
A description of the job.final String
id()
Required - Identifier for the data frame analytics job.final Integer
The maximum number of threads to be used by the analysis.final String
The approximate maximum amount of memory resources that are permitted for analytical processing.of
(Function<UpdateDataFrameAnalyticsRequest.Builder, ObjectBuilder<UpdateDataFrameAnalyticsRequest>> fn) void
serialize
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this object to JSON.protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static void
setupUpdateDataFrameAnalyticsRequestDeserializer
(ObjectDeserializer<UpdateDataFrameAnalyticsRequest.Builder> op) Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forUpdateDataFrameAnalyticsRequest
-
_ENDPOINT
public static final Endpoint<UpdateDataFrameAnalyticsRequest,UpdateDataFrameAnalyticsResponse, _ENDPOINTErrorResponse> Endpoint "ml.update_data_frame_analytics
".
-
-
Method Details
-
of
-
allowLazyStart
Specifies whether this job can start when there is insufficient machine learning node capacity for it to be immediately assigned to a node.API name:
allow_lazy_start
-
description
A description of the job.API name:
description
-
id
Required - Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.API name:
id
-
maxNumThreads
The maximum number of threads to be used by the analysis. Using more threads may decrease the time necessary to complete the analysis at the cost of using more CPU. Note that the process may use additional threads for operational functionality other than the analysis itself.API name:
max_num_threads
-
modelMemoryLimit
The approximate maximum amount of memory resources that are permitted for analytical processing. The default value for data frame analytics jobs is 1gb. If your elasticsearch.yml file contains anxpack.ml.max_model_memory_limit
setting, an error occurs when you try to create data frame analytics jobs that have model_memory_limit values greater than that setting.API name:
model_memory_limit
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupUpdateDataFrameAnalyticsRequestDeserializer
protected static void setupUpdateDataFrameAnalyticsRequestDeserializer(ObjectDeserializer<UpdateDataFrameAnalyticsRequest.Builder> op)
-