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
Namespace
Grafeas \ V1 \ VulnerabilityAssessmentNoteMethods
__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. |
↳ 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 |
Assessment\Justification
Justification provides the justification when the state of the assessment if NOT_AFFECTED. |
↳ remediations |
array<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.
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 |
|
getShortDescription
A one sentence description of this Vex.
| Returns | |
|---|---|
| Type | Description |
string |
|
setShortDescription
A one sentence description of this Vex.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLongDescription
A detailed description of this Vex.
| Returns | |
|---|---|
| Type | Description |
string |
|
setLongDescription
A detailed description of this Vex.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
array<Grafeas\V1\RelatedUrl>
|
| 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 |
|
getJustification
Justification provides the justification when the state of the assessment if NOT_AFFECTED.
| Returns | |
|---|---|
| Type | Description |
Assessment\Justification|null |
|
hasJustification
clearJustification
setJustification
Justification provides the justification when the state of the assessment if NOT_AFFECTED.
| Parameter | |
|---|---|
| Name | Description |
var |
Assessment\Justification
|
| 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<Assessment\Remediation>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|