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

Class ModelPackageModelCard

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.ModelPackageModelCard

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ModelPackageModelCard.Builder,ModelPackageModelCard>

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

The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ModelPackageModelCard.Builder

Method Summary

Modifier and Type	Method	Description
static ModelPackageModelCard.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	modelCardContent()	The content 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.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ModelPackageModelCard.Builder>	serializableBuilderClass()
ModelPackageModelCard.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

modelCardContent

public final String modelCardContent()

The content of the model card. The content must follow the schema described in Model Package Model Card Schema.

Returns:

The content of the model card. The content must follow the schema described in Model Package Model Card Schema.

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 can be made to the model card content. If you try to update the model card content, you will receive the message Model Card is in Archived state.

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 can be made to the model card content. If you try to update the model card content, you will receive the message Model Card is in Archived state.

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 can be made to the model card content. If you try to update the model card content, you will receive the message Model Card is in Archived state.

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 can be made to the model card content. If you try to update the model card content, you will receive the message Model Card is in Archived state.

See Also:

ModelCardStatus

toBuilder

public ModelPackageModelCard.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ModelPackageModelCard.Builder,ModelPackageModelCard>

builder

public static ModelPackageModelCard.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo