#[non_exhaustive]pub struct GetArchiveOutputBuilder { /* private fields */ }
Expand description
A builder for GetArchiveOutput
.
Implementations§
Source§impl GetArchiveOutputBuilder
impl GetArchiveOutputBuilder
Sourcepub fn archive_id(self, input: impl Into<String>) -> Self
pub fn archive_id(self, input: impl Into<String>) -> Self
The unique identifier of the archive.
This field is required.Sourcepub fn set_archive_id(self, input: Option<String>) -> Self
pub fn set_archive_id(self, input: Option<String>) -> Self
The unique identifier of the archive.
Sourcepub fn get_archive_id(&self) -> &Option<String>
pub fn get_archive_id(&self) -> &Option<String>
The unique identifier of the archive.
Sourcepub fn archive_name(self, input: impl Into<String>) -> Self
pub fn archive_name(self, input: impl Into<String>) -> Self
The unique name assigned to the archive.
This field is required.Sourcepub fn set_archive_name(self, input: Option<String>) -> Self
pub fn set_archive_name(self, input: Option<String>) -> Self
The unique name assigned to the archive.
Sourcepub fn get_archive_name(&self) -> &Option<String>
pub fn get_archive_name(&self) -> &Option<String>
The unique name assigned to the archive.
Sourcepub fn archive_arn(self, input: impl Into<String>) -> Self
pub fn archive_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the archive.
This field is required.Sourcepub fn set_archive_arn(self, input: Option<String>) -> Self
pub fn set_archive_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the archive.
Sourcepub fn get_archive_arn(&self) -> &Option<String>
pub fn get_archive_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the archive.
Sourcepub fn archive_state(self, input: ArchiveState) -> Self
pub fn archive_state(self, input: ArchiveState) -> Self
The current state of the archive:
-
ACTIVE
– The archive is ready and available for use. -
PENDING_DELETION
– The archive has been marked for deletion and will be permanently deleted in 30 days. No further modifications can be made in this state.
Sourcepub fn set_archive_state(self, input: Option<ArchiveState>) -> Self
pub fn set_archive_state(self, input: Option<ArchiveState>) -> Self
The current state of the archive:
-
ACTIVE
– The archive is ready and available for use. -
PENDING_DELETION
– The archive has been marked for deletion and will be permanently deleted in 30 days. No further modifications can be made in this state.
Sourcepub fn get_archive_state(&self) -> &Option<ArchiveState>
pub fn get_archive_state(&self) -> &Option<ArchiveState>
The current state of the archive:
-
ACTIVE
– The archive is ready and available for use. -
PENDING_DELETION
– The archive has been marked for deletion and will be permanently deleted in 30 days. No further modifications can be made in this state.
Sourcepub fn retention(self, input: ArchiveRetention) -> Self
pub fn retention(self, input: ArchiveRetention) -> Self
The retention period for emails in this archive.
This field is required.Sourcepub fn set_retention(self, input: Option<ArchiveRetention>) -> Self
pub fn set_retention(self, input: Option<ArchiveRetention>) -> Self
The retention period for emails in this archive.
Sourcepub fn get_retention(&self) -> &Option<ArchiveRetention>
pub fn get_retention(&self) -> &Option<ArchiveRetention>
The retention period for emails in this archive.
Sourcepub fn created_timestamp(self, input: DateTime) -> Self
pub fn created_timestamp(self, input: DateTime) -> Self
The timestamp of when the archive was created.
Sourcepub fn set_created_timestamp(self, input: Option<DateTime>) -> Self
pub fn set_created_timestamp(self, input: Option<DateTime>) -> Self
The timestamp of when the archive was created.
Sourcepub fn get_created_timestamp(&self) -> &Option<DateTime>
pub fn get_created_timestamp(&self) -> &Option<DateTime>
The timestamp of when the archive was created.
Sourcepub fn last_updated_timestamp(self, input: DateTime) -> Self
pub fn last_updated_timestamp(self, input: DateTime) -> Self
The timestamp of when the archive was modified.
Sourcepub fn set_last_updated_timestamp(self, input: Option<DateTime>) -> Self
pub fn set_last_updated_timestamp(self, input: Option<DateTime>) -> Self
The timestamp of when the archive was modified.
Sourcepub fn get_last_updated_timestamp(&self) -> &Option<DateTime>
pub fn get_last_updated_timestamp(&self) -> &Option<DateTime>
The timestamp of when the archive was modified.
Sourcepub fn kms_key_arn(self, input: impl Into<String>) -> Self
pub fn kms_key_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the KMS key used to encrypt the archive.
Sourcepub fn set_kms_key_arn(self, input: Option<String>) -> Self
pub fn set_kms_key_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the KMS key used to encrypt the archive.
Sourcepub fn get_kms_key_arn(&self) -> &Option<String>
pub fn get_kms_key_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the KMS key used to encrypt the archive.
Sourcepub fn build(self) -> Result<GetArchiveOutput, BuildError>
pub fn build(self) -> Result<GetArchiveOutput, BuildError>
Consumes the builder and constructs a GetArchiveOutput
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for GetArchiveOutputBuilder
impl Clone for GetArchiveOutputBuilder
Source§fn clone(&self) -> GetArchiveOutputBuilder
fn clone(&self) -> GetArchiveOutputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for GetArchiveOutputBuilder
impl Debug for GetArchiveOutputBuilder
Source§impl Default for GetArchiveOutputBuilder
impl Default for GetArchiveOutputBuilder
Source§fn default() -> GetArchiveOutputBuilder
fn default() -> GetArchiveOutputBuilder
Source§impl PartialEq for GetArchiveOutputBuilder
impl PartialEq for GetArchiveOutputBuilder
impl StructuralPartialEq for GetArchiveOutputBuilder
Auto Trait Implementations§
impl Freeze for GetArchiveOutputBuilder
impl RefUnwindSafe for GetArchiveOutputBuilder
impl Send for GetArchiveOutputBuilder
impl Sync for GetArchiveOutputBuilder
impl Unpin for GetArchiveOutputBuilder
impl UnwindSafe for GetArchiveOutputBuilder
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);