Class FoundationModelSummary

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:

  • Method Details

    • modelArn

      public final String modelArn()

      The Amazon Resource Name (ARN) of the foundation model.

      Returns:
      The Amazon Resource Name (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()
      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<FoundationModelSummary.Builder,FoundationModelSummary>
      Returns:
      a builder for type T

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