Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ml.action

Class CloseJobAction.Request

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.AbstractTransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.UntypedActionRequest

org.elasticsearch.action.support.tasks.BaseTasksRequest<CloseJobAction.Request>

org.elasticsearch.xpack.core.ml.action.CloseJobAction.Request

All Implemented Interfaces:

Writeable, RefCounted, TaskAwareRequest, TransportRequest, ToXContent, ToXContentObject

Enclosing class:

CloseJobAction

public static class CloseJobAction.Request
extends BaseTasksRequest<CloseJobAction.Request>
implements ToXContentObject

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final ParseField	ALLOW_NO_MATCH
static final ParseField	FORCE
static final ObjectParser<CloseJobAction.Request,Void>	PARSER
static final ParseField	TIMEOUT

Fields inherited from class org.elasticsearch.action.support.tasks.BaseTasksRequest

ALL_ACTIONS, ALL_NODES

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Request()
Request(String jobId)
Request(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	allowNoMatch()
boolean	equals(Object obj)
TimeValue	getCloseTimeout()
String	getJobId()
String[]	getOpenJobIds()
int	hashCode()
boolean	isForce()
boolean	isLocal()
boolean	match(Task task)
static CloseJobAction.Request	parseRequest(String jobId, XContentParser parser)
CloseJobAction.Request	setAllowNoMatch(boolean allowNoMatch)
CloseJobAction.Request	setCloseTimeout(TimeValue closeTimeout)
CloseJobAction.Request	setForce(boolean force)
CloseJobAction.Request	setJobId(String jobId)
CloseJobAction.Request	setLocal(boolean local)
CloseJobAction.Request	setOpenJobIds(String[] openJobIds)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.support.tasks.BaseTasksRequest

canMatchAction, copyFieldsFrom, getActions, getNodes, getParentTaskId, getTargetParentTaskId, getTargetTaskId, getTaskId, getTimeout, matchesActionAndParent, setActions, setNodes, setParentTaskId, setTargetParentTaskId, setTargetTaskId, setTaskId, setTimeout, validate

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.AbstractTransportRequest

copyFieldsFrom, getParentTask, getRequestId, remoteAddress, remoteAddress, setParentTask, setRequestId, toString

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, tryIncRef

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.core.RefCounted

decRef, hasReferences, incRef, mustIncRef, tryIncRef

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, createTask, getDescription, setParentTask

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

TIMEOUT

public static final ParseField TIMEOUT

FORCE

public static final ParseField FORCE

ALLOW_NO_MATCH

public static final ParseField ALLOW_NO_MATCH

PARSER

public static final ObjectParser<CloseJobAction.Request,Void> PARSER

Constructor Details

Request

public Request()

Request

public Request(StreamInput in)
        throws IOException

Throws:

IOException

Request

public Request(String jobId)

Method Details

parseRequest

public static CloseJobAction.Request parseRequest(String jobId,
 XContentParser parser)

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class BaseTasksRequest<CloseJobAction.Request>

Throws:

IOException

getJobId

public String getJobId()

setJobId

public CloseJobAction.Request setJobId(String jobId)

getCloseTimeout

public TimeValue getCloseTimeout()

setCloseTimeout

public CloseJobAction.Request setCloseTimeout(TimeValue closeTimeout)

isForce

public boolean isForce()

setForce

public CloseJobAction.Request setForce(boolean force)

allowNoMatch

public boolean allowNoMatch()

setAllowNoMatch

public CloseJobAction.Request setAllowNoMatch(boolean allowNoMatch)

isLocal

public boolean isLocal()

setLocal

public CloseJobAction.Request setLocal(boolean local)

getOpenJobIds

public String[] getOpenJobIds()

setOpenJobIds

public CloseJobAction.Request setOpenJobIds(String[] openJobIds)

match

public boolean match(Task task)

Overrides:

match in class BaseTasksRequest<CloseJobAction.Request>

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object