Class ContentBlock

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

A block of content in a response.

See Also:

  • Method Details

    • type

      public final ContentBlockType type()

      The type of content in the block.

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

      Returns:
      The type of content in the block.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of content in the block.

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

      Returns:
      The type of content in the block.
      See Also:

    • text

      public final String text()

      The text content of the block.

      Returns:
      The text content of the block.

    • data

      public final SdkBytes data()

      The binary data content of the block.

      Returns:
      The binary data content of the block.

    • mimeType

      public final String mimeType()

      The MIME type of the content.

      Returns:
      The MIME type of the content.

    • uri

      public final String uri()

      The URI of the content.

      Returns:
      The URI of the content.

    • name

      public final String name()

      The name of the content block.

      Returns:
      The name of the content block.

    • description

      public final String description()

      The description of the content block.

      Returns:
      The description of the content block.

    • size

      public final Long size()

      The size of the content in bytes.

      Returns:
      The size of the content in bytes.

    • resource

      public final ResourceContent resource()

      The resource associated with the content block.

      Returns:
      The resource associated with the content block.

    • toBuilder

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

    • builder

      public static ContentBlock.Builder builder()

    • serializableBuilderClass

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