Class InferenceRecommendationsJob

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

A structure that contains a list of recommendation jobs.

See Also:

  • Method Details

    • jobName

      public final String jobName()

      The name of the job.

      Returns:
      The name of the job.

    • jobDescription

      public final String jobDescription()

      The job description.

      Returns:
      The job description.

    • jobType

      public final RecommendationJobType jobType()

      The recommendation job type.

      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 recommendation job type.
      See Also:

    • jobTypeAsString

      public final String jobTypeAsString()

      The recommendation job type.

      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 recommendation job type.
      See Also:

    • jobArn

      public final String jobArn()

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

      Returns:
      The Amazon Resource Name (ARN) of the recommendation 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.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

      Returns:
      The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

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

    • modelName

      public final String modelName()

      The name of the created model.

      Returns:
      The name of the created model.

    • samplePayloadUrl

      public final String samplePayloadUrl()

      The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

      Returns:
      The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

    • modelPackageVersionArn

      public final String modelPackageVersionArn()

      The Amazon Resource Name (ARN) of a versioned model package.

      Returns:
      The Amazon Resource Name (ARN) of a versioned model package.

    • toBuilder

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

    • builder

      public static InferenceRecommendationsJob.Builder builder()

    • serializableBuilderClass

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