Package software.amazon.awssdk.services.sagemaker.model

Class DescribeInferenceRecommendationsJobResponse

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.DescribeInferenceRecommendationsJobResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeInferenceRecommendationsJobResponse.Builder,DescribeInferenceRecommendationsJobResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeInferenceRecommendationsJobResponse extends SageMakerResponse implements ToCopyableBuilder<DescribeInferenceRecommendationsJobResponse.Builder,DescribeInferenceRecommendationsJobResponse>

  • Method Details

    • jobName

      public final String jobName()

      The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

      Returns:
      The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

    • jobDescription

      public final String jobDescription()

      The job description that you provided when you initiated the job.

      Returns:
      The job description that you provided when you initiated the job.

    • jobType

      public final RecommendationJobType jobType()

      The job type that you provided when you initiated the job.

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

      Returns:
      The job type that you provided when you initiated the job.
      See Also:

    • jobTypeAsString

      public final String jobTypeAsString()

      The job type that you provided when you initiated the job.

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

      Returns:
      The job type that you provided when you initiated the job.
      See Also:

    • jobArn

      public final String jobArn()

      The Amazon Resource Name (ARN) of the job.

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

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role you provided when you initiated the job.

      Returns:
      The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role you provided when you initiated the job.

    • status

      public final RecommendationJobStatus status()

      The status of the job.

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

      Returns:
      The status of the job.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the job.

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

      Returns:
      The status of the job.
      See Also:

    • creationTime

      public final Instant creationTime()

      A timestamp that shows when the job was created.

      Returns:
      A timestamp that shows when the job was created.

    • completionTime

      public final Instant completionTime()

      A timestamp that shows when the job completed.

      Returns:
      A timestamp that shows when the job completed.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      A timestamp that shows when the job was last modified.

      Returns:
      A timestamp that shows when the job was last modified.

    • failureReason

      public final String failureReason()

      If the job fails, provides information why the job failed.

      Returns:
      If the job fails, provides information why the job failed.

    • inputConfig

      public final RecommendationJobInputConfig inputConfig()

      Returns information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations you provided when you initiated the job.

      Returns:
      Returns information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations you provided when you initiated the job.

    • stoppingConditions

      public final RecommendationJobStoppingConditions stoppingConditions()

      The stopping conditions that you provided when you initiated the job.

      Returns:
      The stopping conditions that you provided when you initiated the job.

    • hasInferenceRecommendations

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

    • inferenceRecommendations

      public final List<InferenceRecommendation> inferenceRecommendations()

      The recommendations made by Inference Recommender.

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

      Returns:
      The recommendations made by Inference Recommender.

    • hasEndpointPerformances

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

    • endpointPerformances

      public final List<EndpointPerformance> endpointPerformances()

      The performance results from running an Inference Recommender job on an existing endpoint.

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

      Returns:
      The performance results from running an Inference Recommender job on an existing endpoint.

    • toBuilder

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

    • builder

      public static DescribeInferenceRecommendationsJobResponse.Builder builder()

    • serializableBuilderClass

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