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
,ToXContent
,ToXContentObject
,TaskAwareRequest
public class FlushJobRequest extends ActionRequest implements ToXContentObject
Request object to flush a given Machine Learning job.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest
TransportRequest.Empty
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V extends java.lang.Object>, Writeable.Writer<V extends java.lang.Object>
-
Field Summary
Fields Modifier and Type Field Description static ParseField
ADVANCE_TIME
static ParseField
CALC_INTERIM
static ParseField
END
static ConstructingObjectParser<FlushJobRequest,java.lang.Void>
PARSER
static ParseField
SKIP_TIME
static ParseField
START
-
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)
Whentrue
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 withcalcInterim
, specifies the end of the range of buckets on which to calculate interim resultsvoid
setSkipTime(java.lang.String skipTime)
Specifies to skip to a particular time value.void
setStart(java.lang.String start)
When used in conjunction withcalcInterim
, specifies the start of the range of buckets on which to calculate interim results.XContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
ActionRequestValidationException
validate()
Methods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, setParentTask
Methods inherited from class org.elasticsearch.transport.TransportMessage
remoteAddress, remoteAddress
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
-
Field Details
-
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)Whentrue
calculates the interim results for the most recent bucket or all buckets within the latency period.- Parameters:
calcInterim
- defaults tofalse
.
-
getStart
public java.lang.String getStart() -
setStart
public void setStart(java.lang.String start)When used in conjunction withcalcInterim
, 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 withcalcInterim
, 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 classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)- Overrides:
equals
in classjava.lang.Object
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-
validate
- Specified by:
validate
in classActionRequest
-