java.lang.Object
- software.amazon.awssdk.services.bedrock.model.FoundationModelSummary

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<FoundationModelSummary.Builder,FoundationModelSummary>

@Generated("software.amazon.awssdk:codegen")
public final class FoundationModelSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<FoundationModelSummary.Builder,FoundationModelSummary>

Summary information for a foundation model.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface FoundationModelSummary.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static FoundationModelSummary.Builder`	`builder()`
`List<ModelCustomization>`	`customizationsSupported()`	Whether the model supports fine-tuning or continual pre-training.
`List<String>`	`customizationsSupportedAsStrings()`	Whether the model supports fine-tuning or continual pre-training.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasCustomizationsSupported()`	For responses, this returns true if the service returned a value for the CustomizationsSupported property.
`int`	`hashCode()`
`boolean`	`hasInferenceTypesSupported()`	For responses, this returns true if the service returned a value for the InferenceTypesSupported property.
`boolean`	`hasInputModalities()`	For responses, this returns true if the service returned a value for the InputModalities property.
`boolean`	`hasOutputModalities()`	For responses, this returns true if the service returned a value for the OutputModalities property.
`List<InferenceType>`	`inferenceTypesSupported()`	The inference types that the model supports.
`List<String>`	`inferenceTypesSupportedAsStrings()`	The inference types that the model supports.
`List<ModelModality>`	`inputModalities()`	The input modalities that the model supports.
`List<String>`	`inputModalitiesAsStrings()`	The input modalities that the model supports.
`String`	`modelArn()`	The ARN of the foundation model.
`String`	`modelId()`	The model Id of the foundation model.
`FoundationModelLifecycle`	`modelLifecycle()`	Contains details about whether a model version is available or deprecated.
`String`	`modelName()`	The name of the model.
`List<ModelModality>`	`outputModalities()`	The output modalities that the model supports.
`List<String>`	`outputModalitiesAsStrings()`	The output modalities that the model supports.
`String`	`providerName()`	The model's provider name.
`Boolean`	`responseStreamingSupported()`	Indicates whether the model supports streaming.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends FoundationModelSummary.Builder>`	`serializableBuilderClass()`
`FoundationModelSummary.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
  - modelArn
```
public final String modelArn()
```
    The ARN of the foundation model.
    
    Returns:
    
    The ARN of the foundation model.
  - modelId
```
public final String modelId()
```
    The model Id of the foundation model.
    
    Returns:
    
    The model Id of the foundation model.
  - modelName
```
public final String modelName()
```
    The name of the model.
    
    Returns:
    
    The name of the model.
  - providerName
```
public final String providerName()
```
    The model's provider name.
    
    Returns:
    
    The model's provider name.
  - inputModalities
```
public final List<ModelModality> inputModalities()
```
    The input modalities that the model supports.
    
    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 hasInputModalities() method.
    
    Returns:
    
    The input modalities that the model supports.
  - hasInputModalities
```
public final boolean hasInputModalities()
```
    For responses, this returns true if the service returned a value for the InputModalities 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.
  - inputModalitiesAsStrings
```
public final List<String> inputModalitiesAsStrings()
```
    The input modalities that the model supports.
    
    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 hasInputModalities() method.
    
    Returns:
    
    The input modalities that the model supports.
  - outputModalities
```
public final List<ModelModality> outputModalities()
```
    The output modalities that the model supports.
    
    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 hasOutputModalities() method.
    
    Returns:
    
    The output modalities that the model supports.
  - hasOutputModalities
```
public final boolean hasOutputModalities()
```
    For responses, this returns true if the service returned a value for the OutputModalities 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.
  - outputModalitiesAsStrings
```
public final List<String> outputModalitiesAsStrings()
```
    The output modalities that the model supports.
    
    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 hasOutputModalities() method.
    
    Returns:
    
    The output modalities that the model supports.
  - responseStreamingSupported
```
public final Boolean responseStreamingSupported()
```
    Indicates whether the model supports streaming.
    
    Returns:
    
    Indicates whether the model supports streaming.
  - customizationsSupported
```
public final List<ModelCustomization> customizationsSupported()
```
    Whether the model supports fine-tuning or continual pre-training.
    
    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 hasCustomizationsSupported() method.
    
    Returns:
    
    Whether the model supports fine-tuning or continual pre-training.
  - hasCustomizationsSupported
```
public final boolean hasCustomizationsSupported()
```
    For responses, this returns true if the service returned a value for the CustomizationsSupported 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.
  - customizationsSupportedAsStrings
```
public final List<String> customizationsSupportedAsStrings()
```
    Whether the model supports fine-tuning or continual pre-training.
    
    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 hasCustomizationsSupported() method.
    
    Returns:
    
    Whether the model supports fine-tuning or continual pre-training.
  - inferenceTypesSupported
```
public final List<InferenceType> inferenceTypesSupported()
```
    The inference types that the model supports.
    
    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 hasInferenceTypesSupported() method.
    
    Returns:
    
    The inference types that the model supports.
  - hasInferenceTypesSupported
```
public final boolean hasInferenceTypesSupported()
```
    For responses, this returns true if the service returned a value for the InferenceTypesSupported 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.
  - inferenceTypesSupportedAsStrings
```
public final List<String> inferenceTypesSupportedAsStrings()
```
    The inference types that the model supports.
    
    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 hasInferenceTypesSupported() method.
    
    Returns:
    
    The inference types that the model supports.
  - modelLifecycle
```
public final FoundationModelLifecycle modelLifecycle()
```
    Contains details about whether a model version is available or deprecated.
    
    Returns:
    
    Contains details about whether a model version is available or deprecated.
  - toBuilder
```
public FoundationModelSummary.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<FoundationModelSummary.Builder,FoundationModelSummary>
  - builder
```
public static FoundationModelSummary.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends FoundationModelSummary.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

Class FoundationModelSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

modelArn

modelId

modelName

providerName

inputModalities

hasInputModalities

inputModalitiesAsStrings

outputModalities

hasOutputModalities

outputModalitiesAsStrings

responseStreamingSupported

customizationsSupported

hasCustomizationsSupported

customizationsSupportedAsStrings

inferenceTypesSupported

hasInferenceTypesSupported

inferenceTypesSupportedAsStrings

modelLifecycle

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields