Package org.opensearch.ml.common.input.parameter.rcf

Class FitRCFParams

java.lang.Object

org.opensearch.ml.common.input.parameter.rcf.FitRCFParams

All Implemented Interfaces:

org.opensearch.core.common.io.stream.NamedWriteable, org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject, MLAlgoParams

public class FitRCFParams
extends Object
implements MLAlgoParams

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FitRCFParams.FitRCFParamsBuilder

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

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

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANOMALY_RATE
static final String	DATE_FORMAT
static final String	NUMBER_OF_TREES
static final String	OUTPUT_AFTER
static final String	PARSE_FIELD_NAME
static final String	SAMPLE_SIZE
static final String	SHINGLE_SIZE
static final String	TIME_DECAY
static final String	TIME_FIELD
static final String	TIME_ZONE
static final org.opensearch.core.xcontent.NamedXContentRegistry.Entry	XCONTENT_REGISTRY

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
FitRCFParams(Integer numberOfTrees, Integer shingleSize, Integer sampleSize, Integer outputAfter, Double timeDecay, Double anomalyRate, String timeField, String dateFormat, String timeZone)
FitRCFParams(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
static FitRCFParams.FitRCFParamsBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Double	getAnomalyRate()
String	getDateFormat()
Integer	getNumberOfTrees()
Integer	getOutputAfter()
Integer	getSampleSize()
Integer	getShingleSize()
Double	getTimeDecay()
String	getTimeField()
String	getTimeZone()
int	getVersion()
String	getWriteableName()
int	hashCode()
static FitRCFParams	parse(org.opensearch.core.xcontent.XContentParser parser)
void	setAnomalyRate(Double anomalyRate)
void	setDateFormat(String dateFormat)
void	setNumberOfTrees(Integer numberOfTrees)
void	setOutputAfter(Integer outputAfter)
void	setSampleSize(Integer sampleSize)
void	setShingleSize(Integer shingleSize)
void	setTimeDecay(Double timeDecay)
void	setTimeField(String timeField)
void	setTimeZone(String timeZone)
String	toString()
org.opensearch.core.xcontent.XContentBuilder	toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.core.xcontent.ToXContentObject

isFragment

Field Details

PARSE_FIELD_NAME

public static final String PARSE_FIELD_NAME

XCONTENT_REGISTRY

public static final org.opensearch.core.xcontent.NamedXContentRegistry.Entry XCONTENT_REGISTRY

NUMBER_OF_TREES

public static final String NUMBER_OF_TREES

See Also:

• Constant Field Values

SHINGLE_SIZE

public static final String SHINGLE_SIZE

See Also:

• Constant Field Values

SAMPLE_SIZE

public static final String SAMPLE_SIZE

See Also:

• Constant Field Values

OUTPUT_AFTER

public static final String OUTPUT_AFTER

See Also:

• Constant Field Values

TIME_DECAY

public static final String TIME_DECAY

See Also:

• Constant Field Values

ANOMALY_RATE

public static final String ANOMALY_RATE

See Also:

• Constant Field Values

TIME_FIELD

public static final String TIME_FIELD

See Also:

• Constant Field Values

DATE_FORMAT

public static final String DATE_FORMAT

See Also:

• Constant Field Values

TIME_ZONE

public static final String TIME_ZONE

See Also:

• Constant Field Values

Constructor Details

FitRCFParams

public FitRCFParams(Integer numberOfTrees,
 Integer shingleSize,
 Integer sampleSize,
 Integer outputAfter,
 Double timeDecay,
 Double anomalyRate,
 String timeField,
 String dateFormat,
 String timeZone)

FitRCFParams

public FitRCFParams(org.opensearch.core.common.io.stream.StreamInput in)
             throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Throws:

IOException

parse

public static FitRCFParams parse(org.opensearch.core.xcontent.XContentParser parser)
                          throws IOException

Throws:

IOException

getVersion

public int getVersion()

Specified by:

getVersion in interface MLAlgoParams

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface org.opensearch.core.common.io.stream.NamedWriteable

toXContent

public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                        throws IOException

Specified by:

toXContent in interface org.opensearch.core.xcontent.ToXContent

Throws:

IOException

builder

public static FitRCFParams.FitRCFParamsBuilder builder()

getNumberOfTrees

public Integer getNumberOfTrees()

getShingleSize

public Integer getShingleSize()

getSampleSize

public Integer getSampleSize()

getOutputAfter

public Integer getOutputAfter()

getTimeDecay

public Double getTimeDecay()

getAnomalyRate

public Double getAnomalyRate()

getTimeField

public String getTimeField()

getDateFormat

public String getDateFormat()

getTimeZone

public String getTimeZone()

setNumberOfTrees

public void setNumberOfTrees(Integer numberOfTrees)

setShingleSize

public void setShingleSize(Integer shingleSize)

setSampleSize

public void setSampleSize(Integer sampleSize)

setOutputAfter

public void setOutputAfter(Integer outputAfter)

setTimeDecay

public void setTimeDecay(Double timeDecay)

setAnomalyRate

public void setAnomalyRate(Double anomalyRate)

setTimeField

public void setTimeField(String timeField)

setDateFormat

public void setDateFormat(String dateFormat)

setTimeZone

public void setTimeZone(String timeZone)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object