Package org.elasticsearch.client.ml

Class GetOverallBucketsRequest

java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.client.ml.GetOverallBucketsRequest
All Implemented Interfaces:
Writeable, ToXContent, ToXContentObject, TaskAwareRequest
public class GetOverallBucketsRequest
extends ActionRequest
implements ToXContentObject
A request to retrieve overall buckets of set of jobs

  • Field Details

  • Constructor Details

    • GetOverallBucketsRequest

      public GetOverallBucketsRequest​(java.lang.String... jobIds)
      Constructs a request to retrieve overall buckets for a set of jobs
      Parameters:
      jobIds - The job identifiers. Each can be a job identifier, a group name, or a wildcard expression.

    • GetOverallBucketsRequest

      public GetOverallBucketsRequest​(java.util.List<java.lang.String> jobIds)
      Constructs a request to retrieve overall buckets for a set of jobs
      Parameters:
      jobIds - The job identifiers. Each can be a job identifier, a group name, or a wildcard expression.

  • Method Details

    • getJobIds

      public java.util.List<java.lang.String> getJobIds()

    • getTopN

      public java.lang.Integer getTopN()

    • setTopN

      public void setTopN​(java.lang.Integer topN)
      Sets the value of "top_n".
      Parameters:
      topN - The number of top job bucket scores to be used in the overall_score calculation. Defaults to 1.

    • getBucketSpan

      public TimeValue getBucketSpan()

    • setBucketSpan

      public void setBucketSpan​(TimeValue bucketSpan)
      Sets the value of "bucket_span".
      Parameters:
      bucketSpan - The span of the overall buckets. Must be greater or equal to the largest job’s bucket_span. Defaults to the largest job’s bucket_span.

    • isExcludeInterim

      public boolean isExcludeInterim()

    • setExcludeInterim

      public void setExcludeInterim​(java.lang.Boolean excludeInterim)
      Sets the value of "exclude_interim". When true, interim overall buckets will be filtered out. Overall buckets are interim if any of the job buckets within the overall bucket interval are interim.
      Parameters:
      excludeInterim - value of "exclude_interim" to be set

    • getStart

      public java.lang.String getStart()

    • setStart

      public void setStart​(java.lang.String start)
      Sets the value of "start" which is a timestamp. Only overall buckets whose timestamp is on or after the "start" value will be returned.
      Parameters:
      start - String representation of a timestamp; may be an epoch seconds, epoch millis or an ISO string

    • getEnd

      public java.lang.String getEnd()

    • setEnd

      public void setEnd​(java.lang.String end)
      Sets the value of "end" which is a timestamp. Only overall buckets whose timestamp is before the "end" value will be returned.
      Parameters:
      end - String representation of a timestamp; may be an epoch seconds, epoch millis or an ISO string

    • getOverallScore

      public java.lang.Double getOverallScore()

    • setOverallScore

      public void setOverallScore​(double overallScore)
      Sets the value of "overall_score". Only buckets with "overall_score" equal or greater will be returned.
      Parameters:
      overallScore - value of "anomaly_score".

    • setAllowNoJobs

      public void setAllowNoJobs​(boolean allowNoJobs)
      See GetJobRequest.getAllowNoJobs()
      Parameters:
      allowNoJobs - value of "allow_no_jobs".

    • getAllowNoJobs

      public java.lang.Boolean getAllowNoJobs()
      Whether to ignore if a wildcard expression matches no jobs. If this is false, then an error is returned when a wildcard (or _all) does not match any jobs

    • validate

      public ActionRequestValidationException validate()
      Specified by:
      validate in class ActionRequest

    • toXContent

      public XContentBuilder toXContent​(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface ToXContent
      Throws:
      java.io.IOException

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • equals

      public boolean equals​(java.lang.Object obj)
      Overrides:
      equals in class java.lang.Object