Class InferenceComponentSpecification

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

Details about the resources to deploy with this inference component, including the model, container, and compute resources.

See Also:

  • Method Details

    • modelName

      public final String modelName()

      The name of an existing SageMaker AI model object in your account that you want to deploy with the inference component.

      Returns:
      The name of an existing SageMaker AI model object in your account that you want to deploy with the inference component.

    • container

      public final InferenceComponentContainerSpecification container()

      Defines a container that provides the runtime environment for a model that you deploy with an inference component.

      Returns:
      Defines a container that provides the runtime environment for a model that you deploy with an inference component.

    • startupParameters

      public final InferenceComponentStartupParameters startupParameters()

      Settings that take effect while the model container starts up.

      Returns:
      Settings that take effect while the model container starts up.

    • computeResourceRequirements

      public final InferenceComponentComputeResourceRequirements computeResourceRequirements()

      The compute resources allocated to run the model, plus any adapter models, that you assign to the inference component.

      Omit this parameter if your request is meant to create an adapter inference component. An adapter inference component is loaded by a base inference component, and it uses the compute resources of the base inference component.

      Returns:
      The compute resources allocated to run the model, plus any adapter models, that you assign to the inference component.

      Omit this parameter if your request is meant to create an adapter inference component. An adapter inference component is loaded by a base inference component, and it uses the compute resources of the base inference component.

    • baseInferenceComponentName

      public final String baseInferenceComponentName()

      The name of an existing inference component that is to contain the inference component that you're creating with your request.

      Specify this parameter only if your request is meant to create an adapter inference component. An adapter inference component contains the path to an adapter model. The purpose of the adapter model is to tailor the inference output of a base foundation model, which is hosted by the base inference component. The adapter inference component uses the compute resources that you assigned to the base inference component.

      When you create an adapter inference component, use the Container parameter to specify the location of the adapter artifacts. In the parameter value, use the ArtifactUrl parameter of the InferenceComponentContainerSpecification data type.

      Before you can create an adapter inference component, you must have an existing inference component that contains the foundation model that you want to adapt.

      Returns:
      The name of an existing inference component that is to contain the inference component that you're creating with your request.

      Specify this parameter only if your request is meant to create an adapter inference component. An adapter inference component contains the path to an adapter model. The purpose of the adapter model is to tailor the inference output of a base foundation model, which is hosted by the base inference component. The adapter inference component uses the compute resources that you assigned to the base inference component.

      When you create an adapter inference component, use the Container parameter to specify the location of the adapter artifacts. In the parameter value, use the ArtifactUrl parameter of the InferenceComponentContainerSpecification data type.

      Before you can create an adapter inference component, you must have an existing inference component that contains the foundation model that you want to adapt.

    • dataCacheConfig

      public final InferenceComponentDataCacheConfig dataCacheConfig()

      Settings that affect how the inference component caches data.

      Returns:
      Settings that affect how the inference component caches data.

    • toBuilder

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

    • builder

      public static InferenceComponentSpecification.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.