Struct CodeScanningUploadSarifRequest

pub struct CodeScanningUploadSarifRequest {
    pub commit_sha: String,
    pub ref: String,
    pub sarif: String,
    pub checkout_uri: Option<String>,
    pub started_at: Option<String>,
    pub tool_name: Option<String>,
    pub validate: Option<bool>,
}

Fields

commit_sha: String

The SHA of the commit to which the analysis you are uploading relates.

ref: String

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

sarif: String

A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see "SARIF support for code scanning."

checkout_uri: Option<String>

The base directory used in the analysis, as it appears in the SARIF file. This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.

started_at: Option<String>

The time that the analysis run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

tool_name: Option<String>

The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to "API". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the tool_guid parameter of operations such as GET /repos/{owner}/{repo}/code-scanning/alerts.

validate: Option<bool>

Whether the SARIF file will be validated according to the code scanning specifications. This parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning.

Implementations

impl CodeScanningUploadSarifRequest

pub fn new( commit_sha: String, ref: String, sarif: String, ) -> CodeScanningUploadSarifRequest

Trait Implementations

impl Clone for CodeScanningUploadSarifRequest

fn clone(&self) -> CodeScanningUploadSarifRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodeScanningUploadSarifRequest

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

Formats the value using the given formatter.

impl Default for CodeScanningUploadSarifRequest

fn default() -> CodeScanningUploadSarifRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CodeScanningUploadSarifRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CodeScanningUploadSarifRequest

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

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 CodeScanningUploadSarifRequest