FoundationModelDetails (AWS Java SDK :: Services

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

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

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

Information about a foundation model.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface FoundationModelDetails.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`FoundationModelDetails.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static FoundationModelDetails.Builder`	`builder()`
`List<ModelCustomization>`	`customizationsSupported()` The customization that the model supports.
`List<String>`	`customizationsSupportedAsStrings()` The customization that the model supports.
`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 model ARN.
`String`	`modelId()` The model identifier.
`String`	`modelName()` The model name.
`List<ModelModality>`	`outputModalities()` The output modalities that the model supports.
`List<String>`	`outputModalitiesAsStrings()` The output modalities that the model supports.
`String`	`providerName()` he model's provider name.
`Boolean`	`responseStreamingSupported()` Indicates whether the model supports streaming.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends FoundationModelDetails.Builder>`	`serializableBuilderClass()`
`FoundationModelDetails.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 model ARN.
    
    Returns:
    
    The model ARN.
  - modelId
```
public final String modelId()
```
    The model identifier.
    
    Returns:
    
    The model identifier.
  - modelName
```
public final String modelName()
```
    The model name.
    
    Returns:
    
    The model name.
  - providerName
```
public final String providerName()
```
    he model's provider name.
    
    Returns:
    
    he 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()
```
    The customization 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 hasCustomizationsSupported() method.
    
    Returns:
    
    The customization that the model supports.
  - 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()
```
    The customization 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 hasCustomizationsSupported() method.
    
    Returns:
    
    The customization that the model supports.
  - 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.
  - toBuilder
```
public FoundationModelDetails.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<FoundationModelDetails.Builder,FoundationModelDetails>
  - builder
```
public static FoundationModelDetails.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends FoundationModelDetails.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 FoundationModelDetails

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

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields