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

Class JobsRecord.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • id

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

      API name: id

    • state

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

      API name: state

    • openedTime

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

      API name: opened_time

    • assignmentExplanation

      public final JobsRecord.Builder assignmentExplanation(@Nullable String value)
      For open anomaly detection jobs only, contains messages relating to the selection of a node to run the job.

      API name: assignment_explanation

    • dataProcessedRecords

      public final JobsRecord.Builder dataProcessedRecords(@Nullable String value)
      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

      public final JobsRecord.Builder dataProcessedFields(@Nullable String value)
      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

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

      API name: data.input_bytes

    • dataInputRecords

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

      API name: data.input_records

    • dataInputFields

      public final JobsRecord.Builder dataInputFields(@Nullable String value)
      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

      public final JobsRecord.Builder dataInvalidDates(@Nullable String value)
      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

      public final JobsRecord.Builder dataMissingFields(@Nullable String value)
      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

      public final JobsRecord.Builder dataOutOfOrderTimestamps(@Nullable 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. 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

      public final JobsRecord.Builder dataEmptyBuckets(@Nullable String value)
      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

      public final JobsRecord.Builder dataSparseBuckets(@Nullable String value)
      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

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

      API name: data.buckets

    • dataEarliestRecord

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

      API name: data.earliest_record

    • dataLatestRecord

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

      API name: data.latest_record

    • dataLast

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

      API name: data.last

    • dataLastEmptyBucket

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

      API name: data.last_empty_bucket

    • dataLastSparseBucket

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

      API name: data.last_sparse_bucket

    • modelBytes

      public final JobsRecord.Builder modelBytes(@Nullable String value)
      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

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

      API name: model.memory_status

    • modelBytesExceeded

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

      API name: model.bytes_exceeded

    • modelMemoryLimit

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

      API name: model.memory_limit

    • modelByFields

      public final JobsRecord.Builder modelByFields(@Nullable String value)
      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

      public final JobsRecord.Builder modelOverFields(@Nullable String value)
      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

      public final JobsRecord.Builder modelPartitionFields(@Nullable String value)
      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

      public final JobsRecord.Builder modelBucketAllocationFailures(@Nullable String value)
      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

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

      API name: model.categorization_status

    • modelCategorizedDocCount

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

      API name: model.categorized_doc_count

    • modelTotalCategoryCount

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

      API name: model.total_category_count

    • modelFrequentCategoryCount

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

      API name: model.frequent_category_count

    • modelRareCategoryCount

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

      API name: model.rare_category_count

    • modelDeadCategoryCount

      public final JobsRecord.Builder modelDeadCategoryCount(@Nullable 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. Dead categories are a side effect of the way categorization has no prior training.

      API name: model.dead_category_count

    • modelFailedCategoryCount

      public final JobsRecord.Builder modelFailedCategoryCount(@Nullable String value)
      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

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

      API name: model.log_time

    • modelTimestamp

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

      API name: model.timestamp

    • forecastsTotal

      public final JobsRecord.Builder forecastsTotal(@Nullable String value)
      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

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

      API name: forecasts.memory.min

    • forecastsMemoryMax

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

      API name: forecasts.memory.max

    • forecastsMemoryAvg

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

      API name: forecasts.memory.avg

    • forecastsMemoryTotal

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

      API name: forecasts.memory.total

    • forecastsRecordsMin

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

      API name: forecasts.records.min

    • forecastsRecordsMax

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

      API name: forecasts.records.max

    • forecastsRecordsAvg

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

      API name: forecasts.records.avg

    • forecastsRecordsTotal

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

      API name: forecasts.records.total

    • forecastsTimeMin

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

      API name: forecasts.time.min

    • forecastsTimeMax

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

      API name: forecasts.time.max

    • forecastsTimeAvg

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

      API name: forecasts.time.avg

    • forecastsTimeTotal

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

      API name: forecasts.time.total

    • nodeId

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

      API name: node.id

    • nodeName

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

      API name: node.name

    • nodeEphemeralId

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

      API name: node.ephemeral_id

    • nodeAddress

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

      API name: node.address

    • bucketsCount

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

      API name: buckets.count

    • bucketsTimeTotal

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

      API name: buckets.time.total

    • bucketsTimeMin

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

      API name: buckets.time.min

    • bucketsTimeMax

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

      API name: buckets.time.max

    • bucketsTimeExpAvg

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

      API name: buckets.time.exp_avg

    • bucketsTimeExpAvgHour

      public final JobsRecord.Builder bucketsTimeExpAvgHour(@Nullable String value)
      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

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

    • build

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