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

Class BatchRCFParams

java.lang.Object

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

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 BatchRCFParams
extends Object
implements MLAlgoParams

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BatchRCFParams.BatchRCFParamsBuilder

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_SCORE_THRESHOLD
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	TRAINING_DATA_SIZE
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
BatchRCFParams(Integer numberOfTrees, Integer shingleSize, Integer sampleSize, Integer outputAfter, Integer trainingDataSize, Double anomalyScoreThreshold)
BatchRCFParams(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
static BatchRCFParams.BatchRCFParamsBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Double	getAnomalyScoreThreshold()
Integer	getNumberOfTrees()
Integer	getOutputAfter()
Integer	getSampleSize()
Integer	getShingleSize()
Integer	getTrainingDataSize()
int	getVersion()
String	getWriteableName()
int	hashCode()
static BatchRCFParams	parse(org.opensearch.core.xcontent.XContentParser parser)
void	setAnomalyScoreThreshold(Double anomalyScoreThreshold)
void	setNumberOfTrees(Integer numberOfTrees)
void	setOutputAfter(Integer outputAfter)
void	setSampleSize(Integer sampleSize)
void	setShingleSize(Integer shingleSize)
void	setTrainingDataSize(Integer trainingDataSize)
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

TRAINING_DATA_SIZE

public static final String TRAINING_DATA_SIZE

See Also:

• Constant Field Values

ANOMALY_SCORE_THRESHOLD

public static final String ANOMALY_SCORE_THRESHOLD

See Also:

• Constant Field Values

Constructor Details

BatchRCFParams

public BatchRCFParams(Integer numberOfTrees,
 Integer shingleSize,
 Integer sampleSize,
 Integer outputAfter,
 Integer trainingDataSize,
 Double anomalyScoreThreshold)

BatchRCFParams

public BatchRCFParams(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 BatchRCFParams 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 BatchRCFParams.BatchRCFParamsBuilder builder()

getNumberOfTrees

public Integer getNumberOfTrees()

getShingleSize

public Integer getShingleSize()

getSampleSize

public Integer getSampleSize()

getOutputAfter

public Integer getOutputAfter()

getTrainingDataSize

public Integer getTrainingDataSize()

getAnomalyScoreThreshold

public Double getAnomalyScoreThreshold()

setNumberOfTrees

public void setNumberOfTrees(Integer numberOfTrees)

setShingleSize

public void setShingleSize(Integer shingleSize)

setSampleSize

public void setSampleSize(Integer sampleSize)

setOutputAfter

public void setOutputAfter(Integer outputAfter)

setTrainingDataSize

public void setTrainingDataSize(Integer trainingDataSize)

setAnomalyScoreThreshold

public void setAnomalyScoreThreshold(Double anomalyScoreThreshold)

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