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.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest
TransportRequest.Empty
Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V extends Object>, Writeable.Writer<V extends Object>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ConstructingObjectParser<FlushJobRequest,
Void> static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
boolean
getEnd()
getJobId()
getStart()
int
hashCode()
void
setAdvanceTime
(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
When used in conjunction withcalcInterim
, specifies the end of the range of buckets on which to calculate interim resultsvoid
setSkipTime
(String skipTime) Specifies to skip to a particular time value.void
When used in conjunction withcalcInterim
, specifies the start of the range of buckets on which to calculate interim results.org.elasticsearch.xcontent.XContentBuilder
toXContent
(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) validate()
Methods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResult, writeTo
Methods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, setParentTask, toString
Methods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, getDescription, setParentTask
Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
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
Create new Flush job request- Parameters:
jobId
- The job ID of the job to flush
-
-
Method Details
-
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
-
setStart
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
-
setEnd
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
-
setAdvanceTime
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
-
setSkipTime
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() -
equals
-
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceorg.elasticsearch.xcontent.ToXContent
- Throws:
IOException
-
validate
- Specified by:
validate
in classActionRequest
-