Package org.elasticsearch.client.ml

Class StopDatafeedRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.client.ml.StopDatafeedRequest

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject, TaskAwareRequest

public class StopDatafeedRequest
extends ActionRequest
implements ToXContentObject

Request to stop Machine Learning Datafeeds

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>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static ParseField	ALLOW_NO_DATAFEEDS
static ParseField	FORCE
static ConstructingObjectParser<StopDatafeedRequest,Void>	PARSER
static ParseField	TIMEOUT

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
StopDatafeedRequest(String... datafeedIds)	Close the specified Datafeeds via their unique datafeedIds

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
Boolean	getAllowNoDatafeeds()
List<String>	getDatafeedIds()	All the datafeedIds to be stopped
Boolean	getForce()
TimeValue	getTimeout()
int	hashCode()
void	setAllowNoDatafeeds(boolean allowNoDatafeeds)	Whether to ignore if a wildcard expression matches no datafeeds.
void	setForce(boolean force)	Should the stopping be forced.
void	setTimeout(TimeValue timeout)	How long to wait for the stop request to complete before timing out.
static StopDatafeedRequest	stopAllDatafeedsRequest()	Explicitly stop all datafeeds
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
ActionRequestValidationException	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

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Field Detail

TIMEOUT

public static final ParseField TIMEOUT

FORCE

public static final ParseField FORCE

ALLOW_NO_DATAFEEDS

public static final ParseField ALLOW_NO_DATAFEEDS

PARSER

public static final ConstructingObjectParser<StopDatafeedRequest,Void> PARSER

Constructor Detail

StopDatafeedRequest

public StopDatafeedRequest(String... datafeedIds)

Close the specified Datafeeds via their unique datafeedIds

Parameters:

datafeedIds - must be non-null and non-empty and each datafeedId must be non-null

Method Detail

stopAllDatafeedsRequest

public static StopDatafeedRequest stopAllDatafeedsRequest()

Explicitly stop all datafeeds

Returns:

a StopDatafeedRequest for all existing datafeeds

getDatafeedIds

public List<String> getDatafeedIds()

All the datafeedIds to be stopped

getTimeout

public TimeValue getTimeout()

setTimeout

public void setTimeout(TimeValue timeout)

How long to wait for the stop request to complete before timing out.

Parameters:

timeout - Default value: 30 minutes

getForce

public Boolean getForce()

setForce

public void setForce(boolean force)

Should the stopping be forced. Use to forcefully stop a datafeed

Parameters:

force - When true forcefully stop the datafeed. Defaults to false

getAllowNoDatafeeds

public Boolean getAllowNoDatafeeds()

setAllowNoDatafeeds

public void setAllowNoDatafeeds(boolean allowNoDatafeeds)

Whether to ignore if a wildcard expression matches no datafeeds. This includes _all string.

Parameters:

allowNoDatafeeds - When true ignore if wildcard or _all matches no datafeeds. Defaults to true

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object