co.elastic.clients.elasticsearch.ml.Detector 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.
*/
package co.elastic.clients.elasticsearch.ml;
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.JsonpUtils;
import co.elastic.clients.json.ObjectBuilderDeserializer;
import co.elastic.clients.json.ObjectDeserializer;
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.Boolean;
import java.lang.Integer;
import java.lang.String;
import java.util.List;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;
//----------------------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------------------
//
// This code is generated from the Elasticsearch API specification
// at https://github.com/elastic/elasticsearch-specification
//
// Manual updates to this file will be lost when the code is
// re-generated.
//
// If you find a property that is missing or wrongly typed, please
// open an issue or a PR on the API specification repository.
//
//----------------------------------------------------------------
// typedef: ml._types.Detector
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class Detector implements JsonpSerializable {
@Nullable
private final String byFieldName;
private final List customRules;
@Nullable
private final String detectorDescription;
@Nullable
private final Integer detectorIndex;
@Nullable
private final ExcludeFrequent excludeFrequent;
@Nullable
private final String fieldName;
@Nullable
private final String function;
@Nullable
private final String overFieldName;
@Nullable
private final String partitionFieldName;
@Nullable
private final Boolean useNull;
// ---------------------------------------------------------------------------------------------
private Detector(Builder builder) {
this.byFieldName = builder.byFieldName;
this.customRules = ApiTypeHelper.unmodifiable(builder.customRules);
this.detectorDescription = builder.detectorDescription;
this.detectorIndex = builder.detectorIndex;
this.excludeFrequent = builder.excludeFrequent;
this.fieldName = builder.fieldName;
this.function = builder.function;
this.overFieldName = builder.overFieldName;
this.partitionFieldName = builder.partitionFieldName;
this.useNull = builder.useNull;
}
public static Detector of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* The field used to split the data. In particular, this property is used for
* analyzing the splits with respect to their own history. It is used for
* finding unusual values in the context of the split.
*
* API name: {@code by_field_name}
*/
@Nullable
public final String byFieldName() {
return this.byFieldName;
}
/**
* Custom rules enable you to customize the way detectors operate. For example,
* a rule may dictate conditions under which results should be skipped. Kibana
* refers to custom rules as job rules.
*
* API name: {@code custom_rules}
*/
public final List customRules() {
return this.customRules;
}
/**
* A description of the detector.
*
* API name: {@code detector_description}
*/
@Nullable
public final String detectorDescription() {
return this.detectorDescription;
}
/**
* A unique identifier for the detector. This identifier is based on the order
* of the detectors in the analysis_config, starting at zero. If
* you specify a value for this property, it is ignored.
*
* API name: {@code detector_index}
*/
@Nullable
public final Integer detectorIndex() {
return this.detectorIndex;
}
/**
* If set, frequent entities are excluded from influencing the anomaly results.
* Entities can be considered frequent over time or frequent in a population. If
* you are working with both over and by fields, you can set
* exclude_frequent to all for both fields, or to
* by or over for those specific fields.
*
* API name: {@code exclude_frequent}
*/
@Nullable
public final ExcludeFrequent excludeFrequent() {
return this.excludeFrequent;
}
/**
* The field that the detector uses in the function. If you use an event rate
* function such as count or rare, do not specify this field. The
* field_name cannot contain double quotes or backslashes.
*
* API name: {@code field_name}
*/
@Nullable
public final String fieldName() {
return this.fieldName;
}
/**
* The analysis function that is used. For example, count,
* rare, mean, min, max, or
* sum.
*
* API name: {@code function}
*/
@Nullable
public final String function() {
return this.function;
}
/**
* The field used to split the data. In particular, this property is used for
* analyzing the splits with respect to the history of all splits. It is used
* for finding unusual values in the population of all splits.
*
* API name: {@code over_field_name}
*/
@Nullable
public final String overFieldName() {
return this.overFieldName;
}
/**
* The field used to segment the analysis. When you use this property, you have
* completely independent baselines for each value of this field.
*
* API name: {@code partition_field_name}
*/
@Nullable
public final String partitionFieldName() {
return this.partitionFieldName;
}
/**
* Defines whether a new series is used as the null series when there is no
* value for the by or partition fields.
*
* API name: {@code use_null}
*/
@Nullable
public final Boolean useNull() {
return this.useNull;
}
/**
* 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.byFieldName != null) {
generator.writeKey("by_field_name");
generator.write(this.byFieldName);
}
if (ApiTypeHelper.isDefined(this.customRules)) {
generator.writeKey("custom_rules");
generator.writeStartArray();
for (DetectionRule item0 : this.customRules) {
item0.serialize(generator, mapper);
}
generator.writeEnd();
}
if (this.detectorDescription != null) {
generator.writeKey("detector_description");
generator.write(this.detectorDescription);
}
if (this.detectorIndex != null) {
generator.writeKey("detector_index");
generator.write(this.detectorIndex);
}
if (this.excludeFrequent != null) {
generator.writeKey("exclude_frequent");
this.excludeFrequent.serialize(generator, mapper);
}
if (this.fieldName != null) {
generator.writeKey("field_name");
generator.write(this.fieldName);
}
if (this.function != null) {
generator.writeKey("function");
generator.write(this.function);
}
if (this.overFieldName != null) {
generator.writeKey("over_field_name");
generator.write(this.overFieldName);
}
if (this.partitionFieldName != null) {
generator.writeKey("partition_field_name");
generator.write(this.partitionFieldName);
}
if (this.useNull != null) {
generator.writeKey("use_null");
generator.write(this.useNull);
}
}
@Override
public String toString() {
return JsonpUtils.toString(this);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link Detector}.
*/
public static class Builder extends WithJsonObjectBuilderBase implements ObjectBuilder {
@Nullable
private String byFieldName;
@Nullable
private List customRules;
@Nullable
private String detectorDescription;
@Nullable
private Integer detectorIndex;
@Nullable
private ExcludeFrequent excludeFrequent;
@Nullable
private String fieldName;
@Nullable
private String function;
@Nullable
private String overFieldName;
@Nullable
private String partitionFieldName;
@Nullable
private Boolean useNull;
/**
* The field used to split the data. In particular, this property is used for
* analyzing the splits with respect to their own history. It is used for
* finding unusual values in the context of the split.
*
* API name: {@code by_field_name}
*/
public final Builder byFieldName(@Nullable String value) {
this.byFieldName = value;
return this;
}
/**
* Custom rules enable you to customize the way detectors operate. For example,
* a rule may dictate conditions under which results should be skipped. Kibana
* refers to custom rules as job rules.
*
* API name: {@code custom_rules}
*
* Adds all elements of list to customRules.
*/
public final Builder customRules(List list) {
this.customRules = _listAddAll(this.customRules, list);
return this;
}
/**
* Custom rules enable you to customize the way detectors operate. For example,
* a rule may dictate conditions under which results should be skipped. Kibana
* refers to custom rules as job rules.
*
* API name: {@code custom_rules}
*
* Adds one or more values to customRules.
*/
public final Builder customRules(DetectionRule value, DetectionRule... values) {
this.customRules = _listAdd(this.customRules, value, values);
return this;
}
/**
* Custom rules enable you to customize the way detectors operate. For example,
* a rule may dictate conditions under which results should be skipped. Kibana
* refers to custom rules as job rules.
*
* API name: {@code custom_rules}
*
* Adds a value to customRules using a builder lambda.
*/
public final Builder customRules(Function> fn) {
return customRules(fn.apply(new DetectionRule.Builder()).build());
}
/**
* A description of the detector.
*
* API name: {@code detector_description}
*/
public final Builder detectorDescription(@Nullable String value) {
this.detectorDescription = value;
return this;
}
/**
* A unique identifier for the detector. This identifier is based on the order
* of the detectors in the analysis_config, starting at zero. If
* you specify a value for this property, it is ignored.
*
* API name: {@code detector_index}
*/
public final Builder detectorIndex(@Nullable Integer value) {
this.detectorIndex = value;
return this;
}
/**
* If set, frequent entities are excluded from influencing the anomaly results.
* Entities can be considered frequent over time or frequent in a population. If
* you are working with both over and by fields, you can set
* exclude_frequent to all for both fields, or to
* by or over for those specific fields.
*
* API name: {@code exclude_frequent}
*/
public final Builder excludeFrequent(@Nullable ExcludeFrequent value) {
this.excludeFrequent = value;
return this;
}
/**
* The field that the detector uses in the function. If you use an event rate
* function such as count or rare, do not specify this field. The
* field_name cannot contain double quotes or backslashes.
*
* API name: {@code field_name}
*/
public final Builder fieldName(@Nullable String value) {
this.fieldName = value;
return this;
}
/**
* The analysis function that is used. For example, count,
* rare, mean, min, max, or
* sum.
*
* API name: {@code function}
*/
public final Builder function(@Nullable String value) {
this.function = value;
return this;
}
/**
* The field used to split the data. In particular, this property is used for
* analyzing the splits with respect to the history of all splits. It is used
* for finding unusual values in the population of all splits.
*
* API name: {@code over_field_name}
*/
public final Builder overFieldName(@Nullable String value) {
this.overFieldName = value;
return this;
}
/**
* The field used to segment the analysis. When you use this property, you have
* completely independent baselines for each value of this field.
*
* API name: {@code partition_field_name}
*/
public final Builder partitionFieldName(@Nullable String value) {
this.partitionFieldName = value;
return this;
}
/**
* Defines whether a new series is used as the null series when there is no
* value for the by or partition fields.
*
* API name: {@code use_null}
*/
public final Builder useNull(@Nullable Boolean value) {
this.useNull = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link Detector}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public Detector build() {
_checkSingleUse();
return new Detector(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link Detector}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new,
Detector::setupDetectorDeserializer);
protected static void setupDetectorDeserializer(ObjectDeserializer op) {
op.add(Builder::byFieldName, JsonpDeserializer.stringDeserializer(), "by_field_name");
op.add(Builder::customRules, JsonpDeserializer.arrayDeserializer(DetectionRule._DESERIALIZER), "custom_rules");
op.add(Builder::detectorDescription, JsonpDeserializer.stringDeserializer(), "detector_description");
op.add(Builder::detectorIndex, JsonpDeserializer.integerDeserializer(), "detector_index");
op.add(Builder::excludeFrequent, ExcludeFrequent._DESERIALIZER, "exclude_frequent");
op.add(Builder::fieldName, JsonpDeserializer.stringDeserializer(), "field_name");
op.add(Builder::function, JsonpDeserializer.stringDeserializer(), "function");
op.add(Builder::overFieldName, JsonpDeserializer.stringDeserializer(), "over_field_name");
op.add(Builder::partitionFieldName, JsonpDeserializer.stringDeserializer(), "partition_field_name");
op.add(Builder::useNull, JsonpDeserializer.booleanDeserializer(), "use_null");
}
}