Class DetectorRead
java.lang.Object
co.elastic.clients.elasticsearch.ml.DetectorRead
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class DetectorRead extends java.lang.Object implements JsonpSerializable
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
DetectorRead.Builder
Builder forDetectorRead
. -
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<DetectorRead>
_DESERIALIZER
Json deserializer forDetectorRead
-
Method Summary
Modifier and Type Method Description java.lang.String
byFieldName()
The field used to split the data.java.util.List<DetectionRule>
customRules()
Custom rules enable you to customize the way detectors operate.java.lang.String
detectorDescription()
A description of the detector.java.lang.Integer
detectorIndex()
A unique identifier for the detector.ExcludeFrequent
excludeFrequent()
If set, frequent entities are excluded from influencing the anomaly results.java.lang.String
fieldName()
The field that the detector uses in the function.java.lang.String
function()
Required - The analysis function that is used.static DetectorRead
of(java.util.function.Function<DetectorRead.Builder,ObjectBuilder<DetectorRead>> fn)
java.lang.String
overFieldName()
The field used to split the data.java.lang.String
partitionFieldName()
The field used to segment the analysis.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
setupDetectorReadDeserializer(ObjectDeserializer<DetectorRead.Builder> op)
java.lang.String
toString()
java.lang.Boolean
useNull()
Defines whether a new series is used as the null series when there is no value for the by or partition fields.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forDetectorRead
-
-
Method Details
-
of
public static DetectorRead of(java.util.function.Function<DetectorRead.Builder,ObjectBuilder<DetectorRead>> fn) -
byFieldName
@Nullable public final java.lang.String byFieldName()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:
by_field_name
-
customRules
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:
custom_rules
-
detectorDescription
@Nullable public final java.lang.String detectorDescription()A description of the detector.API name:
detector_description
-
detectorIndex
@Nullable public final java.lang.Integer detectorIndex()A unique identifier for the detector. This identifier is based on the order of the detectors in theanalysis_config
, starting at zero. If you specify a value for this property, it is ignored.API name:
detector_index
-
excludeFrequent
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 setexclude_frequent
toall
for both fields, or toby
orover
for those specific fields.API name:
exclude_frequent
-
fieldName
@Nullable public final java.lang.String fieldName()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. Thefield_name
cannot contain double quotes or backslashes.API name:
field_name
-
function
public final java.lang.String function()Required - The analysis function that is used. For example,count
,rare
,mean
,min
,max
, orsum
.API name:
function
-
overFieldName
@Nullable public final java.lang.String overFieldName()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:
over_field_name
-
partitionFieldName
@Nullable public final java.lang.String partitionFieldName()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:
partition_field_name
-
useNull
@Nullable public final java.lang.Boolean useNull()Defines whether a new series is used as the null series when there is no value for the by or partition fields.API name:
use_null
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-
setupDetectorReadDeserializer
-