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:
org.elasticsearch.common.io.stream.Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, org.elasticsearch.tasks.TaskAwareRequest
public class StopDatafeedRequest
extends org.elasticsearch.action.ActionRequest
implements org.elasticsearch.common.xcontent.ToXContentObject
Request to stop Machine Learning Datafeeds

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

    org.elasticsearch.transport.TransportRequest.Empty

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

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

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

    org.elasticsearch.common.io.stream.Writeable.Reader<V extends java.lang.Object>, org.elasticsearch.common.io.stream.Writeable.Writer<V extends java.lang.Object>

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static org.elasticsearch.common.ParseField ALLOW_NO_MATCH  
    static org.elasticsearch.common.ParseField FORCE  
    static org.elasticsearch.common.xcontent.ConstructingObjectParser<StopDatafeedRequest,​java.lang.Void> PARSER  
    static org.elasticsearch.common.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 getAllowNoMatch()  
    java.util.List<java.lang.String> getDatafeedIds()
    All the datafeedIds to be stopped
    java.lang.Boolean getForce()  
    org.elasticsearch.common.unit.TimeValue getTimeout()  
    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.common.unit.TimeValue timeout)
    How long to wait for the stop request to complete before timing out.
    static StopDatafeedRequest stopAllDatafeedsRequest()
    Explicitly stop all datafeeds
    java.lang.String toString()  
    org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)  
    org.elasticsearch.action.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 Details

    • TIMEOUT

      public static final org.elasticsearch.common.ParseField TIMEOUT

    • FORCE

      public static final org.elasticsearch.common.ParseField FORCE

    • ALLOW_NO_MATCH

      public static final org.elasticsearch.common.ParseField ALLOW_NO_MATCH

    • PARSER

      public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<StopDatafeedRequest,​java.lang.Void> PARSER

  • Constructor Details

    • StopDatafeedRequest

      public StopDatafeedRequest​(java.lang.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 Details

    • 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 org.elasticsearch.common.unit.TimeValue getTimeout()

    • setTimeout

      public void setTimeout​(org.elasticsearch.common.unit.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 - When true forcefully stop the datafeed. Defaults to false

    • getAllowNoMatch

      public java.lang.Boolean getAllowNoMatch()

    • setAllowNoMatch

      public void setAllowNoMatch​(boolean allowNoMatch)
      Whether to ignore if a wildcard expression matches no datafeeds. This includes _all string.
      Parameters:
      allowNoMatch - When true ignore if wildcard or _all matches no datafeeds. Defaults to true

    • validate

      public org.elasticsearch.action.ActionRequestValidationException validate()
      Specified by:
      validate in class org.elasticsearch.action.ActionRequest

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • equals

      public boolean equals​(java.lang.Object other)
      Overrides:
      equals in class java.lang.Object

    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      java.io.IOException

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object