Package 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("software.amazon.awssdk:codegen") public final class UpdateModelPackageRequest extends SageMakerRequest implements ToCopyableBuilder<UpdateModelPackageRequest.Builder,UpdateModelPackageRequest>

  • Method Details

    • 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:

    • 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:

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

    • inferenceSpecification

      public final InferenceSpecification inferenceSpecification()

      Specifies details about inference jobs that you can run with models based on this model package, including the following information:

      • The Amazon ECR paths of containers that contain the inference code and model artifacts.

      • The instance types that the model package supports for transform jobs and real-time endpoints used for inference.

      • The input and output content formats that the model package supports for inference.

      Returns:
      Specifies details about inference jobs that you can run with models based on this model package, including the following information:

      • The Amazon ECR paths of containers that contain the inference code and model artifacts.

      • The instance types that the model package supports for transform jobs and real-time endpoints used for inference.

      • The input and output content formats that the model package supports for inference.

    • sourceUri

      public final String sourceUri()

      The URI of the source for the model package.

      Returns:
      The URI of the source for the model package.

    • toBuilder

      public UpdateModelPackageRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateModelPackageRequest.Builder,UpdateModelPackageRequest>
      Specified by:
      toBuilder in class SageMakerRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.