#[non_exhaustive]pub struct CreateScanInputBuilder { /* private fields */ }
Expand description
A builder for CreateScanInput
.
Implementations§
Source§impl CreateScanInputBuilder
impl CreateScanInputBuilder
Sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
The idempotency token for the request. Amazon CodeGuru Security uses this value to prevent the accidental creation of duplicate scans if there are failures and retries.
Sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
The idempotency token for the request. Amazon CodeGuru Security uses this value to prevent the accidental creation of duplicate scans if there are failures and retries.
Sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &Option<String>
The idempotency token for the request. Amazon CodeGuru Security uses this value to prevent the accidental creation of duplicate scans if there are failures and retries.
Sourcepub fn resource_id(self, input: ResourceId) -> Self
pub fn resource_id(self, input: ResourceId) -> Self
The identifier for the resource object to be scanned.
This field is required.Sourcepub fn set_resource_id(self, input: Option<ResourceId>) -> Self
pub fn set_resource_id(self, input: Option<ResourceId>) -> Self
The identifier for the resource object to be scanned.
Sourcepub fn get_resource_id(&self) -> &Option<ResourceId>
pub fn get_resource_id(&self) -> &Option<ResourceId>
The identifier for the resource object to be scanned.
Sourcepub fn scan_name(self, input: impl Into<String>) -> Self
pub fn scan_name(self, input: impl Into<String>) -> Self
The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource. Only allowed for a STANDARD
scan type.
Sourcepub fn set_scan_name(self, input: Option<String>) -> Self
pub fn set_scan_name(self, input: Option<String>) -> Self
The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource. Only allowed for a STANDARD
scan type.
Sourcepub fn get_scan_name(&self) -> &Option<String>
pub fn get_scan_name(&self) -> &Option<String>
The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource. Only allowed for a STANDARD
scan type.
Sourcepub fn scan_type(self, input: ScanType) -> Self
pub fn scan_type(self, input: ScanType) -> Self
The type of scan, either Standard
or Express
. Defaults to Standard
type if missing.
Express
scans run on limited resources and use a limited set of detectors to analyze your code in near-real time. Standard
scans have standard resource limits and use the full set of detectors to analyze your code.
Sourcepub fn set_scan_type(self, input: Option<ScanType>) -> Self
pub fn set_scan_type(self, input: Option<ScanType>) -> Self
The type of scan, either Standard
or Express
. Defaults to Standard
type if missing.
Express
scans run on limited resources and use a limited set of detectors to analyze your code in near-real time. Standard
scans have standard resource limits and use the full set of detectors to analyze your code.
Sourcepub fn get_scan_type(&self) -> &Option<ScanType>
pub fn get_scan_type(&self) -> &Option<ScanType>
The type of scan, either Standard
or Express
. Defaults to Standard
type if missing.
Express
scans run on limited resources and use a limited set of detectors to analyze your code in near-real time. Standard
scans have standard resource limits and use the full set of detectors to analyze your code.
Sourcepub fn analysis_type(self, input: AnalysisType) -> Self
pub fn analysis_type(self, input: AnalysisType) -> Self
The type of analysis you want CodeGuru Security to perform 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. Defaults to Security
type if missing.
Sourcepub fn set_analysis_type(self, input: Option<AnalysisType>) -> Self
pub fn set_analysis_type(self, input: Option<AnalysisType>) -> Self
The type of analysis you want CodeGuru Security to perform 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. Defaults to Security
type if missing.
Sourcepub fn get_analysis_type(&self) -> &Option<AnalysisType>
pub fn get_analysis_type(&self) -> &Option<AnalysisType>
The type of analysis you want CodeGuru Security to perform 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. Defaults to Security
type if missing.
Adds a key-value pair to tags
.
To override the contents of this collection use set_tags
.
An array of key-value pairs used to tag a scan. A tag is a custom attribute label with two parts:
-
A tag key. For example,
CostCenter
,Environment
, orSecret
. Tag keys are case sensitive. -
An optional tag value field. For example,
111122223333
,Production
, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.
An array of key-value pairs used to tag a scan. A tag is a custom attribute label with two parts:
-
A tag key. For example,
CostCenter
,Environment
, orSecret
. Tag keys are case sensitive. -
An optional tag value field. For example,
111122223333
,Production
, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.
An array of key-value pairs used to tag a scan. A tag is a custom attribute label with two parts:
-
A tag key. For example,
CostCenter
,Environment
, orSecret
. Tag keys are case sensitive. -
An optional tag value field. For example,
111122223333
,Production
, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.
Sourcepub fn build(self) -> Result<CreateScanInput, BuildError>
pub fn build(self) -> Result<CreateScanInput, BuildError>
Consumes the builder and constructs a CreateScanInput
.
Source§impl CreateScanInputBuilder
impl CreateScanInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<CreateScanOutput, SdkError<CreateScanError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<CreateScanOutput, SdkError<CreateScanError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for CreateScanInputBuilder
impl Clone for CreateScanInputBuilder
Source§fn clone(&self) -> CreateScanInputBuilder
fn clone(&self) -> CreateScanInputBuilder
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 CreateScanInputBuilder
impl Debug for CreateScanInputBuilder
Source§impl Default for CreateScanInputBuilder
impl Default for CreateScanInputBuilder
Source§fn default() -> CreateScanInputBuilder
fn default() -> CreateScanInputBuilder
Source§impl PartialEq for CreateScanInputBuilder
impl PartialEq for CreateScanInputBuilder
Source§fn eq(&self, other: &CreateScanInputBuilder) -> bool
fn eq(&self, other: &CreateScanInputBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for CreateScanInputBuilder
Auto Trait Implementations§
impl Freeze for CreateScanInputBuilder
impl RefUnwindSafe for CreateScanInputBuilder
impl Send for CreateScanInputBuilder
impl Sync for CreateScanInputBuilder
impl Unpin for CreateScanInputBuilder
impl UnwindSafe for CreateScanInputBuilder
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);