Struct Finding 

#[non_exhaustive]
pub struct Finding {

    pub finding_id: String,
    pub agent_space_id: String,
    pub pentest_id: Option<String>,
    pub pentest_job_id: Option<String>,
    pub code_review_id: Option<String>,
    pub code_review_job_id: Option<String>,
    pub task_id: Option<String>,
    pub name: Option<String>,
    pub description: Option<String>,
    pub status: Option<FindingStatus>,
    pub risk_type: Option<String>,
    pub risk_level: Option<RiskLevel>,
    pub risk_score: Option<String>,
    pub reasoning: Option<String>,
    pub confidence: Option<ConfidenceLevel>,
    pub attack_script: Option<String>,
    pub code_remediation_task: Option<CodeRemediationTask>,
    pub last_updated_by: Option<String>,
    pub code_locations: Option<Vec<CodeLocation>>,
    pub created_at: Option<DateTime>,
    pub updated_at: Option<DateTime>,
}

Represents a security finding discovered during a pentest job. A finding contains details about a vulnerability, including its risk level, confidence, and remediation status.

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.

finding_id: String

The unique identifier of the finding.

agent_space_id: String

The unique identifier of the agent space associated with the finding.

pentest_id: Option<String>

The unique identifier of the pentest associated with the finding.

pentest_job_id: Option<String>

The unique identifier of the pentest job that produced the finding.

code_review_id: Option<String>

The unique identifier of the code review associated with the finding.

code_review_job_id: Option<String>

The unique identifier of the code review job that produced the finding.

task_id: Option<String>

The unique identifier of the task that produced the finding.

name: Option<String>

The name of the finding.

description: Option<String>

A description of the finding.

status: Option<FindingStatus>

The current status of the finding. Valid values include ACTIVE, RESOLVED, ACCEPTED, and FALSE_POSITIVE.

risk_type: Option<String>

The type of security risk identified by the finding.

risk_level: Option<RiskLevel>

The risk level of the finding. Valid values include UNKNOWN, INFORMATIONAL, LOW, MEDIUM, HIGH, and CRITICAL.

risk_score: Option<String>

The numerical risk score of the finding.

reasoning: Option<String>

The reasoning behind the finding, explaining why it was identified as a vulnerability.

confidence: Option<ConfidenceLevel>

The confidence level of the finding. Valid values include FALSE_POSITIVE, UNCONFIRMED, LOW, MEDIUM, and HIGH.

attack_script: Option<String>

The attack script used to reproduce the finding.

code_remediation_task: Option<CodeRemediationTask>

The code remediation task associated with the finding, if code remediation was initiated.

last_updated_by: Option<String>

The identifier of the entity that last updated the finding.

code_locations: Option<Vec<CodeLocation>>

The file locations involved in the vulnerability, as reported by the code scanner.

created_at: Option<DateTime>

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

updated_at: Option<DateTime>

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

Implementations

impl Finding

pub fn finding_id(&self) -> &str

The unique identifier of the finding.

pub fn agent_space_id(&self) -> &str

The unique identifier of the agent space associated with the finding.

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

The unique identifier of the pentest associated with the finding.

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

The unique identifier of the pentest job that produced the finding.

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

The unique identifier of the code review associated with the finding.

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

The unique identifier of the code review job that produced the finding.

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

The unique identifier of the task that produced the finding.

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

The name of the finding.

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

A description of the finding.

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

The current status of the finding. Valid values include ACTIVE, RESOLVED, ACCEPTED, and FALSE_POSITIVE.

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

The type of security risk identified by the finding.

pub fn risk_level(&self) -> Option<&RiskLevel>

The risk level of the finding. Valid values include UNKNOWN, INFORMATIONAL, LOW, MEDIUM, HIGH, and CRITICAL.

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

The numerical risk score of the finding.

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

The reasoning behind the finding, explaining why it was identified as a vulnerability.

pub fn confidence(&self) -> Option<&ConfidenceLevel>

The confidence level of the finding. Valid values include FALSE_POSITIVE, UNCONFIRMED, LOW, MEDIUM, and HIGH.

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

The attack script used to reproduce the finding.

pub fn code_remediation_task(&self) -> Option<&CodeRemediationTask>

The code remediation task associated with the finding, if code remediation was initiated.

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

The identifier of the entity that last updated the finding.

pub fn code_locations(&self) -> &[CodeLocation]

The file locations involved in the vulnerability, as reported by the code scanner.

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

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

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

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

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

impl Finding

pub fn builder() -> FindingBuilder

Creates a new builder-style object to manufacture Finding.

Trait Implementations

impl Clone for Finding

fn clone(&self) -> Finding

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Finding

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

Formats the value using the given formatter.

impl PartialEq for Finding

fn eq(&self, other: &Finding) -> 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 Finding