Package org.elasticsearch.client.ml.datafeed

Class DatafeedConfig

java.lang.Object

org.elasticsearch.client.ml.datafeed.DatafeedConfig

All Implemented Interfaces:

ToXContent, ToXContentObject

public class DatafeedConfig
extends Object
implements 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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static ParseField	AGGREGATIONS
static ParseField	CHUNKING_CONFIG
static ParseField	DELAYED_DATA_CHECK_CONFIG
static ParseField	FREQUENCY
static ParseField	ID
static ParseField	INDEXES
static ParseField	INDICES
static ParseField	MAX_EMPTY_SEARCHES
static ConstructingObjectParser<DatafeedConfig.Builder,Void>	PARSER
static ParseField	QUERY
static ParseField	QUERY_DELAY
static ParseField	SCRIPT_FIELDS
static 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(String id, String jobId)
boolean	equals(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.
BytesReference	getAggregations()
ChunkingConfig	getChunkingConfig()
DelayedDataCheckConfig	getDelayedDataCheckConfig()
TimeValue	getFrequency()
String	getId()
List<String>	getIndices()
String	getJobId()
Integer	getMaxEmptySearches()
BytesReference	getQuery()
TimeValue	getQueryDelay()
List<SearchSourceBuilder.ScriptField>	getScriptFields()
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.
XContentBuilder	toXContent(XContentBuilder builder, 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 Detail

ID

public static final ParseField ID

QUERY_DELAY

public static final ParseField QUERY_DELAY

FREQUENCY

public static final ParseField FREQUENCY

INDEXES

public static final ParseField INDEXES

INDICES

public static final ParseField INDICES

QUERY

public static final ParseField QUERY

SCROLL_SIZE

public static final ParseField SCROLL_SIZE

AGGREGATIONS

public static final ParseField AGGREGATIONS

SCRIPT_FIELDS

public static final ParseField SCRIPT_FIELDS

CHUNKING_CONFIG

public static final ParseField CHUNKING_CONFIG

DELAYED_DATA_CHECK_CONFIG

public static final ParseField DELAYED_DATA_CHECK_CONFIG

MAX_EMPTY_SEARCHES

public static final ParseField MAX_EMPTY_SEARCHES

PARSER

public static final ConstructingObjectParser<DatafeedConfig.Builder,Void> PARSER

Method Detail

getId

public String getId()

getJobId

public String getJobId()

getQueryDelay

public TimeValue getQueryDelay()

getFrequency

public TimeValue getFrequency()

getIndices

public List<String> getIndices()

getScrollSize

public Integer getScrollSize()

getQuery

public BytesReference getQuery()

getAggregations

public BytesReference getAggregations()

getScriptFields

public List<SearchSourceBuilder.ScriptField> getScriptFields()

getChunkingConfig

public ChunkingConfig getChunkingConfig()

getDelayedDataCheckConfig

public DelayedDataCheckConfig getDelayedDataCheckConfig()

getMaxEmptySearches

public Integer getMaxEmptySearches()

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

equals

public boolean equals(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 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 Object

builder

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