org.elasticsearch.client.ml.EstimateModelMemoryRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of elasticsearch-rest-high-level-client Show documentation
Elasticsearch subproject :client:rest-high-level
There is a newer version: 8.0.0-alpha2
Show newest version
/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the Elastic License
 * 2.0 and the Server Side Public License, v 1; you may not use this file except
 * in compliance with, at your election, the Elastic License 2.0 or the Server
 * Side Public License, v 1.
 */

package org.elasticsearch.client.ml;

import org.elasticsearch.client.Validatable;
import org.elasticsearch.client.ValidationException;
import org.elasticsearch.client.ml.job.config.AnalysisConfig;
import org.elasticsearch.xcontent.ToXContentObject;
import org.elasticsearch.xcontent.XContentBuilder;

import java.io.IOException;
import java.util.Collections;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;

/**
 * Request to estimate the model memory an analysis config is likely to need given supplied field cardinalities.
 */
public class EstimateModelMemoryRequest implements Validatable, ToXContentObject {

    public static final String ANALYSIS_CONFIG = "analysis_config";
    public static final String OVERALL_CARDINALITY = "overall_cardinality";
    public static final String MAX_BUCKET_CARDINALITY = "max_bucket_cardinality";

    private final AnalysisConfig analysisConfig;
    private Map overallCardinality = Collections.emptyMap();
    private Map maxBucketCardinality = Collections.emptyMap();

    @Override
    public Optional validate() {
        return Optional.empty();
    }

    public EstimateModelMemoryRequest(AnalysisConfig analysisConfig) {
        this.analysisConfig = Objects.requireNonNull(analysisConfig);
    }

    public AnalysisConfig getAnalysisConfig() {
        return analysisConfig;
    }

    public Map getOverallCardinality() {
        return overallCardinality;
    }

    public void setOverallCardinality(Map overallCardinality) {
        this.overallCardinality = Collections.unmodifiableMap(overallCardinality);
    }

    public Map getMaxBucketCardinality() {
        return maxBucketCardinality;
    }

    public void setMaxBucketCardinality(Map maxBucketCardinality) {
        this.maxBucketCardinality = Collections.unmodifiableMap(maxBucketCardinality);
    }

    @Override
    public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
        builder.startObject();
        builder.field(ANALYSIS_CONFIG, analysisConfig);
        if (overallCardinality.isEmpty() == false) {
            builder.field(OVERALL_CARDINALITY, overallCardinality);
        }
        if (maxBucketCardinality.isEmpty() == false) {
            builder.field(MAX_BUCKET_CARDINALITY, maxBucketCardinality);
        }
        builder.endObject();
        return builder;
    }

    @Override
    public int hashCode() {
        return Objects.hash(analysisConfig, overallCardinality, maxBucketCardinality);
    }

    @Override
    public boolean equals(Object other) {
        if (this == other) {
            return true;
        }

        if (other == null || getClass() != other.getClass()) {
            return false;
        }

        EstimateModelMemoryRequest that = (EstimateModelMemoryRequest) other;
        return Objects.equals(analysisConfig, that.analysisConfig)
            && Objects.equals(overallCardinality, that.overallCardinality)
            && Objects.equals(maxBucketCardinality, that.maxBucketCardinality);
    }
}