Class UpdateDataFrameAnalyticsRequest.Builder
java.lang.Object
co.elastic.clients.elasticsearch.ml.UpdateDataFrameAnalyticsRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<UpdateDataFrameAnalyticsRequest>
- Enclosing class:
- UpdateDataFrameAnalyticsRequest
public static class UpdateDataFrameAnalyticsRequest.Builder extends java.lang.Object implements ObjectBuilder<UpdateDataFrameAnalyticsRequest>
Builder for
UpdateDataFrameAnalyticsRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description UpdateDataFrameAnalyticsRequest.Builder
allowLazyStart(java.lang.Boolean value)
Specifies whether this job can start when there is insufficient machine learning node capacity for it to be immediately assigned to a node.UpdateDataFrameAnalyticsRequest
build()
Builds aUpdateDataFrameAnalyticsRequest
.UpdateDataFrameAnalyticsRequest.Builder
description(java.lang.String value)
A description of the job.UpdateDataFrameAnalyticsRequest.Builder
id(java.lang.String value)
Required - Identifier for the data frame analytics job.UpdateDataFrameAnalyticsRequest.Builder
maxNumThreads(java.lang.Integer value)
The maximum number of threads to be used by the analysis.UpdateDataFrameAnalyticsRequest.Builder
modelMemoryLimit(java.lang.String value)
The approximate maximum amount of memory resources that are permitted for analytical processing.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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
A description of the job.API name:
description
-
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
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
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
-
build
Builds aUpdateDataFrameAnalyticsRequest
.- Specified by:
build
in interfaceObjectBuilder<UpdateDataFrameAnalyticsRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-