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
,org.elasticsearch.core.RefCounted
,TaskAwareRequest
,org.elasticsearch.xcontent.ToXContent
,org.elasticsearch.xcontent.ToXContentObject
public class CloseJobRequest
extends ActionRequest
implements org.elasticsearch.xcontent.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.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V extends Object>, Writeable.Writer<V extends Object>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ConstructingObjectParser<CloseJobRequest,
Void> static final org.elasticsearch.xcontent.ParseField
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
-
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.xcontent.XContentBuilder
toXContent
(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) validate()
Methods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResult, writeTo
Methods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, setParentTask
Methods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef
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
Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Field Details
-
JOB_ID
public static final org.elasticsearch.xcontent.ParseField JOB_ID -
TIMEOUT
public static final org.elasticsearch.xcontent.ParseField TIMEOUT -
FORCE
public static final org.elasticsearch.xcontent.ParseField FORCE -
ALLOW_NO_MATCH
public static final org.elasticsearch.xcontent.ParseField ALLOW_NO_MATCH -
PARSER
public static final org.elasticsearch.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
-
validate
- Specified by:
validate
in classActionRequest
-
hashCode
public int hashCode() -
equals
-
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceorg.elasticsearch.xcontent.ToXContent
- Throws:
IOException
-
toString
- Overrides:
toString
in classTransportRequest
-