Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ml.dataframe

Class DataFrameAnalyticsConfig

java.lang.Object

org.elasticsearch.xpack.core.ml.dataframe.DataFrameAnalyticsConfig

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class DataFrameAnalyticsConfig
extends Object
implements ToXContentObject, Writeable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataFrameAnalyticsConfig.Builder

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 ParseField	ALLOW_LAZY_START
static final ParseField	ANALYSIS
static final ParseField	ANALYZED_FIELDS
static final String	BLANK_DEST_INDEX
static final String	BLANK_ID
static final ParseField	CONFIG_TYPE
static final ParseField	CREATE_TIME
static final ByteSizeValue	DEFAULT_MODEL_MEMORY_LIMIT
static final ParseField	DESCRIPTION
static final ParseField	DEST
static final ParseField	HEADERS
static final ParseField	ID
static final ObjectParser<DataFrameAnalyticsConfig.Builder,Void>	LENIENT_PARSER
static final ParseField	MAX_NUM_THREADS
static final ParseField	META
static final ByteSizeValue	MIN_MODEL_MEMORY_LIMIT
static final ParseField	MODEL_MEMORY_LIMIT
static final ByteSizeValue	PROCESS_MEMORY_OVERHEAD	This includes the overhead of thread stacks and data structures that the program might use that are not instrumented.
static final ParseField	SOURCE
static final ObjectParser<DataFrameAnalyticsConfig.Builder,Void>	STRICT_PARSER
static final String	TYPE
static final ParseField	VERSION

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
DataFrameAnalyticsConfig(StreamInput in)

Method Summary

Modifier and Type	Method	Description
static String	documentId(String id)
boolean	equals(Object o)
static String	extractJobIdFromDocId(String docId)	Returns the job id from the doc id.
DataFrameAnalysis	getAnalysis()
FetchSourceContext	getAnalyzedFields()
Instant	getCreateTime()
String	getDescription()
DataFrameAnalyticsDest	getDest()
Map<String,String>	getHeaders()
String	getId()
Integer	getMaxNumThreads()
Map<String,Object>	getMeta()
ByteSizeValue	getModelMemoryLimit()
DataFrameAnalyticsSource	getSource()
MlConfigVersion	getVersion()
int	hashCode()
boolean	isAllowLazyStart()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

BLANK_ID

public static final String BLANK_ID

See Also:

• Constant Field Values

BLANK_DEST_INDEX

public static final String BLANK_DEST_INDEX

See Also:

• Constant Field Values

TYPE

public static final String TYPE

See Also:

• Constant Field Values

DEFAULT_MODEL_MEMORY_LIMIT

public static final ByteSizeValue DEFAULT_MODEL_MEMORY_LIMIT

MIN_MODEL_MEMORY_LIMIT

public static final ByteSizeValue MIN_MODEL_MEMORY_LIMIT

PROCESS_MEMORY_OVERHEAD

public static final ByteSizeValue PROCESS_MEMORY_OVERHEAD

This includes the overhead of thread stacks and data structures that the program might use that are not instrumented. But it does NOT include the memory used by loading the executable code.

ID

public static final ParseField ID

DESCRIPTION

public static final ParseField DESCRIPTION

SOURCE

public static final ParseField SOURCE

DEST

public static final ParseField DEST

ANALYSIS

public static final ParseField ANALYSIS

CONFIG_TYPE

public static final ParseField CONFIG_TYPE

ANALYZED_FIELDS

public static final ParseField ANALYZED_FIELDS

MODEL_MEMORY_LIMIT

public static final ParseField MODEL_MEMORY_LIMIT

HEADERS

public static final ParseField HEADERS

CREATE_TIME

public static final ParseField CREATE_TIME

VERSION

public static final ParseField VERSION

ALLOW_LAZY_START

public static final ParseField ALLOW_LAZY_START

MAX_NUM_THREADS

public static final ParseField MAX_NUM_THREADS

META

public static final ParseField META

STRICT_PARSER

public static final ObjectParser<DataFrameAnalyticsConfig.Builder,Void> STRICT_PARSER

LENIENT_PARSER

public static final ObjectParser<DataFrameAnalyticsConfig.Builder,Void> LENIENT_PARSER

Constructor Details

DataFrameAnalyticsConfig

public DataFrameAnalyticsConfig(StreamInput in)
                         throws IOException

Throws:

IOException

Method Details

getId

public String getId()

getDescription

public String getDescription()

getSource

public DataFrameAnalyticsSource getSource()

getDest

public DataFrameAnalyticsDest getDest()

getAnalysis

public DataFrameAnalysis getAnalysis()

getAnalyzedFields

public FetchSourceContext getAnalyzedFields()

getModelMemoryLimit

public ByteSizeValue getModelMemoryLimit()

getHeaders

public Map<String,String> getHeaders()

getCreateTime

public Instant getCreateTime()

getVersion

public MlConfigVersion getVersion()

isAllowLazyStart

public boolean isAllowLazyStart()

getMaxNumThreads

public Integer getMaxNumThreads()

getMeta

public Map<String,Object> getMeta()

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

documentId

public static String documentId(String id)

extractJobIdFromDocId

@Nullable
public static String extractJobIdFromDocId(String docId)

Returns the job id from the doc id. Returns null if the doc id is invalid.