ModelPackage (AWS Java SDK :: Services :: Amazon SageMaker 2.16.77 API)

java.lang.Object
- software.amazon.awssdk.services.sagemaker.model.ModelPackage

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ModelPackage.Builder,ModelPackage>

@Generated(value="software.amazon.awssdk:codegen")
public final class ModelPackage
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ModelPackage.Builder,ModelPackage>

A versioned model that can be deployed for SageMaker inference.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ModelPackage.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ModelPackage.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`approvalDescription()` A description provided when the model approval is set.
`static ModelPackage.Builder`	`builder()`
`Boolean`	`certifyForMarketplace()` Whether the model package is to be certified to be listed on AWS Marketplace.
`UserContext`	`createdBy()` Returns the value of the CreatedBy property for this object.
`Instant`	`creationTime()` The time that the model package was created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`InferenceSpecification`	`inferenceSpecification()` Returns the value of the InferenceSpecification property for this object.
`UserContext`	`lastModifiedBy()` Returns the value of the LastModifiedBy property for this object.
`Instant`	`lastModifiedTime()` The last time the model package was modified.
`MetadataProperties`	`metadataProperties()` Returns the value of the MetadataProperties property for this object.
`ModelApprovalStatus`	`modelApprovalStatus()` The approval status of the model.
`String`	`modelApprovalStatusAsString()` The approval status of the model.
`ModelMetrics`	`modelMetrics()` Metrics for the model.
`String`	`modelPackageArn()` The Amazon Resource Name (ARN) of the model package.
`String`	`modelPackageDescription()` The description of the model package.
`String`	`modelPackageGroupName()` The model group to which the model belongs.
`String`	`modelPackageName()` The name of the model.
`ModelPackageStatus`	`modelPackageStatus()` The status of the model package.
`String`	`modelPackageStatusAsString()` The status of the model package.
`ModelPackageStatusDetails`	`modelPackageStatusDetails()` Returns the value of the ModelPackageStatusDetails property for this object.
`Integer`	`modelPackageVersion()` The version number of a versioned model.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ModelPackage.Builder>`	`serializableBuilderClass()`
`SourceAlgorithmSpecification`	`sourceAlgorithmSpecification()` Returns the value of the SourceAlgorithmSpecification property for this object.
`List<Tag>`	`tags()` A list of the tags associated with the model package.
`ModelPackage.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`ModelPackageValidationSpecification`	`validationSpecification()` Returns the value of the ValidationSpecification property for this object.

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
  - modelPackageName
```
public final String modelPackageName()
```
    The name of the model.
    
    Returns:
    
    The name of the model.
  - modelPackageGroupName
```
public final String modelPackageGroupName()
```
    The model group to which the model belongs.
    
    Returns:
    
    The model group to which the model belongs.
  - modelPackageVersion
```
public final Integer modelPackageVersion()
```
    The version number of a versioned model.
    
    Returns:
    
    The version number of a versioned model.
  - modelPackageArn
```
public final String modelPackageArn()
```
    The Amazon Resource Name (ARN) of the model package.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the model package.
  - modelPackageDescription
```
public final String modelPackageDescription()
```
    The description of the model package.
    
    Returns:
    
    The description of the model package.
  - creationTime
```
public final Instant creationTime()
```
    The time that the model package was created.
    
    Returns:
    
    The time that the model package was created.
  - inferenceSpecification
```
public final InferenceSpecification inferenceSpecification()
```
    Returns the value of the InferenceSpecification property for this object.
    
    Returns:
    
    The value of the InferenceSpecification property for this object.
  - sourceAlgorithmSpecification
```
public final SourceAlgorithmSpecification sourceAlgorithmSpecification()
```
    Returns the value of the SourceAlgorithmSpecification property for this object.
    
    Returns:
    
    The value of the SourceAlgorithmSpecification property for this object.
  - validationSpecification
```
public final ModelPackageValidationSpecification validationSpecification()
```
    Returns the value of the ValidationSpecification property for this object.
    
    Returns:
    
    The value of the ValidationSpecification property for this object.
  - modelPackageStatus
```
public final 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.
    If the service returns an enum value that is not available in the current SDK version, modelPackageStatus will return ModelPackageStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modelPackageStatusAsString().
    Returns:
    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.
    See Also:
    
    ModelPackageStatus
  - modelPackageStatusAsString
```
public final String modelPackageStatusAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, modelPackageStatus will return ModelPackageStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modelPackageStatusAsString().
    Returns:
    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.
    See Also:
    
    ModelPackageStatus
  - modelPackageStatusDetails
```
public final ModelPackageStatusDetails modelPackageStatusDetails()
```
    Returns the value of the ModelPackageStatusDetails property for this object.
    
    Returns:
    
    The value of the ModelPackageStatusDetails property for this object.
  - certifyForMarketplace
```
public final Boolean certifyForMarketplace()
```
    Whether the model package is to be certified to be listed on AWS Marketplace. For information about listing model packages on AWS Marketplace, see List Your Algorithm or Model Package on AWS Marketplace.
    
    Returns:
    
    Whether the model package is to be certified to be listed on AWS Marketplace. For information about listing model packages on AWS Marketplace, see List Your Algorithm or Model Package on AWS Marketplace.
  - modelApprovalStatus
```
public final 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.
    If the service returns an enum value that is not available in the current SDK version, modelApprovalStatus will return ModelApprovalStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modelApprovalStatusAsString().
    Returns:
    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.
    See Also:
    
    ModelApprovalStatus
  - modelApprovalStatusAsString
```
public final String modelApprovalStatusAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, modelApprovalStatus will return ModelApprovalStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modelApprovalStatusAsString().
    Returns:
    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.
    See Also:
    
    ModelApprovalStatus
  - 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.
  - metadataProperties
```
public final MetadataProperties metadataProperties()
```
    Returns the value of the MetadataProperties property for this object.
    
    Returns:
    
    The value of the MetadataProperties property for this object.
  - modelMetrics
```
public final ModelMetrics modelMetrics()
```
    Metrics for the model.
    
    Returns:
    
    Metrics for the model.
  - lastModifiedTime
```
public final Instant lastModifiedTime()
```
    The last time the model package was modified.
    
    Returns:
    
    The last time the model package was 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.
  - approvalDescription
```
public final String approvalDescription()
```
    A description provided when the model approval is set.
    
    Returns:
    
    A description provided when the model approval is set.
  - hasTags
```
public final boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public final List<Tag> tags()
```
    A list of the tags associated with the model package. For more information, see Tagging AWS resources in the AWS General Reference Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    A list of the tags associated with the model package. For more information, see Tagging AWS resources in the AWS General Reference Guide.
  - toBuilder
```
public ModelPackage.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ModelPackage.Builder,ModelPackage>
  - builder
```
public static ModelPackage.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ModelPackage.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ModelPackage

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

modelPackageName

modelPackageGroupName

modelPackageVersion

modelPackageArn

modelPackageDescription

creationTime

inferenceSpecification

sourceAlgorithmSpecification

validationSpecification

modelPackageStatus

modelPackageStatusAsString

modelPackageStatusDetails

certifyForMarketplace

modelApprovalStatus

modelApprovalStatusAsString

createdBy

metadataProperties

modelMetrics

lastModifiedTime

lastModifiedBy

approvalDescription

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields