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

Interface Document.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Document.Builder,Document>, SdkBuilder<Document.Builder,Document>, SdkPojo
Enclosing class:
Document
public static interface Document.Builder extends SdkPojo, CopyableBuilder<Document.Builder,Document>

  • Method Details

    • id

      Document.Builder id(String id)

      The identifier of the document.

      Parameters:
      id - The identifier of the document.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attributes

      Document.Builder attributes(Collection<DocumentAttribute> attributes)

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

      Parameters:
      attributes - Custom attributes to apply to the document for refining Amazon Q Business web experience responses.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attributes

      Document.Builder attributes(DocumentAttribute... attributes)

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

      Parameters:
      attributes - Custom attributes to apply to the document for refining Amazon Q Business web experience responses.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attributes

      Document.Builder attributes(Consumer<DocumentAttribute.Builder>... attributes)

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

      This is a convenience method that creates an instance of the DocumentAttribute.Builder avoiding the need to create one manually via DocumentAttribute.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to attributes(List<DocumentAttribute>).

      Parameters:
      attributes - a consumer that will call methods on DocumentAttribute.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • content

      Document.Builder content(DocumentContent content)

      The contents of the document.

      Parameters:
      content - The contents of the document.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • content

      default Document.Builder content(Consumer<DocumentContent.Builder> content)

      The contents of the document.

      This is a convenience method that creates an instance of the DocumentContent.Builder avoiding the need to create one manually via DocumentContent.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to content(DocumentContent).

      Parameters:
      content - a consumer that will call methods on DocumentContent.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • contentType

      Document.Builder contentType(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • contentType

      Document.Builder contentType(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • title

      Document.Builder title(String title)

      The title of the document.

      Parameters:
      title - The title of the document.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accessConfiguration

      Document.Builder accessConfiguration(AccessConfiguration accessConfiguration)

      Configuration information for access permission to a document.

      Parameters:
      accessConfiguration - Configuration information for access permission to a document.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accessConfiguration

      default Document.Builder accessConfiguration(Consumer<AccessConfiguration.Builder> accessConfiguration)

      Configuration information for access permission to a document.

      This is a convenience method that creates an instance of the AccessConfiguration.Builder avoiding the need to create one manually via AccessConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to accessConfiguration(AccessConfiguration).

      Parameters:
      accessConfiguration - a consumer that will call methods on AccessConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • documentEnrichmentConfiguration

      Document.Builder documentEnrichmentConfiguration(DocumentEnrichmentConfiguration documentEnrichmentConfiguration)

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

      Parameters:
      documentEnrichmentConfiguration - The configuration information for altering document metadata and content during the document ingestion process.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • documentEnrichmentConfiguration

      default Document.Builder documentEnrichmentConfiguration(Consumer<DocumentEnrichmentConfiguration.Builder> documentEnrichmentConfiguration)

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

      This is a convenience method that creates an instance of the DocumentEnrichmentConfiguration.Builder avoiding the need to create one manually via DocumentEnrichmentConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to documentEnrichmentConfiguration(DocumentEnrichmentConfiguration).

      Parameters:
      documentEnrichmentConfiguration - a consumer that will call methods on DocumentEnrichmentConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: