Interface DescribeModelPackageResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<DescribeModelPackageResponse.Builder,
,DescribeModelPackageResponse> SageMakerResponse.Builder
,SdkBuilder<DescribeModelPackageResponse.Builder,
,DescribeModelPackageResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
DescribeModelPackageResponse
-
Method Summary
Modifier and TypeMethodDescriptionadditionalInferenceSpecifications
(Collection<AdditionalInferenceSpecificationDefinition> additionalInferenceSpecifications) An array of additional Inference Specification objects.additionalInferenceSpecifications
(Consumer<AdditionalInferenceSpecificationDefinition.Builder>... additionalInferenceSpecifications) An array of additional Inference Specification objects.additionalInferenceSpecifications
(AdditionalInferenceSpecificationDefinition... additionalInferenceSpecifications) An array of additional Inference Specification objects.approvalDescription
(String approvalDescription) A description provided for the model approval.certifyForMarketplace
(Boolean certifyForMarketplace) Whether the model package is certified for listing on Amazon Web Services Marketplace.createdBy
(Consumer<UserContext.Builder> createdBy) Sets the value of the CreatedBy property for this object.createdBy
(UserContext createdBy) Sets the value of the CreatedBy property for this object.creationTime
(Instant creationTime) A timestamp specifying when the model package was created.customerMetadataProperties
(Map<String, String> customerMetadataProperties) The metadata properties associated with the model package versions.The machine learning domain of the model package you specified.driftCheckBaselines
(Consumer<DriftCheckBaselines.Builder> driftCheckBaselines) Represents the drift check baselines that can be used when the model monitor is set using the model package.driftCheckBaselines
(DriftCheckBaselines driftCheckBaselines) Represents the drift check baselines that can be used when the model monitor is set using the model package.inferenceSpecification
(Consumer<InferenceSpecification.Builder> inferenceSpecification) Details about inference jobs that can be run with models based on this model package.inferenceSpecification
(InferenceSpecification inferenceSpecification) Details about inference jobs that can be run with models based on this model package.lastModifiedBy
(Consumer<UserContext.Builder> lastModifiedBy) Sets the value of the LastModifiedBy property for this object.lastModifiedBy
(UserContext lastModifiedBy) Sets the value of the LastModifiedBy property for this object.lastModifiedTime
(Instant lastModifiedTime) The last time that the model package was modified.metadataProperties
(Consumer<MetadataProperties.Builder> metadataProperties) Sets the value of the MetadataProperties property for this object.metadataProperties
(MetadataProperties metadataProperties) Sets the value of the MetadataProperties property for this object.modelApprovalStatus
(String modelApprovalStatus) The approval status of the model package.modelApprovalStatus
(ModelApprovalStatus modelApprovalStatus) The approval status of the model package.modelMetrics
(Consumer<ModelMetrics.Builder> modelMetrics) Metrics for the model.modelMetrics
(ModelMetrics modelMetrics) Metrics for the model.modelPackageArn
(String modelPackageArn) The Amazon Resource Name (ARN) of the model package.modelPackageDescription
(String modelPackageDescription) A brief summary of the model package.modelPackageGroupName
(String modelPackageGroupName) If the model is a versioned model, the name of the model group that the versioned model belongs to.modelPackageName
(String modelPackageName) The name of the model package being described.modelPackageStatus
(String modelPackageStatus) The current status of the model package.modelPackageStatus
(ModelPackageStatus modelPackageStatus) The current status of the model package.modelPackageStatusDetails
(Consumer<ModelPackageStatusDetails.Builder> modelPackageStatusDetails) Details about the current status of the model package.modelPackageStatusDetails
(ModelPackageStatusDetails modelPackageStatusDetails) Details about the current status of the model package.modelPackageVersion
(Integer modelPackageVersion) The version of the model package.samplePayloadUrl
(String samplePayloadUrl) The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored.skipModelValidation
(String skipModelValidation) Indicates if you want to skip model validation.skipModelValidation
(SkipModelValidation skipModelValidation) Indicates if you want to skip model validation.sourceAlgorithmSpecification
(Consumer<SourceAlgorithmSpecification.Builder> sourceAlgorithmSpecification) Details about the algorithm that was used to create the model package.sourceAlgorithmSpecification
(SourceAlgorithmSpecification sourceAlgorithmSpecification) Details about the algorithm that was used to create the model package.The machine learning task you specified that your model package accomplishes.validationSpecification
(Consumer<ModelPackageValidationSpecification.Builder> validationSpecification) Configurations for one or more transform jobs that SageMaker runs to test the model package.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.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.sagemaker.model.SageMakerResponse.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
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
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
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
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
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
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 theInferenceSpecification.Builder
avoiding the need to create one manually viaInferenceSpecification.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toinferenceSpecification(InferenceSpecification)
.- Parameters:
inferenceSpecification
- a consumer that will call methods onInferenceSpecification.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theSourceAlgorithmSpecification.Builder
avoiding the need to create one manually viaSourceAlgorithmSpecification.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosourceAlgorithmSpecification(SourceAlgorithmSpecification)
.- Parameters:
sourceAlgorithmSpecification
- a consumer that will call methods onSourceAlgorithmSpecification.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theModelPackageValidationSpecification.Builder
avoiding the need to create one manually viaModelPackageValidationSpecification.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovalidationSpecification(ModelPackageValidationSpecification)
.- Parameters:
validationSpecification
- a consumer that will call methods onModelPackageValidationSpecification.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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:
-
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 theModelPackageStatusDetails.Builder
avoiding the need to create one manually viaModelPackageStatusDetails.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomodelPackageStatusDetails(ModelPackageStatusDetails)
.- Parameters:
modelPackageStatusDetails
- a consumer that will call methods onModelPackageStatusDetails.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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:
-
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
Sets the value of the CreatedBy property for this object. This is a convenience method that creates an instance of theUserContext.Builder
avoiding the need to create one manually viaUserContext.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocreatedBy(UserContext)
.- Parameters:
createdBy
- a consumer that will call methods onUserContext.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theMetadataProperties.Builder
avoiding the need to create one manually viaMetadataProperties.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tometadataProperties(MetadataProperties)
.- Parameters:
metadataProperties
- a consumer that will call methods onMetadataProperties.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theModelMetrics.Builder
avoiding the need to create one manually viaModelMetrics.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomodelMetrics(ModelMetrics)
.- Parameters:
modelMetrics
- a consumer that will call methods onModelMetrics.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 theUserContext.Builder
avoiding the need to create one manually viaUserContext.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolastModifiedBy(UserContext)
.- Parameters:
lastModifiedBy
- a consumer that will call methods onUserContext.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 theDriftCheckBaselines.Builder
avoiding the need to create one manually viaDriftCheckBaselines.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todriftCheckBaselines(DriftCheckBaselines)
.- Parameters:
driftCheckBaselines
- a consumer that will call methods onDriftCheckBaselines.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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 theAdditionalInferenceSpecificationDefinition.Builder
avoiding the need to create one manually viaAdditionalInferenceSpecificationDefinition.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toadditionalInferenceSpecifications(List<AdditionalInferenceSpecificationDefinition>)
.- Parameters:
additionalInferenceSpecifications
- a consumer that will call methods onAdditionalInferenceSpecificationDefinition.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
skipModelValidation
Indicates if you want to skip model validation.
- Parameters:
skipModelValidation
- Indicates if you want to skip model validation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
skipModelValidation
Indicates if you want to skip model validation.
- Parameters:
skipModelValidation
- Indicates if you want to skip model validation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-