Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ml.datafeed

Class ChunkingConfig

java.lang.Object

org.elasticsearch.xpack.core.ml.datafeed.ChunkingConfig

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class ChunkingConfig
extends Object
implements ToXContentObject, Writeable

The description of how searches should be chunked.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ChunkingConfig.Mode

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final ConstructingObjectParser<ChunkingConfig,Void>	LENIENT_PARSER
static final ParseField	MODE_FIELD
static final ConstructingObjectParser<ChunkingConfig,Void>	STRICT_PARSER
static final ParseField	TIME_SPAN_FIELD

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ChunkingConfig(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
TimeValue	getTimeSpan()
int	hashCode()
boolean	isEnabled()
boolean	isManual()
static ChunkingConfig	newAuto()
static ChunkingConfig	newManual(TimeValue timeSpan)
static ChunkingConfig	newOff()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

MODE_FIELD

public static final ParseField MODE_FIELD

TIME_SPAN_FIELD

public static final ParseField TIME_SPAN_FIELD

LENIENT_PARSER

public static final ConstructingObjectParser<ChunkingConfig,Void> LENIENT_PARSER

STRICT_PARSER

public static final ConstructingObjectParser<ChunkingConfig,Void> STRICT_PARSER

Constructor Details

ChunkingConfig

public ChunkingConfig(StreamInput in)
               throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

getTimeSpan

@Nullable
public TimeValue getTimeSpan()

isEnabled

public boolean isEnabled()

isManual

public boolean isManual()

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

newAuto

public static ChunkingConfig newAuto()

newOff

public static ChunkingConfig newOff()

newManual

public static ChunkingConfig newManual(TimeValue timeSpan)