Struct ThreatSummary 

#[non_exhaustive]
pub struct ThreatSummary {
    pub threat_id: Option<String>,
    pub threat_job_id: Option<String>,
    pub title: Option<String>,
    pub statement: Option<String>,
    pub severity: Option<ThreatSeverity>,
    pub status: Option<ThreatStatus>,
    pub stride: Option<Vec<StrideCategory>>,
    pub created_by: Option<ThreatActor>,
    pub updated_by: Option<ThreatActor>,
    pub created_at: Option<DateTime>,
    pub updated_at: Option<DateTime>,
}

Contains summary information about a threat.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

threat_id: Option<String>

The unique identifier of the threat.

threat_job_id: Option<String>

The unique identifier of the threat model job that produced the threat.

title: Option<String>

A short title summarizing the threat.

statement: Option<String>

The natural-language threat statement.

severity: Option<ThreatSeverity>

The severity level of the threat.

status: Option<ThreatStatus>

The current status of the threat.

stride: Option<Vec<StrideCategory>>

The STRIDE categories applicable to this threat.

created_by: Option<ThreatActor>

Who created this threat.

updated_by: Option<ThreatActor>

Who last updated this threat.

created_at: Option<DateTime>

The date and time the threat was created, in UTC format.

updated_at: Option<DateTime>

The date and time the threat was last updated, in UTC format.

Implementations

impl ThreatSummary

pub fn threat_id(&self) -> Option<&str>

The unique identifier of the threat.

pub fn threat_job_id(&self) -> Option<&str>

The unique identifier of the threat model job that produced the threat.

pub fn title(&self) -> Option<&str>

A short title summarizing the threat.

pub fn statement(&self) -> Option<&str>

The natural-language threat statement.

pub fn severity(&self) -> Option<&ThreatSeverity>

The severity level of the threat.

pub fn status(&self) -> Option<&ThreatStatus>

The current status of the threat.

pub fn stride(&self) -> &[StrideCategory]

The STRIDE categories applicable to this threat.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .stride.is_none().

pub fn created_by(&self) -> Option<&ThreatActor>

Who created this threat.

pub fn updated_by(&self) -> Option<&ThreatActor>

Who last updated this threat.

pub fn created_at(&self) -> Option<&DateTime>

The date and time the threat was created, in UTC format.

pub fn updated_at(&self) -> Option<&DateTime>

The date and time the threat was last updated, in UTC format.

impl ThreatSummary

pub fn builder() -> ThreatSummaryBuilder

Creates a new builder-style object to manufacture ThreatSummary.

Trait Implementations

impl Clone for ThreatSummary

fn clone(&self) -> ThreatSummary

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ThreatSummary

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ThreatSummary

fn eq(&self, other: &ThreatSummary) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ThreatSummary