#[non_exhaustive]pub struct JobSummaryBuilder { /* private fields */ }
Expand description
A builder for JobSummary
.
Implementations§
Source§impl JobSummaryBuilder
impl JobSummaryBuilder
Sourcepub fn bucket_criteria(self, input: S3BucketCriteriaForJob) -> Self
pub fn bucket_criteria(self, input: S3BucketCriteriaForJob) -> Self
The property- and tag-based conditions that determine which S3 buckets are included or excluded from the job's analysis. Each time the job runs, the job uses these criteria to determine which buckets to analyze. A job's definition can contain a bucketCriteria object or a bucketDefinitions array, not both.
Sourcepub fn set_bucket_criteria(self, input: Option<S3BucketCriteriaForJob>) -> Self
pub fn set_bucket_criteria(self, input: Option<S3BucketCriteriaForJob>) -> Self
The property- and tag-based conditions that determine which S3 buckets are included or excluded from the job's analysis. Each time the job runs, the job uses these criteria to determine which buckets to analyze. A job's definition can contain a bucketCriteria object or a bucketDefinitions array, not both.
Sourcepub fn get_bucket_criteria(&self) -> &Option<S3BucketCriteriaForJob>
pub fn get_bucket_criteria(&self) -> &Option<S3BucketCriteriaForJob>
The property- and tag-based conditions that determine which S3 buckets are included or excluded from the job's analysis. Each time the job runs, the job uses these criteria to determine which buckets to analyze. A job's definition can contain a bucketCriteria object or a bucketDefinitions array, not both.
Sourcepub fn bucket_definitions(self, input: S3BucketDefinitionForJob) -> Self
pub fn bucket_definitions(self, input: S3BucketDefinitionForJob) -> Self
Appends an item to bucket_definitions
.
To override the contents of this collection use set_bucket_definitions
.
An array of objects, one for each Amazon Web Services account that owns specific S3 buckets for the job to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job's definition can contain a bucketDefinitions array or a bucketCriteria object, not both.
Sourcepub fn set_bucket_definitions(
self,
input: Option<Vec<S3BucketDefinitionForJob>>,
) -> Self
pub fn set_bucket_definitions( self, input: Option<Vec<S3BucketDefinitionForJob>>, ) -> Self
An array of objects, one for each Amazon Web Services account that owns specific S3 buckets for the job to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job's definition can contain a bucketDefinitions array or a bucketCriteria object, not both.
Sourcepub fn get_bucket_definitions(&self) -> &Option<Vec<S3BucketDefinitionForJob>>
pub fn get_bucket_definitions(&self) -> &Option<Vec<S3BucketDefinitionForJob>>
An array of objects, one for each Amazon Web Services account that owns specific S3 buckets for the job to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job's definition can contain a bucketDefinitions array or a bucketCriteria object, not both.
Sourcepub fn created_at(self, input: DateTime) -> Self
pub fn created_at(self, input: DateTime) -> Self
The date and time, in UTC and extended ISO 8601 format, when the job was created.
Sourcepub fn set_created_at(self, input: Option<DateTime>) -> Self
pub fn set_created_at(self, input: Option<DateTime>) -> Self
The date and time, in UTC and extended ISO 8601 format, when the job was created.
Sourcepub fn get_created_at(&self) -> &Option<DateTime>
pub fn get_created_at(&self) -> &Option<DateTime>
The date and time, in UTC and extended ISO 8601 format, when the job was created.
Sourcepub fn set_job_id(self, input: Option<String>) -> Self
pub fn set_job_id(self, input: Option<String>) -> Self
The unique identifier for the job.
Sourcepub fn get_job_id(&self) -> &Option<String>
pub fn get_job_id(&self) -> &Option<String>
The unique identifier for the job.
Sourcepub fn job_status(self, input: JobStatus) -> Self
pub fn job_status(self, input: JobStatus) -> Self
The current status of the job. Possible values are:
-
CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.
-
COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.
-
IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.
-
PAUSED - Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.
-
RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.
-
USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.
Sourcepub fn set_job_status(self, input: Option<JobStatus>) -> Self
pub fn set_job_status(self, input: Option<JobStatus>) -> Self
The current status of the job. Possible values are:
-
CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.
-
COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.
-
IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.
-
PAUSED - Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.
-
RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.
-
USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.
Sourcepub fn get_job_status(&self) -> &Option<JobStatus>
pub fn get_job_status(&self) -> &Option<JobStatus>
The current status of the job. Possible values are:
-
CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.
-
COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.
-
IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.
-
PAUSED - Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.
-
RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.
-
USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.
Sourcepub fn job_type(self, input: JobType) -> Self
pub fn job_type(self, input: JobType) -> Self
The schedule for running the job. Possible values are:
-
ONE_TIME - The job runs only once.
-
SCHEDULED - The job runs on a daily, weekly, or monthly basis.
Sourcepub fn set_job_type(self, input: Option<JobType>) -> Self
pub fn set_job_type(self, input: Option<JobType>) -> Self
The schedule for running the job. Possible values are:
-
ONE_TIME - The job runs only once.
-
SCHEDULED - The job runs on a daily, weekly, or monthly basis.
Sourcepub fn get_job_type(&self) -> &Option<JobType>
pub fn get_job_type(&self) -> &Option<JobType>
The schedule for running the job. Possible values are:
-
ONE_TIME - The job runs only once.
-
SCHEDULED - The job runs on a daily, weekly, or monthly basis.
Sourcepub fn last_run_error_status(self, input: LastRunErrorStatus) -> Self
pub fn last_run_error_status(self, input: LastRunErrorStatus) -> Self
Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run.
Sourcepub fn set_last_run_error_status(
self,
input: Option<LastRunErrorStatus>,
) -> Self
pub fn set_last_run_error_status( self, input: Option<LastRunErrorStatus>, ) -> Self
Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run.
Sourcepub fn get_last_run_error_status(&self) -> &Option<LastRunErrorStatus>
pub fn get_last_run_error_status(&self) -> &Option<LastRunErrorStatus>
Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run.
Sourcepub fn user_paused_details(self, input: UserPausedDetails) -> Self
pub fn user_paused_details(self, input: UserPausedDetails) -> Self
If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.
Sourcepub fn set_user_paused_details(self, input: Option<UserPausedDetails>) -> Self
pub fn set_user_paused_details(self, input: Option<UserPausedDetails>) -> Self
If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.
Sourcepub fn get_user_paused_details(&self) -> &Option<UserPausedDetails>
pub fn get_user_paused_details(&self) -> &Option<UserPausedDetails>
If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.
Sourcepub fn build(self) -> JobSummary
pub fn build(self) -> JobSummary
Consumes the builder and constructs a JobSummary
.
Trait Implementations§
Source§impl Clone for JobSummaryBuilder
impl Clone for JobSummaryBuilder
Source§fn clone(&self) -> JobSummaryBuilder
fn clone(&self) -> JobSummaryBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for JobSummaryBuilder
impl Debug for JobSummaryBuilder
Source§impl Default for JobSummaryBuilder
impl Default for JobSummaryBuilder
Source§fn default() -> JobSummaryBuilder
fn default() -> JobSummaryBuilder
Source§impl PartialEq for JobSummaryBuilder
impl PartialEq for JobSummaryBuilder
impl StructuralPartialEq for JobSummaryBuilder
Auto Trait Implementations§
impl Freeze for JobSummaryBuilder
impl RefUnwindSafe for JobSummaryBuilder
impl Send for JobSummaryBuilder
impl Sync for JobSummaryBuilder
impl Unpin for JobSummaryBuilder
impl UnwindSafe for JobSummaryBuilder
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);