Package org.elasticsearch.client.ml

Class GetDatafeedRequest

java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.client.ml.GetDatafeedRequest
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 GetDatafeedRequest
extends org.elasticsearch.action.ActionRequest
implements org.elasticsearch.common.xcontent.ToXContentObject
Request object to get DatafeedConfig objects with the matching datafeedIds. _all explicitly gets all the datafeeds in the cluster An empty request (no datafeedIds) implicitly gets all the datafeeds in the cluster

  • 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 DATAFEED_IDS  
    static java.lang.String EXCLUDE_GENERATED  
    static org.elasticsearch.common.xcontent.ConstructingObjectParser<GetDatafeedRequest,​java.lang.Void> PARSER  

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

    EMPTY_PARAMS

  • Constructor Summary

    Constructors 
    Constructor Description
    GetDatafeedRequest​(java.lang.String... datafeedIds)
    Get the specified DatafeedConfig configurations via their unique datafeedIds

  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object other)  
    static GetDatafeedRequest getAllDatafeedsRequest()
    Helper method to create a query that will get ALL datafeeds
    java.lang.Boolean getAllowNoMatch()  
    java.util.List<java.lang.String> getDatafeedIds()
    All the datafeedIds for which to get configuration information
    java.lang.Boolean getExcludeGenerated()  
    int hashCode()  
    void setAllowNoMatch​(boolean allowNoMatch)
    Whether to ignore if a wildcard expression matches no datafeeds.
    void setExcludeGenerated​(boolean excludeGenerated)
    Setting this flag to `true` removes certain fields from the configuration on retrieval.
    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, toString, 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

  • Constructor Details

    • GetDatafeedRequest

      public GetDatafeedRequest​(java.lang.String... datafeedIds)
      Get the specified DatafeedConfig configurations via their unique datafeedIds
      Parameters:
      datafeedIds - must not contain any null values

  • Method Details

    • getAllDatafeedsRequest

      public static GetDatafeedRequest getAllDatafeedsRequest()
      Helper method to create a query that will get ALL datafeeds
      Returns:
      new GetDatafeedRequest object searching for the datafeedId "_all"

    • getDatafeedIds

      public java.util.List<java.lang.String> getDatafeedIds()
      All the datafeedIds for which to get configuration information

    • setAllowNoMatch

      public void setAllowNoMatch​(boolean allowNoMatch)
      Whether to ignore if a wildcard expression matches no datafeeds.
      Parameters:
      allowNoMatch - If this is false, then an error is returned when a wildcard (or _all) does not match any datafeeds

    • getAllowNoMatch

      public java.lang.Boolean getAllowNoMatch()

    • setExcludeGenerated

      public void setExcludeGenerated​(boolean excludeGenerated)
      Setting this flag to `true` removes certain fields from the configuration on retrieval. This is useful when getting the configuration and wanting to put it in another cluster. Default value is false.
      Parameters:
      excludeGenerated - Boolean value indicating if certain fields should be removed

    • getExcludeGenerated

      public java.lang.Boolean getExcludeGenerated()

    • 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