Class DeploymentRecommendation

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

A set of recommended deployment configurations for the model. To get more advanced recommendations, see CreateInferenceRecommendationsJob to create an inference recommendation job.

See Also:

  • Method Details

    • recommendationStatus

      public final RecommendationStatus recommendationStatus()

      Status of the deployment recommendation. The status NOT_APPLICABLE means that SageMaker is unable to provide a default recommendation for the model using the information provided. If the deployment status is IN_PROGRESS, retry your API call after a few seconds to get a COMPLETED deployment recommendation.

      If the service returns an enum value that is not available in the current SDK version, recommendationStatus will return RecommendationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from recommendationStatusAsString().

      Returns:
      Status of the deployment recommendation. The status NOT_APPLICABLE means that SageMaker is unable to provide a default recommendation for the model using the information provided. If the deployment status is IN_PROGRESS, retry your API call after a few seconds to get a COMPLETED deployment recommendation.
      See Also:

    • recommendationStatusAsString

      public final String recommendationStatusAsString()

      Status of the deployment recommendation. The status NOT_APPLICABLE means that SageMaker is unable to provide a default recommendation for the model using the information provided. If the deployment status is IN_PROGRESS, retry your API call after a few seconds to get a COMPLETED deployment recommendation.

      If the service returns an enum value that is not available in the current SDK version, recommendationStatus will return RecommendationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from recommendationStatusAsString().

      Returns:
      Status of the deployment recommendation. The status NOT_APPLICABLE means that SageMaker is unable to provide a default recommendation for the model using the information provided. If the deployment status is IN_PROGRESS, retry your API call after a few seconds to get a COMPLETED deployment recommendation.
      See Also:

    • hasRealTimeInferenceRecommendations

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

    • realTimeInferenceRecommendations

      public final List<RealTimeInferenceRecommendation> realTimeInferenceRecommendations()

      A list of RealTimeInferenceRecommendation items.

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

      Returns:
      A list of RealTimeInferenceRecommendation items.

    • toBuilder

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

    • builder

      public static DeploymentRecommendation.Builder builder()

    • serializableBuilderClass

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