Package co.elastic.clients.elasticsearch.cat.ml_jobs

Class JobsRecord

java.lang.Object
co.elastic.clients.elasticsearch.cat.ml_jobs.JobsRecord
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class JobsRecord extends Object implements JsonpSerializable
See Also:

  • Field Details

  • Method Details

    • of

      public static JobsRecord of(Function<JobsRecord.Builder,ObjectBuilder<JobsRecord>> fn)

    • id

      @Nullable public final String id()
      The anomaly detection job identifier.

      API name: id

    • state

      @Nullable public final JobState state()
      The status of the anomaly detection job.

      API name: state

    • openedTime

      @Nullable public final String openedTime()
      For open jobs only, the amount of time the job has been opened.

      API name: opened_time

    • assignmentExplanation

      @Nullable public final String 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

      @Nullable public final String 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, the processed_record_count is the number of aggregation results processed, not the number of Elasticsearch documents.

      API name: data.processed_records

    • dataProcessedFields

      @Nullable public final String 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

      @Nullable public final String dataInputBytes()
      The number of bytes of input data posted to the anomaly detection job.

      API name: data.input_bytes

    • dataInputRecords

      @Nullable public final String dataInputRecords()
      The number of input documents posted to the anomaly detection job.

      API name: data.input_records

    • dataInputFields

      @Nullable public final String 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

      @Nullable public final String 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

      @Nullable public final String 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 high missing_field_count is often not an indication of data issues. It is not necessarily a cause for concern.

      API name: data.missing_fields

    • dataOutOfOrderTimestamps

      @Nullable public final String 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

      @Nullable public final String dataEmptyBuckets()
      The number of buckets which did not contain any data. If your data contains many empty buckets, consider increasing your bucket_span or using functions that are tolerant to gaps in data such as mean, non_null_sum or non_zero_count.

      API name: data.empty_buckets

    • dataSparseBuckets

      @Nullable public final String 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 longer bucket_span.

      API name: data.sparse_buckets

    • dataBuckets

      @Nullable public final String dataBuckets()
      The total number of buckets processed.

      API name: data.buckets

    • dataEarliestRecord

      @Nullable public final String dataEarliestRecord()
      The timestamp of the earliest chronologically input document.

      API name: data.earliest_record

    • dataLatestRecord

      @Nullable public final String dataLatestRecord()
      The timestamp of the latest chronologically input document.

      API name: data.latest_record

    • dataLast

      @Nullable public final String dataLast()
      The timestamp at which data was last analyzed, according to server time.

      API name: data.last

    • dataLastEmptyBucket

      @Nullable public final String dataLastEmptyBucket()
      The timestamp of the last bucket that did not contain any data.

      API name: data.last_empty_bucket

    • dataLastSparseBucket

      @Nullable public final String dataLastSparseBucket()
      The timestamp of the last bucket that was considered sparse.

      API name: data.last_sparse_bucket

    • modelBytes

      @Nullable public final String 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

      @Nullable public final MemoryStatus modelMemoryStatus()
      The status of the mathematical models.

      API name: model.memory_status

    • modelBytesExceeded

      @Nullable public final String modelBytesExceeded()
      The number of bytes over the high limit for memory usage at the last allocation failure.

      API name: model.bytes_exceeded

    • modelMemoryLimit

      @Nullable public final String modelMemoryLimit()
      The upper limit for model memory usage, checked on increasing values.

      API name: model.memory_limit

    • modelByFields

      @Nullable public final String modelByFields()
      The number of by field values that were analyzed by the models. This value is cumulative for all detectors in the job.

      API name: model.by_fields

    • modelOverFields

      @Nullable public final String modelOverFields()
      The number of over field values that were analyzed by the models. This value is cumulative for all detectors in the job.

      API name: model.over_fields

    • modelPartitionFields

      @Nullable public final String modelPartitionFields()
      The number of partition field values that were analyzed by the models. This value is cumulative for all detectors in the job.

      API name: model.partition_fields

    • modelBucketAllocationFailures

      @Nullable public final String 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 a hard_limit: memory_status property value.

      API name: model.bucket_allocation_failures

    • modelCategorizationStatus

      @Nullable public final CategorizationStatus modelCategorizationStatus()
      The status of categorization for the job.

      API name: model.categorization_status

    • modelCategorizedDocCount

      @Nullable public final String modelCategorizedDocCount()
      The number of documents that have had a field categorized.

      API name: model.categorized_doc_count

    • modelTotalCategoryCount

      @Nullable public final String modelTotalCategoryCount()
      The number of categories created by categorization.

      API name: model.total_category_count

    • modelFrequentCategoryCount

      @Nullable public final String modelFrequentCategoryCount()
      The number of categories that match more than 1% of categorized documents.

      API name: model.frequent_category_count

    • modelRareCategoryCount

      @Nullable public final String modelRareCategoryCount()
      The number of categories that match just one categorized document.

      API name: model.rare_category_count

    • modelDeadCategoryCount

      @Nullable public final String 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

      @Nullable public final String modelFailedCategoryCount()
      The number of times that categorization wanted to create a new category but couldn’t because the job had hit its model_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

      @Nullable public final String modelLogTime()
      The timestamp when the model stats were gathered, according to server time.

      API name: model.log_time

    • modelTimestamp

      @Nullable public final String modelTimestamp()
      The timestamp of the last record when the model stats were gathered.

      API name: model.timestamp

    • forecastsTotal

      @Nullable public final String 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

      @Nullable public final String forecastsMemoryMin()
      The minimum memory usage in bytes for forecasts related to the anomaly detection job.

      API name: forecasts.memory.min

    • forecastsMemoryMax

      @Nullable public final String forecastsMemoryMax()
      The maximum memory usage in bytes for forecasts related to the anomaly detection job.

      API name: forecasts.memory.max

    • forecastsMemoryAvg

      @Nullable public final String forecastsMemoryAvg()
      The average memory usage in bytes for forecasts related to the anomaly detection job.

      API name: forecasts.memory.avg

    • forecastsMemoryTotal

      @Nullable public final String forecastsMemoryTotal()
      The total memory usage in bytes for forecasts related to the anomaly detection job.

      API name: forecasts.memory.total

    • forecastsRecordsMin

      @Nullable public final String forecastsRecordsMin()
      The minimum number of model_forecast documents written for forecasts related to the anomaly detection job.

      API name: forecasts.records.min

    • forecastsRecordsMax

      @Nullable public final String forecastsRecordsMax()
      The maximum number of model_forecast documents written for forecasts related to the anomaly detection job.

      API name: forecasts.records.max

    • forecastsRecordsAvg

      @Nullable public final String forecastsRecordsAvg()
      The average number of model_forecast documents written for forecasts related to the anomaly detection job.

      API name: forecasts.records.avg

    • forecastsRecordsTotal

      @Nullable public final String forecastsRecordsTotal()
      The total number of model_forecast documents written for forecasts related to the anomaly detection job.

      API name: forecasts.records.total

    • forecastsTimeMin

      @Nullable public final String forecastsTimeMin()
      The minimum runtime in milliseconds for forecasts related to the anomaly detection job.

      API name: forecasts.time.min

    • forecastsTimeMax

      @Nullable public final String forecastsTimeMax()
      The maximum runtime in milliseconds for forecasts related to the anomaly detection job.

      API name: forecasts.time.max

    • forecastsTimeAvg

      @Nullable public final String forecastsTimeAvg()
      The average runtime in milliseconds for forecasts related to the anomaly detection job.

      API name: forecasts.time.avg

    • forecastsTimeTotal

      @Nullable public final String forecastsTimeTotal()
      The total runtime in milliseconds for forecasts related to the anomaly detection job.

      API name: forecasts.time.total

    • nodeId

      @Nullable public final String nodeId()
      The uniqe identifier of the assigned node.

      API name: node.id

    • nodeName

      @Nullable public final String nodeName()
      The name of the assigned node.

      API name: node.name

    • nodeEphemeralId

      @Nullable public final String nodeEphemeralId()
      The ephemeral identifier of the assigned node.

      API name: node.ephemeral_id

    • nodeAddress

      @Nullable public final String nodeAddress()
      The network address of the assigned node.

      API name: node.address

    • bucketsCount

      @Nullable public final String bucketsCount()
      The number of bucket results produced by the job.

      API name: buckets.count

    • bucketsTimeTotal

      @Nullable public final String bucketsTimeTotal()
      The sum of all bucket processing times, in milliseconds.

      API name: buckets.time.total

    • bucketsTimeMin

      @Nullable public final String bucketsTimeMin()
      The minimum of all bucket processing times, in milliseconds.

      API name: buckets.time.min

    • bucketsTimeMax

      @Nullable public final String bucketsTimeMax()
      The maximum of all bucket processing times, in milliseconds.

      API name: buckets.time.max

    • bucketsTimeExpAvg

      @Nullable public final String bucketsTimeExpAvg()
      The exponential moving average of all bucket processing times, in milliseconds.

      API name: buckets.time.exp_avg

    • bucketsTimeExpAvgHour

      @Nullable public final String 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

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setupJobsRecordDeserializer

      protected static void setupJobsRecordDeserializer(ObjectDeserializer<JobsRecord.Builder> op)