Class DetectorRead
java.lang.Object
co.elastic.clients.elasticsearch.ml.DetectorRead
- All Implemented Interfaces:
JsonpSerializable
- See Also:
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<DetectorRead>
Json deserializer forDetectorRead
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The field used to split the data.final List<DetectionRule>
An array of custom rule objects, which enable you to customize the way detectors operate.final String
A description of the detector.final Integer
A unique identifier for the detector.final ExcludeFrequent
Contains one of the following values:all
,none
,by
, orover
.final String
The field that the detector uses in the function.final String
function()
Required - The analysis function that is used.static DetectorRead
final String
The field used to split the data.final String
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
toString()
final Boolean
useNull()
Defines whether a new series is used as the null series when there is no value for the by or partition fields.
-
Field Details
-
_DESERIALIZER
Json deserializer forDetectorRead
-
-
Method Details
-
of
-
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
An array of custom rule objects, which enable you to customize the way detectors operate. For example, a rule may dictate to the detector conditions under which results should be skipped. Kibana refers to custom rules as job rules.API name:
custom_rules
-
detectorDescription
A description of the detector.API name:
detector_description
-
detectorIndex
A unique identifier for the detector. This identifier is based on the order of the detectors in theanalysis_config
, starting at zero.API name:
detector_index
-
excludeFrequent
Contains one of the following values:all
,none
,by
, orover
. 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, then you can setexclude_frequent
to all for both fields, or toby
orover
for those specific fields.API name:
exclude_frequent
-
fieldName
The field that the detector uses in the function. If you use an event rate function such ascount
orrare
, do not specify this field.API name:
field_name
-
function
Required - The analysis function that is used. For example,count
,rare
,mean
,min
,max
, andsum
.API name:
function
-
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
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
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
-
setupDetectorReadDeserializer
-