Package org.elasticsearch.client.ml

Class DeleteExpiredDataRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.client.ml.DeleteExpiredDataRequest

All Implemented Interfaces:

Writeable, org.elasticsearch.core.RefCounted, TaskAwareRequest, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject

public class DeleteExpiredDataRequest
extends ActionRequest
implements org.elasticsearch.xcontent.ToXContentObject

Request to delete expired model snapshots and forecasts

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

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
DeleteExpiredDataRequest()	Create a new request to delete expired data
DeleteExpiredDataRequest(String jobId, Float requestsPerSecond, org.elasticsearch.core.TimeValue timeout)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getJobId()	The optional job id The default is `null` meaning all jobs.
Float	getRequestsPerSecond()	The requests allowed per second in the underlying Delete by Query requests executed.
org.elasticsearch.core.TimeValue	getTimeout()	Indicates how long the deletion request will run until it timesout.
int	hashCode()
org.elasticsearch.xcontent.XContentBuilder	toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
ActionRequestValidationException	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

Constructor Details

DeleteExpiredDataRequest

public DeleteExpiredDataRequest()

Create a new request to delete expired data

DeleteExpiredDataRequest

public DeleteExpiredDataRequest(String jobId,
 Float requestsPerSecond,
 org.elasticsearch.core.TimeValue timeout)

Method Details

getRequestsPerSecond

public Float getRequestsPerSecond()

The requests allowed per second in the underlying Delete by Query requests executed. `-1.0f` indicates that the standard nightly cleanup behavior should be ran. Throttling scales according to the number of data nodes. `null` is default and means no throttling will occur.

getTimeout

public org.elasticsearch.core.TimeValue getTimeout()

Indicates how long the deletion request will run until it timesout. Default value is 8 hours.

getJobId

public String getJobId()

The optional job id The default is `null` meaning all jobs.

Returns:

The job id or null

equals

public boolean equals(Object o)

Overrides:

equals in class Object

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toXContent

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

Specified by:

toXContent in interface org.elasticsearch.xcontent.ToXContent

Throws:

IOException