Grafeas V1 Client - Class DiscoveryOccurrence (1.0.0)

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

Provides information about the analysis status of a discovered resource.

Generated from protobuf message grafeas.v1.DiscoveryOccurrence

Namespace

Grafeas \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ continuous_analysis int

Whether the resource is continuously analyzed.

↳ analysis_status int

The status of discovery for the resource.

↳ analysis_completed Grafeas\V1\DiscoveryOccurrence\AnalysisCompleted
↳ analysis_error array<Google\Rpc\Status>

Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors.

↳ analysis_status_error Google\Rpc\Status

When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API.

↳ cpe string

The CPE of the resource being scanned.

↳ last_scan_time Google\Protobuf\Timestamp

The last time this resource was scanned.

↳ archive_time Google\Protobuf\Timestamp

The time occurrences related to this discovery occurrence were archived.

↳ sbom_status Grafeas\V1\DiscoveryOccurrence\SBOMStatus

The status of an SBOM generation.

getContinuousAnalysis

Whether the resource is continuously analyzed.

Returns
Type Description
int

setContinuousAnalysis

Whether the resource is continuously analyzed.

Parameter
Name Description
var int
Returns
Type Description
$this

getAnalysisStatus

The status of discovery for the resource.

Returns
Type Description
int

setAnalysisStatus

The status of discovery for the resource.

Parameter
Name Description
var int
Returns
Type Description
$this

getAnalysisCompleted

Generated from protobuf field .grafeas.v1.DiscoveryOccurrence.AnalysisCompleted analysis_completed = 7;

Returns
Type Description
Grafeas\V1\DiscoveryOccurrence\AnalysisCompleted|null

hasAnalysisCompleted

clearAnalysisCompleted

setAnalysisCompleted

Generated from protobuf field .grafeas.v1.DiscoveryOccurrence.AnalysisCompleted analysis_completed = 7;

Parameter
Name Description
var Grafeas\V1\DiscoveryOccurrence\AnalysisCompleted
Returns
Type Description
$this

getAnalysisError

Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setAnalysisError

Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors.

Parameter
Name Description
var array<Google\Rpc\Status>
Returns
Type Description
$this

getAnalysisStatusError

When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API.

Returns
Type Description
Google\Rpc\Status|null

hasAnalysisStatusError

clearAnalysisStatusError

setAnalysisStatusError

When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API.

Parameter
Name Description
var Google\Rpc\Status
Returns
Type Description
$this

getCpe

The CPE of the resource being scanned.

Returns
Type Description
string

setCpe

The CPE of the resource being scanned.

Parameter
Name Description
var string
Returns
Type Description
$this

getLastScanTime

The last time this resource was scanned.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasLastScanTime

clearLastScanTime

setLastScanTime

The last time this resource was scanned.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getArchiveTime

The time occurrences related to this discovery occurrence were archived.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasArchiveTime

clearArchiveTime

setArchiveTime

The time occurrences related to this discovery occurrence were archived.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getSbomStatus

The status of an SBOM generation.

Returns
Type Description
Grafeas\V1\DiscoveryOccurrence\SBOMStatus|null

hasSbomStatus

clearSbomStatus

setSbomStatus

The status of an SBOM generation.

Parameter
Name Description
var Grafeas\V1\DiscoveryOccurrence\SBOMStatus
Returns
Type Description
$this