Struct AlertInstance

pub struct AlertInstance {
    pub analysis_key: String,
    pub category: Option<String>,
    pub classifications: Option<Vec<String>>,
    pub commit_sha: Option<String>,
    pub environment: String,
    pub location: Option<Box<AlertInstanceLocation>>,
    pub message: Option<Box<CodeScanningAlertInstanceMessage>>,
    pub ref: String,
    pub state: State,
}

Fields

analysis_key: String

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

category: Option<String>

Identifies the configuration under which the analysis was executed.

classifications: Option<Vec<String>>

commit_sha: Option<String>

environment: String

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

location: Option<Box<AlertInstanceLocation>>

message: Option<Box<CodeScanningAlertInstanceMessage>>

ref: String

The full Git reference, formatted as refs/heads/<branch name>.

state: State

State of a code scanning alert.

Implementations

impl AlertInstance

pub fn new( analysis_key: String, environment: String, ref: String, state: State, ) -> AlertInstance

Trait Implementations

impl Clone for AlertInstance

fn clone(&self) -> AlertInstance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AlertInstance

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

Formats the value using the given formatter.

impl Default for AlertInstance

fn default() -> AlertInstance

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AlertInstance

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AlertInstance

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AlertInstance