Package org.elasticsearch.client.ml

Class GetRecordsRequest

java.lang.Object
org.elasticsearch.client.ml.GetRecordsRequest
All Implemented Interfaces:
Validatable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public class GetRecordsRequest
extends java.lang.Object
implements org.elasticsearch.common.xcontent.ToXContentObject, Validatable
A request to retrieve records of a given job

  • Nested Class Summary

    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

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static org.elasticsearch.common.ParseField DESCENDING  
    static org.elasticsearch.common.ParseField END  
    static org.elasticsearch.common.ParseField EXCLUDE_INTERIM  
    static org.elasticsearch.common.xcontent.ObjectParser<GetRecordsRequest,​java.lang.Void> PARSER  
    static org.elasticsearch.common.ParseField RECORD_SCORE  
    static org.elasticsearch.common.ParseField SORT  
    static org.elasticsearch.common.ParseField START  

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

    EMPTY_PARAMS

    Fields inherited from interface org.elasticsearch.client.Validatable

    EMPTY

  • Constructor Summary

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

  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object obj)  
    java.lang.Boolean getDescending()  
    java.lang.String getEnd()  
    java.lang.Boolean getExcludeInterim()  
    java.lang.String getJobId()  
    PageParams getPageParams()  
    java.lang.Double getRecordScore()  
    java.lang.String getSort()  
    java.lang.String getStart()  
    int hashCode()  
    void setDescending​(java.lang.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 setPageParams​(PageParams pageParams)
    Sets the paging parameters
    void setRecordScore​(java.lang.Double recordScore)
    Sets the value of "record_score".
    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.
    org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)  

    Methods inherited from class java.lang.Object

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

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

    isFragment

    Methods inherited from interface org.elasticsearch.client.Validatable

    validate

  • Field Details

    • 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

    • RECORD_SCORE

      public static final org.elasticsearch.common.ParseField RECORD_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<GetRecordsRequest,​java.lang.Void> PARSER

  • Constructor Details

    • GetRecordsRequest

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

  • Method Details

    • getJobId

      public java.lang.String getJobId()

    • getExcludeInterim

      public java.lang.Boolean getExcludeInterim()

    • setExcludeInterim

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

    • getRecordScore

      public java.lang.Double getRecordScore()

    • setRecordScore

      public void setRecordScore​(java.lang.Double recordScore)
      Sets the value of "record_score". Only records with "record_score" equal or greater will be returned.
      Parameters:
      recordScore - value of "record_score".

    • getSort

      public java.lang.String getSort()

    • setSort

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

    • getDescending

      public java.lang.Boolean getDescending()

    • setDescending

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

    • 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