Class DocumentSource

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

Contains the content of a document.

See Also:

  • Method Details

    • bytes

      public final SdkBytes bytes()

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

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

    • s3Location

      public final S3Location s3Location()

      The location of a document object in an Amazon S3 bucket. To see which models support S3 uploads, see Supported models and features for Converse.

      Returns:
      The location of a document object in an Amazon S3 bucket. To see which models support S3 uploads, see Supported models and features for Converse.

    • text

      public final String text()

      The text content of the document source.

      Returns:
      The text content of the document source.

    • hasContent

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

    • content

      public final List<DocumentContentBlock> content()

      The structured content of the document source, which may include various content blocks such as text, images, or other document elements.

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

      Returns:
      The structured content of the document source, which may include various content blocks such as text, images, or other document elements.

    • toBuilder

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

    • builder

      public static DocumentSource.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DocumentSource.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 DocumentSource fromBytes(SdkBytes bytes)
      Create an instance of this class with bytes() initialized to the given value.

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

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

    • fromS3Location

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

      The location of a document object in an Amazon S3 bucket. To see which models support S3 uploads, see Supported models and features for Converse.

      Parameters:
      s3Location - The location of a document object in an Amazon S3 bucket. To see which models support S3 uploads, see Supported models and features for Converse.

    • fromS3Location

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

      The location of a document object in an Amazon S3 bucket. To see which models support S3 uploads, see Supported models and features for Converse.

      Parameters:
      s3Location - The location of a document object in an Amazon S3 bucket. To see which models support S3 uploads, see Supported models and features for Converse.

    • fromText

      public static DocumentSource fromText(String text)
      Create an instance of this class with text() initialized to the given value.

      The text content of the document source.

      Parameters:
      text - The text content of the document source.

    • fromContent

      public static DocumentSource fromContent(List<DocumentContentBlock> content)
      Create an instance of this class with content() initialized to the given value.

      The structured content of the document source, which may include various content blocks such as text, images, or other document elements.

      Parameters:
      content - The structured content of the document source, which may include various content blocks such as text, images, or other document elements.

    • type

      public DocumentSource.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 DocumentSource.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 DocumentSource.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.