#[non_exhaustive]pub struct BackupBuilder { /* private fields */ }
Expand description
A builder for Backup
.
Implementations§
Source§impl BackupBuilder
impl BackupBuilder
Sourcepub fn backup_id(self, input: impl Into<String>) -> Self
pub fn backup_id(self, input: impl Into<String>) -> Self
The ID of the backup.
This field is required.Sourcepub fn set_backup_id(self, input: Option<String>) -> Self
pub fn set_backup_id(self, input: Option<String>) -> Self
The ID of the backup.
Sourcepub fn get_backup_id(&self) -> &Option<String>
pub fn get_backup_id(&self) -> &Option<String>
The ID of the backup.
Sourcepub fn lifecycle(self, input: BackupLifecycle) -> Self
pub fn lifecycle(self, input: BackupLifecycle) -> Self
The lifecycle status of the backup.
-
AVAILABLE
- The backup is fully available. -
PENDING
- For user-initiated backups on Lustre file systems only; Amazon FSx hasn't started creating the backup. -
CREATING
- Amazon FSx is creating the backup. -
TRANSFERRING
- For user-initiated backups on Lustre file systems only; Amazon FSx is transferring the backup to Amazon S3. -
COPYING
- Amazon FSx is copying the backup. -
DELETED
- Amazon FSx deleted the backup and it's no longer available. -
FAILED
- Amazon FSx couldn't finish the backup.
Sourcepub fn set_lifecycle(self, input: Option<BackupLifecycle>) -> Self
pub fn set_lifecycle(self, input: Option<BackupLifecycle>) -> Self
The lifecycle status of the backup.
-
AVAILABLE
- The backup is fully available. -
PENDING
- For user-initiated backups on Lustre file systems only; Amazon FSx hasn't started creating the backup. -
CREATING
- Amazon FSx is creating the backup. -
TRANSFERRING
- For user-initiated backups on Lustre file systems only; Amazon FSx is transferring the backup to Amazon S3. -
COPYING
- Amazon FSx is copying the backup. -
DELETED
- Amazon FSx deleted the backup and it's no longer available. -
FAILED
- Amazon FSx couldn't finish the backup.
Sourcepub fn get_lifecycle(&self) -> &Option<BackupLifecycle>
pub fn get_lifecycle(&self) -> &Option<BackupLifecycle>
The lifecycle status of the backup.
-
AVAILABLE
- The backup is fully available. -
PENDING
- For user-initiated backups on Lustre file systems only; Amazon FSx hasn't started creating the backup. -
CREATING
- Amazon FSx is creating the backup. -
TRANSFERRING
- For user-initiated backups on Lustre file systems only; Amazon FSx is transferring the backup to Amazon S3. -
COPYING
- Amazon FSx is copying the backup. -
DELETED
- Amazon FSx deleted the backup and it's no longer available. -
FAILED
- Amazon FSx couldn't finish the backup.
Sourcepub fn failure_details(self, input: BackupFailureDetails) -> Self
pub fn failure_details(self, input: BackupFailureDetails) -> Self
Details explaining any failures that occurred when creating a backup.
Sourcepub fn set_failure_details(self, input: Option<BackupFailureDetails>) -> Self
pub fn set_failure_details(self, input: Option<BackupFailureDetails>) -> Self
Details explaining any failures that occurred when creating a backup.
Sourcepub fn get_failure_details(&self) -> &Option<BackupFailureDetails>
pub fn get_failure_details(&self) -> &Option<BackupFailureDetails>
Details explaining any failures that occurred when creating a backup.
Sourcepub fn type(self, input: BackupType) -> Self
pub fn type(self, input: BackupType) -> Self
The type of the file-system backup.
This field is required.Sourcepub fn set_type(self, input: Option<BackupType>) -> Self
pub fn set_type(self, input: Option<BackupType>) -> Self
The type of the file-system backup.
Sourcepub fn get_type(&self) -> &Option<BackupType>
pub fn get_type(&self) -> &Option<BackupType>
The type of the file-system backup.
Sourcepub fn progress_percent(self, input: i32) -> Self
pub fn progress_percent(self, input: i32) -> Self
Displays the current percent of progress of an asynchronous task.
Sourcepub fn set_progress_percent(self, input: Option<i32>) -> Self
pub fn set_progress_percent(self, input: Option<i32>) -> Self
Displays the current percent of progress of an asynchronous task.
Sourcepub fn get_progress_percent(&self) -> &Option<i32>
pub fn get_progress_percent(&self) -> &Option<i32>
Displays the current percent of progress of an asynchronous task.
Sourcepub fn creation_time(self, input: DateTime) -> Self
pub fn creation_time(self, input: DateTime) -> Self
The time when a particular backup was created.
This field is required.Sourcepub fn set_creation_time(self, input: Option<DateTime>) -> Self
pub fn set_creation_time(self, input: Option<DateTime>) -> Self
The time when a particular backup was created.
Sourcepub fn get_creation_time(&self) -> &Option<DateTime>
pub fn get_creation_time(&self) -> &Option<DateTime>
The time when a particular backup was created.
Sourcepub fn kms_key_id(self, input: impl Into<String>) -> Self
pub fn kms_key_id(self, input: impl Into<String>) -> Self
The ID of the Key Management Service (KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.
Sourcepub fn set_kms_key_id(self, input: Option<String>) -> Self
pub fn set_kms_key_id(self, input: Option<String>) -> Self
The ID of the Key Management Service (KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.
Sourcepub fn get_kms_key_id(&self) -> &Option<String>
pub fn get_kms_key_id(&self) -> &Option<String>
The ID of the Key Management Service (KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.
Sourcepub fn resource_arn(self, input: impl Into<String>) -> Self
pub fn resource_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) for the backup resource.
Sourcepub fn set_resource_arn(self, input: Option<String>) -> Self
pub fn set_resource_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) for the backup resource.
Sourcepub fn get_resource_arn(&self) -> &Option<String>
pub fn get_resource_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) for the backup resource.
Appends an item to tags
.
To override the contents of this collection use set_tags
.
The tags associated with a particular file system.
The tags associated with a particular file system.
The tags associated with a particular file system.
Sourcepub fn file_system(self, input: FileSystem) -> Self
pub fn file_system(self, input: FileSystem) -> Self
The metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.
This field is required.Sourcepub fn set_file_system(self, input: Option<FileSystem>) -> Self
pub fn set_file_system(self, input: Option<FileSystem>) -> Self
The metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.
Sourcepub fn get_file_system(&self) -> &Option<FileSystem>
pub fn get_file_system(&self) -> &Option<FileSystem>
The metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.
Sourcepub fn directory_information(
self,
input: ActiveDirectoryBackupAttributes,
) -> Self
pub fn directory_information( self, input: ActiveDirectoryBackupAttributes, ) -> Self
The configuration of the self-managed Microsoft Active Directory directory to which the Windows File Server instance is joined.
Sourcepub fn set_directory_information(
self,
input: Option<ActiveDirectoryBackupAttributes>,
) -> Self
pub fn set_directory_information( self, input: Option<ActiveDirectoryBackupAttributes>, ) -> Self
The configuration of the self-managed Microsoft Active Directory directory to which the Windows File Server instance is joined.
Sourcepub fn get_directory_information(
&self,
) -> &Option<ActiveDirectoryBackupAttributes>
pub fn get_directory_information( &self, ) -> &Option<ActiveDirectoryBackupAttributes>
The configuration of the self-managed Microsoft Active Directory directory to which the Windows File Server instance is joined.
Sourcepub fn owner_id(self, input: impl Into<String>) -> Self
pub fn owner_id(self, input: impl Into<String>) -> Self
An Amazon Web Services account ID. This ID is a 12-digit number that you use to construct Amazon Resource Names (ARNs) for resources.
Sourcepub fn set_owner_id(self, input: Option<String>) -> Self
pub fn set_owner_id(self, input: Option<String>) -> Self
An Amazon Web Services account ID. This ID is a 12-digit number that you use to construct Amazon Resource Names (ARNs) for resources.
Sourcepub fn get_owner_id(&self) -> &Option<String>
pub fn get_owner_id(&self) -> &Option<String>
An Amazon Web Services account ID. This ID is a 12-digit number that you use to construct Amazon Resource Names (ARNs) for resources.
Sourcepub fn source_backup_id(self, input: impl Into<String>) -> Self
pub fn source_backup_id(self, input: impl Into<String>) -> Self
The ID of the source backup. Specifies the backup that you are copying.
Sourcepub fn set_source_backup_id(self, input: Option<String>) -> Self
pub fn set_source_backup_id(self, input: Option<String>) -> Self
The ID of the source backup. Specifies the backup that you are copying.
Sourcepub fn get_source_backup_id(&self) -> &Option<String>
pub fn get_source_backup_id(&self) -> &Option<String>
The ID of the source backup. Specifies the backup that you are copying.
Sourcepub fn source_backup_region(self, input: impl Into<String>) -> Self
pub fn source_backup_region(self, input: impl Into<String>) -> Self
The source Region of the backup. Specifies the Region from where this backup is copied.
Sourcepub fn set_source_backup_region(self, input: Option<String>) -> Self
pub fn set_source_backup_region(self, input: Option<String>) -> Self
The source Region of the backup. Specifies the Region from where this backup is copied.
Sourcepub fn get_source_backup_region(&self) -> &Option<String>
pub fn get_source_backup_region(&self) -> &Option<String>
The source Region of the backup. Specifies the Region from where this backup is copied.
Sourcepub fn resource_type(self, input: ResourceType) -> Self
pub fn resource_type(self, input: ResourceType) -> Self
Specifies the resource type that's backed up.
Sourcepub fn set_resource_type(self, input: Option<ResourceType>) -> Self
pub fn set_resource_type(self, input: Option<ResourceType>) -> Self
Specifies the resource type that's backed up.
Sourcepub fn get_resource_type(&self) -> &Option<ResourceType>
pub fn get_resource_type(&self) -> &Option<ResourceType>
Specifies the resource type that's backed up.
Sourcepub fn set_volume(self, input: Option<Volume>) -> Self
pub fn set_volume(self, input: Option<Volume>) -> Self
Describes an Amazon FSx volume.
Sourcepub fn get_volume(&self) -> &Option<Volume>
pub fn get_volume(&self) -> &Option<Volume>
Describes an Amazon FSx volume.
Sourcepub fn size_in_bytes(self, input: i64) -> Self
pub fn size_in_bytes(self, input: i64) -> Self
The size of the backup in bytes. This represents the amount of data that the file system would contain if you restore this backup.
Sourcepub fn set_size_in_bytes(self, input: Option<i64>) -> Self
pub fn set_size_in_bytes(self, input: Option<i64>) -> Self
The size of the backup in bytes. This represents the amount of data that the file system would contain if you restore this backup.
Sourcepub fn get_size_in_bytes(&self) -> &Option<i64>
pub fn get_size_in_bytes(&self) -> &Option<i64>
The size of the backup in bytes. This represents the amount of data that the file system would contain if you restore this backup.
Trait Implementations§
Source§impl Clone for BackupBuilder
impl Clone for BackupBuilder
Source§fn clone(&self) -> BackupBuilder
fn clone(&self) -> BackupBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for BackupBuilder
impl Debug for BackupBuilder
Source§impl Default for BackupBuilder
impl Default for BackupBuilder
Source§fn default() -> BackupBuilder
fn default() -> BackupBuilder
Source§impl PartialEq for BackupBuilder
impl PartialEq for BackupBuilder
impl StructuralPartialEq for BackupBuilder
Auto Trait Implementations§
impl Freeze for BackupBuilder
impl RefUnwindSafe for BackupBuilder
impl Send for BackupBuilder
impl Sync for BackupBuilder
impl Unpin for BackupBuilder
impl UnwindSafe for BackupBuilder
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);