Class DescribeAiRecommendationJobResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.sagemaker.model.SageMakerResponse
software.amazon.awssdk.services.sagemaker.model.DescribeAiRecommendationJobResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeAiRecommendationJobResponse.Builder,DescribeAiRecommendationJobResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeAiRecommendationJobResponse extends SageMakerResponse implements ToCopyableBuilder<DescribeAiRecommendationJobResponse.Builder,DescribeAiRecommendationJobResponse>

  • Method Details

    • aiRecommendationJobName

      public final String aiRecommendationJobName()

      The name of the AI recommendation job.

      Returns:
      The name of the AI recommendation job.

    • aiRecommendationJobArn

      public final String aiRecommendationJobArn()

      The Amazon Resource Name (ARN) of the AI recommendation job.

      Returns:
      The Amazon Resource Name (ARN) of the AI recommendation job.

    • aiRecommendationJobStatus

      public final AIRecommendationJobStatus aiRecommendationJobStatus()

      The status of the AI recommendation job.

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

      Returns:
      The status of the AI recommendation job.
      See Also:

    • aiRecommendationJobStatusAsString

      public final String aiRecommendationJobStatusAsString()

      The status of the AI recommendation job.

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

      Returns:
      The status of the AI recommendation job.
      See Also:

    • failureReason

      public final String failureReason()

      If the recommendation job failed, the reason it failed.

      Returns:
      If the recommendation job failed, the reason it failed.

    • modelSource

      public final AIModelSource modelSource()

      The source of the model that was analyzed.

      Returns:
      The source of the model that was analyzed.

    • outputConfig

      public final AIRecommendationOutputResult outputConfig()

      The output configuration for the recommendation job.

      Returns:
      The output configuration for the recommendation job.

    • inferenceSpecification

      public final AIRecommendationInferenceSpecification inferenceSpecification()

      The inference framework configuration.

      Returns:
      The inference framework configuration.

    • aiWorkloadConfigIdentifier

      public final String aiWorkloadConfigIdentifier()

      The name or Amazon Resource Name (ARN) of the AI workload configuration used for this recommendation job.

      Returns:
      The name or Amazon Resource Name (ARN) of the AI workload configuration used for this recommendation job.

    • optimizeModel

      public final Boolean optimizeModel()

      Whether model optimization techniques were allowed.

      Returns:
      Whether model optimization techniques were allowed.

    • performanceTarget

      public final AIRecommendationPerformanceTarget performanceTarget()

      The performance targets specified for the recommendation job.

      Returns:
      The performance targets specified for the recommendation job.

    • hasRecommendations

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

    • recommendations

      public final List<AIRecommendation> recommendations()

      The list of optimization recommendations generated by the job. Each recommendation includes optimization details, deployment configuration, expected performance metrics, and the associated benchmark job ARN.

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

      Returns:
      The list of optimization recommendations generated by the job. Each recommendation includes optimization details, deployment configuration, expected performance metrics, and the associated benchmark job ARN.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the IAM role used by the recommendation job.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role used by the recommendation job.

    • computeSpec

      public final AIRecommendationComputeSpec computeSpec()

      The compute resource specification for the recommendation job.

      Returns:
      The compute resource specification for the recommendation job.

    • creationTime

      public final Instant creationTime()

      A timestamp that indicates when the recommendation job was created.

      Returns:
      A timestamp that indicates when the recommendation job was created.

    • startTime

      public final Instant startTime()

      A timestamp that indicates when the recommendation job started running.

      Returns:
      A timestamp that indicates when the recommendation job started running.

    • endTime

      public final Instant endTime()

      A timestamp that indicates when the recommendation job completed.

      Returns:
      A timestamp that indicates when the recommendation job completed.

    • hasTags

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

    • tags

      public final List<Tag> tags()

      The tags associated with the recommendation job.

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

      Returns:
      The tags associated with the recommendation job.

    • toBuilder

      public DescribeAiRecommendationJobResponse.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<DescribeAiRecommendationJobResponse.Builder,DescribeAiRecommendationJobResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeAiRecommendationJobResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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