Grafeas V1 Client - Class Detail (0.6.0)

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

A detail for a distro and package affected by this vulnerability and its associated fix (if one is available).

Generated from protobuf message grafeas.v1.VulnerabilityNote.Detail

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ severity_name string

The distro assigned severity of this vulnerability.

↳ description string

A vendor-specific description of this vulnerability.

↳ package_type string

The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).

↳ affected_cpe_uri string

Required. The CPE URI this vulnerability affects.

↳ affected_package string

Required. The package this vulnerability affects.

↳ affected_version_start Grafeas\V1\Version

The version number at the start of an interval in which this vulnerability exists. A vulnerability can affect a package between version numbers that are disjoint sets of intervals (example: [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will be represented in its own Detail. If a specific affected version is provided by a vulnerability database, affected_version_start and affected_version_end will be the same in that Detail.

↳ affected_version_end Grafeas\V1\Version

The version number at the end of an interval in which this vulnerability exists. A vulnerability can affect a package between version numbers that are disjoint sets of intervals (example: [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will be represented in its own Detail. If a specific affected version is provided by a vulnerability database, affected_version_start and affected_version_end will be the same in that Detail.

↳ fixed_cpe_uri string

The distro recommended CPE URI to update to that contains a fix for this vulnerability. It is possible for this to be different from the affected_cpe_uri.

↳ fixed_package string

The distro recommended package to update to that contains a fix for this vulnerability. It is possible for this to be different from the affected_package.

↳ fixed_version Grafeas\V1\Version

The distro recommended version to update to that contains a fix for this vulnerability. Setting this to VersionKind.MAXIMUM means no such version is yet available.

↳ is_obsolete bool

Whether this detail is obsolete. Occurrences are expected not to point to obsolete details.

↳ source_update_time Google\Protobuf\Timestamp

The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.

↳ source string

The source from which the information in this Detail was obtained.

↳ vendor string

The name of the vendor of the product.

getSeverityName

The distro assigned severity of this vulnerability.

Returns
TypeDescription
string

setSeverityName

The distro assigned severity of this vulnerability.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDescription

A vendor-specific description of this vulnerability.

Returns
TypeDescription
string

setDescription

A vendor-specific description of this vulnerability.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPackageType

The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).

Returns
TypeDescription
string

setPackageType

The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAffectedCpeUri

Required. The CPE URI this vulnerability affects.

Returns
TypeDescription
string

setAffectedCpeUri

Required. The CPE URI this vulnerability affects.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAffectedPackage

Required. The package this vulnerability affects.

Returns
TypeDescription
string

setAffectedPackage

Required. The package this vulnerability affects.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAffectedVersionStart

The version number at the start of an interval in which this vulnerability exists. A vulnerability can affect a package between version numbers that are disjoint sets of intervals (example: [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will be represented in its own Detail. If a specific affected version is provided by a vulnerability database, affected_version_start and affected_version_end will be the same in that Detail.

Returns
TypeDescription
Grafeas\V1\Version|null

hasAffectedVersionStart

clearAffectedVersionStart

setAffectedVersionStart

The version number at the start of an interval in which this vulnerability exists. A vulnerability can affect a package between version numbers that are disjoint sets of intervals (example: [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will be represented in its own Detail. If a specific affected version is provided by a vulnerability database, affected_version_start and affected_version_end will be the same in that Detail.

Parameter
NameDescription
var Grafeas\V1\Version
Returns
TypeDescription
$this

getAffectedVersionEnd

The version number at the end of an interval in which this vulnerability exists. A vulnerability can affect a package between version numbers that are disjoint sets of intervals (example: [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will be represented in its own Detail. If a specific affected version is provided by a vulnerability database, affected_version_start and affected_version_end will be the same in that Detail.

Returns
TypeDescription
Grafeas\V1\Version|null

hasAffectedVersionEnd

clearAffectedVersionEnd

setAffectedVersionEnd

The version number at the end of an interval in which this vulnerability exists. A vulnerability can affect a package between version numbers that are disjoint sets of intervals (example: [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will be represented in its own Detail. If a specific affected version is provided by a vulnerability database, affected_version_start and affected_version_end will be the same in that Detail.

Parameter
NameDescription
var Grafeas\V1\Version
Returns
TypeDescription
$this

getFixedCpeUri

The distro recommended CPE URI to update to that contains a fix for this vulnerability. It is possible for this to be different from the affected_cpe_uri.

Returns
TypeDescription
string

setFixedCpeUri

The distro recommended CPE URI to update to that contains a fix for this vulnerability. It is possible for this to be different from the affected_cpe_uri.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFixedPackage

The distro recommended package to update to that contains a fix for this vulnerability. It is possible for this to be different from the affected_package.

Returns
TypeDescription
string

setFixedPackage

The distro recommended package to update to that contains a fix for this vulnerability. It is possible for this to be different from the affected_package.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFixedVersion

The distro recommended version to update to that contains a fix for this vulnerability. Setting this to VersionKind.MAXIMUM means no such version is yet available.

Returns
TypeDescription
Grafeas\V1\Version|null

hasFixedVersion

clearFixedVersion

setFixedVersion

The distro recommended version to update to that contains a fix for this vulnerability. Setting this to VersionKind.MAXIMUM means no such version is yet available.

Parameter
NameDescription
var Grafeas\V1\Version
Returns
TypeDescription
$this

getIsObsolete

Whether this detail is obsolete. Occurrences are expected not to point to obsolete details.

Returns
TypeDescription
bool

setIsObsolete

Whether this detail is obsolete. Occurrences are expected not to point to obsolete details.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getSourceUpdateTime

The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasSourceUpdateTime

clearSourceUpdateTime

setSourceUpdateTime

The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getSource

The source from which the information in this Detail was obtained.

Returns
TypeDescription
string

setSource

The source from which the information in this Detail was obtained.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getVendor

The name of the vendor of the product.

Returns
TypeDescription
string

setVendor

The name of the vendor of the product.

Parameter
NameDescription
var string
Returns
TypeDescription
$this