Resource: Note
A type of analysis that can be done for a resource.
JSON representation |
---|
{ "name" : string , "shortDescription" : string , "longDescription" : string , "kind" : enum ( |
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.
expirationTime
string (
Timestamp
format)
Time of expiration for this note. Empty if note does not expire.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z"
, "2014-10-02T15:01:23.045123456Z"
or "2014-10-02T15:01:23+05:30"
.
createTime
string (
Timestamp
format)
Output only. The time this note was created. This field can be used as a filter in list requests.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z"
, "2014-10-02T15:01:23.045123456Z"
or "2014-10-02T15:01:23+05:30"
.
updateTime
string (
Timestamp
format)
Output only. The time this note was last updated. This field can be used as a filter in list requests.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z"
, "2014-10-02T15:01:23.045123456Z"
or "2014-10-02T15:01:23+05:30"
.
type
. Required. Immutable. The type of analysis this note represents. type
can be only one of the following:vulnerability
object (
VulnerabilityNote
)
A note describing a package vulnerability.
build
object (
BuildNote
)
A note describing build provenance for a verifiable build.
image
object (
ImageNote
)
A note describing a base image.
package
object (
PackageNote
)
A note describing a package hosted by various package managers.
deployment
object (
DeploymentNote
)
A note describing something that can be deployed.
discovery
object (
DiscoveryNote
)
A note describing the initial analysis of a resource.
attestation
object (
AttestationNote
)
A note describing an attestation role.
upgrade
object (
UpgradeNote
)
A note describing available package upgrades.
compliance
object (
ComplianceNote
)
A note describing a compliance check.
dsseAttestation
object (
DSSEAttestationNote
)
A note describing a dsse attestation note.
vulnerabilityAssessment
object (
VulnerabilityAssessmentNote
)
A note describing a vulnerability assessment.
sbomReference
object (
SBOMReferenceNote
)
A note describing an SBOM reference.
secret
object (
SecretNote
)
A note describing a secret.
Methods |
|
---|---|
|
Creates new notes in batch. |
|
Creates a new note. |
|
Deletes the specified note. |
|
Gets the specified note. |
|
Gets the access control policy for a note or an occurrence resource. |
|
Lists notes for the specified project. |
|
Updates the specified note. |
|
Sets the access control policy on the specified note or occurrence. |
|
Returns the permissions that a caller has on the specified note or occurrence. |