Package org.elasticsearch.client.ml

Class FlushJobRequest

java.lang.Object
org.elasticsearch.client.ml.FlushJobRequest
All Implemented Interfaces:
Validatable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public class FlushJobRequest extends Object implements Validatable, org.elasticsearch.common.xcontent.ToXContentObject
Request object to flush a given Machine Learning 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.xcontent.ParseField
    ADVANCE_TIME
     
    static org.elasticsearch.common.xcontent.ParseField
    CALC_INTERIM
     
    static org.elasticsearch.common.xcontent.ParseField
    END
     
    static org.elasticsearch.common.xcontent.ConstructingObjectParser<FlushJobRequest,​Void>
    PARSER
     
    static org.elasticsearch.common.xcontent.ParseField
    SKIP_TIME
     
    static org.elasticsearch.common.xcontent.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
    FlushJobRequest​(String jobId)
    Create new Flush job request

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals​(Object obj)
     
    String
    getAdvanceTime()
     
    boolean
    getCalcInterim()
     
    String
    getEnd()
     
    String
    getJobId()
     
    String
    getSkipTime()
     
    String
    getStart()
     
    int
    hashCode()
     
    void
    setAdvanceTime​(String advanceTime)
    Specifies to advance to a particular time value.
    void
    setCalcInterim​(boolean calcInterim)
    When true calculates the interim results for the most recent bucket or all buckets within the latency period.
    void
    setEnd​(String end)
    When used in conjunction with calcInterim, specifies the end of the range of buckets on which to calculate interim results
    void
    setSkipTime​(String skipTime)
    Specifies to skip to a particular time value.
    void
    setStart​(String start)
    When used in conjunction with calcInterim, specifies the start of the range of buckets on which to calculate interim results.
    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

    • CALC_INTERIM

      public static final org.elasticsearch.common.xcontent.ParseField CALC_INTERIM

    • START

      public static final org.elasticsearch.common.xcontent.ParseField START

    • END

      public static final org.elasticsearch.common.xcontent.ParseField END

    • ADVANCE_TIME

      public static final org.elasticsearch.common.xcontent.ParseField ADVANCE_TIME

    • SKIP_TIME

      public static final org.elasticsearch.common.xcontent.ParseField SKIP_TIME

    • PARSER

      public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<FlushJobRequest,​Void> PARSER

  • Constructor Details

    • FlushJobRequest

      public FlushJobRequest​(String jobId)
      Create new Flush job request
      Parameters:
      jobId - The job ID of the job to flush

  • Method Details

    • getJobId

      public String getJobId()

    • getCalcInterim

      public boolean getCalcInterim()

    • setCalcInterim

      public void setCalcInterim​(boolean calcInterim)
      When true calculates the interim results for the most recent bucket or all buckets within the latency period.
      Parameters:
      calcInterim - defaults to false.

    • getStart

      public String getStart()

    • setStart

      public void setStart​(String start)
      When used in conjunction with calcInterim, specifies the start of the range of buckets on which to calculate interim results.
      Parameters:
      start - the beginning of the range of buckets; may be an epoch seconds, epoch millis or an ISO string

    • getEnd

      public String getEnd()

    • setEnd

      public void setEnd​(String end)
      When used in conjunction with calcInterim, specifies the end of the range of buckets on which to calculate interim results
      Parameters:
      end - the end of the range of buckets; may be an epoch seconds, epoch millis or an ISO string

    • getAdvanceTime

      public String getAdvanceTime()

    • setAdvanceTime

      public void setAdvanceTime​(String advanceTime)
      Specifies to advance to a particular time value. Results are generated and the model is updated for data from the specified time interval.
      Parameters:
      advanceTime - String representation of a timestamp; may be an epoch seconds, epoch millis or an ISO string

    • getSkipTime

      public String getSkipTime()

    • setSkipTime

      public void setSkipTime​(String skipTime)
      Specifies to skip to a particular time value. Results are not generated and the model is not updated for data from the specified time interval.
      Parameters:
      skipTime - String representation of a timestamp; may be an epoch seconds, epoch millis or an ISO string

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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

    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      IOException