Package org.elasticsearch.client.ml

Class StopDatafeedRequest

java.lang.Object
org.elasticsearch.client.ml.StopDatafeedRequest
All Implemented Interfaces:
Validatable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public class StopDatafeedRequest extends Object implements Validatable, org.elasticsearch.common.xcontent.ToXContentObject
Request to stop Machine Learning Datafeeds

  • Nested Class Summary

    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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static org.elasticsearch.common.xcontent.ParseField
    ALLOW_NO_MATCH
     
    static org.elasticsearch.common.xcontent.ParseField
    FORCE
     
    static org.elasticsearch.common.xcontent.ConstructingObjectParser<StopDatafeedRequest,​Void>
    PARSER
     
    static org.elasticsearch.common.xcontent.ParseField
    TIMEOUT
     

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

    EMPTY_PARAMS

    Fields inherited from interface org.elasticsearch.client.Validatable

    EMPTY

  • 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
    getAllowNoMatch()
     
    List<String>
    getDatafeedIds()
    All the datafeedIds to be stopped
    Boolean
    getForce()
     
    org.elasticsearch.core.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.core.TimeValue timeout)
    How long to wait for the stop request to complete before timing out.
    static StopDatafeedRequest
    stopAllDatafeedsRequest()
    Explicitly stop all datafeeds
    String
    toString()
     
    org.elasticsearch.common.xcontent.XContentBuilder
    toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
     

    Methods inherited from class java.lang.Object

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

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

    isFragment

    Methods inherited from interface org.elasticsearch.client.Validatable

    validate

  • Field Details

    • TIMEOUT

      public static final org.elasticsearch.common.xcontent.ParseField TIMEOUT

    • FORCE

      public static final org.elasticsearch.common.xcontent.ParseField FORCE

    • ALLOW_NO_MATCH

      public static final org.elasticsearch.common.xcontent.ParseField ALLOW_NO_MATCH

    • PARSER

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

  • Constructor Details

    • 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 Details

    • 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 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

      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

    • getAllowNoMatch

      public 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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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

    • toXContent

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

    • toString

      public String toString()
      Overrides:
      toString in class Object