Struct DocumentBuilder 

#[non_exhaustive]
pub struct DocumentBuilder { /* private fields */ }

A builder for Document.

Implementations

impl DocumentBuilder

pub fn id(self, input: impl Into<String>) -> Self

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.

This field is required.

pub fn set_id(self, input: Option<String>) -> Self

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.

pub fn get_id(&self) -> &Option<String>

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.

pub fn title(self, input: impl Into<String>) -> Self

The title of the document.

pub fn set_title(self, input: Option<String>) -> Self

The title of the document.

pub fn get_title(&self) -> &Option<String>

The title of the document.

pub fn blob(self, input: Blob) -> Self

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.

pub fn set_blob(self, input: Option<Blob>) -> Self

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.

pub fn get_blob(&self) -> &Option<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.

pub fn s3_path(self, input: S3Path) -> Self

Information required to find a specific file in an Amazon S3 bucket.

pub fn set_s3_path(self, input: Option<S3Path>) -> Self

Information required to find a specific file in an Amazon S3 bucket.

pub fn get_s3_path(&self) -> &Option<S3Path>

Information required to find a specific file in an Amazon S3 bucket.

pub fn attributes(self, input: DocumentAttribute) -> Self

Appends an item to attributes.

To override the contents of this collection use set_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.

pub fn set_attributes(self, input: Option<Vec<DocumentAttribute>>) -> Self

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.

pub fn get_attributes(&self) -> &Option<Vec<DocumentAttribute>>

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.

pub fn access_control_list(self, input: Principal) -> Self

Appends an item to access_control_list.

To override the contents of this collection use set_access_control_list.

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.

pub fn set_access_control_list(self, input: Option<Vec<Principal>>) -> Self

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.

pub fn get_access_control_list(&self) -> &Option<Vec<Principal>>

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.

pub fn hierarchical_access_control_list( self, input: HierarchicalPrincipal, ) -> Self

Appends an item to hierarchical_access_control_list.

To override the contents of this collection use set_hierarchical_access_control_list.

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

pub fn set_hierarchical_access_control_list( self, input: Option<Vec<HierarchicalPrincipal>>, ) -> Self

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

pub fn get_hierarchical_access_control_list( &self, ) -> &Option<Vec<HierarchicalPrincipal>>

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

pub fn content_type(self, input: ContentType) -> Self

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 (content) around the content.

pub fn set_content_type(self, input: Option<ContentType>) -> Self

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 (content) around the content.

pub fn get_content_type(&self) -> &Option<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 (content) around the content.

pub fn access_control_configuration_id(self, input: impl Into<String>) -> Self

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

pub fn set_access_control_configuration_id(self, input: Option<String>) -> Self

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

pub fn get_access_control_configuration_id(&self) -> &Option<String>

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

pub fn build(self) -> Result<Document, BuildError>

Consumes the builder and constructs a Document. This method will fail if any of the following fields are not set:

• id

Trait Implementations

impl Clone for DocumentBuilder

fn clone(&self) -> DocumentBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DocumentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DocumentBuilder

fn default() -> DocumentBuilder

Returns the “default value” for a type.

impl PartialEq for DocumentBuilder

fn eq(&self, other: &DocumentBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DocumentBuilder