DescribeModelPackageResponse (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.sagemaker.model.SageMakerResponse
    - - software.amazon.awssdk.services.sagemaker.model.DescribeModelPackageResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeModelPackageResponse.Builder,DescribeModelPackageResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeModelPackageResponse
extends SageMakerResponse
implements ToCopyableBuilder<DescribeModelPackageResponse.Builder,DescribeModelPackageResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeModelPackageResponse.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<AdditionalInferenceSpecificationDefinition>`	`additionalInferenceSpecifications()` An array of additional Inference Specification objects.
`String`	`approvalDescription()` A description provided for the model approval.
`static DescribeModelPackageResponse.Builder`	`builder()`
`Boolean`	`certifyForMarketplace()` Whether the model package is certified for listing on Amazon Web Services Marketplace.
`UserContext`	`createdBy()` Returns the value of the CreatedBy property for this object.
`Instant`	`creationTime()` A timestamp specifying when the model package was created.
`Map<String,String>`	`customerMetadataProperties()` The metadata properties associated with the model package versions.
`String`	`domain()` The machine learning domain of the model package you specified.
`DriftCheckBaselines`	`driftCheckBaselines()` Represents the drift check baselines that can be used when the model monitor is set using the model package.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAdditionalInferenceSpecifications()` For responses, this returns true if the service returned a value for the AdditionalInferenceSpecifications property.
`boolean`	`hasCustomerMetadataProperties()` For responses, this returns true if the service returned a value for the CustomerMetadataProperties property.
`int`	`hashCode()`
`InferenceSpecification`	`inferenceSpecification()` Details about inference jobs that can be run with models based on this model package.
`UserContext`	`lastModifiedBy()` Returns the value of the LastModifiedBy property for this object.
`Instant`	`lastModifiedTime()` The last time that 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 package.
`String`	`modelApprovalStatusAsString()` The approval status of the model package.
`ModelMetrics`	`modelMetrics()` Metrics for the model.
`String`	`modelPackageArn()` The Amazon Resource Name (ARN) of the model package.
`String`	`modelPackageDescription()` A brief summary of the model package.
`String`	`modelPackageGroupName()` If the model is a versioned model, the name of the model group that the versioned model belongs to.
`String`	`modelPackageName()` The name of the model package being described.
`ModelPackageStatus`	`modelPackageStatus()` The current status of the model package.
`String`	`modelPackageStatusAsString()` The current status of the model package.
`ModelPackageStatusDetails`	`modelPackageStatusDetails()` Details about the current status of the model package.
`Integer`	`modelPackageVersion()` The version of the model package.
`String`	`samplePayloadUrl()` The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeModelPackageResponse.Builder>`	`serializableBuilderClass()`
`SourceAlgorithmSpecification`	`sourceAlgorithmSpecification()` Details about the algorithm that was used to create the model package.
`String`	`task()` The machine learning task you specified that your model package accomplishes.
`DescribeModelPackageResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`ModelPackageValidationSpecification`	`validationSpecification()` Configurations for one or more transform jobs that SageMaker runs to test the model package.

Methods inherited from class software.amazon.awssdk.services.sagemaker.model.SageMakerResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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 package being described.
    
    Returns:
    
    The name of the model package being described.
  - modelPackageGroupName
```
public final String modelPackageGroupName()
```
    If the model is a versioned model, the name of the model group that the versioned model belongs to.
    
    Returns:
    
    If the model is a versioned model, the name of the model group that the versioned model belongs to.
  - modelPackageVersion
```
public final Integer modelPackageVersion()
```
    The version of the model package.
    
    Returns:
    
    The version of the model package.
  - 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()
```
    A brief summary of the model package.
    
    Returns:
    
    A brief summary of the model package.
  - creationTime
```
public final Instant creationTime()
```
    A timestamp specifying when the model package was created.
    
    Returns:
    
    A timestamp specifying when the model package was created.
  - inferenceSpecification
```
public final InferenceSpecification inferenceSpecification()
```
    Details about inference jobs that can be run with models based on this model package.
    
    Returns:
    
    Details about inference jobs that can be run with models based on this model package.
  - sourceAlgorithmSpecification
```
public final SourceAlgorithmSpecification sourceAlgorithmSpecification()
```
    Details about the algorithm that was used to create the model package.
    
    Returns:
    
    Details about the algorithm that was used to create the model package.
  - validationSpecification
```
public final ModelPackageValidationSpecification validationSpecification()
```
    Configurations for one or more transform jobs that SageMaker runs to test the model package.
    
    Returns:
    
    Configurations for one or more transform jobs that SageMaker runs to test the model package.
  - modelPackageStatus
```
public final ModelPackageStatus modelPackageStatus()
```
    The current status of the model package.
    
    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 current status of the model package.
    
    See Also:
    
    ModelPackageStatus
  - modelPackageStatusAsString
```
public final String modelPackageStatusAsString()
```
    The current status of the model package.
    
    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 current status of the model package.
    
    See Also:
    
    ModelPackageStatus
  - modelPackageStatusDetails
```
public final ModelPackageStatusDetails modelPackageStatusDetails()
```
    Details about the current status of the model package.
    
    Returns:
    
    Details about the current status of the model package.
  - certifyForMarketplace
```
public final Boolean certifyForMarketplace()
```
    Whether the model package is certified for listing on Amazon Web Services Marketplace.
    
    Returns:
    
    Whether the model package is certified for listing on Amazon Web Services Marketplace.
  - modelApprovalStatus
```
public final ModelApprovalStatus modelApprovalStatus()
```
    The approval status of the model package.
    
    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 package.
    
    See Also:
    
    ModelApprovalStatus
  - modelApprovalStatusAsString
```
public final String modelApprovalStatusAsString()
```
    The approval status of the model package.
    
    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 package.
    
    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 that the model package was modified.
    
    Returns:
    
    The last time that 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 for the model approval.
    
    Returns:
    
    A description provided for the model approval.
  - hasCustomerMetadataProperties
```
public final boolean hasCustomerMetadataProperties()
```
    For responses, this returns true if the service returned a value for the CustomerMetadataProperties property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - customerMetadataProperties
```
public final Map<String,String> customerMetadataProperties()
```
    The metadata properties associated with the model package versions.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCustomerMetadataProperties() method.
    
    Returns:
    
    The metadata properties associated with the model package versions.
  - driftCheckBaselines
```
public final 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.
    
    Returns:
    
    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.
  - domain
```
public final String domain()
```
    The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.
    
    Returns:
    
    The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.
  - task
```
public final String task()
```
    The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.
    
    Returns:
    
    The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.
  - samplePayloadUrl
```
public final 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).
    
    Returns:
    
    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).
  - hasAdditionalInferenceSpecifications
```
public final boolean hasAdditionalInferenceSpecifications()
```
    For responses, this returns true if the service returned a value for the AdditionalInferenceSpecifications property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - additionalInferenceSpecifications
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdditionalInferenceSpecifications() method.
    
    Returns:
    
    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.
  - toBuilder
```
public DescribeModelPackageResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeModelPackageResponse.Builder,DescribeModelPackageResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeModelPackageResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeModelPackageResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - 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)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeModelPackageResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.sagemaker.model.SageMakerResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

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

hasCustomerMetadataProperties

customerMetadataProperties

driftCheckBaselines

domain

task

samplePayloadUrl

hasAdditionalInferenceSpecifications

additionalInferenceSpecifications

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields