Grafeas V1 Client - Class VexAssessment (1.1.0)

Reference documentation and code samples for the Grafeas V1 Client class VexAssessment.

VexAssessment provides all publisher provided Vex information that is related to this vulnerability.

Generated from protobuf message grafeas.v1.VulnerabilityOccurrence.VexAssessment

Namespace

Grafeas \ V1 \ VulnerabilityOccurrence

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ cve string

Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) tracking number for the vulnerability. Deprecated: Use vulnerability_id instead to denote CVEs.

↳ vulnerability_id string

The vulnerability identifier for this Assessment. Will hold one of common identifiers e.g. CVE, GHSA etc.

↳ related_uris array<Grafeas\V1\RelatedUrl>

Holds a list of references associated with this vulnerability item and assessment.

↳ note_name string

The VulnerabilityAssessment note from which this VexAssessment was generated. This will be of the form: projects/[PROJECT_ID]/notes/[NOTE_ID]. (-- api-linter: core::0122::name-suffix=disabled aip.dev/not-precedent: The suffix is kept for consistency. --)

↳ state int

Provides the state of this Vulnerability assessment.

↳ impacts array

Contains information about the impact of this vulnerability, this will change with time.

↳ remediations array<Grafeas\V1\VulnerabilityAssessmentNote\Assessment\Remediation>

Specifies details on how to handle (and presumably, fix) a vulnerability.

↳ justification Grafeas\V1\VulnerabilityAssessmentNote\Assessment\Justification

Justification provides the justification when the state of the assessment if NOT_AFFECTED.

getCve

Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) tracking number for the vulnerability.

Deprecated: Use vulnerability_id instead to denote CVEs.

Returns
Type Description
string

setCve

Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) tracking number for the vulnerability.

Deprecated: Use vulnerability_id instead to denote CVEs.

Parameter
Name Description
var string
Returns
Type Description
$this

getVulnerabilityId

The vulnerability identifier for this Assessment. Will hold one of common identifiers e.g. CVE, GHSA etc.

Returns
Type Description
string

setVulnerabilityId

The vulnerability identifier for this Assessment. Will hold one of common identifiers e.g. CVE, GHSA etc.

Parameter
Name Description
var string
Returns
Type Description
$this

getRelatedUris

Holds a list of references associated with this vulnerability item and assessment.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setRelatedUris

Holds a list of references associated with this vulnerability item and assessment.

Parameter
Name Description
var array<Grafeas\V1\RelatedUrl>
Returns
Type Description
$this

getNoteName

The VulnerabilityAssessment note from which this VexAssessment was generated.

This will be of the form: projects/[PROJECT_ID]/notes/[NOTE_ID]. (-- api-linter: core::0122::name-suffix=disabled aip.dev/not-precedent: The suffix is kept for consistency. --)

Returns
Type Description
string

setNoteName

The VulnerabilityAssessment note from which this VexAssessment was generated.

This will be of the form: projects/[PROJECT_ID]/notes/[NOTE_ID]. (-- api-linter: core::0122::name-suffix=disabled aip.dev/not-precedent: The suffix is kept for consistency. --)

Parameter
Name Description
var string
Returns
Type Description
$this

getState

Provides the state of this Vulnerability assessment.

Returns
Type Description
int

setState

Provides the state of this Vulnerability assessment.

Parameter
Name Description
var int
Returns
Type Description
$this

getImpacts

Contains information about the impact of this vulnerability, this will change with time.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setImpacts

Contains information about the impact of this vulnerability, this will change with time.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getRemediations

Specifies details on how to handle (and presumably, fix) a vulnerability.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setRemediations

Specifies details on how to handle (and presumably, fix) a vulnerability.

Parameter
Name Description
var array<Grafeas\V1\VulnerabilityAssessmentNote\Assessment\Remediation>
Returns
Type Description
$this

getJustification

Justification provides the justification when the state of the assessment if NOT_AFFECTED.

Returns
Type Description
Grafeas\V1\VulnerabilityAssessmentNote\Assessment\Justification|null

hasJustification

clearJustification

setJustification

Justification provides the justification when the state of the assessment if NOT_AFFECTED.

Parameter
Name Description
var Grafeas\V1\VulnerabilityAssessmentNote\Assessment\Justification
Returns
Type Description
$this