Class AIRecommendation

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

An optimization recommendation generated by an AI recommendation job.

See Also:

  • Method Details

    • recommendationDescription

      public final String recommendationDescription()

      A description of the recommendation.

      Returns:
      A description of the recommendation.

    • hasOptimizationDetails

      public final boolean hasOptimizationDetails()
      For responses, this returns true if the service returned a value for the OptimizationDetails 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.

    • optimizationDetails

      public final List<AIRecommendationOptimizationDetail> optimizationDetails()

      The optimization techniques applied in this recommendation.

      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 hasOptimizationDetails() method.

      Returns:
      The optimization techniques applied in this recommendation.

    • modelDetails

      public final AIRecommendationModelDetails modelDetails()

      Details about the model package associated with this recommendation.

      Returns:
      Details about the model package associated with this recommendation.

    • deploymentConfiguration

      public final AIRecommendationDeploymentConfiguration deploymentConfiguration()

      The deployment configuration for this recommendation, including the container image, instance type, instance count, and environment variables.

      Returns:
      The deployment configuration for this recommendation, including the container image, instance type, instance count, and environment variables.

    • aiBenchmarkJobArn

      public final String aiBenchmarkJobArn()

      The Amazon Resource Name (ARN) of the benchmark job associated with this recommendation.

      Returns:
      The Amazon Resource Name (ARN) of the benchmark job associated with this recommendation.

    • hasExpectedPerformance

      public final boolean hasExpectedPerformance()
      For responses, this returns true if the service returned a value for the ExpectedPerformance 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.

    • expectedPerformance

      public final List<AIRecommendationPerformanceMetric> expectedPerformance()

      The expected performance metrics for this recommendation.

      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 hasExpectedPerformance() method.

      Returns:
      The expected performance metrics for this recommendation.

    • toBuilder

      public AIRecommendation.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<AIRecommendation.Builder,AIRecommendation>
      Returns:
      a builder for type T

    • builder

      public static AIRecommendation.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AIRecommendation.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.