Class AnalysisConfigRead.Builder
- All Implemented Interfaces:
WithJson<AnalysisConfigRead.Builder>
,ObjectBuilder<AnalysisConfigRead>
- Enclosing class:
- AnalysisConfigRead
AnalysisConfigRead
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbucketSpan
(Time value) Required - The size of the interval that the analysis is aggregated into, typically between5m
and1h
.Required - The size of the interval that the analysis is aggregated into, typically between5m
and1h
.build()
Builds aAnalysisConfigRead
.Ifcategorization_field_name
is specified, you can also define the analyzer that is used to interpret the categorization field.categorizationAnalyzer
(Function<CategorizationAnalyzer.Builder, ObjectBuilder<CategorizationAnalyzer>> fn) Ifcategorization_field_name
is specified, you can also define the analyzer that is used to interpret the categorization field.categorizationFieldName
(String value) If this property is specified, the values of the specified field will be categorized.categorizationFilters
(String value, String... values) Ifcategorization_field_name
is specified, you can also define optional filters.categorizationFilters
(List<String> list) Ifcategorization_field_name
is specified, you can also define optional filters.detectors
(DetectorRead value, DetectorRead... values) Required - An array of detector configuration objects.Required - An array of detector configuration objects.detectors
(List<DetectorRead> list) Required - An array of detector configuration objects.influencers
(String value, String... values) Required - A comma separated list of influencer field names.influencers
(List<String> list) Required - A comma separated list of influencer field names.The size of the window in which to expect data that is out of time order.The size of the window in which to expect data that is out of time order.modelPruneWindow
(Time value) Advanced configuration option.Advanced configuration option.multivariateByFields
(Boolean value) This functionality is reserved for internal use.Settings related to how categorization interacts with partition fields.perPartitionCategorization
(Function<PerPartitionCategorization.Builder, ObjectBuilder<PerPartitionCategorization>> fn) Settings related to how categorization interacts with partition fields.protected AnalysisConfigRead.Builder
self()
summaryCountFieldName
(String value) If this property is specified, the data that is fed to the job is expected to be pre-summarized.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
-
bucketSpan
Required - The size of the interval that the analysis is aggregated into, typically between5m
and1h
.API name:
bucket_span
-
bucketSpan
Required - The size of the interval that the analysis is aggregated into, typically between5m
and1h
.API name:
bucket_span
-
categorizationAnalyzer
public final AnalysisConfigRead.Builder categorizationAnalyzer(@Nullable CategorizationAnalyzer value) Ifcategorization_field_name
is specified, you can also define the analyzer that is used to interpret the categorization field. This property cannot be used at the same time ascategorization_filters
. The categorization analyzer specifies how thecategorization_field
is interpreted by the categorization process.API name:
categorization_analyzer
-
categorizationAnalyzer
public final AnalysisConfigRead.Builder categorizationAnalyzer(Function<CategorizationAnalyzer.Builder, ObjectBuilder<CategorizationAnalyzer>> fn) Ifcategorization_field_name
is specified, you can also define the analyzer that is used to interpret the categorization field. This property cannot be used at the same time ascategorization_filters
. The categorization analyzer specifies how thecategorization_field
is interpreted by the categorization process.API name:
categorization_analyzer
-
categorizationFieldName
If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by settingby_field_name
,over_field_name
, orpartition_field_name
to the keywordmlcategory
.API name:
categorization_field_name
-
categorizationFilters
Ifcategorization_field_name
is specified, you can also define optional filters. This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values.API name:
categorization_filters
Adds all elements of
list
tocategorizationFilters
. -
categorizationFilters
Ifcategorization_field_name
is specified, you can also define optional filters. This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values.API name:
categorization_filters
Adds one or more values to
categorizationFilters
. -
detectors
Required - An array of detector configuration objects. Detector configuration objects specify which data fields a job analyzes. They also specify which analytical functions are used. You can specify multiple detectors for a job.API name:
detectors
Adds all elements of
list
todetectors
. -
detectors
Required - An array of detector configuration objects. Detector configuration objects specify which data fields a job analyzes. They also specify which analytical functions are used. You can specify multiple detectors for a job.API name:
detectors
Adds one or more values to
detectors
. -
detectors
public final AnalysisConfigRead.Builder detectors(Function<DetectorRead.Builder, ObjectBuilder<DetectorRead>> fn) Required - An array of detector configuration objects. Detector configuration objects specify which data fields a job analyzes. They also specify which analytical functions are used. You can specify multiple detectors for a job.API name:
detectors
Adds a value to
detectors
using a builder lambda. -
influencers
Required - A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration. You might also want to use a field name that is not specifically named in a detector, but is available as part of the input data. When you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity.API name:
influencers
Adds all elements of
list
toinfluencers
. -
influencers
Required - A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration. You might also want to use a field name that is not specifically named in a detector, but is available as part of the input data. When you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity.API name:
influencers
Adds one or more values to
influencers
. -
modelPruneWindow
Advanced configuration option. Affects the pruning of models that have not been updated for the given time duration. The value must be set to a multiple of thebucket_span
. If set too low, important information may be removed from the model. Typically, set to30d
or longer. If not set, model pruning only occurs if the model memory status reaches the soft limit or the hard limit. For jobs created in 8.1 and later, the default value is the greater of30d
or 20 timesbucket_span
.API name:
model_prune_window
-
modelPruneWindow
public final AnalysisConfigRead.Builder modelPruneWindow(Function<Time.Builder, ObjectBuilder<Time>> fn) Advanced configuration option. Affects the pruning of models that have not been updated for the given time duration. The value must be set to a multiple of thebucket_span
. If set too low, important information may be removed from the model. Typically, set to30d
or longer. If not set, model pruning only occurs if the model memory status reaches the soft limit or the hard limit. For jobs created in 8.1 and later, the default value is the greater of30d
or 20 timesbucket_span
.API name:
model_prune_window
-
latency
The size of the window in which to expect data that is out of time order. Defaults to no latency. If you specify a non-zero value, it must be greater than or equal to one second.API name:
latency
-
latency
The size of the window in which to expect data that is out of time order. Defaults to no latency. If you specify a non-zero value, it must be greater than or equal to one second.API name:
latency
-
multivariateByFields
This functionality is reserved for internal use. It is not supported for use in customer environments and is not subject to the support SLA of official GA features. If set totrue
, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold.API name:
multivariate_by_fields
-
perPartitionCategorization
public final AnalysisConfigRead.Builder perPartitionCategorization(@Nullable PerPartitionCategorization value) Settings related to how categorization interacts with partition fields.API name:
per_partition_categorization
-
perPartitionCategorization
public final AnalysisConfigRead.Builder perPartitionCategorization(Function<PerPartitionCategorization.Builder, ObjectBuilder<PerPartitionCategorization>> fn) Settings related to how categorization interacts with partition fields.API name:
per_partition_categorization
-
summaryCountFieldName
If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The samesummary_count_field_name
applies to all detectors in the job.API name:
summary_count_field_name
-
self
- Specified by:
self
in classWithJsonObjectBuilderBase<AnalysisConfigRead.Builder>
-
build
Builds aAnalysisConfigRead
.- Specified by:
build
in interfaceObjectBuilder<AnalysisConfigRead>
- Throws:
NullPointerException
- if some of the required fields are null.
-