notes

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

Overview

Name	notes
Type	Resource
Id	google.containeranalysis.notes

Fields

The following fields are returned by SELECT queries:

projects_locations_notes_get

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_locations_notes_list

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_notes_get

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_notes_list

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_notes_get	select	projectsId, locationsId, notesId		Gets the specified note.
projects_locations_notes_list	select	projectsId, locationsId	filter, pageSize, pageToken, returnPartialSuccess	Lists notes for the specified project.
projects_notes_get	select	projectsId, notesId		Gets the specified note.
projects_notes_list	select	projectsId	filter, pageSize, pageToken, returnPartialSuccess	Lists notes for the specified project.
projects_locations_notes_create	insert	projectsId, locationsId	noteId	Creates a new note.
projects_locations_notes_batch_create	insert	projectsId, locationsId		Creates new notes in batch.
projects_notes_create	insert	projectsId	noteId	Creates a new note.
projects_notes_batch_create	insert	projectsId		Creates new notes in batch.
projects_locations_notes_patch	update	projectsId, locationsId, notesId	updateMask	Updates the specified note.
projects_notes_patch	update	projectsId, notesId	updateMask	Updates the specified note.
projects_locations_notes_delete	delete	projectsId, locationsId, notesId		Deletes the specified note.
projects_notes_delete	delete	projectsId, notesId		Deletes the specified note.

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
notesId	string
projectsId	string
filter	string
noteId	string
pageSize	integer (int32)
pageToken	string
returnPartialSuccess	boolean
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_notes_get

Gets the specified note.

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.notes
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND notesId = '{{ notesId }}' -- required;

projects_locations_notes_list

Lists notes for the specified 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.notes
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}';

projects_notes_get

Gets the specified note.

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.notes
WHERE projectsId = '{{ projectsId }}' -- required
AND notesId = '{{ notesId }}' -- required;

projects_notes_list

Lists notes for the specified 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.notes
WHERE projectsId = '{{ projectsId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}';

INSERT examples

projects_locations_notes_create

Creates a new note.

INSERT INTO google.containeranalysis.notes (
data__name,
data__shortDescription,
data__longDescription,
data__kind,
data__relatedUrl,
data__expirationTime,
data__createTime,
data__updateTime,
data__relatedNoteNames,
data__vulnerability,
data__build,
data__image,
data__package,
data__deployment,
data__discovery,
data__attestation,
data__upgrade,
data__compliance,
data__dsseAttestation,
data__vulnerabilityAssessment,
data__sbomReference,
data__secret,
projectsId,
locationsId,
noteId
)
SELECT 
'{{ name }}',
'{{ shortDescription }}',
'{{ longDescription }}',
'{{ kind }}',
'{{ relatedUrl }}',
'{{ expirationTime }}',
'{{ createTime }}',
'{{ updateTime }}',
'{{ relatedNoteNames }}',
'{{ vulnerability }}',
'{{ build }}',
'{{ image }}',
'{{ package }}',
'{{ deployment }}',
'{{ discovery }}',
'{{ attestation }}',
'{{ upgrade }}',
'{{ compliance }}',
'{{ dsseAttestation }}',
'{{ vulnerabilityAssessment }}',
'{{ sbomReference }}',
'{{ secret }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ noteId }}'
RETURNING
name,
attestation,
build,
compliance,
createTime,
deployment,
discovery,
dsseAttestation,
expirationTime,
image,
kind,
longDescription,
package,
relatedNoteNames,
relatedUrl,
sbomReference,
secret,
shortDescription,
updateTime,
upgrade,
vulnerability,
vulnerabilityAssessment
;

projects_locations_notes_batch_create

Creates new notes in batch.

INSERT INTO google.containeranalysis.notes (
data__notes,
projectsId,
locationsId
)
SELECT 
'{{ notes }}',
'{{ projectsId }}',
'{{ locationsId }}'
RETURNING
notes
;

projects_notes_create

Creates a new note.

INSERT INTO google.containeranalysis.notes (
data__name,
data__shortDescription,
data__longDescription,
data__kind,
data__relatedUrl,
data__expirationTime,
data__createTime,
data__updateTime,
data__relatedNoteNames,
data__vulnerability,
data__build,
data__image,
data__package,
data__deployment,
data__discovery,
data__attestation,
data__upgrade,
data__compliance,
data__dsseAttestation,
data__vulnerabilityAssessment,
data__sbomReference,
data__secret,
projectsId,
noteId
)
SELECT 
'{{ name }}',
'{{ shortDescription }}',
'{{ longDescription }}',
'{{ kind }}',
'{{ relatedUrl }}',
'{{ expirationTime }}',
'{{ createTime }}',
'{{ updateTime }}',
'{{ relatedNoteNames }}',
'{{ vulnerability }}',
'{{ build }}',
'{{ image }}',
'{{ package }}',
'{{ deployment }}',
'{{ discovery }}',
'{{ attestation }}',
'{{ upgrade }}',
'{{ compliance }}',
'{{ dsseAttestation }}',
'{{ vulnerabilityAssessment }}',
'{{ sbomReference }}',
'{{ secret }}',
'{{ projectsId }}',
'{{ noteId }}'
RETURNING
name,
attestation,
build,
compliance,
createTime,
deployment,
discovery,
dsseAttestation,
expirationTime,
image,
kind,
longDescription,
package,
relatedNoteNames,
relatedUrl,
sbomReference,
secret,
shortDescription,
updateTime,
upgrade,
vulnerability,
vulnerabilityAssessment
;

projects_notes_batch_create

Creates new notes in batch.

INSERT INTO google.containeranalysis.notes (
data__notes,
projectsId
)
SELECT 
'{{ notes }}',
'{{ projectsId }}'
RETURNING
notes
;

Manifest

# Description fields are for documentation purposes
- name: notes
  props:
    - name: projectsId
      value: string
      description: Required parameter for the notes resource.
    - name: locationsId
      value: string
      description: Required parameter for the notes resource.
    - name: name
      value: string
      description: >
        Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
        
    - name: shortDescription
      value: string
      description: >
        A one sentence description of this note.
        
    - name: longDescription
      value: string
      description: >
        A detailed description of this note.
        
    - name: kind
      value: string
      description: >
        Output only. The type of analysis. This field can be used as a filter in list requests.
        
      valid_values: ['NOTE_KIND_UNSPECIFIED', 'VULNERABILITY', 'BUILD', 'IMAGE', 'PACKAGE', 'DEPLOYMENT', 'DISCOVERY', 'ATTESTATION', 'UPGRADE', 'COMPLIANCE', 'DSSE_ATTESTATION', 'VULNERABILITY_ASSESSMENT', 'SBOM_REFERENCE', 'SECRET']
    - name: relatedUrl
      value: array
      description: >
        URLs associated with this note.
        
    - name: expirationTime
      value: string
      description: >
        Time of expiration for this note. Empty if note does not expire.
        
    - name: createTime
      value: string
      description: >
        Output only. The time this note was created. This field can be used as a filter in list requests.
        
    - name: updateTime
      value: string
      description: >
        Output only. The time this note was last updated. This field can be used as a filter in list requests.
        
    - name: relatedNoteNames
      value: array
      description: >
        Other notes related to this note.
        
    - name: vulnerability
      value: object
      description: >
        A note describing a package vulnerability.
        
    - name: build
      value: object
      description: >
        A note describing build provenance for a verifiable build.
        
    - name: image
      value: object
      description: >
        A note describing a base image.
        
    - name: package
      value: object
      description: >
        A note describing a package hosted by various package managers.
        
    - name: deployment
      value: object
      description: >
        A note describing something that can be deployed.
        
    - name: discovery
      value: object
      description: >
        A note describing the initial analysis of a resource.
        
    - name: attestation
      value: object
      description: >
        A note describing an attestation role.
        
    - name: upgrade
      value: object
      description: >
        A note describing available package upgrades.
        
    - name: compliance
      value: object
      description: >
        A note describing a compliance check.
        
    - name: dsseAttestation
      value: object
      description: >
        A note describing a dsse attestation note.
        
    - name: vulnerabilityAssessment
      value: object
      description: >
        A note describing a vulnerability assessment.
        
    - name: sbomReference
      value: object
      description: >
        A note describing an SBOM reference.
        
    - name: secret
      value: object
      description: >
        A note describing a secret.
        
    - name: notes
      value: object
      description: >
        Required. The notes to create. Max allowed length is 1000.
        
    - name: noteId
      value: string

UPDATE examples

projects_locations_notes_patch

Updates the specified note.

UPDATE google.containeranalysis.notes
SET 
data__name = '{{ name }}',
data__shortDescription = '{{ shortDescription }}',
data__longDescription = '{{ longDescription }}',
data__kind = '{{ kind }}',
data__relatedUrl = '{{ relatedUrl }}',
data__expirationTime = '{{ expirationTime }}',
data__createTime = '{{ createTime }}',
data__updateTime = '{{ updateTime }}',
data__relatedNoteNames = '{{ relatedNoteNames }}',
data__vulnerability = '{{ vulnerability }}',
data__build = '{{ build }}',
data__image = '{{ image }}',
data__package = '{{ package }}',
data__deployment = '{{ deployment }}',
data__discovery = '{{ discovery }}',
data__attestation = '{{ attestation }}',
data__upgrade = '{{ upgrade }}',
data__compliance = '{{ compliance }}',
data__dsseAttestation = '{{ dsseAttestation }}',
data__vulnerabilityAssessment = '{{ vulnerabilityAssessment }}',
data__sbomReference = '{{ sbomReference }}',
data__secret = '{{ secret }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND notesId = '{{ notesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
attestation,
build,
compliance,
createTime,
deployment,
discovery,
dsseAttestation,
expirationTime,
image,
kind,
longDescription,
package,
relatedNoteNames,
relatedUrl,
sbomReference,
secret,
shortDescription,
updateTime,
upgrade,
vulnerability,
vulnerabilityAssessment;

projects_notes_patch

Updates the specified note.

UPDATE google.containeranalysis.notes
SET 
data__name = '{{ name }}',
data__shortDescription = '{{ shortDescription }}',
data__longDescription = '{{ longDescription }}',
data__kind = '{{ kind }}',
data__relatedUrl = '{{ relatedUrl }}',
data__expirationTime = '{{ expirationTime }}',
data__createTime = '{{ createTime }}',
data__updateTime = '{{ updateTime }}',
data__relatedNoteNames = '{{ relatedNoteNames }}',
data__vulnerability = '{{ vulnerability }}',
data__build = '{{ build }}',
data__image = '{{ image }}',
data__package = '{{ package }}',
data__deployment = '{{ deployment }}',
data__discovery = '{{ discovery }}',
data__attestation = '{{ attestation }}',
data__upgrade = '{{ upgrade }}',
data__compliance = '{{ compliance }}',
data__dsseAttestation = '{{ dsseAttestation }}',
data__vulnerabilityAssessment = '{{ vulnerabilityAssessment }}',
data__sbomReference = '{{ sbomReference }}',
data__secret = '{{ secret }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND notesId = '{{ notesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
attestation,
build,
compliance,
createTime,
deployment,
discovery,
dsseAttestation,
expirationTime,
image,
kind,
longDescription,
package,
relatedNoteNames,
relatedUrl,
sbomReference,
secret,
shortDescription,
updateTime,
upgrade,
vulnerability,
vulnerabilityAssessment;

DELETE examples

projects_locations_notes_delete

Deletes the specified note.

DELETE FROM google.containeranalysis.notes
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND notesId = '{{ notesId }}' --required;

projects_notes_delete

Deletes the specified note.

DELETE FROM google.containeranalysis.notes
WHERE projectsId = '{{ projectsId }}' --required
AND notesId = '{{ notesId }}' --required;