#[non_exhaustive]pub struct ScanJobBuilder { /* private fields */ }Expand description
A builder for ScanJob.
Implementations§
Source§impl ScanJobBuilder
impl ScanJobBuilder
Sourcepub fn account_id(self, input: impl Into<String>) -> Self
pub fn account_id(self, input: impl Into<String>) -> Self
The account ID that owns the scan job.
This field is required.Sourcepub fn set_account_id(self, input: Option<String>) -> Self
pub fn set_account_id(self, input: Option<String>) -> Self
The account ID that owns the scan job.
Sourcepub fn get_account_id(&self) -> &Option<String>
pub fn get_account_id(&self) -> &Option<String>
The account ID that owns the scan job.
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:backup-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:backup-vault:aBackupVault.
Sourcepub fn get_backup_vault_arn(&self) -> &Option<String>
pub fn get_backup_vault_arn(&self) -> &Option<String>
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
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.
This field is required.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.
Sourcepub fn get_backup_vault_name(&self) -> &Option<String>
pub fn get_backup_vault_name(&self) -> &Option<String>
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.
Sourcepub fn completion_date(self, input: DateTime) -> Self
pub fn completion_date(self, input: DateTime) -> Self
The date and time that a scan 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 scan 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 get_completion_date(&self) -> &Option<DateTime>
pub fn get_completion_date(&self) -> &Option<DateTime>
The date and time that a scan 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 created_by(self, input: ScanJobCreator) -> Self
pub fn created_by(self, input: ScanJobCreator) -> Self
Contains identifying information about the creation of a scan job.
This field is required.Sourcepub fn set_created_by(self, input: Option<ScanJobCreator>) -> Self
pub fn set_created_by(self, input: Option<ScanJobCreator>) -> Self
Contains identifying information about the creation of a scan job.
Sourcepub fn get_created_by(&self) -> &Option<ScanJobCreator>
pub fn get_created_by(&self) -> &Option<ScanJobCreator>
Contains identifying information about the creation of a scan job.
Sourcepub fn creation_date(self, input: DateTime) -> Self
pub fn creation_date(self, input: DateTime) -> Self
The date and time that a scan 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 scan 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 get_creation_date(&self) -> &Option<DateTime>
pub fn get_creation_date(&self) -> &Option<DateTime>
The date and time that a scan 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 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 scan job; 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 scan job; for example, arn:aws:iam::123456789012:role/S3Access.
Sourcepub fn get_iam_role_arn(&self) -> &Option<String>
pub fn get_iam_role_arn(&self) -> &Option<String>
Specifies the IAM role ARN used to create the scan job; for example, arn:aws:iam::123456789012:role/S3Access.
Sourcepub fn malware_scanner(self, input: MalwareScanner) -> Self
pub fn malware_scanner(self, input: MalwareScanner) -> Self
The scanning engine used for the scan job. Currently only GUARDDUTY is supported.
Sourcepub fn set_malware_scanner(self, input: Option<MalwareScanner>) -> Self
pub fn set_malware_scanner(self, input: Option<MalwareScanner>) -> Self
The scanning engine used for the scan job. Currently only GUARDDUTY is supported.
Sourcepub fn get_malware_scanner(&self) -> &Option<MalwareScanner>
pub fn get_malware_scanner(&self) -> &Option<MalwareScanner>
The scanning engine used for the scan job. Currently only GUARDDUTY is supported.
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 the recovery point being scanned; 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 the recovery point being scanned; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Sourcepub fn get_recovery_point_arn(&self) -> &Option<String>
pub fn get_recovery_point_arn(&self) -> &Option<String>
An ARN that uniquely identifies the recovery point being scanned; 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 the source resource of the recovery point being scanned.
This field is required.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 the source resource of the recovery point being scanned.
Sourcepub fn get_resource_arn(&self) -> &Option<String>
pub fn get_resource_arn(&self) -> &Option<String>
An ARN that uniquely identifies the source resource of the recovery point being scanned.
Sourcepub fn resource_name(self, input: impl Into<String>) -> Self
pub fn resource_name(self, input: impl Into<String>) -> Self
The non-unique name of the resource that belongs to the specified backup.
This field is required.Sourcepub fn set_resource_name(self, input: Option<String>) -> Self
pub fn set_resource_name(self, input: Option<String>) -> Self
The non-unique name of the resource that belongs to the specified backup.
Sourcepub fn get_resource_name(&self) -> &Option<String>
pub fn get_resource_name(&self) -> &Option<String>
The non-unique name of the resource that belongs to the specified backup.
Sourcepub fn resource_type(self, input: ScanResourceType) -> Self
pub fn resource_type(self, input: ScanResourceType) -> Self
The type of Amazon Web Services resource being scanned; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
This field is required.Sourcepub fn set_resource_type(self, input: Option<ScanResourceType>) -> Self
pub fn set_resource_type(self, input: Option<ScanResourceType>) -> Self
The type of Amazon Web Services resource being scanned; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
Sourcepub fn get_resource_type(&self) -> &Option<ScanResourceType>
pub fn get_resource_type(&self) -> &Option<ScanResourceType>
The type of Amazon Web Services resource being scanned; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
Sourcepub fn scan_base_recovery_point_arn(self, input: impl Into<String>) -> Self
pub fn scan_base_recovery_point_arn(self, input: impl Into<String>) -> Self
An ARN that uniquely identifies the base recovery point for scanning. This field is populated when an incremental scan job has taken place.
Sourcepub fn set_scan_base_recovery_point_arn(self, input: Option<String>) -> Self
pub fn set_scan_base_recovery_point_arn(self, input: Option<String>) -> Self
An ARN that uniquely identifies the base recovery point for scanning. This field is populated when an incremental scan job has taken place.
Sourcepub fn get_scan_base_recovery_point_arn(&self) -> &Option<String>
pub fn get_scan_base_recovery_point_arn(&self) -> &Option<String>
An ARN that uniquely identifies the base recovery point for scanning. This field is populated when an incremental scan job has taken place.
Sourcepub fn scan_id(self, input: impl Into<String>) -> Self
pub fn scan_id(self, input: impl Into<String>) -> Self
The scan ID generated by the malware scanner for the corresponding scan job.
Sourcepub fn set_scan_id(self, input: Option<String>) -> Self
pub fn set_scan_id(self, input: Option<String>) -> Self
The scan ID generated by the malware scanner for the corresponding scan job.
Sourcepub fn get_scan_id(&self) -> &Option<String>
pub fn get_scan_id(&self) -> &Option<String>
The scan ID generated by the malware scanner for the corresponding scan job.
Sourcepub fn scan_job_id(self, input: impl Into<String>) -> Self
pub fn scan_job_id(self, input: impl Into<String>) -> Self
The unique identifier that identifies the scan job request to Backup.
This field is required.Sourcepub fn set_scan_job_id(self, input: Option<String>) -> Self
pub fn set_scan_job_id(self, input: Option<String>) -> Self
The unique identifier that identifies the scan job request to Backup.
Sourcepub fn get_scan_job_id(&self) -> &Option<String>
pub fn get_scan_job_id(&self) -> &Option<String>
The unique identifier that identifies the scan job request to Backup.
Sourcepub fn scan_mode(self, input: ScanMode) -> Self
pub fn scan_mode(self, input: ScanMode) -> Self
Specifies the scan type use for the scan job.
Includes:
FULL_SCAN will scan the entire data lineage within the backup.
INCREMENTAL_SCAN will scan the data difference between the target recovery point and base recovery point ARN.
Sourcepub fn set_scan_mode(self, input: Option<ScanMode>) -> Self
pub fn set_scan_mode(self, input: Option<ScanMode>) -> Self
Specifies the scan type use for the scan job.
Includes:
FULL_SCAN will scan the entire data lineage within the backup.
INCREMENTAL_SCAN will scan the data difference between the target recovery point and base recovery point ARN.
Sourcepub fn get_scan_mode(&self) -> &Option<ScanMode>
pub fn get_scan_mode(&self) -> &Option<ScanMode>
Specifies the scan type use for the scan job.
Includes:
FULL_SCAN will scan the entire data lineage within the backup.
INCREMENTAL_SCAN will scan the data difference between the target recovery point and base recovery point ARN.
Sourcepub fn scan_result(self, input: ScanResultInfo) -> Self
pub fn scan_result(self, input: ScanResultInfo) -> Self
Contains the scan results information, including the status of threats found during scanning.
Sourcepub fn set_scan_result(self, input: Option<ScanResultInfo>) -> Self
pub fn set_scan_result(self, input: Option<ScanResultInfo>) -> Self
Contains the scan results information, including the status of threats found during scanning.
Sourcepub fn get_scan_result(&self) -> &Option<ScanResultInfo>
pub fn get_scan_result(&self) -> &Option<ScanResultInfo>
Contains the scan results information, including the status of threats found during scanning.
Sourcepub fn scanner_role_arn(self, input: impl Into<String>) -> Self
pub fn scanner_role_arn(self, input: impl Into<String>) -> Self
Specifies the scanner IAM role ARN used for the scan job.
This field is required.Sourcepub fn set_scanner_role_arn(self, input: Option<String>) -> Self
pub fn set_scanner_role_arn(self, input: Option<String>) -> Self
Specifies the scanner IAM role ARN used for the scan job.
Sourcepub fn get_scanner_role_arn(&self) -> &Option<String>
pub fn get_scanner_role_arn(&self) -> &Option<String>
Specifies the scanner IAM role ARN used for the scan job.
Sourcepub fn state(self, input: ScanState) -> Self
pub fn state(self, input: ScanState) -> Self
The current state of the scan job.
Valid values: CREATED | RUNNING | COMPLETED | COMPLETED_WITH_ISSUES | FAILED | CANCELED.
Sourcepub fn set_state(self, input: Option<ScanState>) -> Self
pub fn set_state(self, input: Option<ScanState>) -> Self
The current state of the scan job.
Valid values: CREATED | RUNNING | COMPLETED | COMPLETED_WITH_ISSUES | FAILED | CANCELED.
Sourcepub fn get_state(&self) -> &Option<ScanState>
pub fn get_state(&self) -> &Option<ScanState>
The current state of the scan job.
Valid values: CREATED | RUNNING | COMPLETED | COMPLETED_WITH_ISSUES | FAILED | CANCELED.
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 scan job.
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 scan job.
Sourcepub fn get_status_message(&self) -> &Option<String>
pub fn get_status_message(&self) -> &Option<String>
A detailed message explaining the status of the scan job.
Trait Implementations§
Source§impl Clone for ScanJobBuilder
impl Clone for ScanJobBuilder
Source§fn clone(&self) -> ScanJobBuilder
fn clone(&self) -> ScanJobBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for ScanJobBuilder
impl Debug for ScanJobBuilder
Source§impl Default for ScanJobBuilder
impl Default for ScanJobBuilder
Source§fn default() -> ScanJobBuilder
fn default() -> ScanJobBuilder
Source§impl PartialEq for ScanJobBuilder
impl PartialEq for ScanJobBuilder
impl StructuralPartialEq for ScanJobBuilder
Auto Trait Implementations§
impl Freeze for ScanJobBuilder
impl RefUnwindSafe for ScanJobBuilder
impl Send for ScanJobBuilder
impl Sync for ScanJobBuilder
impl Unpin for ScanJobBuilder
impl UnwindSafe for ScanJobBuilder
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);