Package co.elastic.clients.elasticsearch.ml

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

  • Field Details

  • Method Details

    • of

      public static EstimateModelMemoryRequest of​(java.util.function.Function<EstimateModelMemoryRequest.Builder,​ObjectBuilder<EstimateModelMemoryRequest>> fn)

    • analysisConfig

      @Nullable public final AnalysisConfig analysisConfig()
      For a list of the properties that you can specify in the analysis_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 as influencers 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 the by_field_name, over_field_name and partition_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 a by_field_name, over_field_name or partition_field_name.

      API name: overall_cardinality

    • serialize

      public void serialize​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • setupEstimateModelMemoryRequestDeserializer

      protected static void setupEstimateModelMemoryRequestDeserializer​(ObjectDeserializer<EstimateModelMemoryRequest.Builder> op)