Package software.amazon.awssdk.services.bedrockagentruntime.model

Class ContentBody

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

Contains the body of the API response.

This data type is used in the following API operations:

See Also:

  • Method Details

    • body

      public final String body()

      The body of the API response.

      Returns:
      The body of the API response.

    • hasImages

      public final boolean hasImages()
      For responses, this returns true if the service returned a value for the Images 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.

    • images

      public final List<ImageInput> images()

      Lists details, including format and source, for the image in the response from the function call. You can specify only one image and the function in the returnControlInvocationResults must be a computer use action. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.

      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 hasImages() method.

      Returns:
      Lists details, including format and source, for the image in the response from the function call. You can specify only one image and the function in the returnControlInvocationResults must be a computer use action. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.

    • toBuilder

      public ContentBody.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ContentBody.Builder,ContentBody>

    • builder

      public static ContentBody.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo