pub struct StartArchiveExportFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to StartArchiveExport
.
Initiates an export of emails from the specified archive.
Implementations§
Source§impl StartArchiveExportFluentBuilder
impl StartArchiveExportFluentBuilder
Sourcepub fn as_input(&self) -> &StartArchiveExportInputBuilder
pub fn as_input(&self) -> &StartArchiveExportInputBuilder
Access the StartArchiveExport as a reference.
Sourcepub async fn send(
self,
) -> Result<StartArchiveExportOutput, SdkError<StartArchiveExportError, HttpResponse>>
pub async fn send( self, ) -> Result<StartArchiveExportOutput, SdkError<StartArchiveExportError, 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<StartArchiveExportOutput, StartArchiveExportError, Self>
pub fn customize( self, ) -> CustomizableOperation<StartArchiveExportOutput, StartArchiveExportError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn archive_id(self, input: impl Into<String>) -> Self
pub fn archive_id(self, input: impl Into<String>) -> Self
The identifier of the archive to export emails from.
Sourcepub fn set_archive_id(self, input: Option<String>) -> Self
pub fn set_archive_id(self, input: Option<String>) -> Self
The identifier of the archive to export emails from.
Sourcepub fn get_archive_id(&self) -> &Option<String>
pub fn get_archive_id(&self) -> &Option<String>
The identifier of the archive to export emails from.
Sourcepub fn filters(self, input: ArchiveFilters) -> Self
pub fn filters(self, input: ArchiveFilters) -> Self
Criteria to filter which emails are included in the export.
Sourcepub fn set_filters(self, input: Option<ArchiveFilters>) -> Self
pub fn set_filters(self, input: Option<ArchiveFilters>) -> Self
Criteria to filter which emails are included in the export.
Sourcepub fn get_filters(&self) -> &Option<ArchiveFilters>
pub fn get_filters(&self) -> &Option<ArchiveFilters>
Criteria to filter which emails are included in the export.
Sourcepub fn from_timestamp(self, input: DateTime) -> Self
pub fn from_timestamp(self, input: DateTime) -> Self
The start of the timestamp range to include emails from.
Sourcepub fn set_from_timestamp(self, input: Option<DateTime>) -> Self
pub fn set_from_timestamp(self, input: Option<DateTime>) -> Self
The start of the timestamp range to include emails from.
Sourcepub fn get_from_timestamp(&self) -> &Option<DateTime>
pub fn get_from_timestamp(&self) -> &Option<DateTime>
The start of the timestamp range to include emails from.
Sourcepub fn to_timestamp(self, input: DateTime) -> Self
pub fn to_timestamp(self, input: DateTime) -> Self
The end of the timestamp range to include emails from.
Sourcepub fn set_to_timestamp(self, input: Option<DateTime>) -> Self
pub fn set_to_timestamp(self, input: Option<DateTime>) -> Self
The end of the timestamp range to include emails from.
Sourcepub fn get_to_timestamp(&self) -> &Option<DateTime>
pub fn get_to_timestamp(&self) -> &Option<DateTime>
The end of the timestamp range to include emails from.
Sourcepub fn max_results(self, input: i32) -> Self
pub fn max_results(self, input: i32) -> Self
The maximum number of email items to include in the export.
Sourcepub fn set_max_results(self, input: Option<i32>) -> Self
pub fn set_max_results(self, input: Option<i32>) -> Self
The maximum number of email items to include in the export.
Sourcepub fn get_max_results(&self) -> &Option<i32>
pub fn get_max_results(&self) -> &Option<i32>
The maximum number of email items to include in the export.
Sourcepub fn export_destination_configuration(
self,
input: ExportDestinationConfiguration,
) -> Self
pub fn export_destination_configuration( self, input: ExportDestinationConfiguration, ) -> Self
Details on where to deliver the exported email data.
Sourcepub fn set_export_destination_configuration(
self,
input: Option<ExportDestinationConfiguration>,
) -> Self
pub fn set_export_destination_configuration( self, input: Option<ExportDestinationConfiguration>, ) -> Self
Details on where to deliver the exported email data.
Sourcepub fn get_export_destination_configuration(
&self,
) -> &Option<ExportDestinationConfiguration>
pub fn get_export_destination_configuration( &self, ) -> &Option<ExportDestinationConfiguration>
Details on where to deliver the exported email data.
Sourcepub fn include_metadata(self, input: bool) -> Self
pub fn include_metadata(self, input: bool) -> Self
Whether to include message metadata as JSON files in the export.
Sourcepub fn set_include_metadata(self, input: Option<bool>) -> Self
pub fn set_include_metadata(self, input: Option<bool>) -> Self
Whether to include message metadata as JSON files in the export.
Sourcepub fn get_include_metadata(&self) -> &Option<bool>
pub fn get_include_metadata(&self) -> &Option<bool>
Whether to include message metadata as JSON files in the export.
Trait Implementations§
Source§impl Clone for StartArchiveExportFluentBuilder
impl Clone for StartArchiveExportFluentBuilder
Source§fn clone(&self) -> StartArchiveExportFluentBuilder
fn clone(&self) -> StartArchiveExportFluentBuilder
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 StartArchiveExportFluentBuilder
impl !RefUnwindSafe for StartArchiveExportFluentBuilder
impl Send for StartArchiveExportFluentBuilder
impl Sync for StartArchiveExportFluentBuilder
impl Unpin for StartArchiveExportFluentBuilder
impl !UnwindSafe for StartArchiveExportFluentBuilder
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);