#[non_exhaustive]pub struct SnapshotConfigurationBuilder { /* private fields */ }
Expand description
A builder for SnapshotConfiguration
.
Implementations§
Source§impl SnapshotConfigurationBuilder
impl SnapshotConfigurationBuilder
Sourcepub fn file_groups(self, input: SnapshotFileGroup) -> Self
pub fn file_groups(self, input: SnapshotFileGroup) -> Self
Appends an item to file_groups
.
To override the contents of this collection use set_file_groups
.
A list of SnapshotJobResultFileGroup
objects that contain information about the snapshot that is generated. This list can hold a maximum of 6 FileGroup
configurations.
Sourcepub fn set_file_groups(self, input: Option<Vec<SnapshotFileGroup>>) -> Self
pub fn set_file_groups(self, input: Option<Vec<SnapshotFileGroup>>) -> Self
A list of SnapshotJobResultFileGroup
objects that contain information about the snapshot that is generated. This list can hold a maximum of 6 FileGroup
configurations.
Sourcepub fn get_file_groups(&self) -> &Option<Vec<SnapshotFileGroup>>
pub fn get_file_groups(&self) -> &Option<Vec<SnapshotFileGroup>>
A list of SnapshotJobResultFileGroup
objects that contain information about the snapshot that is generated. This list can hold a maximum of 6 FileGroup
configurations.
Sourcepub fn destination_configuration(
self,
input: SnapshotDestinationConfiguration,
) -> Self
pub fn destination_configuration( self, input: SnapshotDestinationConfiguration, ) -> Self
A structure that contains information on the Amazon S3 bucket that the generated snapshot is stored in.
Sourcepub fn set_destination_configuration(
self,
input: Option<SnapshotDestinationConfiguration>,
) -> Self
pub fn set_destination_configuration( self, input: Option<SnapshotDestinationConfiguration>, ) -> Self
A structure that contains information on the Amazon S3 bucket that the generated snapshot is stored in.
Sourcepub fn get_destination_configuration(
&self,
) -> &Option<SnapshotDestinationConfiguration>
pub fn get_destination_configuration( &self, ) -> &Option<SnapshotDestinationConfiguration>
A structure that contains information on the Amazon S3 bucket that the generated snapshot is stored in.
Sourcepub fn parameters(self, input: Parameters) -> Self
pub fn parameters(self, input: Parameters) -> Self
A list of Amazon QuickSight parameters and the list's override values.
Sourcepub fn set_parameters(self, input: Option<Parameters>) -> Self
pub fn set_parameters(self, input: Option<Parameters>) -> Self
A list of Amazon QuickSight parameters and the list's override values.
Sourcepub fn get_parameters(&self) -> &Option<Parameters>
pub fn get_parameters(&self) -> &Option<Parameters>
A list of Amazon QuickSight parameters and the list's override values.
Sourcepub fn build(self) -> Result<SnapshotConfiguration, BuildError>
pub fn build(self) -> Result<SnapshotConfiguration, BuildError>
Consumes the builder and constructs a SnapshotConfiguration
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for SnapshotConfigurationBuilder
impl Clone for SnapshotConfigurationBuilder
Source§fn clone(&self) -> SnapshotConfigurationBuilder
fn clone(&self) -> SnapshotConfigurationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for SnapshotConfigurationBuilder
impl Debug for SnapshotConfigurationBuilder
Source§impl Default for SnapshotConfigurationBuilder
impl Default for SnapshotConfigurationBuilder
Source§fn default() -> SnapshotConfigurationBuilder
fn default() -> SnapshotConfigurationBuilder
Source§impl PartialEq for SnapshotConfigurationBuilder
impl PartialEq for SnapshotConfigurationBuilder
Source§fn eq(&self, other: &SnapshotConfigurationBuilder) -> bool
fn eq(&self, other: &SnapshotConfigurationBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for SnapshotConfigurationBuilder
Auto Trait Implementations§
impl Freeze for SnapshotConfigurationBuilder
impl RefUnwindSafe for SnapshotConfigurationBuilder
impl Send for SnapshotConfigurationBuilder
impl Sync for SnapshotConfigurationBuilder
impl Unpin for SnapshotConfigurationBuilder
impl UnwindSafe for SnapshotConfigurationBuilder
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);