#[non_exhaustive]pub struct GetScanOutputBuilder { /* private fields */ }
Expand description
A builder for GetScanOutput
.
Implementations§
Source§impl GetScanOutputBuilder
impl GetScanOutputBuilder
Sourcepub fn scan_name(self, input: impl Into<String>) -> Self
pub fn scan_name(self, input: impl Into<String>) -> Self
The name of the scan.
This field is required.Sourcepub fn set_scan_name(self, input: Option<String>) -> Self
pub fn set_scan_name(self, input: Option<String>) -> Self
The name of the scan.
Sourcepub fn get_scan_name(&self) -> &Option<String>
pub fn get_scan_name(&self) -> &Option<String>
The name of the scan.
Sourcepub fn run_id(self, input: impl Into<String>) -> Self
pub fn run_id(self, input: impl Into<String>) -> Self
UUID that identifies the individual scan run.
This field is required.Sourcepub fn set_run_id(self, input: Option<String>) -> Self
pub fn set_run_id(self, input: Option<String>) -> Self
UUID that identifies the individual scan run.
Sourcepub fn get_run_id(&self) -> &Option<String>
pub fn get_run_id(&self) -> &Option<String>
UUID that identifies the individual scan run.
Sourcepub fn scan_state(self, input: ScanState) -> Self
pub fn scan_state(self, input: ScanState) -> Self
The current state of the scan. Returns either InProgress
, Successful
, or Failed
.
Sourcepub fn set_scan_state(self, input: Option<ScanState>) -> Self
pub fn set_scan_state(self, input: Option<ScanState>) -> Self
The current state of the scan. Returns either InProgress
, Successful
, or Failed
.
Sourcepub fn get_scan_state(&self) -> &Option<ScanState>
pub fn get_scan_state(&self) -> &Option<ScanState>
The current state of the scan. Returns either InProgress
, Successful
, or Failed
.
Sourcepub fn created_at(self, input: DateTime) -> Self
pub fn created_at(self, input: DateTime) -> Self
The time the scan was created.
This field is required.Sourcepub fn set_created_at(self, input: Option<DateTime>) -> Self
pub fn set_created_at(self, input: Option<DateTime>) -> Self
The time the scan was created.
Sourcepub fn get_created_at(&self) -> &Option<DateTime>
pub fn get_created_at(&self) -> &Option<DateTime>
The time the scan was created.
Sourcepub fn analysis_type(self, input: AnalysisType) -> Self
pub fn analysis_type(self, input: AnalysisType) -> Self
The type of analysis CodeGuru Security performed in the scan, either Security
or All
. The Security
type only generates findings related to security. The All
type generates both security findings and quality findings.
Sourcepub fn set_analysis_type(self, input: Option<AnalysisType>) -> Self
pub fn set_analysis_type(self, input: Option<AnalysisType>) -> Self
The type of analysis CodeGuru Security performed in the scan, either Security
or All
. The Security
type only generates findings related to security. The All
type generates both security findings and quality findings.
Sourcepub fn get_analysis_type(&self) -> &Option<AnalysisType>
pub fn get_analysis_type(&self) -> &Option<AnalysisType>
The type of analysis CodeGuru Security performed in the scan, either Security
or All
. The Security
type only generates findings related to security. The All
type generates both security findings and quality findings.
Sourcepub fn updated_at(self, input: DateTime) -> Self
pub fn updated_at(self, input: DateTime) -> Self
The time when the scan was last updated. Only available for STANDARD
scan types.
Sourcepub fn set_updated_at(self, input: Option<DateTime>) -> Self
pub fn set_updated_at(self, input: Option<DateTime>) -> Self
The time when the scan was last updated. Only available for STANDARD
scan types.
Sourcepub fn get_updated_at(&self) -> &Option<DateTime>
pub fn get_updated_at(&self) -> &Option<DateTime>
The time when the scan was last updated. Only available for STANDARD
scan types.
Sourcepub fn number_of_revisions(self, input: i64) -> Self
pub fn number_of_revisions(self, input: i64) -> Self
The number of times a scan has been re-run on a revised resource.
Sourcepub fn set_number_of_revisions(self, input: Option<i64>) -> Self
pub fn set_number_of_revisions(self, input: Option<i64>) -> Self
The number of times a scan has been re-run on a revised resource.
Sourcepub fn get_number_of_revisions(&self) -> &Option<i64>
pub fn get_number_of_revisions(&self) -> &Option<i64>
The number of times a scan has been re-run on a revised resource.
Sourcepub fn scan_name_arn(self, input: impl Into<String>) -> Self
pub fn scan_name_arn(self, input: impl Into<String>) -> Self
The ARN for the scan name.
Sourcepub fn set_scan_name_arn(self, input: Option<String>) -> Self
pub fn set_scan_name_arn(self, input: Option<String>) -> Self
The ARN for the scan name.
Sourcepub fn get_scan_name_arn(&self) -> &Option<String>
pub fn get_scan_name_arn(&self) -> &Option<String>
The ARN for the scan name.
Sourcepub fn error_message(self, input: impl Into<String>) -> Self
pub fn error_message(self, input: impl Into<String>) -> Self
Details about the error that causes a scan to fail to be retrieved.
Sourcepub fn set_error_message(self, input: Option<String>) -> Self
pub fn set_error_message(self, input: Option<String>) -> Self
Details about the error that causes a scan to fail to be retrieved.
Sourcepub fn get_error_message(&self) -> &Option<String>
pub fn get_error_message(&self) -> &Option<String>
Details about the error that causes a scan to fail to be retrieved.
Sourcepub fn build(self) -> Result<GetScanOutput, BuildError>
pub fn build(self) -> Result<GetScanOutput, BuildError>
Consumes the builder and constructs a GetScanOutput
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for GetScanOutputBuilder
impl Clone for GetScanOutputBuilder
Source§fn clone(&self) -> GetScanOutputBuilder
fn clone(&self) -> GetScanOutputBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for GetScanOutputBuilder
impl Debug for GetScanOutputBuilder
Source§impl Default for GetScanOutputBuilder
impl Default for GetScanOutputBuilder
Source§fn default() -> GetScanOutputBuilder
fn default() -> GetScanOutputBuilder
Source§impl PartialEq for GetScanOutputBuilder
impl PartialEq for GetScanOutputBuilder
impl StructuralPartialEq for GetScanOutputBuilder
Auto Trait Implementations§
impl Freeze for GetScanOutputBuilder
impl RefUnwindSafe for GetScanOutputBuilder
impl Send for GetScanOutputBuilder
impl Sync for GetScanOutputBuilder
impl Unpin for GetScanOutputBuilder
impl UnwindSafe for GetScanOutputBuilder
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);