Class AnalysisLimits.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<AnalysisLimits.Builder>
co.elastic.clients.elasticsearch.ml.AnalysisLimits.Builder
- All Implemented Interfaces:
WithJson<AnalysisLimits.Builder>
,ObjectBuilder<AnalysisLimits>
- Enclosing class:
- AnalysisLimits
public static class AnalysisLimits.Builder extends WithJsonObjectBuilderBase<AnalysisLimits.Builder> implements ObjectBuilder<AnalysisLimits>
Builder for
AnalysisLimits
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description AnalysisLimits
build()
Builds aAnalysisLimits
.AnalysisLimits.Builder
categorizationExamplesLimit(java.lang.Long value)
The maximum number of examples stored per category in memory and in the results data store.AnalysisLimits.Builder
modelMemoryLimit(java.lang.String value)
The approximate maximum amount of memory resources that are required for analytical processing.protected AnalysisLimits.Builder
self()
Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
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
-
categorizationExamplesLimit
The maximum number of examples stored per category in memory and in the results data store. If you increase this value, more examples are available, however it requires that you have more storage available. If you set this value to 0, no examples are stored. NOTE: Thecategorization_examples_limit
applies only to analysis that uses categorization.API name:
categorization_examples_limit
-
modelMemoryLimit
The approximate maximum amount of memory resources that are required for analytical processing. Once this limit is approached, data pruning becomes more aggressive. Upon exceeding this limit, new entities are not modeled. If thexpack.ml.max_model_memory_limit
setting has a value greater than 0 and less than 1024mb, that value is used instead of the default. The default value is relatively small to ensure that high resource usage is a conscious decision. If you have jobs that are expected to analyze high cardinality fields, you will likely need to use a higher value. If you specify a number instead of a string, the units are assumed to be MiB. Specifying a string is recommended for clarity. If you specify a byte size unit ofb
orkb
and the number does not equate to a discrete number of megabytes, it is rounded down to the closest MiB. The minimum valid value is 1 MiB. If you specify a value less than 1 MiB, an error occurs. If you specify a value for thexpack.ml.max_model_memory_limit
setting, an error occurs when you try to create jobs that havemodel_memory_limit
values greater than that setting value.API name:
model_memory_limit
-
self
- Specified by:
self
in classWithJsonObjectBuilderBase<AnalysisLimits.Builder>
-
build
Builds aAnalysisLimits
.- Specified by:
build
in interfaceObjectBuilder<AnalysisLimits>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-