Class InputImage

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

Contains the image data for multimodal knowledge base queries, including format and content.

This data type is used in the following API operations:

See Also:

  • Method Details

    • format

      public final InputImageFormat format()

      The format of the input image. Supported formats include png, gif, jpeg, and webp.

      If the service returns an enum value that is not available in the current SDK version, format will return InputImageFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().

      Returns:
      The format of the input image. Supported formats include png, gif, jpeg, and webp.
      See Also:

    • formatAsString

      public final String formatAsString()

      The format of the input image. Supported formats include png, gif, jpeg, and webp.

      If the service returns an enum value that is not available in the current SDK version, format will return InputImageFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().

      Returns:
      The format of the input image. Supported formats include png, gif, jpeg, and webp.
      See Also:

    • inlineContent

      public final SdkBytes inlineContent()

      The base64-encoded image data for inline image content. Maximum size is 5MB.

      Returns:
      The base64-encoded image data for inline image content. Maximum size is 5MB.

    • toBuilder

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

    • builder

      public static InputImage.Builder builder()

    • serializableBuilderClass

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