software.amazon.awssdk.services.sagemaker.model

Class UpdateModelPackageRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sagemaker.model.SageMakerRequest

software.amazon.awssdk.services.sagemaker.model.UpdateModelPackageRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateModelPackageRequest.Builder,UpdateModelPackageRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateModelPackageRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<AdditionalInferenceSpecificationDefinition>	additionalInferenceSpecificationsToAdd() An array of additional Inference Specification objects to be added to the existing array additional Inference Specification.
String	approvalDescription() A description for the approval status of the model.
static UpdateModelPackageRequest.Builder	builder()
Map<String,String>	customerMetadataProperties() The metadata properties associated with the model package versions.
List<String>	customerMetadataPropertiesToRemove() The metadata properties associated with the model package versions to remove.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAdditionalInferenceSpecificationsToAdd() For responses, this returns true if the service returned a value for the AdditionalInferenceSpecificationsToAdd property.
boolean	hasCustomerMetadataProperties() For responses, this returns true if the service returned a value for the CustomerMetadataProperties property.
boolean	hasCustomerMetadataPropertiesToRemove() For responses, this returns true if the service returned a value for the CustomerMetadataPropertiesToRemove property.
int	hashCode()
ModelApprovalStatus	modelApprovalStatus() The approval status of the model.
String	modelApprovalStatusAsString() The approval status of the model.
String	modelPackageArn() The Amazon Resource Name (ARN) of the model package.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateModelPackageRequest.Builder>	serializableBuilderClass()
UpdateModelPackageRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

modelPackageArn

public final String modelPackageArn()

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

Returns:

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

modelApprovalStatus

public final ModelApprovalStatus modelApprovalStatus()

The approval status of the model.

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.

See Also:

ModelApprovalStatus

modelApprovalStatusAsString

public final String modelApprovalStatusAsString()

The approval status of the model.

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.

See Also:

ModelApprovalStatus

approvalDescription

public final String approvalDescription()

A description for the approval status of the model.

Returns:

A description for the approval status of the model.

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.

hasCustomerMetadataPropertiesToRemove

public final boolean hasCustomerMetadataPropertiesToRemove()

For responses, this returns true if the service returned a value for the CustomerMetadataPropertiesToRemove 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.

customerMetadataPropertiesToRemove

public final List<String> customerMetadataPropertiesToRemove()

The metadata properties associated with the model package versions to remove.

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 hasCustomerMetadataPropertiesToRemove() method.

Returns:

The metadata properties associated with the model package versions to remove.

hasAdditionalInferenceSpecificationsToAdd

public final boolean hasAdditionalInferenceSpecificationsToAdd()

For responses, this returns true if the service returned a value for the AdditionalInferenceSpecificationsToAdd 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.

additionalInferenceSpecificationsToAdd

public final List<AdditionalInferenceSpecificationDefinition> additionalInferenceSpecificationsToAdd()

An array of additional Inference Specification objects to be added to the existing array additional Inference Specification. Total number of additional Inference Specifications can not exceed 15. 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 hasAdditionalInferenceSpecificationsToAdd() method.

Returns:

An array of additional Inference Specification objects to be added to the existing array additional Inference Specification. Total number of additional Inference Specifications can not exceed 15. 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 UpdateModelPackageRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateModelPackageRequest.Builder,UpdateModelPackageRequest>

Specified by:

toBuilder in class SageMakerRequest

builder

public static UpdateModelPackageRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateModelPackageRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo