Package org.opensearch.ml.common.output

Class MLPredictionOutput

java.lang.Object

org.opensearch.ml.common.output.MLOutput

org.opensearch.ml.common.output.MLPredictionOutput

All Implemented Interfaces:

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

public class MLPredictionOutput
extends MLOutput

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MLPredictionOutput.MLPredictionOutputBuilder

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	PREDICTION_RESULT_FIELD
static final String	STATUS_FIELD
static final String	TASK_ID_FIELD

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
MLPredictionOutput(String taskId, String status, DataFrame predictionResult)
MLPredictionOutput(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
static MLPredictionOutput.MLPredictionOutputBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
DataFrame	getPredictionResult()
String	getStatus()
String	getTaskId()
MLOutputType	getType()
int	hashCode()
void	setPredictionResult(DataFrame predictionResult)
void	setStatus(String status)
void	setTaskId(String taskId)
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 org.opensearch.ml.common.output.MLOutput

fromStream

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

TASK_ID_FIELD

public static final String TASK_ID_FIELD

See Also:

• Constant Field Values

STATUS_FIELD

public static final String STATUS_FIELD

See Also:

• Constant Field Values

PREDICTION_RESULT_FIELD

public static final String PREDICTION_RESULT_FIELD

See Also:

• Constant Field Values

Constructor Details

MLPredictionOutput

public MLPredictionOutput(String taskId,
 String status,
 DataFrame predictionResult)

MLPredictionOutput

public MLPredictionOutput(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

Overrides:

writeTo in class MLOutput

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

Throws:

IOException

getType

public MLOutputType getType()

Specified by:

getType in class MLOutput

builder

public static MLPredictionOutput.MLPredictionOutputBuilder builder()

getTaskId

public String getTaskId()

getStatus

public String getStatus()

getPredictionResult

public DataFrame getPredictionResult()

setTaskId

public void setTaskId(String taskId)

setStatus

public void setStatus(String status)

setPredictionResult

public void setPredictionResult(DataFrame predictionResult)

toString

public String toString()

Overrides:

toString in class Object

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