Struct aws_sdk_backup::operation::describe_backup_job::builders::DescribeBackupJobOutputBuilder
source · #[non_exhaustive]pub struct DescribeBackupJobOutputBuilder { /* private fields */ }
Expand description
A builder for DescribeBackupJobOutput
.
Implementations§
source§impl DescribeBackupJobOutputBuilder
impl DescribeBackupJobOutputBuilder
sourcepub fn account_id(self, input: impl Into<String>) -> Self
pub fn account_id(self, input: impl Into<String>) -> Self
Returns the account ID that owns the backup job.
sourcepub fn set_account_id(self, input: Option<String>) -> Self
pub fn set_account_id(self, input: Option<String>) -> Self
Returns the account ID that owns the backup job.
sourcepub fn backup_job_id(self, input: impl Into<String>) -> Self
pub fn backup_job_id(self, input: impl Into<String>) -> Self
Uniquely identifies a request to Backup to back up a resource.
sourcepub fn set_backup_job_id(self, input: Option<String>) -> Self
pub fn set_backup_job_id(self, input: Option<String>) -> Self
Uniquely identifies a request to Backup to back up a resource.
sourcepub fn backup_vault_name(self, input: impl Into<String>) -> Self
pub fn backup_vault_name(self, input: impl Into<String>) -> Self
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
sourcepub fn set_backup_vault_name(self, input: Option<String>) -> Self
pub fn set_backup_vault_name(self, input: Option<String>) -> Self
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
sourcepub fn backup_vault_arn(self, input: impl Into<String>) -> Self
pub fn backup_vault_arn(self, input: impl Into<String>) -> Self
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.
sourcepub fn set_backup_vault_arn(self, input: Option<String>) -> Self
pub fn set_backup_vault_arn(self, input: Option<String>) -> Self
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.
sourcepub fn recovery_point_arn(self, input: impl Into<String>) -> Self
pub fn recovery_point_arn(self, input: impl Into<String>) -> Self
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.
sourcepub fn set_recovery_point_arn(self, input: Option<String>) -> Self
pub fn set_recovery_point_arn(self, input: Option<String>) -> Self
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.
sourcepub fn resource_arn(self, input: impl Into<String>) -> Self
pub fn resource_arn(self, input: impl Into<String>) -> Self
An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
sourcepub fn set_resource_arn(self, input: Option<String>) -> Self
pub fn set_resource_arn(self, input: Option<String>) -> Self
An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
sourcepub fn creation_date(self, input: DateTime) -> Self
pub fn creation_date(self, input: DateTime) -> Self
The date and time that a backup 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 set_creation_date(self, input: Option<DateTime>) -> Self
pub fn set_creation_date(self, input: Option<DateTime>) -> Self
The date and time that a backup 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, input: DateTime) -> Self
pub fn completion_date(self, input: DateTime) -> Self
The date and time that a job to create a backup 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 set_completion_date(self, input: Option<DateTime>) -> Self
pub fn set_completion_date(self, input: Option<DateTime>) -> Self
The date and time that a job to create a backup 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, input: BackupJobState) -> Self
pub fn state(self, input: BackupJobState) -> Self
The current state of a resource recovery point.
sourcepub fn set_state(self, input: Option<BackupJobState>) -> Self
pub fn set_state(self, input: Option<BackupJobState>) -> Self
The current state of a resource recovery point.
sourcepub fn status_message(self, input: impl Into<String>) -> Self
pub fn status_message(self, input: impl Into<String>) -> Self
A detailed message explaining the status of the job to back up a resource.
sourcepub fn set_status_message(self, input: Option<String>) -> Self
pub fn set_status_message(self, input: Option<String>) -> Self
A detailed message explaining the status of the job to back up a resource.
sourcepub fn percent_done(self, input: impl Into<String>) -> Self
pub fn percent_done(self, input: impl Into<String>) -> Self
Contains an estimated percentage that is complete of a job at the time the job status was queried.
sourcepub fn set_percent_done(self, input: Option<String>) -> Self
pub fn set_percent_done(self, input: Option<String>) -> Self
Contains an estimated percentage that is complete of a job at the time the job status was queried.
sourcepub fn backup_size_in_bytes(self, input: i64) -> Self
pub fn backup_size_in_bytes(self, input: i64) -> Self
The size, in bytes, of a backup.
sourcepub fn set_backup_size_in_bytes(self, input: Option<i64>) -> Self
pub fn set_backup_size_in_bytes(self, input: Option<i64>) -> Self
The size, in bytes, of a backup.
sourcepub fn iam_role_arn(self, input: impl Into<String>) -> Self
pub fn iam_role_arn(self, input: impl Into<String>) -> Self
Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access
.
sourcepub fn set_iam_role_arn(self, input: Option<String>) -> Self
pub fn set_iam_role_arn(self, input: Option<String>) -> Self
Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access
.
sourcepub fn created_by(self, input: RecoveryPointCreator) -> Self
pub fn created_by(self, input: RecoveryPointCreator) -> Self
Contains identifying information about the creation of a backup job, including the BackupPlanArn
, BackupPlanId
, BackupPlanVersion
, and BackupRuleId
of the backup plan that is used to create it.
sourcepub fn set_created_by(self, input: Option<RecoveryPointCreator>) -> Self
pub fn set_created_by(self, input: Option<RecoveryPointCreator>) -> Self
Contains identifying information about the creation of a backup job, including the BackupPlanArn
, BackupPlanId
, BackupPlanVersion
, and BackupRuleId
of the backup plan that is used to create it.
sourcepub fn resource_type(self, input: impl Into<String>) -> Self
pub fn resource_type(self, input: impl Into<String>) -> Self
The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
sourcepub fn set_resource_type(self, input: Option<String>) -> Self
pub fn set_resource_type(self, input: Option<String>) -> Self
The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
sourcepub fn bytes_transferred(self, input: i64) -> Self
pub fn bytes_transferred(self, input: i64) -> Self
The size in bytes transferred to a backup vault at the time that the job status was queried.
sourcepub fn set_bytes_transferred(self, input: Option<i64>) -> Self
pub fn set_bytes_transferred(self, input: Option<i64>) -> Self
The size in bytes transferred to a backup vault at the time that the job status was queried.
sourcepub fn expected_completion_date(self, input: DateTime) -> Self
pub fn expected_completion_date(self, input: DateTime) -> Self
The date and time that a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
sourcepub fn set_expected_completion_date(self, input: Option<DateTime>) -> Self
pub fn set_expected_completion_date(self, input: Option<DateTime>) -> Self
The date and time that a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
sourcepub fn start_by(self, input: DateTime) -> Self
pub fn start_by(self, input: DateTime) -> Self
Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy
time would be 8:00 PM on the date specified. The value of StartBy
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
sourcepub fn set_start_by(self, input: Option<DateTime>) -> Self
pub fn set_start_by(self, input: Option<DateTime>) -> Self
Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy
time would be 8:00 PM on the date specified. The value of StartBy
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
sourcepub fn backup_options(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn backup_options(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to backup_options
.
To override the contents of this collection use set_backup_options
.
Represents the options specified as part of backup plan or on-demand backup job.
sourcepub fn set_backup_options(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_backup_options(self, input: Option<HashMap<String, String>>) -> Self
Represents the options specified as part of backup plan or on-demand backup job.
sourcepub fn backup_type(self, input: impl Into<String>) -> Self
pub fn backup_type(self, input: impl Into<String>) -> Self
Represents the actual backup type selected for a backup job. For example, if a successful Windows Volume Shadow Copy Service (VSS) backup was taken, BackupType
returns "WindowsVSS"
. If BackupType
is empty, then the backup type was a regular backup.
sourcepub fn set_backup_type(self, input: Option<String>) -> Self
pub fn set_backup_type(self, input: Option<String>) -> Self
Represents the actual backup type selected for a backup job. For example, if a successful Windows Volume Shadow Copy Service (VSS) backup was taken, BackupType
returns "WindowsVSS"
. If BackupType
is empty, then the backup type was a regular backup.
sourcepub fn parent_job_id(self, input: impl Into<String>) -> Self
pub fn parent_job_id(self, input: impl Into<String>) -> Self
This returns the parent (composite) resource backup job ID.
sourcepub fn set_parent_job_id(self, input: Option<String>) -> Self
pub fn set_parent_job_id(self, input: Option<String>) -> Self
This returns the parent (composite) resource backup job ID.
sourcepub fn is_parent(self, input: bool) -> Self
pub fn is_parent(self, input: bool) -> Self
This returns the boolean value that a backup job is a parent (composite) job.
sourcepub fn set_is_parent(self, input: Option<bool>) -> Self
pub fn set_is_parent(self, input: Option<bool>) -> Self
This returns the boolean value that a backup job is a parent (composite) job.
sourcepub fn number_of_child_jobs(self, input: i64) -> Self
pub fn number_of_child_jobs(self, input: i64) -> Self
This returns the number of child (nested) backup jobs.
sourcepub fn set_number_of_child_jobs(self, input: Option<i64>) -> Self
pub fn set_number_of_child_jobs(self, input: Option<i64>) -> Self
This returns the number of child (nested) backup jobs.
sourcepub fn child_jobs_in_state(self, k: BackupJobState, v: i64) -> Self
pub fn child_jobs_in_state(self, k: BackupJobState, v: i64) -> Self
Adds a key-value pair to child_jobs_in_state
.
To override the contents of this collection use set_child_jobs_in_state
.
This returns the statistics of the included child (nested) backup jobs.
sourcepub fn set_child_jobs_in_state(
self,
input: Option<HashMap<BackupJobState, i64>>
) -> Self
pub fn set_child_jobs_in_state( self, input: Option<HashMap<BackupJobState, i64>> ) -> Self
This returns the statistics of the included child (nested) backup jobs.
sourcepub fn resource_name(self, input: impl Into<String>) -> Self
pub fn resource_name(self, input: impl Into<String>) -> Self
This is the non-unique name of the resource that belongs to the specified backup.
sourcepub fn set_resource_name(self, input: Option<String>) -> Self
pub fn set_resource_name(self, input: Option<String>) -> Self
This is the non-unique name of the resource that belongs to the specified backup.
sourcepub fn build(self) -> DescribeBackupJobOutput
pub fn build(self) -> DescribeBackupJobOutput
Consumes the builder and constructs a DescribeBackupJobOutput
.
Trait Implementations§
source§impl Clone for DescribeBackupJobOutputBuilder
impl Clone for DescribeBackupJobOutputBuilder
source§fn clone(&self) -> DescribeBackupJobOutputBuilder
fn clone(&self) -> DescribeBackupJobOutputBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Default for DescribeBackupJobOutputBuilder
impl Default for DescribeBackupJobOutputBuilder
source§fn default() -> DescribeBackupJobOutputBuilder
fn default() -> DescribeBackupJobOutputBuilder
source§impl PartialEq<DescribeBackupJobOutputBuilder> for DescribeBackupJobOutputBuilder
impl PartialEq<DescribeBackupJobOutputBuilder> for DescribeBackupJobOutputBuilder
source§fn eq(&self, other: &DescribeBackupJobOutputBuilder) -> bool
fn eq(&self, other: &DescribeBackupJobOutputBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.