Package org.elasticsearch.client.ml
Class CloseJobRequest
java.lang.Object
org.elasticsearch.client.ml.CloseJobRequest
- All Implemented Interfaces:
Validatable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
public class CloseJobRequest
extends Object
implements org.elasticsearch.common.xcontent.ToXContentObject, Validatable
Request to close Machine Learning Jobs
-
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
Modifier and TypeFieldDescriptionstatic org.elasticsearch.common.xcontent.ParseField
static org.elasticsearch.common.xcontent.ParseField
static org.elasticsearch.common.xcontent.ParseField
static org.elasticsearch.common.xcontent.ConstructingObjectParser<CloseJobRequest,Void>
static org.elasticsearch.common.xcontent.ParseField
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
Fields inherited from interface org.elasticsearch.client.Validatable
EMPTY
-
Constructor Summary
ConstructorDescriptionCloseJobRequest(String... jobIds)
Close the specified Jobs via their unique jobIds -
Method Summary
Modifier and TypeMethodDescriptionstatic CloseJobRequest
Explicitly close all jobsboolean
getForce()
All the jobIds to be closedorg.elasticsearch.core.TimeValue
int
hashCode()
void
setAllowNoMatch(boolean allowNoMatch)
Whether to ignore if a wildcard expression matches no jobs.void
setForce(boolean force)
Should the closing be forced.void
setTimeout(org.elasticsearch.core.TimeValue timeout)
How long to wait for the close request to complete before timing out.toString()
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, wait, wait, wait
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject
isFragment
Methods inherited from interface org.elasticsearch.client.Validatable
validate
-
Field Details
-
JOB_ID
public static final org.elasticsearch.common.xcontent.ParseField JOB_ID -
TIMEOUT
public static final org.elasticsearch.common.xcontent.ParseField TIMEOUT -
FORCE
public static final org.elasticsearch.common.xcontent.ParseField FORCE -
ALLOW_NO_MATCH
public static final org.elasticsearch.common.xcontent.ParseField ALLOW_NO_MATCH -
PARSER
public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<CloseJobRequest,Void> PARSER
-
-
Constructor Details
-
CloseJobRequest
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
All the jobIds to be closed -
getTimeout
public org.elasticsearch.core.TimeValue getTimeout() -
setTimeout
public void setTimeout(org.elasticsearch.core.TimeValue timeout)How long to wait for the close request to complete before timing out.- Parameters:
timeout
- Default value: 30 minutes
-
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
-
getAllowNoMatch
-
setAllowNoMatch
public void setAllowNoMatch(boolean allowNoMatch)Whether to ignore if a wildcard expression matches no jobs. This includes_all
string or when no jobs have been specified- Parameters:
allowNoMatch
- Whentrue
ignore if wildcard or_all
matches no jobs. Defaults totrue
-
hashCode
public int hashCode() -
equals
-
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
-
toString
-