Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ml.job.results

Class Forecast

java.lang.Object

org.elasticsearch.xpack.core.ml.job.results.Forecast

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class Forecast
extends Object
implements ToXContentObject, Writeable

Model Forecast POJO.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final ParseField	BUCKET_SPAN
static final ParseField	BY_FIELD_NAME
static final ParseField	BY_FIELD_VALUE
static final ParseField	DETECTOR_INDEX
static final ParseField	FORECAST_ID
static final ParseField	FORECAST_LOWER
static final ParseField	FORECAST_PREDICTION
static final ParseField	FORECAST_UPPER
static final ParseField	MODEL_FEATURE
static final ParseField	PARTITION_FIELD_NAME
static final ParseField	PARTITION_FIELD_VALUE
static final String	RESULT_TYPE_VALUE	Result type
static final ParseField	RESULTS_FIELD
static final ConstructingObjectParser<Forecast,Void>	STRICT_PARSER

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Forecast(String jobId, String forecastId, Date timestamp, long bucketSpan, int detectorIndex)
Forecast(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
long	getBucketSpan()
String	getByFieldName()
String	getByFieldValue()
int	getDetectorIndex()
String	getForecastId()
double	getForecastLower()
double	getForecastPrediction()
double	getForecastUpper()
String	getId()
String	getJobId()
String	getModelFeature()
String	getPartitionFieldName()
String	getPartitionFieldValue()
Date	getTimestamp()
int	hashCode()
void	setByFieldName(String byFieldName)
void	setByFieldValue(String byFieldValue)
void	setForecastLower(double forecastLower)
void	setForecastPrediction(double forecastPrediction)
void	setForecastUpper(double forecastUpper)
void	setModelFeature(String modelFeature)
void	setPartitionFieldName(String partitionFieldName)
void	setPartitionFieldValue(String partitionFieldValue)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

RESULT_TYPE_VALUE

public static final String RESULT_TYPE_VALUE

Result type

See Also:

• Constant Field Values

RESULTS_FIELD

public static final ParseField RESULTS_FIELD

FORECAST_ID

public static final ParseField FORECAST_ID

PARTITION_FIELD_NAME

public static final ParseField PARTITION_FIELD_NAME

PARTITION_FIELD_VALUE

public static final ParseField PARTITION_FIELD_VALUE

BY_FIELD_NAME

public static final ParseField BY_FIELD_NAME

BY_FIELD_VALUE

public static final ParseField BY_FIELD_VALUE

MODEL_FEATURE

public static final ParseField MODEL_FEATURE

FORECAST_LOWER

public static final ParseField FORECAST_LOWER

FORECAST_UPPER

public static final ParseField FORECAST_UPPER

FORECAST_PREDICTION

public static final ParseField FORECAST_PREDICTION

BUCKET_SPAN

public static final ParseField BUCKET_SPAN

DETECTOR_INDEX

public static final ParseField DETECTOR_INDEX

STRICT_PARSER

public static final ConstructingObjectParser<Forecast,Void> STRICT_PARSER

Constructor Details

Forecast

public Forecast(String jobId,
 String forecastId,
 Date timestamp,
 long bucketSpan,
 int detectorIndex)

Forecast

public Forecast(StreamInput in)
         throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

getJobId

public String getJobId()

getForecastId

public String getForecastId()

getId

public String getId()

getTimestamp

public Date getTimestamp()

getBucketSpan

public long getBucketSpan()

getPartitionFieldName

public String getPartitionFieldName()

setPartitionFieldName

public void setPartitionFieldName(String partitionFieldName)

getDetectorIndex

public int getDetectorIndex()

getPartitionFieldValue

public String getPartitionFieldValue()

setPartitionFieldValue

public void setPartitionFieldValue(String partitionFieldValue)

getByFieldName

public String getByFieldName()

setByFieldName

public void setByFieldName(String byFieldName)

getByFieldValue

public String getByFieldValue()

setByFieldValue

public void setByFieldValue(String byFieldValue)

getModelFeature

public String getModelFeature()

setModelFeature

public void setModelFeature(String modelFeature)

getForecastLower

public double getForecastLower()

setForecastLower

public void setForecastLower(double forecastLower)

getForecastUpper

public double getForecastUpper()

setForecastUpper

public void setForecastUpper(double forecastUpper)

getForecastPrediction

public double getForecastPrediction()

setForecastPrediction

public void setForecastPrediction(double forecastPrediction)

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object