Package org.elasticsearch.client.ml
Class DeleteForecastRequest
- java.lang.Object
-
- org.elasticsearch.transport.TransportMessage
-
- org.elasticsearch.transport.TransportRequest
-
- org.elasticsearch.action.ActionRequest
-
- org.elasticsearch.client.ml.DeleteForecastRequest
-
- All Implemented Interfaces:
Streamable
,Writeable
,ToXContent
,ToXContentObject
,TaskAwareRequest
public class DeleteForecastRequest extends ActionRequest implements ToXContentObject
POJO for a delete forecast request
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest
TransportRequest.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 java.lang.String
ALL
static ParseField
ALLOW_NO_FORECASTS
static ParseField
FORECAST_ID
static ConstructingObjectParser<DeleteForecastRequest,java.lang.Void>
PARSER
static ParseField
TIMEOUT
-
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
-
Constructor Summary
Constructors Constructor Description DeleteForecastRequest(java.lang.String jobId)
Create a new DeleteForecastRequest for the given Job ID
-
Method Summary
Modifier and Type Method Description static DeleteForecastRequest
deleteAllForecasts(java.lang.String jobId)
Create a newDeleteForecastRequest
that explicitly deletes all forecastsboolean
equals(java.lang.Object other)
java.lang.Boolean
getAllowNoForecasts()
java.util.List<java.lang.String>
getForecastIds()
java.lang.String
getJobId()
int
hashCode()
void
setAllowNoForecasts(boolean allowNoForecasts)
Sets the value of "allow_no_forecasts".void
setForecastIds(java.lang.String... forecastIds)
The forecast IDs to delete.TimeValue
timeout()
void
timeout(java.lang.String timeout)
Allows to set the timeoutvoid
timeout(TimeValue timeout)
Allows to set the timeoutXContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
ActionRequestValidationException
validate()
-
Methods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResult, readFrom, writeTo
-
Methods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, setParentTask
-
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.tasks.TaskAwareRequest
createTask, getDescription, setParentTask
-
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject
isFragment
-
-
-
-
Field Detail
-
FORECAST_ID
public static final ParseField FORECAST_ID
-
ALLOW_NO_FORECASTS
public static final ParseField ALLOW_NO_FORECASTS
-
TIMEOUT
public static final ParseField TIMEOUT
-
ALL
public static final java.lang.String ALL
- See Also:
- Constant Field Values
-
PARSER
public static final ConstructingObjectParser<DeleteForecastRequest,java.lang.Void> PARSER
-
-
Method Detail
-
deleteAllForecasts
public static DeleteForecastRequest deleteAllForecasts(java.lang.String jobId)
Create a newDeleteForecastRequest
that explicitly deletes all forecasts- Parameters:
jobId
- the jobId of the Job whose forecasts to delete
-
getJobId
public java.lang.String getJobId()
-
getForecastIds
public java.util.List<java.lang.String> getForecastIds()
-
setForecastIds
public void setForecastIds(java.lang.String... forecastIds)
The forecast IDs to delete. Can be also beALL
to explicitly delete ALL forecasts- Parameters:
forecastIds
- forecast IDs to delete
-
getAllowNoForecasts
public java.lang.Boolean getAllowNoForecasts()
-
setAllowNoForecasts
public void setAllowNoForecasts(boolean allowNoForecasts)
Sets the value of "allow_no_forecasts".- Parameters:
allowNoForecasts
- whentrue
no error is thrown whenALL
does not find any forecasts
-
timeout
public void timeout(java.lang.String timeout)
Allows to set the timeout- Parameters:
timeout
- timeout as a string (e.g. 1s)
-
timeout
public void timeout(TimeValue timeout)
Allows to set the timeout- Parameters:
timeout
- timeout as aTimeValue
-
timeout
public TimeValue timeout()
-
equals
public boolean equals(java.lang.Object other)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
validate
public ActionRequestValidationException validate()
- Specified by:
validate
in classActionRequest
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-
-