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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface InferenceComponentSpecification.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`baseInferenceComponentName()`	The name of an existing inference component that is to contain the inference component that you're creating with your request.
`static InferenceComponentSpecification.Builder`	`builder()`
`InferenceComponentComputeResourceRequirements`	`computeResourceRequirements()`	The compute resources allocated to run the model, plus any adapter models, that you assign to the inference component.
`InferenceComponentContainerSpecification`	`container()`	Defines a container that provides the runtime environment for a model that you deploy with an inference component.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`modelName()`	The name of an existing SageMaker model object in your account that you want to deploy with the inference component.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends InferenceComponentSpecification.Builder>`	`serializableBuilderClass()`
`InferenceComponentStartupParameters`	`startupParameters()`	Settings that take effect while the model container starts up.
`InferenceComponentSpecification.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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
  - modelName
```
public final String modelName()
```
    The name of an existing SageMaker model object in your account that you want to deploy with the inference component.
    
    Returns:
    
    The name of an existing SageMaker 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.
  - toBuilder
```
public InferenceComponentSpecification.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<InferenceComponentSpecification.Builder,InferenceComponentSpecification>
  - 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)
```
    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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class InferenceComponentSpecification

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

modelName

container

startupParameters

computeResourceRequirements

baseInferenceComponentName

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField