Grafeas V1 Client - Class Assessment (0.6.0)

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

Assessment provides all information that is related to a single vulnerability for this product.

Generated from protobuf message grafeas.v1.VulnerabilityAssessmentNote.Assessment

Methods

__construct

Constructor.

Parameters
NameDescription
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.

↳ short_description string

A one sentence description of this Vex.

↳ long_description string

A detailed description of this Vex.

↳ related_uris array<Grafeas\V1\RelatedUrl>

Holds a list of references associated with this vulnerability item and assessment. These uris have additional information about the vulnerability and the assessment itself. E.g. Link to a document which details how this assessment concluded the state of this vulnerability.

↳ state int

Provides the state of this Vulnerability assessment.

↳ impacts array

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

↳ justification Grafeas\V1\VulnerabilityAssessmentNote\Assessment\Justification

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

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

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

getCve

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

Returns
TypeDescription
string

setCve

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getShortDescription

A one sentence description of this Vex.

Returns
TypeDescription
string

setShortDescription

A one sentence description of this Vex.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getLongDescription

A detailed description of this Vex.

Returns
TypeDescription
string

setLongDescription

A detailed description of this Vex.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRelatedUris

Holds a list of references associated with this vulnerability item and assessment. These uris have additional information about the vulnerability and the assessment itself. E.g. Link to a document which details how this assessment concluded the state of this vulnerability.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setRelatedUris

Holds a list of references associated with this vulnerability item and assessment. These uris have additional information about the vulnerability and the assessment itself. E.g. Link to a document which details how this assessment concluded the state of this vulnerability.

Parameter
NameDescription
var array<Grafeas\V1\RelatedUrl>
Returns
TypeDescription
$this

getState

Provides the state of this Vulnerability assessment.

Returns
TypeDescription
int

setState

Provides the state of this Vulnerability assessment.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getImpacts

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setImpacts

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

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getJustification

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

Returns
TypeDescription
Grafeas\V1\VulnerabilityAssessmentNote\Assessment\Justification|null

hasJustification

clearJustification

setJustification

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

Parameter
NameDescription
var Grafeas\V1\VulnerabilityAssessmentNote\Assessment\Justification
Returns
TypeDescription
$this

getRemediations

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setRemediations

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

Parameter
NameDescription
var array<Grafeas\V1\VulnerabilityAssessmentNote\Assessment\Remediation>
Returns
TypeDescription
$this