Grafeas V1 Client - Class Occurrence (1.1.2)

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

An instance of an analysis type that has been found on a resource.

Generated from protobuf message grafeas.v1.Occurrence

Namespace

Grafeas \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Output only. The name of the occurrence in the form of projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID].
↳ resource_uri string

Required. Immutable. A URI that represents the resource for which the occurrence applies. For example, https://gcr.io/project/image@sha256:123abc for a Docker image.
↳ note_name string

Required. Immutable. The analysis note associated with this occurrence, in the form of projects/[PROVIDER_ID]/notes/[NOTE_ID]. This field can be used as a filter in list requests.
↳ kind int

Output only. This explicitly denotes which of the occurrence details are specified. This field can be used as a filter in list requests.
↳ remediation string

A description of actions that can be taken to remedy the note.
↳ create_time Google\Protobuf\Timestamp

Output only. The time this occurrence was created.
↳ update_time Google\Protobuf\Timestamp

Output only. The time this occurrence was last updated.
↳ vulnerability VulnerabilityOccurrence

Describes a security vulnerability.
↳ build BuildOccurrence

Describes a verifiable build.
↳ image ImageOccurrence

Describes how this resource derives from the basis in the associated note.
↳ package PackageOccurrence

Describes the installation of a package on the linked resource.
↳ deployment DeploymentOccurrence

Describes the deployment of an artifact on a runtime.
↳ discovery DiscoveryOccurrence

Describes when a resource was discovered.
↳ attestation AttestationOccurrence

Describes an attestation of an artifact.
↳ upgrade UpgradeOccurrence

Describes an available package upgrade on the linked resource.
↳ compliance ComplianceOccurrence

Describes a compliance violation on a linked resource.
↳ dsse_attestation DSSEAttestationOccurrence

Describes an attestation of an artifact using dsse.
↳ sbom_reference SBOMReferenceOccurrence

Describes a specific SBOM reference occurrences.
↳ envelope Envelope

https://github.com/secure-systems-lab/dsse

getName

Output only. The name of the occurrence in the form of projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID].

Returns
Type Description
string

setName

Output only. The name of the occurrence in the form of projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID].

Parameter
Name Description
var string
Returns
Type Description
$this

getResourceUri

Required. Immutable. A URI that represents the resource for which the occurrence applies. For example, https://gcr.io/project/image@sha256:123abc for a Docker image.

Returns
Type Description
string

setResourceUri

Required. Immutable. A URI that represents the resource for which the occurrence applies. For example, https://gcr.io/project/image@sha256:123abc for a Docker image.

Parameter
Name Description
var string
Returns
Type Description
$this

getNoteName

Required. Immutable. The analysis note associated with this occurrence, in the form of projects/[PROVIDER_ID]/notes/[NOTE_ID]. This field can be used as a filter in list requests.

Returns
Type Description
string

setNoteName

Required. Immutable. The analysis note associated with this occurrence, in the form of projects/[PROVIDER_ID]/notes/[NOTE_ID]. This field can be used as a filter in list requests.

Parameter
Name Description
var string
Returns
Type Description
$this

getKind

Output only. This explicitly denotes which of the occurrence details are specified. This field can be used as a filter in list requests.

Returns
Type Description
int

setKind

Output only. This explicitly denotes which of the occurrence details are specified. This field can be used as a filter in list requests.

Parameter
Name Description
var int
Returns
Type Description
$this

getRemediation

A description of actions that can be taken to remedy the note.

Returns
Type Description
string

setRemediation

A description of actions that can be taken to remedy the note.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. The time this occurrence was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time this occurrence was created.

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

getUpdateTime

Output only. The time this occurrence was last updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time this occurrence was last updated.

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

getVulnerability

Describes a security vulnerability.

Returns
Type Description
VulnerabilityOccurrence|null

hasVulnerability

setVulnerability

Describes a security vulnerability.

Parameter
Name Description
var VulnerabilityOccurrence
Returns
Type Description
$this

getBuild

Describes a verifiable build.

Returns
Type Description
BuildOccurrence|null

hasBuild

setBuild

Describes a verifiable build.

Parameter
Name Description
var BuildOccurrence
Returns
Type Description
$this

getImage

Describes how this resource derives from the basis in the associated note.

Returns
Type Description
ImageOccurrence|null

hasImage

setImage

Describes how this resource derives from the basis in the associated note.

Parameter
Name Description
var ImageOccurrence
Returns
Type Description
$this

getPackage

Describes the installation of a package on the linked resource.

Returns
Type Description
PackageOccurrence|null

hasPackage

setPackage

Describes the installation of a package on the linked resource.

Parameter
Name Description
var PackageOccurrence
Returns
Type Description
$this

getDeployment

Describes the deployment of an artifact on a runtime.

Returns
Type Description
DeploymentOccurrence|null

hasDeployment

setDeployment

Describes the deployment of an artifact on a runtime.

Parameter
Name Description
var DeploymentOccurrence
Returns
Type Description
$this

getDiscovery

Describes when a resource was discovered.

Returns
Type Description
DiscoveryOccurrence|null

hasDiscovery

setDiscovery

Describes when a resource was discovered.

Parameter
Name Description
var DiscoveryOccurrence
Returns
Type Description
$this

getAttestation

Describes an attestation of an artifact.

Returns
Type Description
AttestationOccurrence|null

hasAttestation

setAttestation

Describes an attestation of an artifact.

Parameter
Name Description
var AttestationOccurrence
Returns
Type Description
$this

getUpgrade

Describes an available package upgrade on the linked resource.

Returns
Type Description
UpgradeOccurrence|null

hasUpgrade

setUpgrade

Describes an available package upgrade on the linked resource.

Parameter
Name Description
var UpgradeOccurrence
Returns
Type Description
$this

getCompliance

Describes a compliance violation on a linked resource.

Returns
Type Description
ComplianceOccurrence|null

hasCompliance

setCompliance

Describes a compliance violation on a linked resource.

Parameter
Name Description
var ComplianceOccurrence
Returns
Type Description
$this

getDsseAttestation

Describes an attestation of an artifact using dsse.

Returns
Type Description
DSSEAttestationOccurrence|null

hasDsseAttestation

setDsseAttestation

Describes an attestation of an artifact using dsse.

Parameter
Name Description
var DSSEAttestationOccurrence
Returns
Type Description
$this

getSbomReference

Describes a specific SBOM reference occurrences.

Returns
Type Description
SBOMReferenceOccurrence|null

hasSbomReference

setSbomReference

Describes a specific SBOM reference occurrences.

Parameter
Name Description
var SBOMReferenceOccurrence
Returns
Type Description
$this

getEnvelope

https://github.com/secure-systems-lab/dsse

Returns
Type Description
Envelope|null

hasEnvelope

clearEnvelope

setEnvelope

https://github.com/secure-systems-lab/dsse

Parameter
Name Description
var Envelope
Returns
Type Description
$this

getDetails

Returns
Type Description
string