Package org.elasticsearch.client.ml

Class PreviewDatafeedRequest

java.lang.Object
org.elasticsearch.client.ml.PreviewDatafeedRequest
All Implemented Interfaces:
Validatable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public class PreviewDatafeedRequest extends Object implements Validatable, org.elasticsearch.common.xcontent.ToXContentObject
Request to preview a MachineLearning Datafeed

  • 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.ConstructingObjectParser<PreviewDatafeedRequest,​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
    PreviewDatafeedRequest​(String datafeedId)
    Create a new request with the desired datafeedId
    PreviewDatafeedRequest​(DatafeedConfig datafeedConfig, Job jobConfig)
    Create a new request to preview the provided datafeed config and optional job config

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals​(Object other)
     
    static PreviewDatafeedRequest
    fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)
     
    DatafeedConfig
    getDatafeedConfig()
     
    String
    getDatafeedId()
     
    Job
    getJobConfig()
     
    int
    hashCode()
     
    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

  • Constructor Details

    • PreviewDatafeedRequest

      public PreviewDatafeedRequest​(String datafeedId)
      Create a new request with the desired datafeedId
      Parameters:
      datafeedId - unique datafeedId, must not be null

    • PreviewDatafeedRequest

      public PreviewDatafeedRequest​(DatafeedConfig datafeedConfig, Job jobConfig)
      Create a new request to preview the provided datafeed config and optional job config
      Parameters:
      datafeedConfig - The datafeed to preview
      jobConfig - The associated job config (required if the datafeed does not refer to an existing job)

  • Method Details

    • fromXContent

      public static PreviewDatafeedRequest fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser) throws IOException
      Throws:
      IOException

    • getDatafeedId

      public String getDatafeedId()

    • getDatafeedConfig

      public DatafeedConfig getDatafeedConfig()

    • getJobConfig

      public Job getJobConfig()

    • 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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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