Package org.elasticsearch.client.ml
Class DeleteExpiredDataRequest
java.lang.Object
org.elasticsearch.client.ml.DeleteExpiredDataRequest
- All Implemented Interfaces:
Validatable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
public class DeleteExpiredDataRequest
extends Object
implements Validatable, org.elasticsearch.common.xcontent.ToXContentObject
Request to delete expired model snapshots and forecasts
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params
-
Field Summary
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
Fields inherited from interface org.elasticsearch.client.Validatable
EMPTY
-
Constructor Summary
ConstructorDescriptionCreate a new request to delete expired dataDeleteExpiredDataRequest(String jobId, Float requestsPerSecond, org.elasticsearch.core.TimeValue timeout)
-
Method Summary
Modifier and TypeMethodDescriptionboolean
getJobId()
The optional job id The default is `null` meaning all jobs.The requests allowed per second in the underlying Delete by Query requests executed.org.elasticsearch.core.TimeValue
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)
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
Methods inherited from interface org.elasticsearch.client.Validatable
validate
-
Constructor Details
-
DeleteExpiredDataRequest
public DeleteExpiredDataRequest()Create a new request to delete expired data -
DeleteExpiredDataRequest
-
-
Method Details
-
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
The optional job id The default is `null` meaning all jobs.- Returns:
- The job id or null
-
equals
-
hashCode
public int hashCode() -
toXContent
public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws IOException- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- Throws:
IOException
-