Package org.opensearch.ml.common.output

Class MLOutput

java.lang.Object
org.opensearch.ml.common.output.MLOutput
All Implemented Interfaces:
org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject, Output
Direct Known Subclasses:
MLPredictionOutput, MLTrainingOutput, ModelTensorOutput, SampleAlgoOutput
public abstract class MLOutput extends Object implements Output
ML output data. Must specify output type and

  • Nested Class Summary

    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 inherited from interface org.opensearch.core.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    MLOutput()
     
    MLOutput(@NonNull MLOutputType outputType)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static MLOutput
    fromStream(org.opensearch.core.common.io.stream.StreamInput in)
     
    protected abstract MLOutputType
    getType()
     
    void
    writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
     

    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.ToXContent

    toXContent

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

    isFragment

  • Constructor Details

    • MLOutput

      public MLOutput()

    • MLOutput

      public MLOutput(@NonNull @NonNull MLOutputType outputType)

  • 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

    • fromStream

      public static MLOutput fromStream(org.opensearch.core.common.io.stream.StreamInput in) throws IOException
      Throws:
      IOException

    • getType

      protected abstract MLOutputType getType()