Class DetectorRead.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<DetectorRead.Builder>
co.elastic.clients.elasticsearch.ml.DetectorRead.Builder
- All Implemented Interfaces:
WithJson<DetectorRead.Builder>
,ObjectBuilder<DetectorRead>
- Enclosing class:
- DetectorRead
public static class DetectorRead.Builder
extends WithJsonObjectBuilderBase<DetectorRead.Builder>
implements ObjectBuilder<DetectorRead>
Builder for
DetectorRead
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aDetectorRead
.final DetectorRead.Builder
byFieldName
(String value) The field used to split the data.final DetectorRead.Builder
customRules
(DetectionRule value, DetectionRule... values) An array of custom rule objects, which enable you to customize the way detectors operate.final DetectorRead.Builder
An array of custom rule objects, which enable you to customize the way detectors operate.final DetectorRead.Builder
customRules
(List<DetectionRule> list) An array of custom rule objects, which enable you to customize the way detectors operate.final DetectorRead.Builder
detectorDescription
(String value) A description of the detector.final DetectorRead.Builder
detectorIndex
(Integer value) A unique identifier for the detector.final DetectorRead.Builder
excludeFrequent
(ExcludeFrequent value) Contains one of the following values:all
,none
,by
, orover
.final DetectorRead.Builder
The field that the detector uses in the function.final DetectorRead.Builder
Required - The analysis function that is used.final DetectorRead.Builder
overFieldName
(String value) The field used to split the data.final DetectorRead.Builder
partitionFieldName
(String value) The field used to segment the analysis.protected DetectorRead.Builder
self()
final DetectorRead.Builder
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 co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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
Adds all elements of
list
tocustomRules
. -
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
Adds one or more values to
customRules
. -
customRules
public final DetectorRead.Builder customRules(Function<DetectionRule.Builder, ObjectBuilder<DetectionRule>> fn) 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
Adds a value to
customRules
using a builder lambda. -
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
-
self
- Specified by:
self
in classWithJsonObjectBuilderBase<DetectorRead.Builder>
-
build
Builds aDetectorRead
.- Specified by:
build
in interfaceObjectBuilder<DetectorRead>
- Throws:
NullPointerException
- if some of the required fields are null.
-