Struct SnapshotJob

pub struct SnapshotJob {
    pub id: String,
    pub correlator: String,
    pub html_url: Option<String>,
}

Fields

id: String

The external ID of the job.

correlator: String

Correlator provides a key that is used to group snapshots submitted over time. Only the "latest" submitted snapshot for a given combination of job.correlator and detector.name will be considered when calculating a repository’s current dependencies. Correlator should be as unique as it takes to distinguish all detection runs for a given "wave" of CI workflow you run. If you’re using GitHub Actions, a good default value for this could be the environment variables GITHUB_WORKFLOW and GITHUB_JOB concatenated together. If you’re using a build matrix, then you’ll also need to add additional key(s) to distinguish between each submission inside a matrix variation.

html_url: Option<String>

The url for the job.

Implementations

impl SnapshotJob

pub fn new(id: String, correlator: String) -> SnapshotJob

Trait Implementations

impl Clone for SnapshotJob

fn clone(&self) -> SnapshotJob

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SnapshotJob

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

Formats the value using the given formatter.

impl Default for SnapshotJob

fn default() -> SnapshotJob

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SnapshotJob

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SnapshotJob

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

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 SnapshotJob