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

Class DescribeModelCardResponse

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

  • Method Details

    • modelCardArn

      public final String modelCardArn()

      The Amazon Resource Name (ARN) of the model card.

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

    • modelCardName

      public final String modelCardName()

      The name of the model card.

      Returns:
      The name of the model card.

    • modelCardVersion

      public final Integer modelCardVersion()

      The version of the model card.

      Returns:
      The version of the model card.

    • content

      public final String content()

      The content of the model card.

      Returns:
      The content of the model card.

    • modelCardStatus

      public final ModelCardStatus modelCardStatus()

      The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

      • Draft: The model card is a work in progress.

      • PendingReview: The model card is pending review.

      • Approved: The model card is approved.

      • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

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

      Returns:
      The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

      • Draft: The model card is a work in progress.

      • PendingReview: The model card is pending review.

      • Approved: The model card is approved.

      • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

      See Also:

    • modelCardStatusAsString

      public final String modelCardStatusAsString()

      The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

      • Draft: The model card is a work in progress.

      • PendingReview: The model card is pending review.

      • Approved: The model card is approved.

      • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

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

      Returns:
      The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

      • Draft: The model card is a work in progress.

      • PendingReview: The model card is pending review.

      • Approved: The model card is approved.

      • Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

      See Also:

    • securityConfig

      public final ModelCardSecurityConfig securityConfig()

      The security configuration used to protect model card content.

      Returns:
      The security configuration used to protect model card content.

    • creationTime

      public final Instant creationTime()

      The date and time the model card was created.

      Returns:
      The date and time the model card was created.

    • createdBy

      public final UserContext createdBy()
      Returns the value of the CreatedBy property for this object.
      Returns:
      The value of the CreatedBy property for this object.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The date and time the model card was last modified.

      Returns:
      The date and time the model card was last modified.

    • lastModifiedBy

      public final UserContext lastModifiedBy()
      Returns the value of the LastModifiedBy property for this object.
      Returns:
      The value of the LastModifiedBy property for this object.

    • modelCardProcessingStatus

      public final ModelCardProcessingStatus modelCardProcessingStatus()

      The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.

      • DeletePending: Model card deletion request received.

      • DeleteInProgress: Model card deletion is in progress.

      • ContentDeleted: Deleted model card content.

      • ExportJobsDeleted: Deleted all export jobs associated with the model card.

      • DeleteCompleted: Successfully deleted the model card.

      • DeleteFailed: The model card failed to delete.

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

      Returns:
      The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.

      • DeletePending: Model card deletion request received.

      • DeleteInProgress: Model card deletion is in progress.

      • ContentDeleted: Deleted model card content.

      • ExportJobsDeleted: Deleted all export jobs associated with the model card.

      • DeleteCompleted: Successfully deleted the model card.

      • DeleteFailed: The model card failed to delete.

      See Also:

    • modelCardProcessingStatusAsString

      public final String modelCardProcessingStatusAsString()

      The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.

      • DeletePending: Model card deletion request received.

      • DeleteInProgress: Model card deletion is in progress.

      • ContentDeleted: Deleted model card content.

      • ExportJobsDeleted: Deleted all export jobs associated with the model card.

      • DeleteCompleted: Successfully deleted the model card.

      • DeleteFailed: The model card failed to delete.

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

      Returns:
      The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.

      • DeletePending: Model card deletion request received.

      • DeleteInProgress: Model card deletion is in progress.

      • ContentDeleted: Deleted model card content.

      • ExportJobsDeleted: Deleted all export jobs associated with the model card.

      • DeleteCompleted: Successfully deleted the model card.

      • DeleteFailed: The model card failed to delete.

      See Also:

    • toBuilder

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

    • builder

      public static DescribeModelCardResponse.Builder builder()

    • serializableBuilderClass

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