Interface Document.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Document.Builder,
,Document> SdkBuilder<Document.Builder,
,Document> SdkPojo
- Enclosing class:
Document
-
Method Summary
Modifier and TypeMethodDescriptionaccessControlConfigurationId
(String accessControlConfigurationId) The identifier of the access control configuration that you want to apply to the document.accessControlList
(Collection<Principal> accessControlList) Information on principals (users and/or groups) and which documents they should have access to.accessControlList
(Consumer<Principal.Builder>... accessControlList) Information on principals (users and/or groups) and which documents they should have access to.accessControlList
(Principal... accessControlList) Information on principals (users and/or groups) and which documents they should have access to.attributes
(Collection<DocumentAttribute> attributes) Custom attributes to apply to the document.attributes
(Consumer<DocumentAttribute.Builder>... attributes) Custom attributes to apply to the document.attributes
(DocumentAttribute... attributes) Custom attributes to apply to the document.The contents of the document.contentType
(String contentType) The file type of the document in theBlob
field.contentType
(ContentType contentType) The file type of the document in theBlob
field.hierarchicalAccessControlList
(Collection<HierarchicalPrincipal> hierarchicalAccessControlList) The list of principal lists that define the hierarchy for which documents users should have access to.hierarchicalAccessControlList
(Consumer<HierarchicalPrincipal.Builder>... hierarchicalAccessControlList) The list of principal lists that define the hierarchy for which documents users should have access to.hierarchicalAccessControlList
(HierarchicalPrincipal... hierarchicalAccessControlList) The list of principal lists that define the hierarchy for which documents users should have access to.A identifier of the document in the index.default Document.Builder
s3Path
(Consumer<S3Path.Builder> s3Path) Sets the value of the S3Path property for this object.Sets the value of the S3Path property for this object.The title of the document.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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 theBatchPutDocument
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 theBatchPutDocument
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
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
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
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.
-
s3Path
Sets the value of the S3Path property for this object. This is a convenience method that creates an instance of theS3Path.Builder
avoiding the need to create one manually viaS3Path.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tos3Path(S3Path)
.- Parameters:
s3Path
- a consumer that will call methods onS3Path.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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 theDocumentAttribute.Builder
avoiding the need to create one manually viaDocumentAttribute.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toattributes(List<DocumentAttribute>)
.- Parameters:
attributes
- a consumer that will call methods onDocumentAttribute.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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 thePrincipal.Builder
avoiding the need to create one manually viaPrincipal.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toaccessControlList(List<Principal>)
.- Parameters:
accessControlList
- a consumer that will call methods onPrincipal.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
hierarchicalAccessControlList
Document.Builder hierarchicalAccessControlList(Consumer<HierarchicalPrincipal.Builder>... hierarchicalAccessControlList) The list of principal lists that define the hierarchy for which documents users should have access to.
This is a convenience method that creates an instance of theHierarchicalPrincipal.Builder
avoiding the need to create one manually viaHierarchicalPrincipal.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tohierarchicalAccessControlList(List<HierarchicalPrincipal>)
.- Parameters:
hierarchicalAccessControlList
- a consumer that will call methods onHierarchicalPrincipal.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theBlob
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
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 theBlob
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:
-
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.
-