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

Class RCFSummarizeParams

java.lang.Object

org.opensearch.ml.common.input.parameter.clustering.RCFSummarizeParams

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RCFSummarizeParams.DistanceType
static class	RCFSummarizeParams.RCFSummarizeParamsBuilder

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	DISTANCE_TYPE_FIELD
static final String	INITIAL_K_FIELD
static final String	MAX_K_FIELD
static final String	PARALLEL__FIELD
static final String	PARSE_FIELD_NAME
static final String	PHASE1_REASSIGN_FIELD
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
RCFSummarizeParams(Integer maxK, Integer initialK, RCFSummarizeParams.DistanceType distanceType, Boolean phase1Reassign, Boolean parallel)
RCFSummarizeParams(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
static RCFSummarizeParams.RCFSummarizeParamsBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
RCFSummarizeParams.DistanceType	getDistanceType()
Integer	getInitialK()
Integer	getMaxK()
Boolean	getParallel()
Boolean	getPhase1Reassign()
int	getVersion()
String	getWriteableName()
int	hashCode()
static MLAlgoParams	parse(org.opensearch.core.xcontent.XContentParser parser)
void	setDistanceType(RCFSummarizeParams.DistanceType distanceType)
void	setInitialK(Integer initialK)
void	setMaxK(Integer maxK)
void	setParallel(Boolean parallel)
void	setPhase1Reassign(Boolean phase1Reassign)
RCFSummarizeParams.RCFSummarizeParamsBuilder	toBuilder()
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

MAX_K_FIELD

public static final String MAX_K_FIELD

See Also:

• Constant Field Values

INITIAL_K_FIELD

public static final String INITIAL_K_FIELD

See Also:

• Constant Field Values

DISTANCE_TYPE_FIELD

public static final String DISTANCE_TYPE_FIELD

See Also:

• Constant Field Values

PHASE1_REASSIGN_FIELD

public static final String PHASE1_REASSIGN_FIELD

See Also:

• Constant Field Values

PARALLEL__FIELD

public static final String PARALLEL__FIELD

See Also:

• Constant Field Values

Constructor Details

RCFSummarizeParams

public RCFSummarizeParams(Integer maxK,
 Integer initialK,
 RCFSummarizeParams.DistanceType distanceType,
 Boolean phase1Reassign,
 Boolean parallel)

RCFSummarizeParams

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

Throws:

IOException

Method Details

parse

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

Throws:

IOException

getWriteableName

public String getWriteableName()

Specified by:

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

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

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

getVersion

public int getVersion()

Specified by:

getVersion in interface MLAlgoParams

builder

public static RCFSummarizeParams.RCFSummarizeParamsBuilder builder()

toBuilder

public RCFSummarizeParams.RCFSummarizeParamsBuilder toBuilder()

getMaxK

public Integer getMaxK()

getInitialK

public Integer getInitialK()

getDistanceType

public RCFSummarizeParams.DistanceType getDistanceType()

getPhase1Reassign

public Boolean getPhase1Reassign()

getParallel

public Boolean getParallel()

setMaxK

public void setMaxK(Integer maxK)

setInitialK

public void setInitialK(Integer initialK)

setDistanceType

public void setDistanceType(RCFSummarizeParams.DistanceType distanceType)

setPhase1Reassign

public void setPhase1Reassign(Boolean phase1Reassign)

setParallel

public void setParallel(Boolean parallel)

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