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
Modifier and TypeFieldDescriptionstatic org.elasticsearch.common.xcontent.ParseField
static org.elasticsearch.common.xcontent.ParseField
static org.elasticsearch.common.xcontent.ParseField
static org.elasticsearch.common.xcontent.ConstructingObjectParser<FlushJobRequest,Void>
static org.elasticsearch.common.xcontent.ParseField
static org.elasticsearch.common.xcontent.ParseField
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
Fields inherited from interface org.elasticsearch.client.Validatable
EMPTY
-
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.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
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.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws IOException- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- Throws:
IOException
-