notes

Creates, updates, deletes, gets or lists a notes resource.

Overview

Name	notes
Type	Resource
Id	google.containeranalysis.notes

Fields

Name	Datatype	Description
name	string	Output only. The name of the note in the form of projects/[PROVIDER_ID]/notes/[NOTE_ID].
attestation	object	Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one Authority for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project.
build	object	Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence.
compliance	object
createTime	string	Output only. The time this note was created. This field can be used as a filter in list requests.
deployment	object	An artifact that can be deployed in some runtime.
discovery	object	A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A Discovery occurrence is created in a consumer's project at the start of analysis.
dsseAttestation	object
expirationTime	string	Time of expiration for this note. Empty if note does not expire.
image	object	Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g., a tag of the resource_url.
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	PackageNote represents a particular package version.
relatedNoteNames	array	Other notes related to this note.
relatedUrl	array	URLs associated with this note.
sbomReference	object	The note representing an SBOM reference.
shortDescription	string	A one sentence description of this note.
updateTime	string	Output only. The time this note was last updated. This field can be used as a filter in list requests.
upgrade	object	An Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be an Upgrade Note. For Windows, windows_update field represents the information related to the update.
vulnerability	object	A security vulnerability that can be found in resources.
vulnerabilityAssessment	object	A single VulnerabilityAssessmentNote represents one particular product's vulnerability assessment for one CVE.

Methods

Name	Accessible by	Required Params	Description
projects_locations_notes_get	SELECT	locationsId, notesId, projectsId	Gets the specified note.
projects_locations_notes_list	SELECT	locationsId, projectsId	Lists notes for the specified project.
projects_notes_get	SELECT	notesId, projectsId	Gets the specified note.
projects_notes_list	SELECT	projectsId	Lists notes for the specified project.
projects_locations_notes_batch_create	INSERT	locationsId, projectsId	Creates new notes in batch.
projects_locations_notes_create	INSERT	locationsId, projectsId	Creates a new note.
projects_notes_batch_create	INSERT	projectsId	Creates new notes in batch.
projects_notes_create	INSERT	projectsId	Creates a new note.
projects_locations_notes_delete	DELETE	locationsId, notesId, projectsId	Deletes the specified note.
projects_notes_delete	DELETE	notesId, projectsId	Deletes the specified note.
projects_locations_notes_patch	UPDATE	locationsId, notesId, projectsId	Updates the specified note.
projects_notes_patch	UPDATE	notesId, projectsId	Updates the specified note.

SELECT examples

Lists notes for the specified project.

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

INSERT example

Use the following StackQL query and manifest file to create a new notes resource.

All Properties

/*+ create */
INSERT INTO google.containeranalysis.notes (
projectsId,
notes
)
SELECT 
'{{ projectsId }}',
'{{ notes }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: notes
      value: object

UPDATE example

Updates a notes resource.

/*+ update */
UPDATE google.containeranalysis.notes
SET 
image = '{{ image }}',
relatedNoteNames = '{{ relatedNoteNames }}',
deployment = '{{ deployment }}',
name = '{{ name }}',
dsseAttestation = '{{ dsseAttestation }}',
build = '{{ build }}',
expirationTime = '{{ expirationTime }}',
sbomReference = '{{ sbomReference }}',
package = '{{ package }}',
discovery = '{{ discovery }}',
vulnerability = '{{ vulnerability }}',
compliance = '{{ compliance }}',
longDescription = '{{ longDescription }}',
upgrade = '{{ upgrade }}',
vulnerabilityAssessment = '{{ vulnerabilityAssessment }}',
shortDescription = '{{ shortDescription }}',
attestation = '{{ attestation }}',
relatedUrl = '{{ relatedUrl }}'
WHERE 
notesId = '{{ notesId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified notes resource.

/*+ delete */
DELETE FROM google.containeranalysis.notes
WHERE notesId = '{{ notesId }}'
AND projectsId = '{{ projectsId }}';