software.amazon.awssdk.services.sagemaker.model

Interface DescribeModelPackageResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeModelPackageResponse.Builder,DescribeModelPackageResponse>, SageMakerResponse.Builder, SdkBuilder<DescribeModelPackageResponse.Builder,DescribeModelPackageResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeModelPackageResponse

public static interface DescribeModelPackageResponse.Builder
extends SageMakerResponse.Builder, SdkPojo, CopyableBuilder<DescribeModelPackageResponse.Builder,DescribeModelPackageResponse>

Method Summary

Modifier and Type	Method and Description
DescribeModelPackageResponse.Builder	additionalInferenceSpecifications(AdditionalInferenceSpecificationDefinition... additionalInferenceSpecifications) An array of additional Inference Specification objects.
DescribeModelPackageResponse.Builder	additionalInferenceSpecifications(Collection<AdditionalInferenceSpecificationDefinition> additionalInferenceSpecifications) An array of additional Inference Specification objects.
DescribeModelPackageResponse.Builder	additionalInferenceSpecifications(Consumer<AdditionalInferenceSpecificationDefinition.Builder>... additionalInferenceSpecifications) An array of additional Inference Specification objects.
DescribeModelPackageResponse.Builder	approvalDescription(String approvalDescription) A description provided for the model approval.
DescribeModelPackageResponse.Builder	certifyForMarketplace(Boolean certifyForMarketplace) Whether the model package is certified for listing on Amazon Web Services Marketplace.
default DescribeModelPackageResponse.Builder	createdBy(Consumer<UserContext.Builder> createdBy) Sets the value of the CreatedBy property for this object.
DescribeModelPackageResponse.Builder	createdBy(UserContext createdBy) Sets the value of the CreatedBy property for this object.
DescribeModelPackageResponse.Builder	creationTime(Instant creationTime) A timestamp specifying when the model package was created.
DescribeModelPackageResponse.Builder	customerMetadataProperties(Map<String,String> customerMetadataProperties) The metadata properties associated with the model package versions.
DescribeModelPackageResponse.Builder	domain(String domain) The machine learning domain of the model package you specified.
default DescribeModelPackageResponse.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.
DescribeModelPackageResponse.Builder	driftCheckBaselines(DriftCheckBaselines driftCheckBaselines) Represents the drift check baselines that can be used when the model monitor is set using the model package.
default DescribeModelPackageResponse.Builder	inferenceSpecification(Consumer<InferenceSpecification.Builder> inferenceSpecification) Details about inference jobs that can be run with models based on this model package.
DescribeModelPackageResponse.Builder	inferenceSpecification(InferenceSpecification inferenceSpecification) Details about inference jobs that can be run with models based on this model package.
default DescribeModelPackageResponse.Builder	lastModifiedBy(Consumer<UserContext.Builder> lastModifiedBy) Sets the value of the LastModifiedBy property for this object.
DescribeModelPackageResponse.Builder	lastModifiedBy(UserContext lastModifiedBy) Sets the value of the LastModifiedBy property for this object.
DescribeModelPackageResponse.Builder	lastModifiedTime(Instant lastModifiedTime) The last time that the model package was modified.
default DescribeModelPackageResponse.Builder	metadataProperties(Consumer<MetadataProperties.Builder> metadataProperties) Sets the value of the MetadataProperties property for this object.
DescribeModelPackageResponse.Builder	metadataProperties(MetadataProperties metadataProperties) Sets the value of the MetadataProperties property for this object.
DescribeModelPackageResponse.Builder	modelApprovalStatus(ModelApprovalStatus modelApprovalStatus) The approval status of the model package.
DescribeModelPackageResponse.Builder	modelApprovalStatus(String modelApprovalStatus) The approval status of the model package.
default DescribeModelPackageResponse.Builder	modelMetrics(Consumer<ModelMetrics.Builder> modelMetrics) Metrics for the model.
DescribeModelPackageResponse.Builder	modelMetrics(ModelMetrics modelMetrics) Metrics for the model.
DescribeModelPackageResponse.Builder	modelPackageArn(String modelPackageArn) The Amazon Resource Name (ARN) of the model package.
DescribeModelPackageResponse.Builder	modelPackageDescription(String modelPackageDescription) A brief summary of the model package.
DescribeModelPackageResponse.Builder	modelPackageGroupName(String modelPackageGroupName) If the model is a versioned model, the name of the model group that the versioned model belongs to.
DescribeModelPackageResponse.Builder	modelPackageName(String modelPackageName) The name of the model package being described.
DescribeModelPackageResponse.Builder	modelPackageStatus(ModelPackageStatus modelPackageStatus) The current status of the model package.
DescribeModelPackageResponse.Builder	modelPackageStatus(String modelPackageStatus) The current status of the model package.
default DescribeModelPackageResponse.Builder	modelPackageStatusDetails(Consumer<ModelPackageStatusDetails.Builder> modelPackageStatusDetails) Details about the current status of the model package.
DescribeModelPackageResponse.Builder	modelPackageStatusDetails(ModelPackageStatusDetails modelPackageStatusDetails) Details about the current status of the model package.
DescribeModelPackageResponse.Builder	modelPackageVersion(Integer modelPackageVersion) The version of the model package.
DescribeModelPackageResponse.Builder	samplePayloadUrl(String samplePayloadUrl) The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored.
default DescribeModelPackageResponse.Builder	sourceAlgorithmSpecification(Consumer<SourceAlgorithmSpecification.Builder> sourceAlgorithmSpecification) Details about the algorithm that was used to create the model package.
DescribeModelPackageResponse.Builder	sourceAlgorithmSpecification(SourceAlgorithmSpecification sourceAlgorithmSpecification) Details about the algorithm that was used to create the model package.
DescribeModelPackageResponse.Builder	task(String task) The machine learning task you specified that your model package accomplishes.
default DescribeModelPackageResponse.Builder	validationSpecification(Consumer<ModelPackageValidationSpecification.Builder> validationSpecification) Configurations for one or more transform jobs that SageMaker runs to test the model package.
DescribeModelPackageResponse.Builder	validationSpecification(ModelPackageValidationSpecification validationSpecification) Configurations for one or more transform jobs that SageMaker runs to test the model package.

Methods inherited from interface software.amazon.awssdk.services.sagemaker.model.SageMakerResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

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

DescribeModelPackageResponse.Builder modelPackageName(String modelPackageName)

The name of the model package being described.

Parameters:

modelPackageName - The name of the model package being described.

Returns:

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

modelPackageGroupName

DescribeModelPackageResponse.Builder modelPackageGroupName(String modelPackageGroupName)

If the model is a versioned model, the name of the model group that the versioned model belongs to.

Parameters:

modelPackageGroupName - If the model is a versioned model, the name of the model group that the versioned model belongs to.

Returns:

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

modelPackageVersion

DescribeModelPackageResponse.Builder modelPackageVersion(Integer modelPackageVersion)

The version of the model package.

Parameters:

modelPackageVersion - The version of the model package.

Returns:

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

modelPackageArn

DescribeModelPackageResponse.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

DescribeModelPackageResponse.Builder modelPackageDescription(String modelPackageDescription)

A brief summary of the model package.

Parameters:

modelPackageDescription - A brief summary of the model package.

Returns:

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

creationTime

DescribeModelPackageResponse.Builder creationTime(Instant creationTime)

A timestamp specifying when the model package was created.

Parameters:

creationTime - A timestamp specifying when the model package was created.

Returns:

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

inferenceSpecification

DescribeModelPackageResponse.Builder inferenceSpecification(InferenceSpecification inferenceSpecification)

Details about inference jobs that can be run with models based on this model package.

Parameters:

inferenceSpecification - Details about inference jobs that can be run with models based on this model package.

Returns:

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

inferenceSpecification

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

Details about inference jobs that can be run with models based on this model package.

This is a convenience method 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

DescribeModelPackageResponse.Builder sourceAlgorithmSpecification(SourceAlgorithmSpecification sourceAlgorithmSpecification)

Details about the algorithm that was used to create the model package.

Parameters:

sourceAlgorithmSpecification - Details about the algorithm that was used to create the model package.

Returns:

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

sourceAlgorithmSpecification

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

Details about the algorithm that was used to create the model package.

This is a convenience method 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

DescribeModelPackageResponse.Builder validationSpecification(ModelPackageValidationSpecification validationSpecification)

Configurations for one or more transform jobs that SageMaker runs to test the model package.

Parameters:

validationSpecification - Configurations for one or more transform jobs that SageMaker runs to test the model package.

Returns:

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

validationSpecification

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

Configurations for one or more transform jobs that SageMaker runs to test the model package.

This is a convenience method 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

DescribeModelPackageResponse.Builder modelPackageStatus(String modelPackageStatus)

The current status of the model package.

Parameters:

modelPackageStatus - The current status of the model package.

Returns:

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

See Also:

ModelPackageStatus, ModelPackageStatus

modelPackageStatus

DescribeModelPackageResponse.Builder modelPackageStatus(ModelPackageStatus modelPackageStatus)

The current status of the model package.

Parameters:

modelPackageStatus - The current status of the model package.

Returns:

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

See Also:

ModelPackageStatus, ModelPackageStatus

modelPackageStatusDetails

DescribeModelPackageResponse.Builder modelPackageStatusDetails(ModelPackageStatusDetails modelPackageStatusDetails)

Details about the current status of the model package.

Parameters:

modelPackageStatusDetails - Details about the current status of the model package.

Returns:

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

modelPackageStatusDetails

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

Details about the current status of the model package.

This is a convenience method 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

DescribeModelPackageResponse.Builder certifyForMarketplace(Boolean certifyForMarketplace)

Whether the model package is certified for listing on Amazon Web Services Marketplace.

Parameters:

certifyForMarketplace - Whether the model package is certified for listing on Amazon Web Services Marketplace.

Returns:

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

modelApprovalStatus

DescribeModelPackageResponse.Builder modelApprovalStatus(String modelApprovalStatus)

The approval status of the model package.

Parameters:

modelApprovalStatus - The approval status of the model package.

Returns:

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

See Also:

ModelApprovalStatus, ModelApprovalStatus

modelApprovalStatus

DescribeModelPackageResponse.Builder modelApprovalStatus(ModelApprovalStatus modelApprovalStatus)

The approval status of the model package.

Parameters:

modelApprovalStatus - The approval status of the model package.

Returns:

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

See Also:

ModelApprovalStatus, ModelApprovalStatus

createdBy

DescribeModelPackageResponse.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 DescribeModelPackageResponse.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)

metadataProperties

DescribeModelPackageResponse.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 DescribeModelPackageResponse.Builder metadataProperties(Consumer<MetadataProperties.Builder> metadataProperties)

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

DescribeModelPackageResponse.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 DescribeModelPackageResponse.Builder modelMetrics(Consumer<ModelMetrics.Builder> modelMetrics)

Metrics for the model.

This is a convenience method 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

DescribeModelPackageResponse.Builder lastModifiedTime(Instant lastModifiedTime)

The last time that the model package was modified.

Parameters:

lastModifiedTime - The last time that the model package was modified.

Returns:

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

lastModifiedBy

DescribeModelPackageResponse.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 DescribeModelPackageResponse.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)

approvalDescription

DescribeModelPackageResponse.Builder approvalDescription(String approvalDescription)

A description provided for the model approval.

Parameters:

approvalDescription - A description provided for the model approval.

Returns:

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

customerMetadataProperties

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

The metadata properties associated with the model package versions.

Parameters:

customerMetadataProperties - The metadata properties associated with the model package versions.

Returns:

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

driftCheckBaselines

DescribeModelPackageResponse.Builder driftCheckBaselines(DriftCheckBaselines driftCheckBaselines)

Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.

Parameters:

driftCheckBaselines - Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.

Returns:

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

driftCheckBaselines

default DescribeModelPackageResponse.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. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.

This is a convenience method 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)

domain

DescribeModelPackageResponse.Builder domain(String domain)

The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.

Parameters:

domain - The machine learning domain of the model package you specified. 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

DescribeModelPackageResponse.Builder task(String task)

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

Parameters:

task - The machine learning task you specified that 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

DescribeModelPackageResponse.Builder samplePayloadUrl(String samplePayloadUrl)

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

Parameters:

samplePayloadUrl - The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points 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

DescribeModelPackageResponse.Builder additionalInferenceSpecifications(Collection<AdditionalInferenceSpecificationDefinition> additionalInferenceSpecifications)

An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

Parameters:

additionalInferenceSpecifications - An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

Returns:

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

additionalInferenceSpecifications

DescribeModelPackageResponse.Builder additionalInferenceSpecifications(AdditionalInferenceSpecificationDefinition... additionalInferenceSpecifications)

An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

Parameters:

additionalInferenceSpecifications - An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

Returns:

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

additionalInferenceSpecifications

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

An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

This is a convenience method 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)