#[non_exhaustive]pub struct BatchPutDocumentInputBuilder { /* private fields */ }Expand description
A builder for BatchPutDocumentInput.
Implementations§
Source§impl BatchPutDocumentInputBuilder
impl BatchPutDocumentInputBuilder
Sourcepub fn index_id(self, input: impl Into<String>) -> Self
pub fn index_id(self, input: impl Into<String>) -> Self
The identifier of the index to add the documents to. You need to create the index first using the CreateIndex API.
Sourcepub fn set_index_id(self, input: Option<String>) -> Self
pub fn set_index_id(self, input: Option<String>) -> Self
The identifier of the index to add the documents to. You need to create the index first using the CreateIndex API.
Sourcepub fn get_index_id(&self) -> &Option<String>
pub fn get_index_id(&self) -> &Option<String>
The identifier of the index to add the documents to. You need to create the index first using the CreateIndex API.
Sourcepub fn role_arn(self, input: impl Into<String>) -> Self
pub fn role_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket. For more information, see IAM access roles for Amazon Kendra.
Sourcepub fn set_role_arn(self, input: Option<String>) -> Self
pub fn set_role_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket. For more information, see IAM access roles for Amazon Kendra.
Sourcepub fn get_role_arn(&self) -> &Option<String>
pub fn get_role_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket. For more information, see IAM access roles for Amazon Kendra.
Sourcepub fn documents(self, input: Document) -> Self
pub fn documents(self, input: Document) -> Self
Appends an item to documents.
To override the contents of this collection use set_documents.
One or more documents to add to the index.
Documents have the following file size limits.
-
50 MB total size for any file
-
5 MB extracted text for any file
For more information, see Quotas.
Sourcepub fn set_documents(self, input: Option<Vec<Document>>) -> Self
pub fn set_documents(self, input: Option<Vec<Document>>) -> Self
One or more documents to add to the index.
Documents have the following file size limits.
-
50 MB total size for any file
-
5 MB extracted text for any file
For more information, see Quotas.
Sourcepub fn get_documents(&self) -> &Option<Vec<Document>>
pub fn get_documents(&self) -> &Option<Vec<Document>>
One or more documents to add to the index.
Documents have the following file size limits.
-
50 MB total size for any file
-
5 MB extracted text for any file
For more information, see Quotas.
Sourcepub fn custom_document_enrichment_configuration(
self,
input: CustomDocumentEnrichmentConfiguration,
) -> Self
pub fn custom_document_enrichment_configuration( self, input: CustomDocumentEnrichmentConfiguration, ) -> Self
Configuration information for altering your document metadata and content during the document ingestion process when you use the BatchPutDocument API.
For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.
Sourcepub fn set_custom_document_enrichment_configuration(
self,
input: Option<CustomDocumentEnrichmentConfiguration>,
) -> Self
pub fn set_custom_document_enrichment_configuration( self, input: Option<CustomDocumentEnrichmentConfiguration>, ) -> Self
Configuration information for altering your document metadata and content during the document ingestion process when you use the BatchPutDocument API.
For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.
Sourcepub fn get_custom_document_enrichment_configuration(
&self,
) -> &Option<CustomDocumentEnrichmentConfiguration>
pub fn get_custom_document_enrichment_configuration( &self, ) -> &Option<CustomDocumentEnrichmentConfiguration>
Configuration information for altering your document metadata and content during the document ingestion process when you use the BatchPutDocument API.
For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.
Sourcepub fn build(self) -> Result<BatchPutDocumentInput, BuildError>
pub fn build(self) -> Result<BatchPutDocumentInput, BuildError>
Consumes the builder and constructs a BatchPutDocumentInput.
Source§impl BatchPutDocumentInputBuilder
impl BatchPutDocumentInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<BatchPutDocumentOutput, SdkError<BatchPutDocumentError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<BatchPutDocumentOutput, SdkError<BatchPutDocumentError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for BatchPutDocumentInputBuilder
impl Clone for BatchPutDocumentInputBuilder
Source§fn clone(&self) -> BatchPutDocumentInputBuilder
fn clone(&self) -> BatchPutDocumentInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for BatchPutDocumentInputBuilder
impl Debug for BatchPutDocumentInputBuilder
Source§impl Default for BatchPutDocumentInputBuilder
impl Default for BatchPutDocumentInputBuilder
Source§fn default() -> BatchPutDocumentInputBuilder
fn default() -> BatchPutDocumentInputBuilder
Source§impl PartialEq for BatchPutDocumentInputBuilder
impl PartialEq for BatchPutDocumentInputBuilder
Source§fn eq(&self, other: &BatchPutDocumentInputBuilder) -> bool
fn eq(&self, other: &BatchPutDocumentInputBuilder) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for BatchPutDocumentInputBuilder
Auto Trait Implementations§
impl Freeze for BatchPutDocumentInputBuilder
impl RefUnwindSafe for BatchPutDocumentInputBuilder
impl Send for BatchPutDocumentInputBuilder
impl Sync for BatchPutDocumentInputBuilder
impl Unpin for BatchPutDocumentInputBuilder
impl UnwindSafe for BatchPutDocumentInputBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);