Class Category.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<Category.Builder>
co.elastic.clients.elasticsearch.ml.Category.Builder
- All Implemented Interfaces:
WithJson<Category.Builder>
,ObjectBuilder<Category>
- Enclosing class:
- Category
public static class Category.Builder
extends WithJsonObjectBuilderBase<Category.Builder>
implements ObjectBuilder<Category>
Builder for
Category
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aCategory
.final Category.Builder
categoryId
(Number value) Required - A unique identifier for the category.final Category.Builder
Required - A list of examples of actual values that matched the category.final Category.Builder
Required - A list of examples of actual values that matched the category.final Category.Builder
grokPattern
(String value) [experimental] A Grok pattern that could be used in Logstash or an ingest pipeline to extract fields from messages that match the category.final Category.Builder
Required - Identifier for the anomaly detection job.final Category.Builder
maxMatchingLength
(Number value) Required - The maximum length of the fields that matched the category.final Category.Builder
mlcategory
(String value) Required - API name:mlcategory
final Category.Builder
numMatches
(Long value) The number of messages that have been matched by this category.final Category.Builder
API name:p
final Category.Builder
partitionFieldName
(String value) If per-partition categorization is enabled, this property identifies the field used to segment the categorization.final Category.Builder
partitionFieldValue
(String value) If per-partition categorization is enabled, this property identifies the value of the partition_field_name for the category.final Category.Builder
preferredToCategories
(String value, String... values) A list of category_id entries that this current category encompasses.final Category.Builder
preferredToCategories
(List<String> list) A list of category_id entries that this current category encompasses.final Category.Builder
Required - A regular expression that is used to search for values that match the category.final Category.Builder
resultType
(String value) Required - API name:result_type
protected Category.Builder
self()
final Category.Builder
Required - A space separated list of the common tokens that are matched in values of the category.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
-
categoryId
Required - A unique identifier for the category. category_id is unique at the job level, even when per-partition categorization is enabled.API name:
category_id
-
examples
Required - A list of examples of actual values that matched the category.API name:
examples
Adds all elements of
list
toexamples
. -
examples
Required - A list of examples of actual values that matched the category.API name:
examples
Adds one or more values to
examples
. -
grokPattern
[experimental] A Grok pattern that could be used in Logstash or an ingest pipeline to extract fields from messages that match the category. This field is experimental and may be changed or removed in a future release. The Grok patterns that are found are not optimal, but are often a good starting point for manual tweaking.API name:
grok_pattern
-
jobId
Required - Identifier for the anomaly detection job.API name:
job_id
-
maxMatchingLength
Required - The maximum length of the fields that matched the category. The value is increased by 10% to enable matching for similar fields that have not been analyzed.API name:
max_matching_length
-
partitionFieldName
If per-partition categorization is enabled, this property identifies the field used to segment the categorization. It is not present when per-partition categorization is disabled.API name:
partition_field_name
-
partitionFieldValue
If per-partition categorization is enabled, this property identifies the value of the partition_field_name for the category. It is not present when per-partition categorization is disabled.API name:
partition_field_value
-
regex
Required - A regular expression that is used to search for values that match the category.API name:
regex
-
terms
Required - A space separated list of the common tokens that are matched in values of the category.API name:
terms
-
numMatches
The number of messages that have been matched by this category. This is only guaranteed to have the latest accurate count after a job _flush or _closeAPI name:
num_matches
-
preferredToCategories
A list of category_id entries that this current category encompasses. Any new message that is processed by the categorizer will match against this category and not any of the categories in this list. This is only guaranteed to have the latest accurate list of categories after a job _flush or _closeAPI name:
preferred_to_categories
Adds all elements of
list
topreferredToCategories
. -
preferredToCategories
A list of category_id entries that this current category encompasses. Any new message that is processed by the categorizer will match against this category and not any of the categories in this list. This is only guaranteed to have the latest accurate list of categories after a job _flush or _closeAPI name:
preferred_to_categories
Adds one or more values to
preferredToCategories
. -
p
API name:p
-
resultType
Required - API name:result_type
-
mlcategory
Required - API name:mlcategory
-
self
- Specified by:
self
in classWithJsonObjectBuilderBase<Category.Builder>
-
build
Builds aCategory
.- Specified by:
build
in interfaceObjectBuilder<Category>
- Throws:
NullPointerException
- if some of the required fields are null.
-