java.lang.Object
- software.amazon.awssdk.services.sagemaker.model.ModelCard

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ModelCard.Builder,ModelCard>

@Generated("software.amazon.awssdk:codegen")
public final class ModelCard
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ModelCard.Builder,ModelCard>

An Amazon SageMaker Model Card.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ModelCard.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ModelCard.Builder`	`builder()`
`String`	`content()`	The content of the model card.
`UserContext`	`createdBy()`	Returns the value of the CreatedBy property for this object.
`Instant`	`creationTime()`	The date and time that 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()`	The date and time that the model card was last modified.
`String`	`modelCardArn()`	The Amazon Resource Name (ARN) of the model card.
`String`	`modelCardName()`	The unique name of the model card.
`ModelCardStatus`	`modelCardStatus()`	The approval status of the model card within your organization.
`String`	`modelCardStatusAsString()`	The approval status of the model card within your organization.
`Integer`	`modelCardVersion()`	The version of the model card.
`String`	`modelId()`	The unique name (ID) of the model.
`String`	`modelPackageGroupName()`	The model package group that contains the model package.
`String`	`riskRating()`	The risk rating of the model.
`List<SdkField<?>>`	`sdkFields()`
`ModelCardSecurityConfig`	`securityConfig()`	The security configuration used to protect model card data.
`static Class<? extends ModelCard.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()`	Key-value pairs used to manage metadata for the model card.
`ModelCard.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) of the model card.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the model card.
  - modelCardName
```
public final String modelCardName()
```
    The unique name of the model card.
    
    Returns:
    
    The unique 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. Content uses the model card JSON schema and provided as a string.
    
    Returns:
    
    The content of the model card. Content uses the model card JSON schema and provided as a string.
  - 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:
    
    ModelCardStatus
  - 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:
    
    ModelCardStatus
  - securityConfig
```
public final ModelCardSecurityConfig securityConfig()
```
    The security configuration used to protect model card data.
    
    Returns:
    
    The security configuration used to protect model card data.
  - creationTime
```
public final Instant creationTime()
```
    The date and time that the model card was created.
    
    Returns:
    
    The date and time that 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 that the model card was last modified.
    
    Returns:
    
    The date and time that 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.
  - 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()
```
    Key-value pairs used to manage metadata for the 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:
    
    Key-value pairs used to manage metadata for the model card.
  - modelId
```
public final String modelId()
```
    The unique name (ID) of the model.
    
    Returns:
    
    The unique name (ID) of the model.
  - riskRating
```
public final String riskRating()
```
    The risk rating of the model. Different organizations might have different criteria for model card risk ratings. For more information, see Risk ratings.
    
    Returns:
    
    The risk rating of the model. Different organizations might have different criteria for model card risk ratings. For more information, see Risk ratings.
  - modelPackageGroupName
```
public final String modelPackageGroupName()
```
    The model package group that contains the model package. Only relevant for model cards created for model packages in the Amazon SageMaker Model Registry.
    
    Returns:
    
    The model package group that contains the model package. Only relevant for model cards created for model packages in the Amazon SageMaker Model Registry.
  - toBuilder
```
public ModelCard.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ModelCard.Builder,ModelCard>
  - builder
```
public static ModelCard.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ModelCard.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class ModelCard

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

modelCardArn

modelCardName

modelCardVersion

content

modelCardStatus

modelCardStatusAsString

securityConfig

creationTime

createdBy

lastModifiedTime

lastModifiedBy

hasTags

tags

modelId

riskRating

modelPackageGroupName

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields