Package software.amazon.awssdk.services.qbusiness.model

Class Document

    • Method Detail

      • id

        public final String id()

        The identifier of the document.

        Returns:
        The identifier of the document.

      • hasAttributes

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

      • attributes

        public final List<DocumentAttribute> attributes()

        Custom attributes to apply to the document for refining Amazon Q Business web experience responses.

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

        Returns:
        Custom attributes to apply to the document for refining Amazon Q Business web experience responses.

      • content

        public final DocumentContent content()

        The contents of the document.

        Returns:
        The contents of the document.

      • contentType

        public final ContentType contentType()

        The file type of the document in the Blob field.

        If you want to index snippets or subsets of HTML documents instead of the entirety of the HTML documents, you add the HTML start and closing tags (<HTML>content</HTML>) around the content.

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

        Returns:
        The file type of the document in the Blob field.

        If you want to index snippets or subsets of HTML documents instead of the entirety of the HTML documents, you add the HTML start and closing tags (<HTML>content</HTML>) around the content.

        See Also:
        ContentType

      • contentTypeAsString

        public final String contentTypeAsString()

        The file type of the document in the Blob field.

        If you want to index snippets or subsets of HTML documents instead of the entirety of the HTML documents, you add the HTML start and closing tags (<HTML>content</HTML>) around the content.

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

        Returns:
        The file type of the document in the Blob field.

        If you want to index snippets or subsets of HTML documents instead of the entirety of the HTML documents, you add the HTML start and closing tags (<HTML>content</HTML>) around the content.

        See Also:
        ContentType

      • title

        public final String title()

        The title of the document.

        Returns:
        The title of the document.

      • accessConfiguration

        public final AccessConfiguration accessConfiguration()

        Configuration information for access permission to a document.

        Returns:
        Configuration information for access permission to a document.

      • documentEnrichmentConfiguration

        public final DocumentEnrichmentConfiguration documentEnrichmentConfiguration()

        The configuration information for altering document metadata and content during the document ingestion process.

        Returns:
        The configuration information for altering document metadata and content during the document ingestion process.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • 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)