Package org.elasticsearch.client.ml

Class GetDatafeedStatsRequest

java.lang.Object
org.elasticsearch.client.ml.GetDatafeedStatsRequest
All Implemented Interfaces:
Validatable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public class GetDatafeedStatsRequest extends Object implements Validatable, org.elasticsearch.common.xcontent.ToXContentObject
Request object to get DatafeedStats by their respective datafeedIds _all explicitly gets all the datafeeds' statistics in the cluster An empty request (no datafeedIds) implicitly gets all the datafeeds' statistics in the cluster

  • 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.ConstructingObjectParser<GetDatafeedStatsRequest,​Void>
    PARSER
     

    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
    GetDatafeedStatsRequest​(String... datafeedIds)
    Get the specified Datafeed's statistics via their unique datafeedIds

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals​(Object other)
     
    static GetDatafeedStatsRequest
    getAllDatafeedStatsRequest()
    Explicitly gets all datafeeds statistics
    Boolean
    getAllowNoMatch()
     
    List<String>
    getDatafeedIds()
    All the datafeedIds for which to get statistics
    int
    hashCode()
     
    void
    setAllowNoMatch​(boolean allowNoMatch)
    Whether to ignore if a wildcard expression matches no datafeeds.
    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, toString, wait, wait, wait

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

    isFragment

    Methods inherited from interface org.elasticsearch.client.Validatable

    validate

  • Field Details

    • ALLOW_NO_MATCH

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

    • PARSER

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

  • Constructor Details

    • GetDatafeedStatsRequest

      public GetDatafeedStatsRequest​(String... datafeedIds)
      Get the specified Datafeed's statistics via their unique datafeedIds
      Parameters:
      datafeedIds - must be non-null and each datafeedId must be non-null

  • Method Details

    • getAllDatafeedStatsRequest

      public static GetDatafeedStatsRequest getAllDatafeedStatsRequest()
      Explicitly gets all datafeeds statistics
      Returns:
      a GetDatafeedStatsRequest for all existing datafeeds

    • getDatafeedIds

      public List<String> getDatafeedIds()
      All the datafeedIds for which to get statistics

    • getAllowNoMatch

      public Boolean getAllowNoMatch()

    • setAllowNoMatch

      public void setAllowNoMatch​(boolean allowNoMatch)
      Whether to ignore if a wildcard expression matches no datafeeds. This includes _all string or when no datafeeds have been specified
      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