REST Resource: providers.notes

• Resource: Note
  • JSON representation
• Methods

Resource: Note

Provides a detailed description of a Note.

JSON representation

{ "name": string, "shortDescription": string, "longDescription": string, "kind": enum (Kind), "relatedUrl": [ { object (RelatedUrl) } ], "expirationTime": string, "createTime": string, "updateTime": string, // Union field note_type can be only one of the following: "vulnerabilityType": { object (VulnerabilityType) }, "buildType": { object (BuildType) }, "baseImage": { object (Basis) }, "package": { object (Package) }, "deployable": { object (Deployable) }, "discovery": { object (Discovery) }, "attestationAuthority": { object (AttestationAuthority) }, "upgrade": { object (UpgradeNote) } // End of list of possible types for union field note_type. }

Fields
name	string The name of the note in the form "projects/{provider_project_id}/notes/{NOTE_ID}"
shortDescription	string A one sentence description of this Note.
longDescription	string A detailed description of this Note.
kind	enum (Kind) Output only. This explicitly denotes which kind of note is specified. 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, null if note does not expire. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "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, accurate to nanoseconds. Example: "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, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
Union field note_type. The type of note. note_type can be only one of the following:
vulnerabilityType	object (VulnerabilityType) A package vulnerability type of note.
buildType	object (BuildType) Build provenance type 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 a provider/analysis type.
attestationAuthority	object (AttestationAuthority) A note describing an attestation role.
upgrade	object (UpgradeNote) A note describing an upgrade.

Methods
create	Creates a new Note.
delete	Deletes the given Note from the system.
get	Returns the requested Note.
getIamPolicy	Gets the access control policy for a note or an Occurrence resource.
list	Lists all Notes for a given project.
patch	Updates an existing 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 resource.