pub struct BatchDeleteDocumentFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to BatchDeleteDocument.
Removes one or more documents from an index. The documents must have been added with the BatchPutDocument API.
The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to your Amazon Web Services CloudWatch log. You can also use the BatchGetDocumentStatus API to monitor the progress of deleting your documents.
Deleting documents from an index using BatchDeleteDocument could take up to an hour or more, depending on the number of documents you want to delete.
Implementations§
Source§impl BatchDeleteDocumentFluentBuilder
impl BatchDeleteDocumentFluentBuilder
Sourcepub fn as_input(&self) -> &BatchDeleteDocumentInputBuilder
pub fn as_input(&self) -> &BatchDeleteDocumentInputBuilder
Access the BatchDeleteDocument as a reference.
Sourcepub async fn send(
self,
) -> Result<BatchDeleteDocumentOutput, SdkError<BatchDeleteDocumentError, HttpResponse>>
pub async fn send( self, ) -> Result<BatchDeleteDocumentOutput, SdkError<BatchDeleteDocumentError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<BatchDeleteDocumentOutput, BatchDeleteDocumentError, Self>
pub fn customize( self, ) -> CustomizableOperation<BatchDeleteDocumentOutput, BatchDeleteDocumentError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
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 that contains the documents to delete.
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 that contains the documents to delete.
Sourcepub fn get_index_id(&self) -> &Option<String>
pub fn get_index_id(&self) -> &Option<String>
The identifier of the index that contains the documents to delete.
Sourcepub fn document_id_list(self, input: impl Into<String>) -> Self
pub fn document_id_list(self, input: impl Into<String>) -> Self
Appends an item to DocumentIdList.
To override the contents of this collection use set_document_id_list.
One or more identifiers for documents to delete from the index.
Sourcepub fn set_document_id_list(self, input: Option<Vec<String>>) -> Self
pub fn set_document_id_list(self, input: Option<Vec<String>>) -> Self
One or more identifiers for documents to delete from the index.
Sourcepub fn get_document_id_list(&self) -> &Option<Vec<String>>
pub fn get_document_id_list(&self) -> &Option<Vec<String>>
One or more identifiers for documents to delete from the index.
Sourcepub fn data_source_sync_job_metric_target(
self,
input: DataSourceSyncJobMetricTarget,
) -> Self
pub fn data_source_sync_job_metric_target( self, input: DataSourceSyncJobMetricTarget, ) -> Self
Maps a particular data source sync job to a particular data source.
Sourcepub fn set_data_source_sync_job_metric_target(
self,
input: Option<DataSourceSyncJobMetricTarget>,
) -> Self
pub fn set_data_source_sync_job_metric_target( self, input: Option<DataSourceSyncJobMetricTarget>, ) -> Self
Maps a particular data source sync job to a particular data source.
Sourcepub fn get_data_source_sync_job_metric_target(
&self,
) -> &Option<DataSourceSyncJobMetricTarget>
pub fn get_data_source_sync_job_metric_target( &self, ) -> &Option<DataSourceSyncJobMetricTarget>
Maps a particular data source sync job to a particular data source.
Trait Implementations§
Source§impl Clone for BatchDeleteDocumentFluentBuilder
impl Clone for BatchDeleteDocumentFluentBuilder
Source§fn clone(&self) -> BatchDeleteDocumentFluentBuilder
fn clone(&self) -> BatchDeleteDocumentFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for BatchDeleteDocumentFluentBuilder
impl !RefUnwindSafe for BatchDeleteDocumentFluentBuilder
impl Send for BatchDeleteDocumentFluentBuilder
impl Sync for BatchDeleteDocumentFluentBuilder
impl Unpin for BatchDeleteDocumentFluentBuilder
impl !UnwindSafe for BatchDeleteDocumentFluentBuilder
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);