Class AnalysisLimits
java.lang.Object
co.elastic.clients.elasticsearch.ml.AnalysisLimits
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class AnalysisLimits extends java.lang.Object implements JsonpSerializable
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AnalysisLimits.Builder
Builder forAnalysisLimits
. -
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<AnalysisLimits>
_DESERIALIZER
Json deserializer forAnalysisLimits
-
Method Summary
Modifier and Type Method Description java.lang.Long
categorizationExamplesLimit()
The maximum number of examples stored per category in memory and in the results data store.java.lang.String
modelMemoryLimit()
The approximate maximum amount of memory resources that are required for analytical processing.static AnalysisLimits
of(java.util.function.Function<AnalysisLimits.Builder,ObjectBuilder<AnalysisLimits>> 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
setupAnalysisLimitsDeserializer(ObjectDeserializer<AnalysisLimits.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 forAnalysisLimits
-
-
Method Details
-
of
public static AnalysisLimits of(java.util.function.Function<AnalysisLimits.Builder,ObjectBuilder<AnalysisLimits>> fn) -
categorizationExamplesLimit
@Nullable public final java.lang.Long 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
@Nullable public final java.lang.String 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
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupAnalysisLimitsDeserializer
protected static void setupAnalysisLimitsDeserializer(ObjectDeserializer<AnalysisLimits.Builder> op)
-