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:
org.elasticsearch.common.io.stream.Writeable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
,org.elasticsearch.tasks.TaskAwareRequest
public class DeleteExpiredDataRequest
extends org.elasticsearch.action.ActionRequest
implements org.elasticsearch.common.xcontent.ToXContentObject
Request to delete expired model snapshots and forecasts
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest
org.elasticsearch.transport.TransportRequest.Empty
-
Field Summary
-
Constructor Summary
Constructors Constructor Description DeleteExpiredDataRequest()
Create a new request to delete expired dataDeleteExpiredDataRequest(java.lang.String jobId, java.lang.Float requestsPerSecond, org.elasticsearch.common.unit.TimeValue timeout)
-
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object o)
java.lang.String
getJobId()
The optional job id The default is `null` meaning all jobs.java.lang.Float
getRequestsPerSecond()
The requests allowed per second in the underlying Delete by Query requests executed.org.elasticsearch.common.unit.TimeValue
getTimeout()
Indicates how long the deletion request will run until it timesout.int
hashCode()
org.elasticsearch.common.xcontent.XContentBuilder
toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
org.elasticsearch.action.ActionRequestValidationException
validate()
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
-
Constructor Details
-
DeleteExpiredDataRequest
public DeleteExpiredDataRequest()Create a new request to delete expired data -
DeleteExpiredDataRequest
public DeleteExpiredDataRequest(java.lang.String jobId, java.lang.Float requestsPerSecond, org.elasticsearch.common.unit.TimeValue timeout)
-
-
Method Details
-
getRequestsPerSecond
public java.lang.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.common.unit.TimeValue getTimeout()Indicates how long the deletion request will run until it timesout. Default value is 8 hours. -
getJobId
public java.lang.String getJobId()The optional job id The default is `null` meaning all jobs.- Returns:
- The job id or null
-
equals
public boolean equals(java.lang.Object o)- Overrides:
equals
in classjava.lang.Object
-
validate
public org.elasticsearch.action.ActionRequestValidationException validate()- Specified by:
validate
in classorg.elasticsearch.action.ActionRequest
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-
toXContent
public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- Throws:
java.io.IOException
-