Package org.elasticsearch.client.ml

Class GetBucketsRequest

java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.client.ml.GetBucketsRequest
All Implemented Interfaces:
org.elasticsearch.common.io.stream.Writeable, org.elasticsearch.common.util.concurrent.RefCounted, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, org.elasticsearch.tasks.TaskAwareRequest
public class GetBucketsRequest
extends org.elasticsearch.action.ActionRequest
implements org.elasticsearch.common.xcontent.ToXContentObject
A request to retrieve buckets of a given job

  • 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 ANOMALY_SCORE  
    static org.elasticsearch.common.ParseField DESCENDING  
    static org.elasticsearch.common.ParseField END  
    static org.elasticsearch.common.ParseField EXCLUDE_INTERIM  
    static org.elasticsearch.common.ParseField EXPAND  
    static org.elasticsearch.common.xcontent.ObjectParser<GetBucketsRequest,​java.lang.Void> PARSER  
    static org.elasticsearch.common.ParseField SORT  
    static org.elasticsearch.common.ParseField START  

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

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor Description
    GetBucketsRequest​(java.lang.String jobId)
    Constructs a request to retrieve buckets of a given job

  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object obj)  
    java.lang.Double getAnomalyScore()  
    java.lang.Boolean getDescending()  
    java.lang.String getEnd()  
    java.lang.Boolean getExcludeInterim()  
    java.lang.String getJobId()  
    PageParams getPageParams()  
    java.lang.String getSort()  
    java.lang.String getStart()  
    java.lang.String getTimestamp()  
    int hashCode()  
    boolean isExpand()  
    void setAnomalyScore​(java.lang.Double anomalyScore)
    Sets the value of "anomaly_score".
    void setDescending​(boolean descending)
    Sets the value of "desc".
    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 setExpand​(java.lang.Boolean expand)
    Sets the value of "expand".
    void setPageParams​(PageParams pageParams)
    Sets the paging parameters
    void setSort​(java.lang.String sort)
    Sets the value of "sort".
    void setStart​(java.lang.String start)
    Sets the value of "start" which is a timestamp.
    void setTimestamp​(java.lang.String timestamp)
    Sets the timestamp of a specific bucket to be retrieved.
    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

    decRef, incRef, remoteAddress, remoteAddress, tryIncRef

    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

    • EXPAND

      public static final org.elasticsearch.common.ParseField EXPAND

    • 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

    • ANOMALY_SCORE

      public static final org.elasticsearch.common.ParseField ANOMALY_SCORE

    • SORT

      public static final org.elasticsearch.common.ParseField SORT

    • DESCENDING

      public static final org.elasticsearch.common.ParseField DESCENDING

    • PARSER

      public static final org.elasticsearch.common.xcontent.ObjectParser<GetBucketsRequest,​java.lang.Void> PARSER

  • Constructor Details

    • GetBucketsRequest

      public GetBucketsRequest​(java.lang.String jobId)
      Constructs a request to retrieve buckets of a given job
      Parameters:
      jobId - id of the job to retrieve buckets of

  • Method Details

    • getJobId

      public java.lang.String getJobId()

    • setTimestamp

      public void setTimestamp​(java.lang.String timestamp)
      Sets the timestamp of a specific bucket to be retrieved.
      Parameters:
      timestamp - String representation of a timestamp; may be an epoch seconds, epoch millis or an ISO string

    • getTimestamp

      public java.lang.String getTimestamp()

    • isExpand

      public boolean isExpand()

    • setExpand

      public void setExpand​(java.lang.Boolean expand)
      Sets the value of "expand". When true, buckets will be expanded to include their records.
      Parameters:
      expand - value of "expand" to be set

    • getExcludeInterim

      public java.lang.Boolean getExcludeInterim()

    • setExcludeInterim

      public void setExcludeInterim​(java.lang.Boolean excludeInterim)
      Sets the value of "exclude_interim". When true, interim buckets will be filtered out.
      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 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 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

    • getPageParams

      public PageParams getPageParams()

    • setPageParams

      public void setPageParams​(PageParams pageParams)
      Sets the paging parameters
      Parameters:
      pageParams - the paging parameters

    • getAnomalyScore

      public java.lang.Double getAnomalyScore()

    • setAnomalyScore

      public void setAnomalyScore​(java.lang.Double anomalyScore)
      Sets the value of "anomaly_score". Only buckets with "anomaly_score" equal or greater will be returned.
      Parameters:
      anomalyScore - value of "anomaly_score".

    • getSort

      public java.lang.String getSort()

    • setSort

      public void setSort​(java.lang.String sort)
      Sets the value of "sort". Specifies the bucket field to sort on.
      Parameters:
      sort - value of "sort".

    • getDescending

      public java.lang.Boolean getDescending()

    • setDescending

      public void setDescending​(boolean descending)
      Sets the value of "desc". Specifies the sorting order.
      Parameters:
      descending - value of "desc"

    • 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