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(value="software.amazon.awssdk:codegen")
public final class DescribeModelCardResponse
extends SageMakerResponse
implements ToCopyableBuilder<DescribeModelCardResponse.Builder,DescribeModelCardResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeModelCardResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeModelCardResponse.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 the model card was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
UserContext	lastModifiedBy() Returns the value of the LastModifiedBy property for this object.
Instant	lastModifiedTime() The date and time the model card was last modified.
String	modelCardArn() The Amazon Resource Name (ARN) of the model card.
String	modelCardName() The name of the model card.
ModelCardProcessingStatus	modelCardProcessingStatus() The processing status of model card deletion.
String	modelCardProcessingStatusAsString() The processing status of model card deletion.
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.
List<SdkField<?>>	sdkFields()
ModelCardSecurityConfig	securityConfig() The security configuration used to protect model card content.
static Class<? extends DescribeModelCardResponse.Builder>	serializableBuilderClass()
DescribeModelCardResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.sagemaker.model.SageMakerResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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 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:

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 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:

ModelCardProcessingStatus

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:

ModelCardProcessingStatus

toBuilder

public DescribeModelCardResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeModelCardResponse.Builder,DescribeModelCardResponse>

Overrides:

toBuilder in class AwsResponse

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)

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo