Struct AlertInstance

pub struct AlertInstance {
    pub analysis_key: String,
    pub classifications: Vec<String>,
    pub commit_sha: Option<String>,
    pub environment: String,
    pub location: Option<AlertInstanceLocation>,
    pub message: Option<AlertInstanceMessage>,
    pub ref_: String,
    pub state: AlertInstanceState,
}

AlertInstance

JSON schema

{
 "title": "Alert Instance",
 "type": "object",
 "required": [
   "analysis_key",
   "environment",
   "ref",
   "state"
 ],
 "properties": {
   "analysis_key": {
     "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.",
     "type": "string"
   },
   "classifications": {
     "type": "array",
     "items": {
       "type": "string"
     }
   },
   "commit_sha": {
     "type": "string"
   },
   "environment": {
     "description": "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.",
     "type": "string"
   },
   "location": {
     "type": "object",
     "properties": {
       "end_column": {
         "type": "integer"
       },
       "end_line": {
         "type": "integer"
       },
       "path": {
         "type": "string"
       },
       "start_column": {
         "type": "integer"
       },
       "start_line": {
         "type": "integer"
       }
     },
     "additionalProperties": false
   },
   "message": {
     "type": "object",
     "properties": {
       "text": {
         "type": "string"
       }
     },
     "additionalProperties": false
   },
   "ref": {
     "description": "The full Git reference, formatted as `refs/heads/<branch name>`.",
     "type": "string"
   },
   "state": {
     "description": "State of a code scanning alert.",
     "type": "string",
     "enum": [
       "open",
       "dismissed",
       "fixed"
     ]
   }
 },
 "additionalProperties": false,
 "$schema": "http://json-schema.org/draft-07/schema"
}

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.

classifications: 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<AlertInstanceLocation>

message: Option<AlertInstanceMessage>

ref_: String

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

state: AlertInstanceState

State of a code scanning alert.

Implementations

impl AlertInstance

pub fn builder() -> 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<'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 From<&AlertInstance> for AlertInstance

fn from(value: &AlertInstance) -> Self

Converts to this type from the input type.

impl From<AlertInstance> for AlertInstance

fn from(value: AlertInstance) -> Self

Converts to this type from the input type.

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 TryFrom<AlertInstance> for AlertInstance

type Error = String

The type returned in the event of a conversion error.

fn try_from(value: AlertInstance) -> Result<Self, String>

Performs the conversion.