Class JobsRecord.Builder
- All Implemented Interfaces:
WithJson<JobsRecord.Builder>
,ObjectBuilder<JobsRecord>
- Enclosing class:
- JobsRecord
JobsRecord
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal JobsRecord.Builder
assignmentExplanation
(String value) For open anomaly detection jobs only, contains messages relating to the selection of a node to run the job.final JobsRecord.Builder
bucketsCount
(String value) The number of bucket results produced by the job.final JobsRecord.Builder
bucketsTimeExpAvg
(String value) The exponential moving average of all bucket processing times, in milliseconds.final JobsRecord.Builder
bucketsTimeExpAvgHour
(String value) The exponential moving average of bucket processing times calculated in a one hour time window, in milliseconds.final JobsRecord.Builder
bucketsTimeMax
(String value) The maximum of all bucket processing times, in milliseconds.final JobsRecord.Builder
bucketsTimeMin
(String value) The minimum of all bucket processing times, in milliseconds.final JobsRecord.Builder
bucketsTimeTotal
(String value) The sum of all bucket processing times, in milliseconds.build()
Builds aJobsRecord
.final JobsRecord.Builder
dataBuckets
(String value) The total number of buckets processed.final JobsRecord.Builder
dataEarliestRecord
(String value) The timestamp of the earliest chronologically input document.final JobsRecord.Builder
dataEmptyBuckets
(String value) The number of buckets which did not contain any data.final JobsRecord.Builder
dataInputBytes
(String value) The number of bytes of input data posted to the anomaly detection job.final JobsRecord.Builder
dataInputFields
(String value) The total number of fields in input documents posted to the anomaly detection job.final JobsRecord.Builder
dataInputRecords
(String value) The number of input documents posted to the anomaly detection job.final JobsRecord.Builder
dataInvalidDates
(String value) The number of input documents with either a missing date field or a date that could not be parsed.final JobsRecord.Builder
The timestamp at which data was last analyzed, according to server time.final JobsRecord.Builder
dataLastEmptyBucket
(String value) The timestamp of the last bucket that did not contain any data.final JobsRecord.Builder
dataLastSparseBucket
(String value) The timestamp of the last bucket that was considered sparse.final JobsRecord.Builder
dataLatestRecord
(String value) The timestamp of the latest chronologically input document.final JobsRecord.Builder
dataMissingFields
(String value) The number of input documents that are missing a field that the anomaly detection job is configured to analyze.final JobsRecord.Builder
dataOutOfOrderTimestamps
(String value) The number of input documents that have a timestamp chronologically preceding the start of the current anomaly detection bucket offset by the latency window.final JobsRecord.Builder
dataProcessedFields
(String value) The total number of fields in all the documents that have been processed by the anomaly detection job.final JobsRecord.Builder
dataProcessedRecords
(String value) The number of input documents that have been processed by the anomaly detection job.final JobsRecord.Builder
dataSparseBuckets
(String value) The number of buckets that contained few data points compared to the expected number of data points.final JobsRecord.Builder
forecastsMemoryAvg
(String value) The average memory usage in bytes for forecasts related to the anomaly detection job.final JobsRecord.Builder
forecastsMemoryMax
(String value) The maximum memory usage in bytes for forecasts related to the anomaly detection job.final JobsRecord.Builder
forecastsMemoryMin
(String value) The minimum memory usage in bytes for forecasts related to the anomaly detection job.final JobsRecord.Builder
forecastsMemoryTotal
(String value) The total memory usage in bytes for forecasts related to the anomaly detection job.final JobsRecord.Builder
forecastsRecordsAvg
(String value) The average number ofmodel_forecast
documents written for forecasts related to the anomaly detection job.final JobsRecord.Builder
forecastsRecordsMax
(String value) The maximum number ofmodel_forecast
documents written for forecasts related to the anomaly detection job.final JobsRecord.Builder
forecastsRecordsMin
(String value) The minimum number ofmodel_forecast
documents written for forecasts related to the anomaly detection job.final JobsRecord.Builder
forecastsRecordsTotal
(String value) The total number ofmodel_forecast
documents written for forecasts related to the anomaly detection job.final JobsRecord.Builder
forecastsTimeAvg
(String value) The average runtime in milliseconds for forecasts related to the anomaly detection job.final JobsRecord.Builder
forecastsTimeMax
(String value) The maximum runtime in milliseconds for forecasts related to the anomaly detection job.final JobsRecord.Builder
forecastsTimeMin
(String value) The minimum runtime in milliseconds for forecasts related to the anomaly detection job.final JobsRecord.Builder
forecastsTimeTotal
(String value) The total runtime in milliseconds for forecasts related to the anomaly detection job.final JobsRecord.Builder
forecastsTotal
(String value) The number of individual forecasts currently available for the job.final JobsRecord.Builder
The anomaly detection job identifier.final JobsRecord.Builder
The number of buckets for which new entities in incoming data were not processed due to insufficient model memory.final JobsRecord.Builder
modelByFields
(String value) The number ofby
field values that were analyzed by the models.final JobsRecord.Builder
modelBytes
(String value) The number of bytes of memory used by the models.final JobsRecord.Builder
modelBytesExceeded
(String value) The number of bytes over the high limit for memory usage at the last allocation failure.final JobsRecord.Builder
The status of categorization for the job.final JobsRecord.Builder
modelCategorizedDocCount
(String value) The number of documents that have had a field categorized.final JobsRecord.Builder
modelDeadCategoryCount
(String value) The number of categories created by categorization that will never be assigned again because another category’s definition makes it a superset of the dead category.final JobsRecord.Builder
modelFailedCategoryCount
(String value) The number of times that categorization wanted to create a new category but couldn’t because the job had hit itsmodel_memory_limit
.final JobsRecord.Builder
modelFrequentCategoryCount
(String value) The number of categories that match more than 1% of categorized documents.final JobsRecord.Builder
modelLogTime
(String value) The timestamp when the model stats were gathered, according to server time.final JobsRecord.Builder
modelMemoryLimit
(String value) The upper limit for model memory usage, checked on increasing values.final JobsRecord.Builder
modelMemoryStatus
(MemoryStatus value) The status of the mathematical models.final JobsRecord.Builder
modelOverFields
(String value) The number ofover
field values that were analyzed by the models.final JobsRecord.Builder
modelPartitionFields
(String value) The number ofpartition
field values that were analyzed by the models.final JobsRecord.Builder
modelRareCategoryCount
(String value) The number of categories that match just one categorized document.final JobsRecord.Builder
modelTimestamp
(String value) The timestamp of the last record when the model stats were gathered.final JobsRecord.Builder
modelTotalCategoryCount
(String value) The number of categories created by categorization.final JobsRecord.Builder
nodeAddress
(String value) The network address of the assigned node.final JobsRecord.Builder
nodeEphemeralId
(String value) The ephemeral identifier of the assigned node.final JobsRecord.Builder
The uniqe identifier of the assigned node.final JobsRecord.Builder
The name of the assigned node.final JobsRecord.Builder
openedTime
(String value) For open jobs only, the amount of time the job has been opened.protected JobsRecord.Builder
self()
final JobsRecord.Builder
The status of the anomaly detection job.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
-
id
The anomaly detection job identifier.API name:
id
-
state
The status of the anomaly detection job.API name:
state
-
openedTime
For open jobs only, the amount of time the job has been opened.API name:
opened_time
-
assignmentExplanation
For open anomaly detection jobs only, contains messages relating to the selection of a node to run the job.API name:
assignment_explanation
-
dataProcessedRecords
The number of input documents that have been processed by the anomaly detection job. This value includes documents with missing fields, since they are nonetheless analyzed. If you use datafeeds and have aggregations in your search query, theprocessed_record_count
is the number of aggregation results processed, not the number of Elasticsearch documents.API name:
data.processed_records
-
dataProcessedFields
The total number of fields in all the documents that have been processed by the anomaly detection job. Only fields that are specified in the detector configuration object contribute to this count. The timestamp is not included in this count.API name:
data.processed_fields
-
dataInputBytes
The number of bytes of input data posted to the anomaly detection job.API name:
data.input_bytes
-
dataInputRecords
The number of input documents posted to the anomaly detection job.API name:
data.input_records
-
dataInputFields
The total number of fields in input documents posted to the anomaly detection job. This count includes fields that are not used in the analysis. However, be aware that if you are using a datafeed, it extracts only the required fields from the documents it retrieves before posting them to the job.API name:
data.input_fields
-
dataInvalidDates
The number of input documents with either a missing date field or a date that could not be parsed.API name:
data.invalid_dates
-
dataMissingFields
The number of input documents that are missing a field that the anomaly detection job is configured to analyze. Input documents with missing fields are still processed because it is possible that not all fields are missing. If you are using datafeeds or posting data to the job in JSON format, a highmissing_field_count
is often not an indication of data issues. It is not necessarily a cause for concern.API name:
data.missing_fields
-
dataOutOfOrderTimestamps
The number of input documents that have a timestamp chronologically preceding the start of the current anomaly detection bucket offset by the latency window. This information is applicable only when you provide data to the anomaly detection job by using the post data API. These out of order documents are discarded, since jobs require time series data to be in ascending chronological order.API name:
data.out_of_order_timestamps
-
dataEmptyBuckets
The number of buckets which did not contain any data. If your data contains many empty buckets, consider increasing yourbucket_span
or using functions that are tolerant to gaps in data such as mean,non_null_sum
ornon_zero_count
.API name:
data.empty_buckets
-
dataSparseBuckets
The number of buckets that contained few data points compared to the expected number of data points. If your data contains many sparse buckets, consider using a longerbucket_span
.API name:
data.sparse_buckets
-
dataBuckets
The total number of buckets processed.API name:
data.buckets
-
dataEarliestRecord
The timestamp of the earliest chronologically input document.API name:
data.earliest_record
-
dataLatestRecord
The timestamp of the latest chronologically input document.API name:
data.latest_record
-
dataLast
The timestamp at which data was last analyzed, according to server time.API name:
data.last
-
dataLastEmptyBucket
The timestamp of the last bucket that did not contain any data.API name:
data.last_empty_bucket
-
dataLastSparseBucket
The timestamp of the last bucket that was considered sparse.API name:
data.last_sparse_bucket
-
modelBytes
The number of bytes of memory used by the models. This is the maximum value since the last time the model was persisted. If the job is closed, this value indicates the latest size.API name:
model.bytes
-
modelMemoryStatus
The status of the mathematical models.API name:
model.memory_status
-
modelBytesExceeded
The number of bytes over the high limit for memory usage at the last allocation failure.API name:
model.bytes_exceeded
-
modelMemoryLimit
The upper limit for model memory usage, checked on increasing values.API name:
model.memory_limit
-
modelByFields
The number ofby
field values that were analyzed by the models. This value is cumulative for all detectors in the job.API name:
model.by_fields
-
modelOverFields
The number ofover
field values that were analyzed by the models. This value is cumulative for all detectors in the job.API name:
model.over_fields
-
modelPartitionFields
The number ofpartition
field values that were analyzed by the models. This value is cumulative for all detectors in the job.API name:
model.partition_fields
-
modelBucketAllocationFailures
The number of buckets for which new entities in incoming data were not processed due to insufficient model memory. This situation is also signified by ahard_limit: memory_status
property value.API name:
model.bucket_allocation_failures
-
modelCategorizationStatus
The status of categorization for the job.API name:
model.categorization_status
-
modelCategorizedDocCount
The number of documents that have had a field categorized.API name:
model.categorized_doc_count
-
modelTotalCategoryCount
The number of categories created by categorization.API name:
model.total_category_count
-
modelFrequentCategoryCount
The number of categories that match more than 1% of categorized documents.API name:
model.frequent_category_count
-
modelRareCategoryCount
The number of categories that match just one categorized document.API name:
model.rare_category_count
-
modelDeadCategoryCount
The number of categories created by categorization that will never be assigned again because another category’s definition makes it a superset of the dead category. Dead categories are a side effect of the way categorization has no prior training.API name:
model.dead_category_count
-
modelFailedCategoryCount
The number of times that categorization wanted to create a new category but couldn’t because the job had hit itsmodel_memory_limit
. This count does not track which specific categories failed to be created. Therefore you cannot use this value to determine the number of unique categories that were missed.API name:
model.failed_category_count
-
modelLogTime
The timestamp when the model stats were gathered, according to server time.API name:
model.log_time
-
modelTimestamp
The timestamp of the last record when the model stats were gathered.API name:
model.timestamp
-
forecastsTotal
The number of individual forecasts currently available for the job. A value of one or more indicates that forecasts exist.API name:
forecasts.total
-
forecastsMemoryMin
The minimum memory usage in bytes for forecasts related to the anomaly detection job.API name:
forecasts.memory.min
-
forecastsMemoryMax
The maximum memory usage in bytes for forecasts related to the anomaly detection job.API name:
forecasts.memory.max
-
forecastsMemoryAvg
The average memory usage in bytes for forecasts related to the anomaly detection job.API name:
forecasts.memory.avg
-
forecastsMemoryTotal
The total memory usage in bytes for forecasts related to the anomaly detection job.API name:
forecasts.memory.total
-
forecastsRecordsMin
The minimum number ofmodel_forecast
documents written for forecasts related to the anomaly detection job.API name:
forecasts.records.min
-
forecastsRecordsMax
The maximum number ofmodel_forecast
documents written for forecasts related to the anomaly detection job.API name:
forecasts.records.max
-
forecastsRecordsAvg
The average number ofmodel_forecast
documents written for forecasts related to the anomaly detection job.API name:
forecasts.records.avg
-
forecastsRecordsTotal
The total number ofmodel_forecast
documents written for forecasts related to the anomaly detection job.API name:
forecasts.records.total
-
forecastsTimeMin
The minimum runtime in milliseconds for forecasts related to the anomaly detection job.API name:
forecasts.time.min
-
forecastsTimeMax
The maximum runtime in milliseconds for forecasts related to the anomaly detection job.API name:
forecasts.time.max
-
forecastsTimeAvg
The average runtime in milliseconds for forecasts related to the anomaly detection job.API name:
forecasts.time.avg
-
forecastsTimeTotal
The total runtime in milliseconds for forecasts related to the anomaly detection job.API name:
forecasts.time.total
-
nodeId
The uniqe identifier of the assigned node.API name:
node.id
-
nodeName
The name of the assigned node.API name:
node.name
-
nodeEphemeralId
The ephemeral identifier of the assigned node.API name:
node.ephemeral_id
-
nodeAddress
The network address of the assigned node.API name:
node.address
-
bucketsCount
The number of bucket results produced by the job.API name:
buckets.count
-
bucketsTimeTotal
The sum of all bucket processing times, in milliseconds.API name:
buckets.time.total
-
bucketsTimeMin
The minimum of all bucket processing times, in milliseconds.API name:
buckets.time.min
-
bucketsTimeMax
The maximum of all bucket processing times, in milliseconds.API name:
buckets.time.max
-
bucketsTimeExpAvg
The exponential moving average of all bucket processing times, in milliseconds.API name:
buckets.time.exp_avg
-
bucketsTimeExpAvgHour
The exponential moving average of bucket processing times calculated in a one hour time window, in milliseconds.API name:
buckets.time.exp_avg_hour
-
self
- Specified by:
self
in classWithJsonObjectBuilderBase<JobsRecord.Builder>
-
build
Builds aJobsRecord
.- Specified by:
build
in interfaceObjectBuilder<JobsRecord>
- Throws:
NullPointerException
- if some of the required fields are null.
-