co.elastic.clients.elasticsearch.ml.EstimateModelMemoryRequest Maven / Gradle / Ivy
Show all versions of elasticsearch-java Show documentation
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
//----------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------
package co.elastic.clients.elasticsearch.ml;
import co.elastic.clients.elasticsearch._types.ErrorResponse;
import co.elastic.clients.elasticsearch._types.RequestBase;
import co.elastic.clients.json.JsonpDeserializable;
import co.elastic.clients.json.JsonpDeserializer;
import co.elastic.clients.json.JsonpMapper;
import co.elastic.clients.json.JsonpSerializable;
import co.elastic.clients.json.ObjectBuilderDeserializer;
import co.elastic.clients.json.ObjectDeserializer;
import co.elastic.clients.transport.Endpoint;
import co.elastic.clients.transport.endpoints.SimpleEndpoint;
import co.elastic.clients.util.ApiTypeHelper;
import co.elastic.clients.util.ObjectBuilder;
import co.elastic.clients.util.WithJsonObjectBuilderBase;
import jakarta.json.stream.JsonGenerator;
import java.lang.Long;
import java.lang.String;
import java.util.Collections;
import java.util.Map;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;
// typedef: ml.estimate_model_memory.Request
/**
* 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 API
* specification
*/
@JsonpDeserializable
public class EstimateModelMemoryRequest extends RequestBase implements JsonpSerializable {
@Nullable
private final AnalysisConfig analysisConfig;
private final Map maxBucketCardinality;
private final Map overallCardinality;
// ---------------------------------------------------------------------------------------------
private EstimateModelMemoryRequest(Builder builder) {
this.analysisConfig = builder.analysisConfig;
this.maxBucketCardinality = ApiTypeHelper.unmodifiable(builder.maxBucketCardinality);
this.overallCardinality = ApiTypeHelper.unmodifiable(builder.overallCardinality);
}
public static EstimateModelMemoryRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* For a list of the properties that you can specify in the
* analysis_config component of the body of this API.
*
* API name: {@code analysis_config}
*/
@Nullable
public final AnalysisConfig analysisConfig() {
return this.analysisConfig;
}
/**
* 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: {@code max_bucket_cardinality}
*/
public final Map maxBucketCardinality() {
return this.maxBucketCardinality;
}
/**
* 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: {@code overall_cardinality}
*/
public final Map overallCardinality() {
return this.overallCardinality;
}
/**
* Serialize this object to JSON.
*/
public void serialize(JsonGenerator generator, JsonpMapper mapper) {
generator.writeStartObject();
serializeInternal(generator, mapper);
generator.writeEnd();
}
protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
if (this.analysisConfig != null) {
generator.writeKey("analysis_config");
this.analysisConfig.serialize(generator, mapper);
}
if (ApiTypeHelper.isDefined(this.maxBucketCardinality)) {
generator.writeKey("max_bucket_cardinality");
generator.writeStartObject();
for (Map.Entry item0 : this.maxBucketCardinality.entrySet()) {
generator.writeKey(item0.getKey());
generator.write(item0.getValue());
}
generator.writeEnd();
}
if (ApiTypeHelper.isDefined(this.overallCardinality)) {
generator.writeKey("overall_cardinality");
generator.writeStartObject();
for (Map.Entry item0 : this.overallCardinality.entrySet()) {
generator.writeKey(item0.getKey());
generator.write(item0.getValue());
}
generator.writeEnd();
}
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link EstimateModelMemoryRequest}.
*/
public static class Builder extends WithJsonObjectBuilderBase
implements
ObjectBuilder {
@Nullable
private AnalysisConfig analysisConfig;
@Nullable
private Map maxBucketCardinality;
@Nullable
private Map overallCardinality;
/**
* For a list of the properties that you can specify in the
* analysis_config component of the body of this API.
*
* API name: {@code analysis_config}
*/
public final Builder analysisConfig(@Nullable AnalysisConfig value) {
this.analysisConfig = value;
return this;
}
/**
* For a list of the properties that you can specify in the
* analysis_config component of the body of this API.
*
* API name: {@code analysis_config}
*/
public final Builder analysisConfig(Function> fn) {
return this.analysisConfig(fn.apply(new AnalysisConfig.Builder()).build());
}
/**
* 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: {@code max_bucket_cardinality}
*
* Adds all entries of map to maxBucketCardinality.
*/
public final Builder maxBucketCardinality(Map map) {
this.maxBucketCardinality = _mapPutAll(this.maxBucketCardinality, map);
return this;
}
/**
* 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: {@code max_bucket_cardinality}
*
* Adds an entry to maxBucketCardinality.
*/
public final Builder maxBucketCardinality(String key, Long value) {
this.maxBucketCardinality = _mapPut(this.maxBucketCardinality, key, value);
return this;
}
/**
* 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: {@code overall_cardinality}
*
* Adds all entries of map to overallCardinality.
*/
public final Builder overallCardinality(Map map) {
this.overallCardinality = _mapPutAll(this.overallCardinality, map);
return this;
}
/**
* 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: {@code overall_cardinality}
*
* Adds an entry to overallCardinality.
*/
public final Builder overallCardinality(String key, Long value) {
this.overallCardinality = _mapPut(this.overallCardinality, key, value);
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link EstimateModelMemoryRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public EstimateModelMemoryRequest build() {
_checkSingleUse();
return new EstimateModelMemoryRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link EstimateModelMemoryRequest}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, EstimateModelMemoryRequest::setupEstimateModelMemoryRequestDeserializer);
protected static void setupEstimateModelMemoryRequestDeserializer(
ObjectDeserializer op) {
op.add(Builder::analysisConfig, AnalysisConfig._DESERIALIZER, "analysis_config");
op.add(Builder::maxBucketCardinality,
JsonpDeserializer.stringMapDeserializer(JsonpDeserializer.longDeserializer()),
"max_bucket_cardinality");
op.add(Builder::overallCardinality,
JsonpDeserializer.stringMapDeserializer(JsonpDeserializer.longDeserializer()), "overall_cardinality");
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code ml.estimate_model_memory}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/ml.estimate_model_memory",
// Request method
request -> {
return "POST";
},
// Request path
request -> {
return "/_ml/anomaly_detectors/_estimate_model_memory";
},
// Request parameters
request -> {
return Collections.emptyMap();
}, SimpleEndpoint.emptyMap(), true, EstimateModelMemoryResponse._DESERIALIZER);
}