software.amazon.awssdk.services.sagemaker.model

Interface ModelCard.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ModelCard.Builder,ModelCard>, SdkBuilder<ModelCard.Builder,ModelCard>, SdkPojo

Enclosing class:

ModelCard

public static interface ModelCard.Builder
extends SdkPojo, CopyableBuilder<ModelCard.Builder,ModelCard>

Method Summary

Modifier and Type	Method and Description
ModelCard.Builder	content(String content) The content of the model card.
default ModelCard.Builder	createdBy(Consumer<UserContext.Builder> createdBy) Sets the value of the CreatedBy property for this object.
ModelCard.Builder	createdBy(UserContext createdBy) Sets the value of the CreatedBy property for this object.
ModelCard.Builder	creationTime(Instant creationTime) The date and time that the model card was created.
default ModelCard.Builder	lastModifiedBy(Consumer<UserContext.Builder> lastModifiedBy) Sets the value of the LastModifiedBy property for this object.
ModelCard.Builder	lastModifiedBy(UserContext lastModifiedBy) Sets the value of the LastModifiedBy property for this object.
ModelCard.Builder	lastModifiedTime(Instant lastModifiedTime) The date and time that the model card was last modified.
ModelCard.Builder	modelCardArn(String modelCardArn) The Amazon Resource Name (ARN) of the model card.
ModelCard.Builder	modelCardName(String modelCardName) The unique name of the model card.
ModelCard.Builder	modelCardStatus(ModelCardStatus modelCardStatus) The approval status of the model card within your organization.
ModelCard.Builder	modelCardStatus(String modelCardStatus) The approval status of the model card within your organization.
ModelCard.Builder	modelCardVersion(Integer modelCardVersion) The version of the model card.
ModelCard.Builder	modelId(String modelId) The unique name (ID) of the model.
ModelCard.Builder	riskRating(String riskRating) The risk rating of the model.
default ModelCard.Builder	securityConfig(Consumer<ModelCardSecurityConfig.Builder> securityConfig) The security configuration used to protect model card data.
ModelCard.Builder	securityConfig(ModelCardSecurityConfig securityConfig) The security configuration used to protect model card data.
ModelCard.Builder	tags(Collection<Tag> tags) Key-value pairs used to manage metadata for the model card.
ModelCard.Builder	tags(Consumer<Tag.Builder>... tags) Key-value pairs used to manage metadata for the model card.
ModelCard.Builder	tags(Tag... tags) Key-value pairs used to manage metadata for the model card.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

modelCardArn

ModelCard.Builder modelCardArn(String modelCardArn)

The Amazon Resource Name (ARN) of the model card.

Parameters:

modelCardArn - The Amazon Resource Name (ARN) of the model card.

Returns:

Returns a reference to this object so that method calls can be chained together.

modelCardName

ModelCard.Builder modelCardName(String modelCardName)

The unique name of the model card.

Parameters:

modelCardName - The unique name of the model card.

Returns:

Returns a reference to this object so that method calls can be chained together.

modelCardVersion

ModelCard.Builder modelCardVersion(Integer modelCardVersion)

The version of the model card.

Parameters:

modelCardVersion - The version of the model card.

Returns:

Returns a reference to this object so that method calls can be chained together.

content

ModelCard.Builder content(String content)

The content of the model card. Content uses the model card JSON schema and provided as a string.

Parameters:

content - The content of the model card. Content uses the model card JSON schema and provided as a string.

Returns:

Returns a reference to this object so that method calls can be chained together.

modelCardStatus

ModelCard.Builder modelCardStatus(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ModelCardStatus, ModelCardStatus

modelCardStatus

ModelCard.Builder modelCardStatus(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ModelCardStatus, ModelCardStatus

securityConfig

ModelCard.Builder securityConfig(ModelCardSecurityConfig securityConfig)

The security configuration used to protect model card data.

Parameters:

securityConfig - The security configuration used to protect model card data.

Returns:

Returns a reference to this object so that method calls can be chained together.

securityConfig

default ModelCard.Builder securityConfig(Consumer<ModelCardSecurityConfig.Builder> securityConfig)

The security configuration used to protect model card data.

This is a convenience method that creates an instance of the ModelCardSecurityConfig.Builder avoiding the need to create one manually via ModelCardSecurityConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to securityConfig(ModelCardSecurityConfig).

Parameters:

securityConfig - a consumer that will call methods on ModelCardSecurityConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

securityConfig(ModelCardSecurityConfig)

creationTime

ModelCard.Builder creationTime(Instant creationTime)

The date and time that the model card was created.

Parameters:

creationTime - The date and time that the model card was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

createdBy

ModelCard.Builder createdBy(UserContext createdBy)

Sets the value of the CreatedBy property for this object.

Parameters:

createdBy - The new value for the CreatedBy property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

createdBy

default ModelCard.Builder createdBy(Consumer<UserContext.Builder> createdBy)

Sets the value of the CreatedBy property for this object. This is a convenience method that creates an instance of the UserContext.Builder avoiding the need to create one manually via UserContext.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to createdBy(UserContext).

Parameters:

createdBy - a consumer that will call methods on UserContext.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

createdBy(UserContext)

lastModifiedTime

ModelCard.Builder lastModifiedTime(Instant lastModifiedTime)

The date and time that the model card was last modified.

Parameters:

lastModifiedTime - The date and time that the model card was last modified.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastModifiedBy

ModelCard.Builder lastModifiedBy(UserContext lastModifiedBy)

Sets the value of the LastModifiedBy property for this object.

Parameters:

lastModifiedBy - The new value for the LastModifiedBy property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastModifiedBy

default ModelCard.Builder lastModifiedBy(Consumer<UserContext.Builder> lastModifiedBy)

Sets the value of the LastModifiedBy property for this object. This is a convenience method that creates an instance of the UserContext.Builder avoiding the need to create one manually via UserContext.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lastModifiedBy(UserContext).

Parameters:

lastModifiedBy - a consumer that will call methods on UserContext.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

lastModifiedBy(UserContext)

tags

ModelCard.Builder tags(Collection<Tag> tags)

Key-value pairs used to manage metadata for the model card.

Parameters:

tags - Key-value pairs used to manage metadata for the model card.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

ModelCard.Builder tags(Tag... tags)

Key-value pairs used to manage metadata for the model card.

Parameters:

tags - Key-value pairs used to manage metadata for the model card.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

ModelCard.Builder tags(Consumer<Tag.Builder>... tags)

Key-value pairs used to manage metadata for the model card.

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tags(java.util.Collection)

modelId

ModelCard.Builder modelId(String modelId)

The unique name (ID) of the model.

Parameters:

modelId - The unique name (ID) of the model.

Returns:

Returns a reference to this object so that method calls can be chained together.

riskRating

ModelCard.Builder riskRating(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.