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:
org.elasticsearch.common.io.stream.Writeable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
,org.elasticsearch.tasks.TaskAwareRequest
public class CloseJobRequest
extends org.elasticsearch.action.ActionRequest
implements org.elasticsearch.common.xcontent.ToXContentObject
Request to close Machine Learning Jobs
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest
org.elasticsearch.transport.TransportRequest.Empty
-
Field Summary
Fields Modifier and Type Field Description static org.elasticsearch.common.ParseField
ALLOW_NO_JOBS
static org.elasticsearch.common.ParseField
FORCE
static org.elasticsearch.common.ParseField
JOB_ID
static org.elasticsearch.common.xcontent.ConstructingObjectParser<CloseJobRequest,java.lang.Void>
PARSER
static org.elasticsearch.common.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 closedorg.elasticsearch.common.unit.TimeValue
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(org.elasticsearch.common.unit.TimeValue timeout)
How long to wait for the close request to complete before timing out.java.lang.String
toString()
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, wait, wait, wait
-
Field Details
-
JOB_ID
public static final org.elasticsearch.common.ParseField JOB_ID -
TIMEOUT
public static final org.elasticsearch.common.ParseField TIMEOUT -
FORCE
public static final org.elasticsearch.common.ParseField FORCE -
ALLOW_NO_JOBS
public static final org.elasticsearch.common.ParseField ALLOW_NO_JOBS -
PARSER
public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<CloseJobRequest,java.lang.Void> PARSER
-
-
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
public org.elasticsearch.common.unit.TimeValue getTimeout() -
setTimeout
public void setTimeout(org.elasticsearch.common.unit.TimeValue timeout)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
public org.elasticsearch.action.ActionRequestValidationException validate()- Specified by:
validate
in classorg.elasticsearch.action.ActionRequest
-
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 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
-
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-