software.amazon.awssdk.services.sagemaker.model

Interface ModelPackage.Builder

All Superinterfaces:

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

Enclosing class:

ModelPackage

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

Method Summary

Modifier and Type	Method and Description
ModelPackage.Builder	additionalInferenceSpecifications(AdditionalInferenceSpecificationDefinition... additionalInferenceSpecifications) An array of additional Inference Specification objects.
ModelPackage.Builder	additionalInferenceSpecifications(Collection<AdditionalInferenceSpecificationDefinition> additionalInferenceSpecifications) An array of additional Inference Specification objects.
ModelPackage.Builder	additionalInferenceSpecifications(Consumer<AdditionalInferenceSpecificationDefinition.Builder>... additionalInferenceSpecifications) An array of additional Inference Specification objects.
ModelPackage.Builder	approvalDescription(String approvalDescription) A description provided when the model approval is set.
ModelPackage.Builder	certifyForMarketplace(Boolean certifyForMarketplace) Whether the model package is to be certified to be listed on Amazon Web Services Marketplace.
default ModelPackage.Builder	createdBy(Consumer<UserContext.Builder> createdBy) Sets the value of the CreatedBy property for this object.
ModelPackage.Builder	createdBy(UserContext createdBy) Sets the value of the CreatedBy property for this object.
ModelPackage.Builder	creationTime(Instant creationTime) The time that the model package was created.
ModelPackage.Builder	customerMetadataProperties(Map<String,String> customerMetadataProperties) The metadata properties for the model package.
ModelPackage.Builder	domain(String domain) The machine learning domain of your model package and its components.
default ModelPackage.Builder	driftCheckBaselines(Consumer<DriftCheckBaselines.Builder> driftCheckBaselines) Represents the drift check baselines that can be used when the model monitor is set using the model package.
ModelPackage.Builder	driftCheckBaselines(DriftCheckBaselines driftCheckBaselines) Represents the drift check baselines that can be used when the model monitor is set using the model package.
default ModelPackage.Builder	inferenceSpecification(Consumer<InferenceSpecification.Builder> inferenceSpecification) Sets the value of the InferenceSpecification property for this object.
ModelPackage.Builder	inferenceSpecification(InferenceSpecification inferenceSpecification) Sets the value of the InferenceSpecification property for this object.
default ModelPackage.Builder	lastModifiedBy(Consumer<UserContext.Builder> lastModifiedBy) Sets the value of the LastModifiedBy property for this object.
ModelPackage.Builder	lastModifiedBy(UserContext lastModifiedBy) Sets the value of the LastModifiedBy property for this object.
ModelPackage.Builder	lastModifiedTime(Instant lastModifiedTime) The last time the model package was modified.
default ModelPackage.Builder	metadataProperties(Consumer<MetadataProperties.Builder> metadataProperties) Sets the value of the MetadataProperties property for this object.
ModelPackage.Builder	metadataProperties(MetadataProperties metadataProperties) Sets the value of the MetadataProperties property for this object.
ModelPackage.Builder	modelApprovalStatus(ModelApprovalStatus modelApprovalStatus) The approval status of the model.
ModelPackage.Builder	modelApprovalStatus(String modelApprovalStatus) The approval status of the model.
default ModelPackage.Builder	modelMetrics(Consumer<ModelMetrics.Builder> modelMetrics) Metrics for the model.
ModelPackage.Builder	modelMetrics(ModelMetrics modelMetrics) Metrics for the model.
ModelPackage.Builder	modelPackageArn(String modelPackageArn) The Amazon Resource Name (ARN) of the model package.
ModelPackage.Builder	modelPackageDescription(String modelPackageDescription) The description of the model package.
ModelPackage.Builder	modelPackageGroupName(String modelPackageGroupName) The model group to which the model belongs.
ModelPackage.Builder	modelPackageName(String modelPackageName) The name of the model.
ModelPackage.Builder	modelPackageStatus(ModelPackageStatus modelPackageStatus) The status of the model package.
ModelPackage.Builder	modelPackageStatus(String modelPackageStatus) The status of the model package.
default ModelPackage.Builder	modelPackageStatusDetails(Consumer<ModelPackageStatusDetails.Builder> modelPackageStatusDetails) Sets the value of the ModelPackageStatusDetails property for this object.
ModelPackage.Builder	modelPackageStatusDetails(ModelPackageStatusDetails modelPackageStatusDetails) Sets the value of the ModelPackageStatusDetails property for this object.
ModelPackage.Builder	modelPackageVersion(Integer modelPackageVersion) The version number of a versioned model.
ModelPackage.Builder	samplePayloadUrl(String samplePayloadUrl) The Amazon Simple Storage Service path where the sample payload are stored.
default ModelPackage.Builder	sourceAlgorithmSpecification(Consumer<SourceAlgorithmSpecification.Builder> sourceAlgorithmSpecification) Sets the value of the SourceAlgorithmSpecification property for this object.
ModelPackage.Builder	sourceAlgorithmSpecification(SourceAlgorithmSpecification sourceAlgorithmSpecification) Sets the value of the SourceAlgorithmSpecification property for this object.
ModelPackage.Builder	tags(Collection<Tag> tags) A list of the tags associated with the model package.
ModelPackage.Builder	tags(Consumer<Tag.Builder>... tags) A list of the tags associated with the model package.
ModelPackage.Builder	tags(Tag... tags) A list of the tags associated with the model package.
ModelPackage.Builder	task(String task) The machine learning task your model package accomplishes.
default ModelPackage.Builder	validationSpecification(Consumer<ModelPackageValidationSpecification.Builder> validationSpecification) Sets the value of the ValidationSpecification property for this object.
ModelPackage.Builder	validationSpecification(ModelPackageValidationSpecification validationSpecification) Sets the value of the ValidationSpecification property for this object.

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

modelPackageName

ModelPackage.Builder modelPackageName(String modelPackageName)

The name of the model.

Parameters:

modelPackageName - The name of the model.

Returns:

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

modelPackageGroupName

ModelPackage.Builder modelPackageGroupName(String modelPackageGroupName)

The model group to which the model belongs.

Parameters:

modelPackageGroupName - The model group to which the model belongs.

Returns:

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

modelPackageVersion

ModelPackage.Builder modelPackageVersion(Integer modelPackageVersion)

The version number of a versioned model.

Parameters:

modelPackageVersion - The version number of a versioned model.

Returns:

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

modelPackageArn

ModelPackage.Builder modelPackageArn(String modelPackageArn)

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

Parameters:

modelPackageArn - The Amazon Resource Name (ARN) of the model package.

Returns:

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

modelPackageDescription

ModelPackage.Builder modelPackageDescription(String modelPackageDescription)

The description of the model package.

Parameters:

modelPackageDescription - The description of the model package.

Returns:

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

creationTime

ModelPackage.Builder creationTime(Instant creationTime)

The time that the model package was created.

Parameters:

creationTime - The time that the model package was created.

Returns:

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

inferenceSpecification

ModelPackage.Builder inferenceSpecification(InferenceSpecification inferenceSpecification)

Sets the value of the InferenceSpecification property for this object.

Parameters:

inferenceSpecification - The new value for the InferenceSpecification property for this object.

Returns:

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

inferenceSpecification

default ModelPackage.Builder inferenceSpecification(Consumer<InferenceSpecification.Builder> inferenceSpecification)

Sets the value of the InferenceSpecification property for this object. This is a convenience that creates an instance of the InferenceSpecification.Builder avoiding the need to create one manually via InferenceSpecification.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inferenceSpecification(InferenceSpecification).

Parameters:

inferenceSpecification - a consumer that will call methods on InferenceSpecification.Builder

Returns:

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

See Also:

inferenceSpecification(InferenceSpecification)

sourceAlgorithmSpecification

ModelPackage.Builder sourceAlgorithmSpecification(SourceAlgorithmSpecification sourceAlgorithmSpecification)

Sets the value of the SourceAlgorithmSpecification property for this object.

Parameters:

sourceAlgorithmSpecification - The new value for the SourceAlgorithmSpecification property for this object.

Returns:

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

sourceAlgorithmSpecification

default ModelPackage.Builder sourceAlgorithmSpecification(Consumer<SourceAlgorithmSpecification.Builder> sourceAlgorithmSpecification)

Sets the value of the SourceAlgorithmSpecification property for this object. This is a convenience that creates an instance of the SourceAlgorithmSpecification.Builder avoiding the need to create one manually via SourceAlgorithmSpecification.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sourceAlgorithmSpecification(SourceAlgorithmSpecification).

Parameters:

sourceAlgorithmSpecification - a consumer that will call methods on SourceAlgorithmSpecification.Builder

Returns:

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

See Also:

sourceAlgorithmSpecification(SourceAlgorithmSpecification)

validationSpecification

ModelPackage.Builder validationSpecification(ModelPackageValidationSpecification validationSpecification)

Sets the value of the ValidationSpecification property for this object.

Parameters:

validationSpecification - The new value for the ValidationSpecification property for this object.

Returns:

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

validationSpecification

default ModelPackage.Builder validationSpecification(Consumer<ModelPackageValidationSpecification.Builder> validationSpecification)

Sets the value of the ValidationSpecification property for this object. This is a convenience that creates an instance of the ModelPackageValidationSpecification.Builder avoiding the need to create one manually via ModelPackageValidationSpecification.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to validationSpecification(ModelPackageValidationSpecification) .

Parameters:

validationSpecification - a consumer that will call methods on ModelPackageValidationSpecification.Builder

Returns:

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

See Also:

validationSpecification(ModelPackageValidationSpecification)

modelPackageStatus

ModelPackage.Builder modelPackageStatus(String modelPackageStatus)

The status of the model package. This can be one of the following values.

• PENDING - The model package is pending being created.

• IN_PROGRESS - The model package is in the process of being created.

• COMPLETED - The model package was successfully created.

• FAILED - The model package failed.

• DELETING - The model package is in the process of being deleted.

Parameters:

modelPackageStatus - The status of the model package. This can be one of the following values.

• PENDING - The model package is pending being created.

• IN_PROGRESS - The model package is in the process of being created.

• COMPLETED - The model package was successfully created.

• FAILED - The model package failed.

• DELETING - The model package is in the process of being deleted.

Returns:

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

See Also:

ModelPackageStatus, ModelPackageStatus

modelPackageStatus

ModelPackage.Builder modelPackageStatus(ModelPackageStatus modelPackageStatus)

The status of the model package. This can be one of the following values.

• PENDING - The model package is pending being created.

• IN_PROGRESS - The model package is in the process of being created.

• COMPLETED - The model package was successfully created.

• FAILED - The model package failed.

• DELETING - The model package is in the process of being deleted.

Parameters:

modelPackageStatus - The status of the model package. This can be one of the following values.

• PENDING - The model package is pending being created.

• IN_PROGRESS - The model package is in the process of being created.

• COMPLETED - The model package was successfully created.

• FAILED - The model package failed.

• DELETING - The model package is in the process of being deleted.

Returns:

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

See Also:

ModelPackageStatus, ModelPackageStatus

modelPackageStatusDetails

ModelPackage.Builder modelPackageStatusDetails(ModelPackageStatusDetails modelPackageStatusDetails)

Sets the value of the ModelPackageStatusDetails property for this object.

Parameters:

modelPackageStatusDetails - The new value for the ModelPackageStatusDetails property for this object.

Returns:

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

modelPackageStatusDetails

default ModelPackage.Builder modelPackageStatusDetails(Consumer<ModelPackageStatusDetails.Builder> modelPackageStatusDetails)

Sets the value of the ModelPackageStatusDetails property for this object. This is a convenience that creates an instance of the ModelPackageStatusDetails.Builder avoiding the need to create one manually via ModelPackageStatusDetails.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to modelPackageStatusDetails(ModelPackageStatusDetails).

Parameters:

modelPackageStatusDetails - a consumer that will call methods on ModelPackageStatusDetails.Builder

Returns:

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

See Also:

modelPackageStatusDetails(ModelPackageStatusDetails)

certifyForMarketplace

ModelPackage.Builder certifyForMarketplace(Boolean certifyForMarketplace)

Whether the model package is to be certified to be listed on Amazon Web Services Marketplace. For information about listing model packages on Amazon Web Services Marketplace, see List Your Algorithm or Model Package on Amazon Web Services Marketplace.

Parameters:

certifyForMarketplace - Whether the model package is to be certified to be listed on Amazon Web Services Marketplace. For information about listing model packages on Amazon Web Services Marketplace, see List Your Algorithm or Model Package on Amazon Web Services Marketplace.

Returns:

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

modelApprovalStatus

ModelPackage.Builder modelApprovalStatus(String modelApprovalStatus)

The approval status of the model. This can be one of the following values.

• APPROVED - The model is approved

• REJECTED - The model is rejected.

• PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.

Parameters:

modelApprovalStatus - The approval status of the model. This can be one of the following values.

• APPROVED - The model is approved

• REJECTED - The model is rejected.

• PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.

Returns:

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

See Also:

ModelApprovalStatus, ModelApprovalStatus

modelApprovalStatus

ModelPackage.Builder modelApprovalStatus(ModelApprovalStatus modelApprovalStatus)

The approval status of the model. This can be one of the following values.

• APPROVED - The model is approved

• REJECTED - The model is rejected.

• PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.

Parameters:

modelApprovalStatus - The approval status of the model. This can be one of the following values.

• APPROVED - The model is approved

• REJECTED - The model is rejected.

• PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.

Returns:

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

See Also:

ModelApprovalStatus, ModelApprovalStatus

createdBy

ModelPackage.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 ModelPackage.Builder createdBy(Consumer<UserContext.Builder> createdBy)

Sets the value of the CreatedBy property for this object. This is a convenience 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)

metadataProperties

ModelPackage.Builder metadataProperties(MetadataProperties metadataProperties)

Sets the value of the MetadataProperties property for this object.

Parameters:

metadataProperties - The new value for the MetadataProperties property for this object.

Returns:

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

metadataProperties

default ModelPackage.Builder metadataProperties(Consumer<MetadataProperties.Builder> metadataProperties)

Sets the value of the MetadataProperties property for this object. This is a convenience that creates an instance of the MetadataProperties.Builder avoiding the need to create one manually via MetadataProperties.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to metadataProperties(MetadataProperties).

Parameters:

metadataProperties - a consumer that will call methods on MetadataProperties.Builder

Returns:

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

See Also:

metadataProperties(MetadataProperties)

modelMetrics

ModelPackage.Builder modelMetrics(ModelMetrics modelMetrics)

Metrics for the model.

Parameters:

modelMetrics - Metrics for the model.

Returns:

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

modelMetrics

default ModelPackage.Builder modelMetrics(Consumer<ModelMetrics.Builder> modelMetrics)

Metrics for the model.

This is a convenience that creates an instance of the ModelMetrics.Builder avoiding the need to create one manually via ModelMetrics.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to modelMetrics(ModelMetrics).

Parameters:

modelMetrics - a consumer that will call methods on ModelMetrics.Builder

Returns:

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

See Also:

modelMetrics(ModelMetrics)

lastModifiedTime

ModelPackage.Builder lastModifiedTime(Instant lastModifiedTime)

The last time the model package was modified.

Parameters:

lastModifiedTime - The last time the model package was modified.

Returns:

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

lastModifiedBy

ModelPackage.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 ModelPackage.Builder lastModifiedBy(Consumer<UserContext.Builder> lastModifiedBy)

Sets the value of the LastModifiedBy property for this object. This is a convenience 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)

approvalDescription

ModelPackage.Builder approvalDescription(String approvalDescription)

A description provided when the model approval is set.

Parameters:

approvalDescription - A description provided when the model approval is set.

Returns:

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

domain

ModelPackage.Builder domain(String domain)

The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.

Parameters:

domain - The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.

Returns:

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

task

ModelPackage.Builder task(String task)

The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification.

Parameters:

task - The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification.

Returns:

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

samplePayloadUrl

ModelPackage.Builder samplePayloadUrl(String samplePayloadUrl)

The Amazon Simple Storage Service path where the sample payload are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

Parameters:

samplePayloadUrl - The Amazon Simple Storage Service path where the sample payload are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

Returns:

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

additionalInferenceSpecifications

ModelPackage.Builder additionalInferenceSpecifications(Collection<AdditionalInferenceSpecificationDefinition> additionalInferenceSpecifications)

An array of additional Inference Specification objects.

Parameters:

additionalInferenceSpecifications - An array of additional Inference Specification objects.

Returns:

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

additionalInferenceSpecifications

ModelPackage.Builder additionalInferenceSpecifications(AdditionalInferenceSpecificationDefinition... additionalInferenceSpecifications)

An array of additional Inference Specification objects.

Parameters:

additionalInferenceSpecifications - An array of additional Inference Specification objects.

Returns:

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

additionalInferenceSpecifications

ModelPackage.Builder additionalInferenceSpecifications(Consumer<AdditionalInferenceSpecificationDefinition.Builder>... additionalInferenceSpecifications)

An array of additional Inference Specification objects.

This is a convenience that creates an instance of the .Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #additionalInferenceSpecifications(List).

Parameters:

additionalInferenceSpecifications - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#additionalInferenceSpecifications(List)

tags

ModelPackage.Builder tags(Collection<Tag> tags)

A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

Parameters:

tags - A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

Returns:

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

tags

ModelPackage.Builder tags(Tag... tags)

A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

Parameters:

tags - A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

Returns:

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

tags

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

A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

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

Returns:

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

See Also:

#tags(List)

customerMetadataProperties

ModelPackage.Builder customerMetadataProperties(Map<String,String> customerMetadataProperties)

The metadata properties for the model package.

Parameters:

customerMetadataProperties - The metadata properties for the model package.

Returns:

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

driftCheckBaselines

ModelPackage.Builder driftCheckBaselines(DriftCheckBaselines driftCheckBaselines)

Represents the drift check baselines that can be used when the model monitor is set using the model package.

Parameters:

driftCheckBaselines - Represents the drift check baselines that can be used when the model monitor is set using the model package.

Returns:

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

driftCheckBaselines

default ModelPackage.Builder driftCheckBaselines(Consumer<DriftCheckBaselines.Builder> driftCheckBaselines)

Represents the drift check baselines that can be used when the model monitor is set using the model package.

This is a convenience that creates an instance of the DriftCheckBaselines.Builder avoiding the need to create one manually via DriftCheckBaselines.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to driftCheckBaselines(DriftCheckBaselines).

Parameters:

driftCheckBaselines - a consumer that will call methods on DriftCheckBaselines.Builder

Returns:

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

See Also:

driftCheckBaselines(DriftCheckBaselines)