REST Resource: projects.notes

Resource: Note

A type of analysis that can be done for a resource.

JSON representation 
{
  "name": string,
  "shortDescription": string,
  "longDescription": string,
  "kind": enum (NoteKind),
  "relatedUrl": [
    {
      object (RelatedUrl)
    }
  ],
  "expirationTime": string,
  "createTime": string,
  "updateTime": string,
  "relatedNoteNames": [
    string
  ],

  // Union field type can be only one of the following:
  "vulnerability": {
    object (Vulnerability)
  },
  "build": {
    object (Build)
  },
  "baseImage": {
    object (Basis)
  },
  "package": {
    object (Package)
  },
  "deployable": {
    object (Deployable)
  },
  "discovery": {
    object (Discovery)
  },
  "attestationAuthority": {
    object (Authority)
  },
  "intoto": {
    object (InToto)
  },
  "sbom": {
    object (DocumentNote)
  },
  "spdxPackage": {
    object (PackageInfoNote)
  },
  "spdxFile": {
    object (FileNote)
  },
  "spdxRelationship": {
    object (RelationshipNote)
  },
  "vulnerabilityAssessment": {
    object (VulnerabilityAssessmentNote)
  },
  "sbomReference": {
    object (SBOMReferenceNote)
  }
  // End of list of possible types for union field type.
}
Fields
name

string

Output only. The name of the note in the form of projects/[PROVIDER_ID]/notes/[NOTE_ID].
shortDescription

string

A one sentence description of this note.
longDescription

string

A detailed description of this note.
kind

enum (NoteKind)

Output only. The type of analysis. This field can be used as a filter in list requests.
relatedUrl[]

object (RelatedUrl)

URLs associated with this note.
expirationTime

string (Timestamp format)

Time of expiration for this note. Empty if note does not expire.

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

string (Timestamp format)

Output only. The time this note was created. This field can be used as a filter in list requests.

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 note was last updated. This field can be used as a filter in list requests.

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".
relatedNoteNames[]

string

Other notes related to this note.
Union field type. Required. Immutable. The type of analysis this note represents. type can be only one of the following:
vulnerability

object (Vulnerability)

A note describing a package vulnerability.
build

object (Build)

A note describing build provenance for a verifiable build.
baseImage

object (Basis)

A note describing a base image.
package

object (Package)

A note describing a package hosted by various package managers.
deployable

object (Deployable)

A note describing something that can be deployed.
discovery

object (Discovery)

A note describing the initial analysis of a resource.
attestationAuthority

object (Authority)

A note describing an attestation role.
intoto

object (InToto)

A note describing an in-toto link.
sbom

object (DocumentNote)

A note describing a software bill of materials.
spdxPackage

object (PackageInfoNote)

A note describing an SPDX Package.
spdxFile

object (FileNote)

A note describing an SPDX File.
spdxRelationship

object (RelationshipNote)

A note describing an SPDX File.
vulnerabilityAssessment

object (VulnerabilityAssessmentNote)

A note describing a vulnerability assessment.
sbomReference

object (SBOMReferenceNote)

A note describing an SBOM reference.

Methods

batchCreate

 Creates new notes in batch.

create

 Creates a new note.

delete

 Deletes the specified note.

get

 Gets the specified note.

getIamPolicy

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

list

 Lists notes for the specified project.

patch

 Updates the specified note.

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.