Package org.elasticsearch.client.ml
Class CloseJobRequest
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.client.ml.CloseJobRequest
- All Implemented Interfaces:
Writeable
,ToXContent
,ToXContentObject
,TaskAwareRequest
public class CloseJobRequest extends ActionRequest implements ToXContentObject
Request to close Machine Learning Jobs
-
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 ParseField
ALLOW_NO_JOBS
static ParseField
FORCE
static ParseField
JOB_ID
static ConstructingObjectParser<CloseJobRequest,java.lang.Void>
PARSER
static ParseField
TIMEOUT
-
Constructor Summary
Constructors Constructor Description CloseJobRequest(java.lang.String... jobIds)
Close the specified Jobs via their unique jobIds -
Method Summary
Modifier and Type Method Description static CloseJobRequest
closeAllJobsRequest()
Explicitly close all jobsboolean
equals(java.lang.Object other)
java.lang.Boolean
getAllowNoJobs()
java.lang.Boolean
getForce()
java.util.List<java.lang.String>
getJobIds()
All the jobIds to be closedTimeValue
getTimeout()
int
hashCode()
void
setAllowNoJobs(boolean allowNoJobs)
Whether to ignore if a wildcard expression matches no jobs.void
setForce(boolean force)
Should the closing be forced.void
setTimeout(TimeValue timeout)
How long to wait for the close request to complete before timing out.java.lang.String
toString()
XContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
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, wait, wait, wait
Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, getDescription, setParentTask
-
Field Details
-
Constructor Details
-
CloseJobRequest
public CloseJobRequest(java.lang.String... jobIds)Close the specified Jobs via their unique jobIds- Parameters:
jobIds
- must be non-null and non-empty and each jobId must be non-null
-
-
Method Details
-
closeAllJobsRequest
Explicitly close all jobs- Returns:
- a
CloseJobRequest
for all existing jobs
-
getJobIds
public java.util.List<java.lang.String> getJobIds()All the jobIds to be closed -
getTimeout
-
setTimeout
How long to wait for the close request to complete before timing out.- Parameters:
timeout
- Default value: 30 minutes
-
getForce
public java.lang.Boolean getForce() -
setForce
public void setForce(boolean force)Should the closing be forced. Use to close a failed job, or to forcefully close a job which has not responded to its initial close request.- Parameters:
force
- Whentrue
forcefully close the job. Defaults tofalse
-
getAllowNoJobs
public java.lang.Boolean getAllowNoJobs() -
setAllowNoJobs
public void setAllowNoJobs(boolean allowNoJobs)Whether to ignore if a wildcard expression matches no jobs. This includes_all
string or when no jobs have been specified- Parameters:
allowNoJobs
- Whentrue
ignore if wildcard or_all
matches no jobs. Defaults totrue
-
validate
- Specified by:
validate
in classActionRequest
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object other)- Overrides:
equals
in classjava.lang.Object
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-