Class ImageInput

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

Details about an image in the result from a function in the action group invocation. You can specify images only when the function is a computer use action. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.

See Also:

  • Method Details

    • format

      public final ImageInputFormat format()

      The type of image in the result.

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

      Returns:
      The type of image in the result.
      See Also:

    • formatAsString

      public final String formatAsString()

      The type of image in the result.

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

      Returns:
      The type of image in the result.
      See Also:

    • source

      public final ImageInputSource source()

      The source of the image in the result.

      Returns:
      The source of the image in the result.

    • toBuilder

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

    • builder

      public static ImageInput.Builder builder()

    • serializableBuilderClass

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