Package software.amazon.awssdk.services.kendra.model

Interface Document.Builder

    • Method Detail

      • id

        Document.Builder id​(String id)

        A identifier of the document in the index.

        Note, each document ID must be unique per index. You cannot create a data source to index your documents with their unique IDs and then use the BatchPutDocument API to index the same documents, or vice versa. You can delete a data source and then use the BatchPutDocument API to index the same documents, or vice versa.

        Parameters:
        id - A identifier of the document in the index.

        Note, each document ID must be unique per index. You cannot create a data source to index your documents with their unique IDs and then use the BatchPutDocument API to index the same documents, or vice versa. You can delete a data source and then use the BatchPutDocument API to index the same documents, or vice versa.

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

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

      • blob

        Document.Builder blob​(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 Kendra APIs. If you are calling the Amazon Kendra 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 Kendra APIs. If you are calling the Amazon Kendra endpoint directly using REST, you must base64 encode the contents before sending.

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

      • s3Path

        Document.Builder s3Path​(S3Path s3Path)
        Sets the value of the S3Path property for this object.
        Parameters:
        s3Path - The new value for the S3Path property for this object.
        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. Use the custom attributes to provide additional information for searching, to provide facets for refining searches, and to provide additional information in the query response.

        For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide information on the synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job.

        Parameters:
        attributes - Custom attributes to apply to the document. Use the custom attributes to provide additional information for searching, to provide facets for refining searches, and to provide additional information in the query response.

        For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide information on the synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job.

        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. Use the custom attributes to provide additional information for searching, to provide facets for refining searches, and to provide additional information in the query response.

        For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide information on the synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job.

        Parameters:
        attributes - Custom attributes to apply to the document. Use the custom attributes to provide additional information for searching, to provide facets for refining searches, and to provide additional information in the query response.

        For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide information on the synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job.

        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. Use the custom attributes to provide additional information for searching, to provide facets for refining searches, and to provide additional information in the query response.

        For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide information on the synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job.

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

        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:
        #attributes(java.util.Collection)

      • accessControlList

        Document.Builder accessControlList​(Collection<Principal> accessControlList)

        Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

        Parameters:
        accessControlList - Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • accessControlList

        Document.Builder accessControlList​(Principal... accessControlList)

        Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

        Parameters:
        accessControlList - Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • accessControlList

        Document.Builder accessControlList​(Consumer<Principal.Builder>... accessControlList)

        Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #accessControlList(List).

        Parameters:
        accessControlList - a consumer that will call methods on Principal.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #accessControlList(java.util.Collection)

      • hierarchicalAccessControlList

        Document.Builder hierarchicalAccessControlList​(Collection<HierarchicalPrincipal> hierarchicalAccessControlList)

        The list of principal lists that define the hierarchy for which documents users should have access to.

        Parameters:
        hierarchicalAccessControlList - The list of principal lists that define the hierarchy for which documents users should have access to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • hierarchicalAccessControlList

        Document.Builder hierarchicalAccessControlList​(HierarchicalPrincipal... hierarchicalAccessControlList)

        The list of principal lists that define the hierarchy for which documents users should have access to.

        Parameters:
        hierarchicalAccessControlList - The list of principal lists that define the hierarchy for which documents users should have access to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • 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 must 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 must 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, ContentType

      • 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 must 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 must 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, ContentType

      • accessControlConfigurationId

        Document.Builder accessControlConfigurationId​(String accessControlConfigurationId)

        The identifier of the access control configuration that you want to apply to the document.

        Parameters:
        accessControlConfigurationId - The identifier of the access control configuration that you want to apply to the document.
        Returns:
        Returns a reference to this object so that method calls can be chained together.