#[non_exhaustive]pub struct CopyJob {Show 22 fields
pub account_id: Option<String>,
pub copy_job_id: Option<String>,
pub source_backup_vault_arn: Option<String>,
pub source_recovery_point_arn: Option<String>,
pub destination_backup_vault_arn: Option<String>,
pub destination_recovery_point_arn: Option<String>,
pub resource_arn: Option<String>,
pub creation_date: Option<DateTime>,
pub completion_date: Option<DateTime>,
pub state: Option<CopyJobState>,
pub status_message: Option<String>,
pub backup_size_in_bytes: Option<i64>,
pub iam_role_arn: Option<String>,
pub created_by: Option<RecoveryPointCreator>,
pub resource_type: Option<String>,
pub parent_job_id: Option<String>,
pub is_parent: bool,
pub composite_member_identifier: Option<String>,
pub number_of_child_jobs: Option<i64>,
pub child_jobs_in_state: Option<HashMap<CopyJobState, i64>>,
pub resource_name: Option<String>,
pub message_category: Option<String>,
}
Expand description
Contains detailed information about a copy job.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.account_id: Option<String>
The account ID that owns the copy job.
copy_job_id: Option<String>
Uniquely identifies a copy job.
source_backup_vault_arn: Option<String>
An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault
.
source_recovery_point_arn: Option<String>
An ARN that uniquely identifies a source recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.
destination_backup_vault_arn: Option<String>
An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault
.
destination_recovery_point_arn: Option<String>
An ARN that uniquely identifies a destination recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.
resource_arn: Option<String>
The Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
creation_date: Option<DateTime>
The date and time a copy job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
completion_date: Option<DateTime>
The date and time a copy job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
state: Option<CopyJobState>
The current state of a copy job.
status_message: Option<String>
A detailed message explaining the status of the job to copy a resource.
backup_size_in_bytes: Option<i64>
The size, in bytes, of a copy job.
iam_role_arn: Option<String>
Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access
.
created_by: Option<RecoveryPointCreator>
Contains information about the backup plan and rule that Backup used to initiate the recovery point backup.
resource_type: Option<String>
The type of Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
parent_job_id: Option<String>
This uniquely identifies a request to Backup to copy a resource. The return will be the parent (composite) job ID.
is_parent: bool
This is a boolean value indicating this is a parent (composite) copy job.
composite_member_identifier: Option<String>
The identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.
number_of_child_jobs: Option<i64>
The number of child (nested) copy jobs.
child_jobs_in_state: Option<HashMap<CopyJobState, i64>>
This returns the statistics of the included child (nested) copy jobs.
resource_name: Option<String>
The non-unique name of the resource that belongs to the specified backup.
message_category: Option<String>
This parameter is the job count for the specified message category.
Example strings may include AccessDenied
, SUCCESS
, AGGREGATE_ALL
, and InvalidParameters
. See Monitoring for a list of MessageCategory strings.
The the value ANY returns count of all message categories.
AGGREGATE_ALL
aggregates job counts for all message categories and returns the sum
Implementations§
Source§impl CopyJob
impl CopyJob
Sourcepub fn account_id(&self) -> Option<&str>
pub fn account_id(&self) -> Option<&str>
The account ID that owns the copy job.
Sourcepub fn copy_job_id(&self) -> Option<&str>
pub fn copy_job_id(&self) -> Option<&str>
Uniquely identifies a copy job.
Sourcepub fn source_backup_vault_arn(&self) -> Option<&str>
pub fn source_backup_vault_arn(&self) -> Option<&str>
An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault
.
Sourcepub fn source_recovery_point_arn(&self) -> Option<&str>
pub fn source_recovery_point_arn(&self) -> Option<&str>
An ARN that uniquely identifies a source recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.
Sourcepub fn destination_backup_vault_arn(&self) -> Option<&str>
pub fn destination_backup_vault_arn(&self) -> Option<&str>
An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault
.
Sourcepub fn destination_recovery_point_arn(&self) -> Option<&str>
pub fn destination_recovery_point_arn(&self) -> Option<&str>
An ARN that uniquely identifies a destination recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.
Sourcepub fn resource_arn(&self) -> Option<&str>
pub fn resource_arn(&self) -> Option<&str>
The Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
Sourcepub fn creation_date(&self) -> Option<&DateTime>
pub fn creation_date(&self) -> Option<&DateTime>
The date and time a copy job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Sourcepub fn completion_date(&self) -> Option<&DateTime>
pub fn completion_date(&self) -> Option<&DateTime>
The date and time a copy job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Sourcepub fn state(&self) -> Option<&CopyJobState>
pub fn state(&self) -> Option<&CopyJobState>
The current state of a copy job.
Sourcepub fn status_message(&self) -> Option<&str>
pub fn status_message(&self) -> Option<&str>
A detailed message explaining the status of the job to copy a resource.
Sourcepub fn backup_size_in_bytes(&self) -> Option<i64>
pub fn backup_size_in_bytes(&self) -> Option<i64>
The size, in bytes, of a copy job.
Sourcepub fn iam_role_arn(&self) -> Option<&str>
pub fn iam_role_arn(&self) -> Option<&str>
Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access
.
Sourcepub fn created_by(&self) -> Option<&RecoveryPointCreator>
pub fn created_by(&self) -> Option<&RecoveryPointCreator>
Contains information about the backup plan and rule that Backup used to initiate the recovery point backup.
Sourcepub fn resource_type(&self) -> Option<&str>
pub fn resource_type(&self) -> Option<&str>
The type of Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
Sourcepub fn parent_job_id(&self) -> Option<&str>
pub fn parent_job_id(&self) -> Option<&str>
This uniquely identifies a request to Backup to copy a resource. The return will be the parent (composite) job ID.
Sourcepub fn is_parent(&self) -> bool
pub fn is_parent(&self) -> bool
This is a boolean value indicating this is a parent (composite) copy job.
Sourcepub fn composite_member_identifier(&self) -> Option<&str>
pub fn composite_member_identifier(&self) -> Option<&str>
The identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.
Sourcepub fn number_of_child_jobs(&self) -> Option<i64>
pub fn number_of_child_jobs(&self) -> Option<i64>
The number of child (nested) copy jobs.
Sourcepub fn child_jobs_in_state(&self) -> Option<&HashMap<CopyJobState, i64>>
pub fn child_jobs_in_state(&self) -> Option<&HashMap<CopyJobState, i64>>
This returns the statistics of the included child (nested) copy jobs.
Sourcepub fn resource_name(&self) -> Option<&str>
pub fn resource_name(&self) -> Option<&str>
The non-unique name of the resource that belongs to the specified backup.
Sourcepub fn message_category(&self) -> Option<&str>
pub fn message_category(&self) -> Option<&str>
This parameter is the job count for the specified message category.
Example strings may include AccessDenied
, SUCCESS
, AGGREGATE_ALL
, and InvalidParameters
. See Monitoring for a list of MessageCategory strings.
The the value ANY returns count of all message categories.
AGGREGATE_ALL
aggregates job counts for all message categories and returns the sum
Trait Implementations§
impl StructuralPartialEq for CopyJob
Auto Trait Implementations§
impl Freeze for CopyJob
impl RefUnwindSafe for CopyJob
impl Send for CopyJob
impl Sync for CopyJob
impl Unpin for CopyJob
impl UnwindSafe for CopyJob
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);