occurrences_notes

Creates, updates, deletes, gets or lists an occurrences_notes resource.

Overview

Name	occurrences_notes
Type	Resource
Id	google.containeranalysis.occurrences_notes

Fields

The following fields are returned by SELECT queries:

projects_locations_occurrences_get_notes

Successful response

Name	Datatype	Description
name	string	Output only. The name of the note in the form of projects/[PROVIDER_ID]/notes/[NOTE_ID].
attestation	object	A note describing an attestation role. (id: AttestationNote)
build	object	A note describing build provenance for a verifiable build. (id: BuildNote)
compliance	object	A note describing a compliance check. (id: ComplianceNote)
createTime	string (google-datetime)	Output only. The time this note was created. This field can be used as a filter in list requests.
deployment	object	A note describing something that can be deployed. (id: DeploymentNote)
discovery	object	A note describing the initial analysis of a resource. (id: DiscoveryNote)
dsseAttestation	object	A note describing a dsse attestation note. (id: DSSEAttestationNote)
expirationTime	string (google-datetime)	Time of expiration for this note. Empty if note does not expire.
image	object	A note describing a base image. (id: ImageNote)
kind	string	Output only. The type of analysis. This field can be used as a filter in list requests.
longDescription	string	A detailed description of this note.
package	object	A note describing a package hosted by various package managers. (id: PackageNote)
relatedNoteNames	array	Other notes related to this note.
relatedUrl	array	URLs associated with this note.
sbomReference	object	A note describing an SBOM reference. (id: SBOMReferenceNote)
secret	object	A note describing a secret. (id: SecretNote)
shortDescription	string	A one sentence description of this note.
updateTime	string (google-datetime)	Output only. The time this note was last updated. This field can be used as a filter in list requests.
upgrade	object	A note describing available package upgrades. (id: UpgradeNote)
vulnerability	object	A note describing a package vulnerability. (id: VulnerabilityNote)
vulnerabilityAssessment	object	A note describing a vulnerability assessment. (id: VulnerabilityAssessmentNote)

projects_occurrences_get_notes

Successful response

Name	Datatype	Description
name	string	Output only. The name of the note in the form of projects/[PROVIDER_ID]/notes/[NOTE_ID].
attestation	object	A note describing an attestation role. (id: AttestationNote)
build	object	A note describing build provenance for a verifiable build. (id: BuildNote)
compliance	object	A note describing a compliance check. (id: ComplianceNote)
createTime	string (google-datetime)	Output only. The time this note was created. This field can be used as a filter in list requests.
deployment	object	A note describing something that can be deployed. (id: DeploymentNote)
discovery	object	A note describing the initial analysis of a resource. (id: DiscoveryNote)
dsseAttestation	object	A note describing a dsse attestation note. (id: DSSEAttestationNote)
expirationTime	string (google-datetime)	Time of expiration for this note. Empty if note does not expire.
image	object	A note describing a base image. (id: ImageNote)
kind	string	Output only. The type of analysis. This field can be used as a filter in list requests.
longDescription	string	A detailed description of this note.
package	object	A note describing a package hosted by various package managers. (id: PackageNote)
relatedNoteNames	array	Other notes related to this note.
relatedUrl	array	URLs associated with this note.
sbomReference	object	A note describing an SBOM reference. (id: SBOMReferenceNote)
secret	object	A note describing a secret. (id: SecretNote)
shortDescription	string	A one sentence description of this note.
updateTime	string (google-datetime)	Output only. The time this note was last updated. This field can be used as a filter in list requests.
upgrade	object	A note describing available package upgrades. (id: UpgradeNote)
vulnerability	object	A note describing a package vulnerability. (id: VulnerabilityNote)
vulnerabilityAssessment	object	A note describing a vulnerability assessment. (id: VulnerabilityAssessmentNote)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_occurrences_get_notes	select	projectsId, locationsId, occurrencesId		Gets the note attached to the specified occurrence. Consumer projects can use this method to get a note that belongs to a provider project.
projects_occurrences_get_notes	select	projectsId, occurrencesId		Gets the note attached to the specified occurrence. Consumer projects can use this method to get a note that belongs to a provider project.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
occurrencesId	string
projectsId	string

SELECT examples

projects_locations_occurrences_get_notes

Gets the note attached to the specified occurrence. Consumer projects can use this method to get a note that belongs to a provider project.

SELECT
name,
attestation,
build,
compliance,
createTime,
deployment,
discovery,
dsseAttestation,
expirationTime,
image,
kind,
longDescription,
package,
relatedNoteNames,
relatedUrl,
sbomReference,
secret,
shortDescription,
updateTime,
upgrade,
vulnerability,
vulnerabilityAssessment
FROM google.containeranalysis.occurrences_notes
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND occurrencesId = '{{ occurrencesId }}' -- required;

projects_occurrences_get_notes

Gets the note attached to the specified occurrence. Consumer projects can use this method to get a note that belongs to a provider project.

SELECT
name,
attestation,
build,
compliance,
createTime,
deployment,
discovery,
dsseAttestation,
expirationTime,
image,
kind,
longDescription,
package,
relatedNoteNames,
relatedUrl,
sbomReference,
secret,
shortDescription,
updateTime,
upgrade,
vulnerability,
vulnerabilityAssessment
FROM google.containeranalysis.occurrences_notes
WHERE projectsId = '{{ projectsId }}' -- required
AND occurrencesId = '{{ occurrencesId }}' -- required;