Module org.elasticsearch.xcore
Class ForecastRequestStats
java.lang.Object
org.elasticsearch.xpack.core.ml.job.results.ForecastRequestStats
- All Implemented Interfaces:
Writeable,org.elasticsearch.xcontent.ToXContent,org.elasticsearch.xcontent.ToXContentObject
public final class ForecastRequestStats
extends Object
implements org.elasticsearch.xcontent.ToXContentObject, Writeable
Model ForecastRequestStats POJO.
This information is produced by the autodetect process and contains
information about errors, progress and counters. There is exactly 1 document
per forecast request, getting updated while the request is processed.
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ConstructingObjectParser<ForecastRequestStats, Void> static final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldstatic final StringResult typestatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ConstructingObjectParser<ForecastRequestStats, Void> Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsConstructorDescriptionForecastRequestStats(String jobId, String forecastId) ForecastRequestStats(ForecastRequestStats forecastRequestStats) -
Method Summary
Modifier and TypeMethodDescriptionstatic StringdocumentId(String jobId, String forecastId) booleangetId()Return the document ID used for indexing.getJobId()longlongdoubleProgress information of the ForecastRequest in the range 0 to 1, while 1 means finishedlonginthashCode()voidsetCreateTime(Instant createTime) voidsetEndTime(Instant endTime) voidsetExpiryTime(Instant expiryTime) voidsetMemoryUsage(long memoryUsage) voidsetMessages(List<String> messages) voidsetProcessingTime(long processingTime) voidsetProgress(double progress) voidsetRecordCount(long recordCount) voidsetStartTime(Instant startTime) voidvoidsetTimeStamp(Instant timeStamp) org.elasticsearch.xcontent.XContentBuildertoXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) voidwriteTo(StreamOutput out) Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Field Details
-
RESULT_TYPE_VALUE
Result type- See Also:
-
RESULTS_FIELD
public static final org.elasticsearch.xcontent.ParseField RESULTS_FIELD -
FORECAST_ID
public static final org.elasticsearch.xcontent.ParseField FORECAST_ID -
START_TIME
public static final org.elasticsearch.xcontent.ParseField START_TIME -
END_TIME
public static final org.elasticsearch.xcontent.ParseField END_TIME -
CREATE_TIME
public static final org.elasticsearch.xcontent.ParseField CREATE_TIME -
EXPIRY_TIME
public static final org.elasticsearch.xcontent.ParseField EXPIRY_TIME -
MESSAGES
public static final org.elasticsearch.xcontent.ParseField MESSAGES -
PROCESSING_TIME_MS
public static final org.elasticsearch.xcontent.ParseField PROCESSING_TIME_MS -
PROGRESS
public static final org.elasticsearch.xcontent.ParseField PROGRESS -
PROCESSED_RECORD_COUNT
public static final org.elasticsearch.xcontent.ParseField PROCESSED_RECORD_COUNT -
STATUS
public static final org.elasticsearch.xcontent.ParseField STATUS -
MEMORY_USAGE
public static final org.elasticsearch.xcontent.ParseField MEMORY_USAGE -
STRICT_PARSER
public static final org.elasticsearch.xcontent.ConstructingObjectParser<ForecastRequestStats,Void> STRICT_PARSER -
LENIENT_PARSER
public static final org.elasticsearch.xcontent.ConstructingObjectParser<ForecastRequestStats,Void> LENIENT_PARSER
-
-
Constructor Details
-
ForecastRequestStats
-
ForecastRequestStats
-
ForecastRequestStats
- Throws:
IOException
-
-
Method Details
-
writeTo
- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceorg.elasticsearch.xcontent.ToXContent- Throws:
IOException
-
getJobId
-
getForecastId
-
documentId
-
getId
Return the document ID used for indexing. As there is 1 and only 1 document per forecast request, the id has no dynamic parts.- Returns:
- id
-
setRecordCount
public void setRecordCount(long recordCount) -
getRecordCount
public long getRecordCount() -
getMessages
-
setMessages
-
setTimeStamp
-
getTimestamp
-
setStartTime
-
getStartTime
-
getEndTime
-
setEndTime
-
setCreateTime
-
getCreateTime
-
setExpiryTime
-
getExpiryTime
-
getProgress
public double getProgress()Progress information of the ForecastRequest in the range 0 to 1, while 1 means finished- Returns:
- progress value
-
setProgress
public void setProgress(double progress) -
getProcessingTime
public long getProcessingTime() -
setProcessingTime
public void setProcessingTime(long processingTime) -
getMemoryUsage
public long getMemoryUsage() -
setMemoryUsage
public void setMemoryUsage(long memoryUsage) -
getStatus
-
setStatus
-
equals
-
hashCode
public int hashCode()
-