Struct CodeScanningAlertInstance

pub struct CodeScanningAlertInstance {
    pub ref: Option<String>,
    pub analysis_key: Option<String>,
    pub environment: Option<String>,
    pub category: Option<String>,
    pub state: Option<CodeScanningAlertState>,
    pub commit_sha: Option<String>,
    pub message: Option<Box<CodeScanningAlertInstanceMessage>>,
    pub location: Option<Box<CodeScanningAlertLocation>>,
    pub html_url: Option<String>,
    pub classifications: Option<Vec<CodeScanningAlertClassification>>,
}

Fields

ref: Option<String>

The Git reference, formatted as refs/pull/<number>/merge, refs/pull/<number>/head, refs/heads/<branch name> or simply <branch name>.

analysis_key: Option<String>

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

environment: Option<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.

category: Option<String>

Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code.

state: Option<CodeScanningAlertState>

commit_sha: Option<String>

message: Option<Box<CodeScanningAlertInstanceMessage>>

location: Option<Box<CodeScanningAlertLocation>>

html_url: Option<String>

classifications: Option<Vec<CodeScanningAlertClassification>>

Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file.

Implementations

impl CodeScanningAlertInstance

pub fn new() -> CodeScanningAlertInstance

Trait Implementations

impl Clone for CodeScanningAlertInstance

fn clone(&self) -> CodeScanningAlertInstance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodeScanningAlertInstance

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

Formats the value using the given formatter.

impl Default for CodeScanningAlertInstance

fn default() -> CodeScanningAlertInstance

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CodeScanningAlertInstance

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CodeScanningAlertInstance

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

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 CodeScanningAlertInstance