Package org.elasticsearch.client.ml

Class ForecastJobResponse

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.client.ml.ForecastJobResponse

All Implemented Interfaces:

Streamable, Writeable, ToXContent, ToXContentObject

public class ForecastJobResponse
extends ActionResponse
implements ToXContentObject

Forecast response object

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportResponse

TransportResponse.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	ACKNOWLEDGED
static ParseField	FORECAST_ID
static ConstructingObjectParser<ForecastJobResponse,java.lang.Void>	PARSER

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ForecastJobResponse(boolean acknowledged, java.lang.String forecastId)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
static ForecastJobResponse	fromXContent(XContentParser parser)
java.lang.String	getForecastId()	The created forecast ID
int	hashCode()
boolean	isAcknowledged()	Forecast creating acknowledgement
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class org.elasticsearch.action.ActionResponse

readFrom, writeTo

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.common.xcontent.ToXContentObject

isFragment

Field Detail

ACKNOWLEDGED

public static final ParseField ACKNOWLEDGED

FORECAST_ID

public static final ParseField FORECAST_ID

PARSER

public static final ConstructingObjectParser<ForecastJobResponse,java.lang.Void> PARSER

Constructor Detail

ForecastJobResponse

public ForecastJobResponse(boolean acknowledged,
                           java.lang.String forecastId)

Method Detail

fromXContent

public static ForecastJobResponse fromXContent(XContentParser parser)
                                        throws java.io.IOException

Throws:

java.io.IOException

isAcknowledged

public boolean isAcknowledged()

Forecast creating acknowledgement

Returns:

true indicates success, false otherwise

getForecastId

public java.lang.String getForecastId()

The created forecast ID

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException