Package org.elasticsearch.client.ml

Class FlushJobRequest

java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.client.ml.FlushJobRequest
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 FlushJobRequest
extends org.elasticsearch.action.ActionRequest
implements org.elasticsearch.common.xcontent.ToXContentObject
Request object to flush a given Machine Learning 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 ADVANCE_TIME  
    static org.elasticsearch.common.ParseField CALC_INTERIM  
    static org.elasticsearch.common.ParseField END  
    static org.elasticsearch.common.xcontent.ConstructingObjectParser<FlushJobRequest,​java.lang.Void> PARSER  
    static org.elasticsearch.common.ParseField SKIP_TIME  
    static org.elasticsearch.common.ParseField START  

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

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor Description
    FlushJobRequest​(java.lang.String jobId)
    Create new Flush job request

  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object obj)  
    java.lang.String getAdvanceTime()  
    boolean getCalcInterim()  
    java.lang.String getEnd()  
    java.lang.String getJobId()  
    java.lang.String getSkipTime()  
    java.lang.String getStart()  
    int hashCode()  
    void setAdvanceTime​(java.lang.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​(java.lang.String end)
    When used in conjunction with calcInterim, specifies the end of the range of buckets on which to calculate interim results
    void setSkipTime​(java.lang.String skipTime)
    Specifies to skip to a particular time value.
    void setStart​(java.lang.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)  
    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

    • CALC_INTERIM

      public static final org.elasticsearch.common.ParseField CALC_INTERIM

    • START

      public static final org.elasticsearch.common.ParseField START

    • END

      public static final org.elasticsearch.common.ParseField END

    • ADVANCE_TIME

      public static final org.elasticsearch.common.ParseField ADVANCE_TIME

    • SKIP_TIME

      public static final org.elasticsearch.common.ParseField SKIP_TIME

    • PARSER

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

  • Constructor Details

    • FlushJobRequest

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

  • Method Details

    • getJobId

      public java.lang.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 java.lang.String getStart()

    • setStart

      public void setStart​(java.lang.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 java.lang.String getEnd()

    • setEnd

      public void setEnd​(java.lang.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 java.lang.String getAdvanceTime()

    • setAdvanceTime

      public void setAdvanceTime​(java.lang.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 java.lang.String getSkipTime()

    • setSkipTime

      public void setSkipTime​(java.lang.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 java.lang.Object

    • equals

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

    • 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

    • validate

      public org.elasticsearch.action.ActionRequestValidationException validate()
      Specified by:
      validate in class org.elasticsearch.action.ActionRequest