Class UpdateDataFrameAnalyticsRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.UpdateDataFrameAnalyticsRequest
- All Implemented Interfaces:
ElasticsearchCommonRequest
,JsonpSerializable
@JsonpDeserializable public final class UpdateDataFrameAnalyticsRequest extends RequestBase implements JsonpSerializable
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
UpdateDataFrameAnalyticsRequest.Builder
Builder forUpdateDataFrameAnalyticsRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<UpdateDataFrameAnalyticsRequest>
_DESERIALIZER
Json deserializer forUpdateDataFrameAnalyticsRequest
static Endpoint<UpdateDataFrameAnalyticsRequest,UpdateDataFrameAnalyticsResponse,ElasticsearchError>
ENDPOINT
Endpoint "ml.update_data_frame_analytics
". -
Constructor Summary
Constructors Constructor Description UpdateDataFrameAnalyticsRequest(UpdateDataFrameAnalyticsRequest.Builder builder)
UpdateDataFrameAnalyticsRequest(java.util.function.Function<UpdateDataFrameAnalyticsRequest.Builder,UpdateDataFrameAnalyticsRequest.Builder> fn)
-
Method Summary
Modifier and Type Method Description java.lang.Boolean
allowLazyStart()
Specifies whether this job can start when there is insufficient machine learning node capacity for it to be immediately assigned to a node.java.lang.String
description()
A description of the job.java.lang.String
id()
Required - Identifier for the data frame analytics job.java.lang.Integer
maxNumThreads()
The maximum number of threads to be used by the analysis.java.lang.String
modelMemoryLimit()
The approximate maximum amount of memory resources that are permitted for analytical processing.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(DelegatingDeserializer<UpdateDataFrameAnalyticsRequest.Builder> op)
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forUpdateDataFrameAnalyticsRequest
-
ENDPOINT
public static final Endpoint<UpdateDataFrameAnalyticsRequest,UpdateDataFrameAnalyticsResponse,ElasticsearchError> ENDPOINTEndpoint "ml.update_data_frame_analytics
".
-
-
Constructor Details
-
UpdateDataFrameAnalyticsRequest
-
UpdateDataFrameAnalyticsRequest
public UpdateDataFrameAnalyticsRequest(java.util.function.Function<UpdateDataFrameAnalyticsRequest.Builder,UpdateDataFrameAnalyticsRequest.Builder> fn)
-
-
Method Details
-
id
public java.lang.String 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
-
description
@Nullable public java.lang.String description()A description of the job.API name:
description
-
modelMemoryLimit
@Nullable public java.lang.String 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 an xpack.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
-
maxNumThreads
@Nullable public java.lang.Integer maxNumThreads()The maximum number of threads to be used by the analysis. The default value is 1. 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
-
allowLazyStart
@Nullable public java.lang.Boolean 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
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupUpdateDataFrameAnalyticsRequestDeserializer
protected static void setupUpdateDataFrameAnalyticsRequestDeserializer(DelegatingDeserializer<UpdateDataFrameAnalyticsRequest.Builder> op)
-