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:
Streamable
,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 extends java.lang.Object>, Writeable.Writer<V extends java.lang.Object>
-
-
Field Summary
Fields Modifier and Type Field Description static ParseField
ALLOW_NO_DATAFEEDS
static ParseField
FORCE
static ConstructingObjectParser<StopDatafeedRequest,java.lang.Void>
PARSER
static ParseField
TIMEOUT
-
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
-
Constructor Summary
Constructors Constructor Description StopDatafeedRequest(java.lang.String... datafeedIds)
Close the specified Datafeeds via their unique datafeedIds
-
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object other)
java.lang.Boolean
getAllowNoDatafeeds()
java.util.List<java.lang.String>
getDatafeedIds()
All the datafeedIds to be stoppedjava.lang.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 datafeedsjava.lang.String
toString()
XContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
ActionRequestValidationException
validate()
-
Methods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResult, readFrom, 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,java.lang.Void> PARSER
-
-
Method Detail
-
stopAllDatafeedsRequest
public static StopDatafeedRequest stopAllDatafeedsRequest()
Explicitly stop all datafeeds- Returns:
- a
StopDatafeedRequest
for all existing datafeeds
-
getDatafeedIds
public java.util.List<java.lang.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 java.lang.Boolean getForce()
-
setForce
public void setForce(boolean force)
Should the stopping be forced. Use to forcefully stop a datafeed- Parameters:
force
- Whentrue
forcefully stop the datafeed. Defaults tofalse
-
getAllowNoDatafeeds
public java.lang.Boolean getAllowNoDatafeeds()
-
setAllowNoDatafeeds
public void setAllowNoDatafeeds(boolean allowNoDatafeeds)
Whether to ignore if a wildcard expression matches no datafeeds. This includes_all
string.- Parameters:
allowNoDatafeeds
- Whentrue
ignore if wildcard or_all
matches no datafeeds. Defaults totrue
-
validate
public ActionRequestValidationException validate()
- Specified by:
validate
in classActionRequest
-
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 XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-