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

Class ModelDashboardModelCard

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

The model card for a model displayed in the Amazon SageMaker Model Dashboard.

See Also:

  • Method Details

    • modelCardArn

      public final String modelCardArn()

      The Amazon Resource Name (ARN) for a model card.

      Returns:
      The Amazon Resource Name (ARN) for a model card.

    • modelCardName

      public final String modelCardName()

      The name of a model card.

      Returns:
      The name of a model card.

    • modelCardVersion

      public final Integer modelCardVersion()

      The model card version.

      Returns:
      The model card version.

    • modelCardStatus

      public final ModelCardStatus modelCardStatus()

      The model card status.

      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 model card status.
      See Also:

    • modelCardStatusAsString

      public final String modelCardStatusAsString()

      The model card status.

      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 model card status.
      See Also:

    • securityConfig

      public final ModelCardSecurityConfig securityConfig()

      The KMS Key ID (KMSKeyId) for encryption of model card information.

      Returns:
      The KMS Key ID (KMSKeyId) for encryption of model card information.

    • creationTime

      public final Instant creationTime()

      A timestamp that indicates when the model card was created.

      Returns:
      A timestamp that indicates when 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()

      A timestamp that indicates when the model card was last updated.

      Returns:
      A timestamp that indicates when the model card was last updated.

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

    • 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 a model card.

      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 a model card.

    • modelId

      public final String modelId()

      For models created in SageMaker, this is the model ARN. For models created outside of SageMaker, this is a user-customized string.

      Returns:
      For models created in SageMaker, this is the model ARN. For models created outside of SageMaker, this is a user-customized string.

    • riskRating

      public final String riskRating()

      A model card's risk rating. Can be low, medium, or high.

      Returns:
      A model card's risk rating. Can be low, medium, or high.

    • toBuilder

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

    • builder

      public static ModelDashboardModelCard.Builder builder()

    • serializableBuilderClass

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