REST Resource: projects.occurrences

Resource: Occurrence

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

JSON representation 
{
  "name": string,
  "resourceUri": string,
  "noteName": string,
  "kind": enum (NoteKind),
  "remediation": string,
  "createTime": string,
  "updateTime": string,
  "envelope": {
    object (Envelope)
  },

  // Union field details can be only one of the following:
  "vulnerability": {
    object (VulnerabilityOccurrence)
  },
  "build": {
    object (BuildOccurrence)
  },
  "image": {
    object (ImageOccurrence)
  },
  "package": {
    object (PackageOccurrence)
  },
  "deployment": {
    object (DeploymentOccurrence)
  },
  "discovery": {
    object (DiscoveryOccurrence)
  },
  "attestation": {
    object (AttestationOccurrence)
  },
  "upgrade": {
    object (UpgradeOccurrence)
  },
  "compliance": {
    object (ComplianceOccurrence)
  },
  "dsseAttestation": {
    object (DSSEAttestationOccurrence)
  },
  "sbomReference": {
    object (SBOMReferenceOccurrence)
  }
  // End of list of possible types for union field details.
}
Fields
name

string

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

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.
noteName

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

enum (NoteKind)

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.
createTime

string (Timestamp format)

Output only. The time this occurrence was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. The time this occurrence was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
envelope

object (Envelope)

https://github.com/secure-systems-lab/dsse
Union field details. Required. Immutable. Describes the details of the note kind found on this resource. details can be only one of the following:
vulnerability

object (VulnerabilityOccurrence)

Describes a security vulnerability.
build

object (BuildOccurrence)

Describes a verifiable build.
image

object (ImageOccurrence)

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

object (PackageOccurrence)

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

object (DeploymentOccurrence)

Describes the deployment of an artifact on a runtime.
discovery

object (DiscoveryOccurrence)

Describes when a resource was discovered.
attestation

object (AttestationOccurrence)

Describes an attestation of an artifact.
upgrade

object (UpgradeOccurrence)

Describes an available package upgrade on the linked resource.
compliance

object (ComplianceOccurrence)

Describes a compliance violation on a linked resource.
dsseAttestation

object (DSSEAttestationOccurrence)

Describes an attestation of an artifact using dsse.
sbomReference

object (SBOMReferenceOccurrence)

Describes a specific SBOM reference occurrences.

Methods

batchCreate

 Creates new occurrences in batch.

create

 Creates a new occurrence.

delete

 Deletes the specified occurrence.

get

 Gets the specified occurrence.

getIamPolicy

 Gets the access control policy for a note or an occurrence resource.

getNotes

 Gets the note attached to the specified occurrence.

getVulnerabilitySummary

 Gets a summary of the number and severity of occurrences.

list

 Lists occurrences for the specified project.

patch

 Updates the specified occurrence.

setIamPolicy

 Sets the access control policy on the specified note or occurrence.

testIamPermissions

 Returns the permissions that a caller has on the specified note or occurrence.