#[non_exhaustive]pub struct SignalBuilder { /* private fields */ }Expand description
A builder for Signal.
Implementations§
Source§impl SignalBuilder
impl SignalBuilder
Sourcepub fn uid(self, input: impl Into<String>) -> Self
pub fn uid(self, input: impl Into<String>) -> Self
The unique identifier of the signal.
This field is required.Sourcepub fn type(self, input: SignalType) -> Self
pub fn type(self, input: SignalType) -> Self
The type of the signal used to identify an attack sequence.
Signals can be GuardDuty findings or activities observed in data sources that GuardDuty monitors. For more information, see Foundational data sources in the Amazon GuardDuty User Guide.
A signal type can be one of the valid values listed in this API. Here are the related descriptions:
-
FINDING- Individually generated GuardDuty finding. -
CLOUD_TRAIL- Activity observed from CloudTrail logs -
S3_DATA_EVENTS- Activity observed from CloudTrail data events for S3. Activities associated with this type will show up only when you have enabled GuardDuty S3 Protection feature in your account. For more information about S3 Protection and steps to enable it, see S3 Protection in the Amazon GuardDuty User Guide.
Sourcepub fn set_type(self, input: Option<SignalType>) -> Self
pub fn set_type(self, input: Option<SignalType>) -> Self
The type of the signal used to identify an attack sequence.
Signals can be GuardDuty findings or activities observed in data sources that GuardDuty monitors. For more information, see Foundational data sources in the Amazon GuardDuty User Guide.
A signal type can be one of the valid values listed in this API. Here are the related descriptions:
-
FINDING- Individually generated GuardDuty finding. -
CLOUD_TRAIL- Activity observed from CloudTrail logs -
S3_DATA_EVENTS- Activity observed from CloudTrail data events for S3. Activities associated with this type will show up only when you have enabled GuardDuty S3 Protection feature in your account. For more information about S3 Protection and steps to enable it, see S3 Protection in the Amazon GuardDuty User Guide.
Sourcepub fn get_type(&self) -> &Option<SignalType>
pub fn get_type(&self) -> &Option<SignalType>
The type of the signal used to identify an attack sequence.
Signals can be GuardDuty findings or activities observed in data sources that GuardDuty monitors. For more information, see Foundational data sources in the Amazon GuardDuty User Guide.
A signal type can be one of the valid values listed in this API. Here are the related descriptions:
-
FINDING- Individually generated GuardDuty finding. -
CLOUD_TRAIL- Activity observed from CloudTrail logs -
S3_DATA_EVENTS- Activity observed from CloudTrail data events for S3. Activities associated with this type will show up only when you have enabled GuardDuty S3 Protection feature in your account. For more information about S3 Protection and steps to enable it, see S3 Protection in the Amazon GuardDuty User Guide.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The description of the signal.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
The description of the signal.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
The description of the signal.
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name of the signal. For example, when signal type is FINDING, the signal name is the name of the finding.
Sourcepub fn set_name(self, input: Option<String>) -> Self
pub fn set_name(self, input: Option<String>) -> Self
The name of the signal. For example, when signal type is FINDING, the signal name is the name of the finding.
Sourcepub fn get_name(&self) -> &Option<String>
pub fn get_name(&self) -> &Option<String>
The name of the signal. For example, when signal type is FINDING, the signal name is the name of the finding.
Sourcepub fn created_at(self, input: DateTime) -> Self
pub fn created_at(self, input: DateTime) -> Self
The timestamp when the first finding or activity related to this signal was observed.
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 timestamp when the first finding or activity related to this signal was observed.
Sourcepub fn get_created_at(&self) -> &Option<DateTime>
pub fn get_created_at(&self) -> &Option<DateTime>
The timestamp when the first finding or activity related to this signal was observed.
Sourcepub fn updated_at(self, input: DateTime) -> Self
pub fn updated_at(self, input: DateTime) -> Self
The timestamp when this signal was last observed.
This field is required.Sourcepub fn set_updated_at(self, input: Option<DateTime>) -> Self
pub fn set_updated_at(self, input: Option<DateTime>) -> Self
The timestamp when this signal was last observed.
Sourcepub fn get_updated_at(&self) -> &Option<DateTime>
pub fn get_updated_at(&self) -> &Option<DateTime>
The timestamp when this signal was last observed.
Sourcepub fn first_seen_at(self, input: DateTime) -> Self
pub fn first_seen_at(self, input: DateTime) -> Self
The timestamp when the first finding or activity related to this signal was observed.
This field is required.Sourcepub fn set_first_seen_at(self, input: Option<DateTime>) -> Self
pub fn set_first_seen_at(self, input: Option<DateTime>) -> Self
The timestamp when the first finding or activity related to this signal was observed.
Sourcepub fn get_first_seen_at(&self) -> &Option<DateTime>
pub fn get_first_seen_at(&self) -> &Option<DateTime>
The timestamp when the first finding or activity related to this signal was observed.
Sourcepub fn last_seen_at(self, input: DateTime) -> Self
pub fn last_seen_at(self, input: DateTime) -> Self
The timestamp when the last finding or activity related to this signal was observed.
This field is required.Sourcepub fn set_last_seen_at(self, input: Option<DateTime>) -> Self
pub fn set_last_seen_at(self, input: Option<DateTime>) -> Self
The timestamp when the last finding or activity related to this signal was observed.
Sourcepub fn get_last_seen_at(&self) -> &Option<DateTime>
pub fn get_last_seen_at(&self) -> &Option<DateTime>
The timestamp when the last finding or activity related to this signal was observed.
Sourcepub fn severity(self, input: f64) -> Self
pub fn severity(self, input: f64) -> Self
The severity associated with the signal. For more information about severity, see Findings severity levels in the Amazon GuardDuty User Guide.
Sourcepub fn set_severity(self, input: Option<f64>) -> Self
pub fn set_severity(self, input: Option<f64>) -> Self
The severity associated with the signal. For more information about severity, see Findings severity levels in the Amazon GuardDuty User Guide.
Sourcepub fn get_severity(&self) -> &Option<f64>
pub fn get_severity(&self) -> &Option<f64>
The severity associated with the signal. For more information about severity, see Findings severity levels in the Amazon GuardDuty User Guide.
Sourcepub fn count(self, input: i32) -> Self
pub fn count(self, input: i32) -> Self
The number of times this signal was observed.
This field is required.Sourcepub fn set_count(self, input: Option<i32>) -> Self
pub fn set_count(self, input: Option<i32>) -> Self
The number of times this signal was observed.
Sourcepub fn resource_uids(self, input: impl Into<String>) -> Self
pub fn resource_uids(self, input: impl Into<String>) -> Self
Appends an item to resource_uids.
To override the contents of this collection use set_resource_uids.
Information about the unique identifiers of the resources involved in the signal.
Sourcepub fn set_resource_uids(self, input: Option<Vec<String>>) -> Self
pub fn set_resource_uids(self, input: Option<Vec<String>>) -> Self
Information about the unique identifiers of the resources involved in the signal.
Sourcepub fn get_resource_uids(&self) -> &Option<Vec<String>>
pub fn get_resource_uids(&self) -> &Option<Vec<String>>
Information about the unique identifiers of the resources involved in the signal.
Sourcepub fn actor_ids(self, input: impl Into<String>) -> Self
pub fn actor_ids(self, input: impl Into<String>) -> Self
Appends an item to actor_ids.
To override the contents of this collection use set_actor_ids.
Information about the IDs of the threat actors involved in the signal.
Sourcepub fn set_actor_ids(self, input: Option<Vec<String>>) -> Self
pub fn set_actor_ids(self, input: Option<Vec<String>>) -> Self
Information about the IDs of the threat actors involved in the signal.
Sourcepub fn get_actor_ids(&self) -> &Option<Vec<String>>
pub fn get_actor_ids(&self) -> &Option<Vec<String>>
Information about the IDs of the threat actors involved in the signal.
Sourcepub fn endpoint_ids(self, input: impl Into<String>) -> Self
pub fn endpoint_ids(self, input: impl Into<String>) -> Self
Appends an item to endpoint_ids.
To override the contents of this collection use set_endpoint_ids.
Information about the endpoint IDs associated with this signal.
Sourcepub fn set_endpoint_ids(self, input: Option<Vec<String>>) -> Self
pub fn set_endpoint_ids(self, input: Option<Vec<String>>) -> Self
Information about the endpoint IDs associated with this signal.
Sourcepub fn get_endpoint_ids(&self) -> &Option<Vec<String>>
pub fn get_endpoint_ids(&self) -> &Option<Vec<String>>
Information about the endpoint IDs associated with this signal.
Sourcepub fn signal_indicators(self, input: Indicator) -> Self
pub fn signal_indicators(self, input: Indicator) -> Self
Appends an item to signal_indicators.
To override the contents of this collection use set_signal_indicators.
Contains information about the indicators associated with the signals.
Sourcepub fn set_signal_indicators(self, input: Option<Vec<Indicator>>) -> Self
pub fn set_signal_indicators(self, input: Option<Vec<Indicator>>) -> Self
Contains information about the indicators associated with the signals.
Sourcepub fn get_signal_indicators(&self) -> &Option<Vec<Indicator>>
pub fn get_signal_indicators(&self) -> &Option<Vec<Indicator>>
Contains information about the indicators associated with the signals.
Trait Implementations§
Source§impl Clone for SignalBuilder
impl Clone for SignalBuilder
Source§fn clone(&self) -> SignalBuilder
fn clone(&self) -> SignalBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for SignalBuilder
impl Debug for SignalBuilder
Source§impl Default for SignalBuilder
impl Default for SignalBuilder
Source§fn default() -> SignalBuilder
fn default() -> SignalBuilder
Source§impl PartialEq for SignalBuilder
impl PartialEq for SignalBuilder
impl StructuralPartialEq for SignalBuilder
Auto Trait Implementations§
impl Freeze for SignalBuilder
impl RefUnwindSafe for SignalBuilder
impl Send for SignalBuilder
impl Sync for SignalBuilder
impl Unpin for SignalBuilder
impl UnwindSafe for SignalBuilder
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);