Package org.elasticsearch.client.ml.datafeed

Class DelayedDataCheckConfig

java.lang.Object

org.elasticsearch.client.ml.datafeed.DelayedDataCheckConfig

All Implemented Interfaces:

ToXContent, ToXContentObject

public class DelayedDataCheckConfig
extends java.lang.Object
implements ToXContentObject

The configuration object containing the delayed data check settings. See enabledDelayedDataCheckConfig(TimeValue) for creating a new enabled datacheck with the given check_window See disabledDelayedDataCheckConfig() for creating a config for disabling delayed data checking.

Nested Class Summary

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	CHECK_WINDOW
static ParseField	ENABLED
static ConstructingObjectParser<DelayedDataCheckConfig,java.lang.Void>	PARSER

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

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
static DelayedDataCheckConfig	disabledDelayedDataCheckConfig()	This creates a new DelayedDataCheckConfig that disables the data check.
static DelayedDataCheckConfig	enabledDelayedDataCheckConfig(TimeValue timeValue)	This creates a new DelayedDataCheckConfig that has a check_window of the passed `timeValue` We query the index to the latest finalized bucket from this TimeValue in the past looking to see if any data has been indexed since the data was read with the Datafeed.
boolean	equals(java.lang.Object obj)
TimeValue	getCheckWindow()
int	hashCode()
boolean	isEnabled()
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

ENABLED

public static final ParseField ENABLED

CHECK_WINDOW

public static final ParseField CHECK_WINDOW

PARSER

public static final ConstructingObjectParser<DelayedDataCheckConfig,java.lang.Void> PARSER

Method Detail

enabledDelayedDataCheckConfig

public static DelayedDataCheckConfig enabledDelayedDataCheckConfig(TimeValue timeValue)

This creates a new DelayedDataCheckConfig that has a check_window of the passed `timeValue` We query the index to the latest finalized bucket from this TimeValue in the past looking to see if any data has been indexed since the data was read with the Datafeed. The window must be larger than the AnalysisConfig.bucketSpan, less than 24 hours, and span less than 10,000x buckets.

Parameters:

timeValue - The time length in the past from the latest finalized bucket to look for latent data. If `null` is provided, the appropriate window is calculated when it is used

disabledDelayedDataCheckConfig

public static DelayedDataCheckConfig disabledDelayedDataCheckConfig()

This creates a new DelayedDataCheckConfig that disables the data check.

isEnabled

public boolean isEnabled()

getCheckWindow

@Nullable
public TimeValue getCheckWindow()

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object