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:
Writeable, org.elasticsearch.core.RefCounted, TaskAwareRequest, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject
public class FlushJobRequest extends ActionRequest implements org.elasticsearch.xcontent.ToXContentObject
Request object to flush a given Machine Learning job.

  • Field Details

    • CALC_INTERIM

      public static final org.elasticsearch.xcontent.ParseField CALC_INTERIM

    • START

      public static final org.elasticsearch.xcontent.ParseField START

    • END

      public static final org.elasticsearch.xcontent.ParseField END

    • ADVANCE_TIME

      public static final org.elasticsearch.xcontent.ParseField ADVANCE_TIME

    • SKIP_TIME

      public static final org.elasticsearch.xcontent.ParseField SKIP_TIME

    • PARSER

      public static final org.elasticsearch.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.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

    • validate

      public ActionRequestValidationException validate()
      Specified by:
      validate in class ActionRequest