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
,org.elasticsearch.core.RefCounted
,TaskAwareRequest
,org.elasticsearch.xcontent.ToXContent
,org.elasticsearch.xcontent.ToXContentObject
public class StopDatafeedRequest
extends ActionRequest
implements org.elasticsearch.xcontent.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.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.ConstructingObjectParser<StopDatafeedRequest,
Void> static final org.elasticsearch.xcontent.ParseField
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
ConstructorDescriptionStopDatafeedRequest
(String... datafeedIds) Close the specified Datafeeds via their unique datafeedIds -
Method Summary
Modifier and TypeMethodDescriptionboolean
All the datafeedIds to be stoppedgetForce()
org.elasticsearch.core.TimeValue
int
hashCode()
void
setAllowNoMatch
(boolean allowNoMatch) Whether to ignore if a wildcard expression matches no datafeeds.void
setForce
(boolean force) Should the stopping be forced.void
setTimeout
(org.elasticsearch.core.TimeValue timeout) How long to wait for the stop request to complete before timing out.static StopDatafeedRequest
Explicitly stop all datafeedstoString()
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
-
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<StopDatafeedRequest,Void> PARSER
-
-
Constructor Details
-
StopDatafeedRequest
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 Details
-
stopAllDatafeedsRequest
Explicitly stop all datafeeds- Returns:
- a
StopDatafeedRequest
for all existing datafeeds
-
getDatafeedIds
All the datafeedIds to be stopped -
getTimeout
public org.elasticsearch.core.TimeValue getTimeout() -
setTimeout
public void setTimeout(org.elasticsearch.core.TimeValue timeout) How long to wait for the stop request to complete before timing out.- Parameters:
timeout
- Default value: 30 minutes
-
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
-
getAllowNoMatch
-
setAllowNoMatch
public void setAllowNoMatch(boolean allowNoMatch) Whether to ignore if a wildcard expression matches no datafeeds. This includes_all
string.- Parameters:
allowNoMatch
- Whentrue
ignore if wildcard or_all
matches no datafeeds. 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
-