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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ModelDashboardModelCard.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ModelDashboardModelCard.Builder
builder()
UserContext
createdBy()
Returns the value of the CreatedBy property for this object.Instant
creationTime()
A timestamp that indicates when the model card was created.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.UserContext
lastModifiedBy()
Returns the value of the LastModifiedBy property for this object.Instant
lastModifiedTime()
A timestamp that indicates when the model card was last updated.String
modelCardArn()
The Amazon Resource Name (ARN) for a model card.String
modelCardName()
The name of a model card.ModelCardStatus
modelCardStatus()
The model card status.String
modelCardStatusAsString()
The model card status.Integer
modelCardVersion()
The model card version.String
modelId()
For models created in SageMaker, this is the model ARN.String
riskRating()
A model card's risk rating.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
ModelCardSecurityConfig
securityConfig()
The KMS Key ID (KMSKeyId
) for encryption of model card information.static Class<? extends ModelDashboardModelCard.Builder>
serializableBuilderClass()
List<Tag>
tags()
The tags associated with a model card.ModelDashboardModelCard.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 returnModelCardStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommodelCardStatusAsString()
.- Returns:
- The model card status.
- See Also:
ModelCardStatus
-
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 returnModelCardStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommodelCardStatusAsString()
.- Returns:
- The model card status.
- See Also:
ModelCardStatus
-
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 theisEmpty()
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()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ModelDashboardModelCard.Builder,ModelDashboardModelCard>
-
builder
public static ModelDashboardModelCard.Builder builder()
-
serializableBuilderClass
public static Class<? extends ModelDashboardModelCard.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-