Class Prediction

java.lang.Object
software.amazon.awssdk.services.machinelearning.model.Prediction
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Prediction.Builder,Prediction>
@Generated("software.amazon.awssdk:codegen") public final class Prediction extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Prediction.Builder,Prediction>

The output from a Predict operation:

  • Details - Contains the following attributes: DetailsAttributes.PREDICTIVE_MODEL_TYPE - REGRESSION | BINARY | MULTICLASS DetailsAttributes.ALGORITHM - SGD

  • PredictedLabel - Present for either a BINARY or MULTICLASS MLModel request.

  • PredictedScores - Contains the raw classification score corresponding to each label.

  • PredictedValue - Present for a REGRESSION MLModel request.

See Also:

  • Method Details

    • predictedLabel

      public final String predictedLabel()

      The prediction label for either a BINARY or MULTICLASS MLModel.

      Returns:
      The prediction label for either a BINARY or MULTICLASS MLModel.

    • predictedValue

      public final Float predictedValue()

      The prediction value for REGRESSION MLModel.

      Returns:
      The prediction value for REGRESSION MLModel.

    • hasPredictedScores

      public final boolean hasPredictedScores()
      For responses, this returns true if the service returned a value for the PredictedScores property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • predictedScores

      public final Map<String,Float> predictedScores()
      Returns the value of the PredictedScores property for this object.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPredictedScores() method.

      Returns:
      The value of the PredictedScores property for this object.

    • details

      public final Map<DetailsAttributes,String> details()
      Returns the value of the Details property for this object.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDetails() method.

      Returns:
      The value of the Details property for this object.

    • hasDetails

      public final boolean hasDetails()
      For responses, this returns true if the service returned a value for the Details property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • detailsAsStrings

      public final Map<String,String> detailsAsStrings()
      Returns the value of the Details property for this object.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDetails() method.

      Returns:
      The value of the Details property for this object.

    • toBuilder

      public Prediction.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Prediction.Builder,Prediction>
      Returns:
      a builder for type T

    • builder

      public static Prediction.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Prediction.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.