Class DocumentContent

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

The contents of a document.

See Also:

  • Method Details

    • blob

      public final SdkBytes blob()

      The contents of the document. Documents passed to the blob parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Q Business APIs. If you are calling the Amazon Q Business endpoint directly using REST, you must base64 encode the contents before sending.

      Returns:
      The contents of the document. Documents passed to the blob parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Q Business APIs. If you are calling the Amazon Q Business endpoint directly using REST, you must base64 encode the contents before sending.

    • s3

      public final S3 s3()

      The path to the document in an Amazon S3 bucket.

      Returns:
      The path to the document in an Amazon S3 bucket.

    • toBuilder

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

    • builder

      public static DocumentContent.Builder builder()

    • serializableBuilderClass

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

    • fromBlob

      public static DocumentContent fromBlob(SdkBytes blob)
      Create an instance of this class with blob() initialized to the given value.

      The contents of the document. Documents passed to the blob parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Q Business APIs. If you are calling the Amazon Q Business endpoint directly using REST, you must base64 encode the contents before sending.

      Parameters:
      blob - The contents of the document. Documents passed to the blob parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Q Business APIs. If you are calling the Amazon Q Business endpoint directly using REST, you must base64 encode the contents before sending.

    • fromS3

      public static DocumentContent fromS3(S3 s3)
      Create an instance of this class with s3() initialized to the given value.

      The path to the document in an Amazon S3 bucket.

      Parameters:
      s3 - The path to the document in an Amazon S3 bucket.

    • fromS3

      public static DocumentContent fromS3(Consumer<S3.Builder> s3)
      Create an instance of this class with s3() initialized to the given value.

      The path to the document in an Amazon S3 bucket.

      Parameters:
      s3 - The path to the document in an Amazon S3 bucket.

    • type

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