Package org.opensearch.ml.common.output

Class MLTrainingOutput

java.lang.Object

org.opensearch.ml.common.output.MLOutput

org.opensearch.ml.common.output.MLTrainingOutput

All Implemented Interfaces:

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

public class MLTrainingOutput
extends MLOutput

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MLTrainingOutput.MLTrainingOutputBuilder

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	MODEL_ID_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
MLTrainingOutput(String modelId, String taskId, String status)
MLTrainingOutput(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
static MLTrainingOutput.MLTrainingOutputBuilder	builder()
String	getModelId()
String	getStatus()
String	getTaskId()
MLOutputType	getType()
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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

isFragment

Field Details

MODEL_ID_FIELD

public static final String MODEL_ID_FIELD

See Also:

• Constant Field Values

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

Constructor Details

MLTrainingOutput

public MLTrainingOutput(String modelId,
 String taskId,
 String status)

MLTrainingOutput

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

Throws:

IOException

Method Details

getType

public MLOutputType getType()

Specified by:

getType in class MLOutput

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

builder

public static MLTrainingOutput.MLTrainingOutputBuilder builder()

getModelId

public String getModelId()

getTaskId

public String getTaskId()

getStatus

public String getStatus()