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

Class DescribeEdgePackagingJobResponse

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

  • Method Details

    • edgePackagingJobArn

      public final String edgePackagingJobArn()

      The Amazon Resource Name (ARN) of the edge packaging job.

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

    • edgePackagingJobName

      public final String edgePackagingJobName()

      The name of the edge packaging job.

      Returns:
      The name of the edge packaging job.

    • compilationJobName

      public final String compilationJobName()

      The name of the SageMaker Neo compilation job that is used to locate model artifacts that are being packaged.

      Returns:
      The name of the SageMaker Neo compilation job that is used to locate model artifacts that are being packaged.

    • modelName

      public final String modelName()

      The name of the model.

      Returns:
      The name of the model.

    • modelVersion

      public final String modelVersion()

      The version of the model.

      Returns:
      The version of the model.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact Neo.

      Returns:
      The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact Neo.

    • outputConfig

      public final EdgeOutputConfig outputConfig()

      The output configuration for the edge packaging job.

      Returns:
      The output configuration for the edge packaging job.

    • resourceKey

      public final String resourceKey()

      The Amazon Web Services KMS key to use when encrypting the EBS volume the job run on.

      Returns:
      The Amazon Web Services KMS key to use when encrypting the EBS volume the job run on.

    • edgePackagingJobStatus

      public final EdgePackagingJobStatus edgePackagingJobStatus()

      The current status of the packaging job.

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

      Returns:
      The current status of the packaging job.
      See Also:

    • edgePackagingJobStatusAsString

      public final String edgePackagingJobStatusAsString()

      The current status of the packaging job.

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

      Returns:
      The current status of the packaging job.
      See Also:

    • edgePackagingJobStatusMessage

      public final String edgePackagingJobStatusMessage()

      Returns a message describing the job status and error messages.

      Returns:
      Returns a message describing the job status and error messages.

    • creationTime

      public final Instant creationTime()

      The timestamp of when the packaging job was created.

      Returns:
      The timestamp of when the packaging job was created.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The timestamp of when the job was last updated.

      Returns:
      The timestamp of when the job was last updated.

    • modelArtifact

      public final String modelArtifact()

      The Amazon Simple Storage (S3) URI where model artifacts ares stored.

      Returns:
      The Amazon Simple Storage (S3) URI where model artifacts ares stored.

    • modelSignature

      public final String modelSignature()

      The signature document of files in the model artifact.

      Returns:
      The signature document of files in the model artifact.

    • presetDeploymentOutput

      public final EdgePresetDeploymentOutput presetDeploymentOutput()

      The output of a SageMaker Edge Manager deployable resource.

      Returns:
      The output of a SageMaker Edge Manager deployable resource.

    • toBuilder

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

    • builder

      public static DescribeEdgePackagingJobResponse.Builder builder()

    • serializableBuilderClass

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