Package org.elasticsearch.client.ml.datafeed

Class DatafeedConfig

java.lang.Object
org.elasticsearch.client.ml.datafeed.DatafeedConfig
All Implemented Interfaces:
org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public class DatafeedConfig
extends java.lang.Object
implements org.elasticsearch.common.xcontent.ToXContentObject
The datafeed configuration object. It specifies which indices to get the data from and offers parameters for customizing different aspects of the process.

  • Nested Class Summary

    Nested Classes
    Modifier and Type Class Description
    static class  DatafeedConfig.Builder  

    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.ParseField AGGREGATIONS  
    static org.elasticsearch.common.ParseField CHUNKING_CONFIG  
    static org.elasticsearch.common.ParseField DELAYED_DATA_CHECK_CONFIG  
    static org.elasticsearch.common.ParseField FREQUENCY  
    static org.elasticsearch.common.ParseField ID  
    static org.elasticsearch.common.ParseField INDEXES  
    static org.elasticsearch.common.ParseField INDICES  
    static org.elasticsearch.common.ParseField INDICES_OPTIONS  
    static org.elasticsearch.common.ParseField MAX_EMPTY_SEARCHES  
    static org.elasticsearch.common.xcontent.ConstructingObjectParser<DatafeedConfig.Builder,​java.lang.Void> PARSER  
    static org.elasticsearch.common.ParseField QUERY  
    static org.elasticsearch.common.ParseField QUERY_DELAY  
    static org.elasticsearch.common.ParseField SCRIPT_FIELDS  
    static org.elasticsearch.common.ParseField SCROLL_SIZE  

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

    EMPTY_PARAMS

  • Method Summary

    Modifier and Type Method Description
    static DatafeedConfig.Builder builder​(java.lang.String id, java.lang.String jobId)  
    boolean equals​(java.lang.Object other)
    The lists of indices and types are compared for equality but they are not sorted first so this test could fail simply because the indices and types lists are in different orders.
    org.elasticsearch.common.bytes.BytesReference getAggregations()  
    ChunkingConfig getChunkingConfig()  
    DelayedDataCheckConfig getDelayedDataCheckConfig()  
    org.elasticsearch.common.unit.TimeValue getFrequency()  
    java.lang.String getId()  
    java.util.List<java.lang.String> getIndices()  
    org.elasticsearch.action.support.IndicesOptions getIndicesOptions()  
    java.lang.String getJobId()  
    java.lang.Integer getMaxEmptySearches()  
    org.elasticsearch.common.bytes.BytesReference getQuery()  
    org.elasticsearch.common.unit.TimeValue getQueryDelay()  
    java.util.Map<java.lang.String,​java.lang.Object> getRuntimeMappings()  
    java.util.List<org.elasticsearch.search.builder.SearchSourceBuilder.ScriptField> getScriptFields()  
    java.lang.Integer getScrollSize()  
    int hashCode()
    Note this could be a heavy operation when a query or aggregations are set as we need to convert the bytes references into maps to compute a stable hash code.
    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

  • Field Details

    • ID

      public static final org.elasticsearch.common.ParseField ID

    • QUERY_DELAY

      public static final org.elasticsearch.common.ParseField QUERY_DELAY

    • FREQUENCY

      public static final org.elasticsearch.common.ParseField FREQUENCY

    • INDEXES

      public static final org.elasticsearch.common.ParseField INDEXES

    • INDICES

      public static final org.elasticsearch.common.ParseField INDICES

    • QUERY

      public static final org.elasticsearch.common.ParseField QUERY

    • SCROLL_SIZE

      public static final org.elasticsearch.common.ParseField SCROLL_SIZE

    • AGGREGATIONS

      public static final org.elasticsearch.common.ParseField AGGREGATIONS

    • SCRIPT_FIELDS

      public static final org.elasticsearch.common.ParseField SCRIPT_FIELDS

    • CHUNKING_CONFIG

      public static final org.elasticsearch.common.ParseField CHUNKING_CONFIG

    • DELAYED_DATA_CHECK_CONFIG

      public static final org.elasticsearch.common.ParseField DELAYED_DATA_CHECK_CONFIG

    • MAX_EMPTY_SEARCHES

      public static final org.elasticsearch.common.ParseField MAX_EMPTY_SEARCHES

    • INDICES_OPTIONS

      public static final org.elasticsearch.common.ParseField INDICES_OPTIONS

    • PARSER

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

  • Method Details

    • getId

      public java.lang.String getId()

    • getJobId

      public java.lang.String getJobId()

    • getQueryDelay

      public org.elasticsearch.common.unit.TimeValue getQueryDelay()

    • getFrequency

      public org.elasticsearch.common.unit.TimeValue getFrequency()

    • getIndices

      public java.util.List<java.lang.String> getIndices()

    • getScrollSize

      public java.lang.Integer getScrollSize()

    • getQuery

      public org.elasticsearch.common.bytes.BytesReference getQuery()

    • getAggregations

      public org.elasticsearch.common.bytes.BytesReference getAggregations()

    • getScriptFields

      public java.util.List<org.elasticsearch.search.builder.SearchSourceBuilder.ScriptField> getScriptFields()

    • getChunkingConfig

      public ChunkingConfig getChunkingConfig()

    • getDelayedDataCheckConfig

      public DelayedDataCheckConfig getDelayedDataCheckConfig()

    • getMaxEmptySearches

      public java.lang.Integer getMaxEmptySearches()

    • getIndicesOptions

      public org.elasticsearch.action.support.IndicesOptions getIndicesOptions()

    • getRuntimeMappings

      public java.util.Map<java.lang.String,​java.lang.Object> getRuntimeMappings()

    • 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

    • equals

      public boolean equals​(java.lang.Object other)
      The lists of indices and types are compared for equality but they are not sorted first so this test could fail simply because the indices and types lists are in different orders. Also note this could be a heavy operation when a query or aggregations are set as we need to convert the bytes references into maps to correctly compare them.
      Overrides:
      equals in class java.lang.Object

    • hashCode

      public int hashCode()
      Note this could be a heavy operation when a query or aggregations are set as we need to convert the bytes references into maps to compute a stable hash code.
      Overrides:
      hashCode in class java.lang.Object

    • builder

      public static DatafeedConfig.Builder builder​(java.lang.String id, java.lang.String jobId)