Class Category.Builder
java.lang.Object
co.elastic.clients.elasticsearch.ml.Category.Builder
- All Implemented Interfaces:
ObjectBuilder<Category>
- Enclosing class:
- Category
public static class Category.Builder extends java.lang.Object implements ObjectBuilder<Category>
Builder for
Category
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description Category.Builder
addExamples(java.lang.String value)
Add a value toexamples(List)
, creating the list if needed.Category.Builder
addPreferredToCategories(java.lang.String value)
Add a value topreferredToCategories(List)
, creating the list if needed.Category
build()
Builds aCategory
.Category.Builder
categoryId(java.lang.Number value)
Required - A unique identifier for the category.Category.Builder
examples(java.lang.String... value)
Required - A list of examples of actual values that matched the category.Category.Builder
examples(java.util.List<java.lang.String> value)
Required - A list of examples of actual values that matched the category.Category.Builder
grokPattern(java.lang.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.Category.Builder
jobId(java.lang.String value)
Required - Identifier for the anomaly detection job.Category.Builder
maxMatchingLength(java.lang.Number value)
Required - The maximum length of the fields that matched the category.Category.Builder
mlcategory(java.lang.String value)
Required - API name:mlcategory
Category.Builder
numMatches(java.lang.Long value)
The number of messages that have been matched by this category.Category.Builder
p(java.lang.String value)
API name:p
Category.Builder
partitionFieldName(java.lang.String value)
If per-partition categorization is enabled, this property identifies the field used to segment the categorization.Category.Builder
partitionFieldValue(java.lang.String value)
If per-partition categorization is enabled, this property identifies the value of the partition_field_name for the category.Category.Builder
preferredToCategories(java.lang.String... value)
A list of category_id entries that this current category encompasses.Category.Builder
preferredToCategories(java.util.List<java.lang.String> value)
A list of category_id entries that this current category encompasses.Category.Builder
regex(java.lang.String value)
Required - A regular expression that is used to search for values that match the category.Category.Builder
resultType(java.lang.String value)
Required - API name:result_type
Category.Builder
terms(java.lang.String value)
Required - A space separated list of the common tokens that are matched in values of the category.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
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
-
examples
Required - A list of examples of actual values that matched the category.API name:
examples
-
addExamples
Add a value toexamples(List)
, creating the list if needed. -
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
-
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
-
addPreferredToCategories
Add a value topreferredToCategories(List)
, creating the list if needed. -
p
API name:p
-
resultType
Required - API name:result_type
-
mlcategory
Required - API name:mlcategory
-
build
Builds aCategory
.- Specified by:
build
in interfaceObjectBuilder<Category>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-