Package co.elastic.clients.elasticsearch.ml

Class AnalysisConfigRead.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<AnalysisConfigRead.Builder>
co.elastic.clients.elasticsearch.ml.AnalysisConfigRead.Builder
All Implemented Interfaces:
WithJson<AnalysisConfigRead.Builder>, ObjectBuilder<AnalysisConfigRead>
Enclosing class:
AnalysisConfigRead
public static class AnalysisConfigRead.Builder extends WithJsonObjectBuilderBase<AnalysisConfigRead.Builder> implements ObjectBuilder<AnalysisConfigRead>
Builder for AnalysisConfigRead.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • bucketSpan

      public final AnalysisConfigRead.Builder bucketSpan(Time value)
      Required - The size of the interval that the analysis is aggregated into, typically between 5m and 1h.

      API name: bucket_span

    • bucketSpan

      public final AnalysisConfigRead.Builder bucketSpan(Function<Time.Builder,ObjectBuilder<Time>> fn)
      Required - The size of the interval that the analysis is aggregated into, typically between 5m and 1h.

      API name: bucket_span

    • categorizationAnalyzer

      public final AnalysisConfigRead.Builder categorizationAnalyzer(@Nullable CategorizationAnalyzer value)
      If categorization_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 as categorization_filters. The categorization analyzer specifies how the categorization_field is interpreted by the categorization process.

      API name: categorization_analyzer

    • categorizationAnalyzer

      public final AnalysisConfigRead.Builder categorizationAnalyzer(Function<CategorizationAnalyzer.Builder,ObjectBuilder<CategorizationAnalyzer>> fn)
      If categorization_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 as categorization_filters. The categorization analyzer specifies how the categorization_field is interpreted by the categorization process.

      API name: categorization_analyzer

    • categorizationFieldName

      public final AnalysisConfigRead.Builder categorizationFieldName(@Nullable String value)
      If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting by_field_name, over_field_name, or partition_field_name to the keyword mlcategory.

      API name: categorization_field_name

    • categorizationFilters

      public final AnalysisConfigRead.Builder categorizationFilters(List<String> list)
      If categorization_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 to categorizationFilters.

    • categorizationFilters

      public final AnalysisConfigRead.Builder categorizationFilters(String value, String... values)
      If categorization_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

      public final AnalysisConfigRead.Builder detectors(List<DetectorRead> list)
      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 to detectors.

    • detectors

      public final AnalysisConfigRead.Builder detectors(DetectorRead value, DetectorRead... values)
      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

      public final AnalysisConfigRead.Builder influencers(List<String> list)
      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 to influencers.

    • influencers

      public final AnalysisConfigRead.Builder influencers(String value, String... values)
      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

      public final AnalysisConfigRead.Builder modelPruneWindow(@Nullable Time value)
      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 the bucket_span. If set too low, important information may be removed from the model. Typically, set to 30d 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 of 30d or 20 times bucket_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 the bucket_span. If set too low, important information may be removed from the model. Typically, set to 30d 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 of 30d or 20 times bucket_span.

      API name: model_prune_window

    • latency

      public final AnalysisConfigRead.Builder latency(@Nullable Time value)
      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

      public final AnalysisConfigRead.Builder latency(Function<Time.Builder,ObjectBuilder<Time>> fn)
      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

      public final AnalysisConfigRead.Builder multivariateByFields(@Nullable Boolean value)
      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 to true, 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

      public final AnalysisConfigRead.Builder summaryCountFieldName(@Nullable String value)
      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 same summary_count_field_name applies to all detectors in the job.

      API name: summary_count_field_name

    • self

      protected AnalysisConfigRead.Builder self()
      Specified by:
      self in class WithJsonObjectBuilderBase<AnalysisConfigRead.Builder>

    • build

      public AnalysisConfigRead build()
      Builds a AnalysisConfigRead.
      Specified by:
      build in interface ObjectBuilder<AnalysisConfigRead>
      Throws:
      NullPointerException - if some of the required fields are null.