Class EstimateModelMemoryRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.EstimateModelMemoryRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class EstimateModelMemoryRequest extends RequestBase implements JsonpSerializable
Makes an estimation of the memory usage for an anomaly detection job model.
It is based on analysis configuration details for the job and cardinality
estimates for the fields it references.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
EstimateModelMemoryRequest.Builder
Builder forEstimateModelMemoryRequest
.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<EstimateModelMemoryRequest>
_DESERIALIZER
Json deserializer forEstimateModelMemoryRequest
static Endpoint<EstimateModelMemoryRequest,EstimateModelMemoryResponse,ErrorResponse>
_ENDPOINT
Endpoint "ml.estimate_model_memory
". -
Method Summary
Modifier and Type Method Description AnalysisConfig
analysisConfig()
For a list of the properties that you can specify in theanalysis_config
component of the body of this API.java.util.Map<java.lang.String,java.lang.Long>
maxBucketCardinality()
Estimates of the highest cardinality in a single bucket that is observed for influencer fields over the time period that the job analyzes data.static EstimateModelMemoryRequest
of(java.util.function.Function<EstimateModelMemoryRequest.Builder,ObjectBuilder<EstimateModelMemoryRequest>> fn)
java.util.Map<java.lang.String,java.lang.Long>
overallCardinality()
Estimates of the cardinality that is observed for fields over the whole time period that the job analyzes data.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
setupEstimateModelMemoryRequestDeserializer(ObjectDeserializer<EstimateModelMemoryRequest.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 forEstimateModelMemoryRequest
-
_ENDPOINT
public static final Endpoint<EstimateModelMemoryRequest,EstimateModelMemoryResponse,ErrorResponse> _ENDPOINTEndpoint "ml.estimate_model_memory
".
-
-
Method Details
-
of
public static EstimateModelMemoryRequest of(java.util.function.Function<EstimateModelMemoryRequest.Builder,ObjectBuilder<EstimateModelMemoryRequest>> fn) -
analysisConfig
For a list of the properties that you can specify in theanalysis_config
component of the body of this API.API name:
analysis_config
-
maxBucketCardinality
public final java.util.Map<java.lang.String,java.lang.Long> maxBucketCardinality()Estimates of the highest cardinality in a single bucket that is observed for influencer fields over the time period that the job analyzes data. To produce a good answer, values must be provided for all influencer fields. Providing values for fields that are not listed asinfluencers
has no effect on the estimation.API name:
max_bucket_cardinality
-
overallCardinality
public final java.util.Map<java.lang.String,java.lang.Long> overallCardinality()Estimates of the cardinality that is observed for fields over the whole time period that the job analyzes data. To produce a good answer, values must be provided for fields referenced in theby_field_name
,over_field_name
andpartition_field_name
of any detectors. Providing values for other fields has no effect on the estimation. It can be omitted from the request if no detectors have aby_field_name
,over_field_name
orpartition_field_name
.API name:
overall_cardinality
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupEstimateModelMemoryRequestDeserializer
protected static void setupEstimateModelMemoryRequestDeserializer(ObjectDeserializer<EstimateModelMemoryRequest.Builder> op)
-