Class AdditionalInferenceSpecificationDefinition

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.AdditionalInferenceSpecificationDefinition
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AdditionalInferenceSpecificationDefinition.Builder,AdditionalInferenceSpecificationDefinition>
@Generated("software.amazon.awssdk:codegen") public final class AdditionalInferenceSpecificationDefinition extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AdditionalInferenceSpecificationDefinition.Builder,AdditionalInferenceSpecificationDefinition>

A structure of additional Inference Specification. Additional Inference Specification specifies details about inference jobs that can be run with models based on this model package

See Also:

  • Method Details

    • name

      public final String name()

      A unique name to identify the additional inference specification. The name must be unique within the list of your additional inference specifications for a particular model package.

      Returns:
      A unique name to identify the additional inference specification. The name must be unique within the list of your additional inference specifications for a particular model package.

    • description

      public final String description()

      A description of the additional Inference specification

      Returns:
      A description of the additional Inference specification

    • hasContainers

      public final boolean hasContainers()
      For responses, this returns true if the service returned a value for the Containers 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.

    • containers

      public final List<ModelPackageContainerDefinition> containers()

      The Amazon ECR registry path of the Docker image that contains the inference code.

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

      Returns:
      The Amazon ECR registry path of the Docker image that contains the inference code.

    • supportedTransformInstanceTypes

      public final List<TransformInstanceType> supportedTransformInstanceTypes()

      A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

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

      Returns:
      A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

    • hasSupportedTransformInstanceTypes

      public final boolean hasSupportedTransformInstanceTypes()
      For responses, this returns true if the service returned a value for the SupportedTransformInstanceTypes 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.

    • supportedTransformInstanceTypesAsStrings

      public final List<String> supportedTransformInstanceTypesAsStrings()

      A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

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

      Returns:
      A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

    • supportedRealtimeInferenceInstanceTypes

      public final List<ProductionVariantInstanceType> supportedRealtimeInferenceInstanceTypes()

      A list of the instance types that are used to generate inferences in real-time.

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

      Returns:
      A list of the instance types that are used to generate inferences in real-time.

    • hasSupportedRealtimeInferenceInstanceTypes

      public final boolean hasSupportedRealtimeInferenceInstanceTypes()
      For responses, this returns true if the service returned a value for the SupportedRealtimeInferenceInstanceTypes 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.

    • supportedRealtimeInferenceInstanceTypesAsStrings

      public final List<String> supportedRealtimeInferenceInstanceTypesAsStrings()

      A list of the instance types that are used to generate inferences in real-time.

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

      Returns:
      A list of the instance types that are used to generate inferences in real-time.

    • hasSupportedContentTypes

      public final boolean hasSupportedContentTypes()
      For responses, this returns true if the service returned a value for the SupportedContentTypes 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.

    • supportedContentTypes

      public final List<String> supportedContentTypes()

      The supported MIME types for the input data.

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

      Returns:
      The supported MIME types for the input data.

    • hasSupportedResponseMIMETypes

      public final boolean hasSupportedResponseMIMETypes()
      For responses, this returns true if the service returned a value for the SupportedResponseMIMETypes 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.

    • supportedResponseMIMETypes

      public final List<String> supportedResponseMIMETypes()

      The supported MIME types for the output data.

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

      Returns:
      The supported MIME types for the output data.

    • toBuilder

      public AdditionalInferenceSpecificationDefinition.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<AdditionalInferenceSpecificationDefinition.Builder,AdditionalInferenceSpecificationDefinition>
      Returns:
      a builder for type T

    • builder

      public static AdditionalInferenceSpecificationDefinition.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AdditionalInferenceSpecificationDefinition.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)
      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)

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