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:
org.elasticsearch.common.io.stream.Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, org.elasticsearch.tasks.TaskAwareRequest

public class GetOverallBucketsRequest
extends org.elasticsearch.action.ActionRequest
implements org.elasticsearch.common.xcontent.ToXContentObject
A request to retrieve overall buckets of set of jobs
  • Nested Class Summary

    Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

    org.elasticsearch.transport.TransportRequest.Empty

    Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

    Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

    org.elasticsearch.common.io.stream.Writeable.Reader<V extends java.lang.Object>, org.elasticsearch.common.io.stream.Writeable.Writer<V extends java.lang.Object>
  • Field Summary

    Fields 
    Modifier and Type Field Description
    static org.elasticsearch.common.ParseField ALLOW_NO_JOBS  
    static org.elasticsearch.common.ParseField BUCKET_SPAN  
    static org.elasticsearch.common.ParseField END  
    static org.elasticsearch.common.ParseField EXCLUDE_INTERIM  
    static org.elasticsearch.common.ParseField OVERALL_SCORE  
    static org.elasticsearch.common.xcontent.ConstructingObjectParser<GetOverallBucketsRequest,​java.lang.Void> PARSER  
    static org.elasticsearch.common.ParseField START  
    static org.elasticsearch.common.ParseField TOP_N  

    Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

    EMPTY_PARAMS
  • Constructor Summary

    Constructors 
    Constructor Description
    GetOverallBucketsRequest​(java.lang.String... jobIds)
    Constructs a request to retrieve overall buckets for a set of jobs
    GetOverallBucketsRequest​(java.util.List<java.lang.String> jobIds)
    Constructs a request to retrieve overall buckets for a set of jobs
  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object obj)  
    java.lang.Boolean getAllowNoJobs()
    Whether to ignore if a wildcard expression matches no jobs.
    org.elasticsearch.common.unit.TimeValue getBucketSpan()  
    java.lang.String getEnd()  
    java.util.List<java.lang.String> getJobIds()  
    java.lang.Double getOverallScore()  
    java.lang.String getStart()  
    java.lang.Integer getTopN()  
    int hashCode()  
    boolean isExcludeInterim()  
    void setAllowNoJobs​(boolean allowNoJobs)
    void setBucketSpan​(org.elasticsearch.common.unit.TimeValue bucketSpan)
    Sets the value of "bucket_span".
    void setEnd​(java.lang.String end)
    Sets the value of "end" which is a timestamp.
    void setExcludeInterim​(java.lang.Boolean excludeInterim)
    Sets the value of "exclude_interim".
    void setOverallScore​(double overallScore)
    Sets the value of "overall_score".
    void setStart​(java.lang.String start)
    Sets the value of "start" which is a timestamp.
    void setTopN​(java.lang.Integer topN)
    Sets the value of "top_n".
    org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)  
    org.elasticsearch.action.ActionRequestValidationException validate()  

    Methods inherited from class org.elasticsearch.action.ActionRequest

    getShouldStoreResult, writeTo

    Methods inherited from class org.elasticsearch.transport.TransportRequest

    getParentTask, setParentTask

    Methods inherited from class org.elasticsearch.transport.TransportMessage

    remoteAddress, remoteAddress

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

    createTask, getDescription, setParentTask

    Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

    isFragment
  • Field Details

    • TOP_N

      public static final org.elasticsearch.common.ParseField TOP_N
    • BUCKET_SPAN

      public static final org.elasticsearch.common.ParseField BUCKET_SPAN
    • OVERALL_SCORE

      public static final org.elasticsearch.common.ParseField OVERALL_SCORE
    • EXCLUDE_INTERIM

      public static final org.elasticsearch.common.ParseField EXCLUDE_INTERIM
    • START

      public static final org.elasticsearch.common.ParseField START
    • END

      public static final org.elasticsearch.common.ParseField END
    • ALLOW_NO_JOBS

      public static final org.elasticsearch.common.ParseField ALLOW_NO_JOBS
    • PARSER

      public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<GetOverallBucketsRequest,​java.lang.Void> PARSER
  • 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 org.elasticsearch.common.unit.TimeValue getBucketSpan()
    • setBucketSpan

      public void setBucketSpan​(org.elasticsearch.common.unit.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)
      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 org.elasticsearch.action.ActionRequestValidationException validate()
      Specified by:
      validate in class org.elasticsearch.action.ActionRequest
    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.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