Class ImageSource

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

The source for an image.

See Also:

  • Method Details

    • bytes

      public final SdkBytes bytes()

      The raw image bytes for the image. If you use an Amazon Web Services SDK, you don't need to encode the image bytes in base64.

      Returns:
      The raw image bytes for the image. If you use an Amazon Web Services SDK, you don't need to encode the image bytes in base64.

    • s3Location

      public final S3Location s3Location()

      The path to the Amazon S3 bucket where the image is stored.

      Returns:
      The path to the Amazon S3 bucket where the image is stored.

    • toBuilder

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

    • builder

      public static ImageSource.Builder builder()

    • serializableBuilderClass

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

    • fromBytes

      public static ImageSource fromBytes(SdkBytes bytes)
      Create an instance of this class with bytes() initialized to the given value.

      The raw image bytes for the image. If you use an Amazon Web Services SDK, you don't need to encode the image bytes in base64.

      Parameters:
      bytes - The raw image bytes for the image. If you use an Amazon Web Services SDK, you don't need to encode the image bytes in base64.

    • fromS3Location

      public static ImageSource fromS3Location(S3Location s3Location)
      Create an instance of this class with s3Location() initialized to the given value.

      The path to the Amazon S3 bucket where the image is stored.

      Parameters:
      s3Location - The path to the Amazon S3 bucket where the image is stored.

    • fromS3Location

      public static ImageSource fromS3Location(Consumer<S3Location.Builder> s3Location)
      Create an instance of this class with s3Location() initialized to the given value.

      The path to the Amazon S3 bucket where the image is stored.

      Parameters:
      s3Location - The path to the Amazon S3 bucket where the image is stored.

    • type

      public ImageSource.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be ImageSource.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be ImageSource.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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