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.core.RefCounted, org.elasticsearch.tasks.TaskAwareRequest, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject
public class GetBucketsRequest extends org.elasticsearch.action.ActionRequest implements org.elasticsearch.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.xcontent.ToXContent

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

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

    org.elasticsearch.common.io.stream.Writeable.Reader<V extends Object>, org.elasticsearch.common.io.stream.Writeable.Writer<V extends Object>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.elasticsearch.xcontent.ParseField
    ANOMALY_SCORE
     
    static final org.elasticsearch.xcontent.ParseField
    DESCENDING
     
    static final org.elasticsearch.xcontent.ParseField
    END
     
    static final org.elasticsearch.xcontent.ParseField
    EXCLUDE_INTERIM
     
    static final org.elasticsearch.xcontent.ParseField
    EXPAND
     
    static final org.elasticsearch.xcontent.ObjectParser<GetBucketsRequest,Void>
    PARSER
     
    static final org.elasticsearch.xcontent.ParseField
    SORT
     
    static final org.elasticsearch.xcontent.ParseField
    START
     

    Fields inherited from interface org.elasticsearch.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

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

  • Method Summary

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

    Methods inherited from class org.elasticsearch.transport.TransportMessage

    decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

    createTask, getDescription, setParentTask

    Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

    isFragment

  • Field Details

    • EXPAND

      public static final org.elasticsearch.xcontent.ParseField EXPAND

    • EXCLUDE_INTERIM

      public static final org.elasticsearch.xcontent.ParseField EXCLUDE_INTERIM

    • START

      public static final org.elasticsearch.xcontent.ParseField START

    • END

      public static final org.elasticsearch.xcontent.ParseField END

    • ANOMALY_SCORE

      public static final org.elasticsearch.xcontent.ParseField ANOMALY_SCORE

    • SORT

      public static final org.elasticsearch.xcontent.ParseField SORT

    • DESCENDING

      public static final org.elasticsearch.xcontent.ParseField DESCENDING

    • PARSER

      public static final org.elasticsearch.xcontent.ObjectParser<GetBucketsRequest,Void> PARSER

  • Constructor Details

    • GetBucketsRequest

      public GetBucketsRequest(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 String getJobId()

    • setTimestamp

      public void setTimestamp(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 String getTimestamp()

    • isExpand

      public boolean isExpand()

    • setExpand

      public void setExpand(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 Boolean getExcludeInterim()

    • setExcludeInterim

      public void setExcludeInterim(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 String getStart()

    • setStart

      public void setStart(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 String getEnd()

    • setEnd

      public void setEnd(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 Double getAnomalyScore()

    • setAnomalyScore

      public void setAnomalyScore(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 String getSort()

    • setSort

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

    • getDescending

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object