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:
Writeable
,org.elasticsearch.core.RefCounted
,TaskAwareRequest
,org.elasticsearch.xcontent.ToXContent
,org.elasticsearch.xcontent.ToXContentObject
public class DeleteForecastRequest
extends ActionRequest
implements org.elasticsearch.xcontent.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.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V extends Object>, Writeable.Writer<V extends Object>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ConstructingObjectParser<DeleteForecastRequest,
Void> static final org.elasticsearch.xcontent.ParseField
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
ConstructorDescriptionDeleteForecastRequest
(String jobId) Create a new DeleteForecastRequest for the given Job ID -
Method Summary
Modifier and TypeMethodDescriptionstatic DeleteForecastRequest
deleteAllForecasts
(String jobId) Create a newDeleteForecastRequest
that explicitly deletes all forecastsboolean
getJobId()
int
hashCode()
void
setAllowNoForecasts
(boolean allowNoForecasts) Sets the value of "allow_no_forecasts".void
setForecastIds
(String... forecastIds) The forecast IDs to delete.org.elasticsearch.core.TimeValue
timeout()
void
Allows to set the timeoutvoid
timeout
(org.elasticsearch.core.TimeValue timeout) Allows to set the timeoutorg.elasticsearch.xcontent.XContentBuilder
toXContent
(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) validate()
Methods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResult, writeTo
Methods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, setParentTask, toString
Methods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, getDescription, setParentTask
Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Field Details
-
FORECAST_ID
public static final org.elasticsearch.xcontent.ParseField FORECAST_ID -
ALLOW_NO_FORECASTS
public static final org.elasticsearch.xcontent.ParseField ALLOW_NO_FORECASTS -
TIMEOUT
public static final org.elasticsearch.xcontent.ParseField TIMEOUT -
ALL
- See Also:
-
PARSER
public static final org.elasticsearch.xcontent.ConstructingObjectParser<DeleteForecastRequest,Void> PARSER
-
-
Constructor Details
-
DeleteForecastRequest
Create a new DeleteForecastRequest for the given Job ID- Parameters:
jobId
- the jobId of the Job whose forecast(s) to delete
-
-
Method Details
-
deleteAllForecasts
Create a newDeleteForecastRequest
that explicitly deletes all forecasts- Parameters:
jobId
- the jobId of the Job whose forecasts to delete
-
getJobId
-
getForecastIds
-
setForecastIds
The forecast IDs to delete. Can be also beALL
to explicitly delete ALL forecasts- Parameters:
forecastIds
- forecast IDs to delete
-
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
Allows to set the timeout- Parameters:
timeout
- timeout as a string (e.g. 1s)
-
timeout
public void timeout(org.elasticsearch.core.TimeValue timeout) Allows to set the timeout- Parameters:
timeout
- timeout as aTimeValue
-
timeout
public org.elasticsearch.core.TimeValue timeout() -
equals
-
hashCode
public int hashCode() -
validate
- Specified by:
validate
in classActionRequest
-
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceorg.elasticsearch.xcontent.ToXContent
- Throws:
IOException
-