Grafeas v1 API - Class Note (3.6.0)

public sealed class Note : IMessage<Note>, IEquatable<Note>, IDeepCloneable<Note>, IBufferMessage, IMessage

Reference documentation and code samples for the Grafeas v1 API class Note.

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

Inheritance

object > Note

Namespace

Grafeas.V1

Assembly

Grafeas.V1.dll

Constructors

Note()

public Note()

Note(Note)

public Note(Note other)
Parameter
Name Description
other Note

Properties

Attestation

public AttestationNote Attestation { get; set; }

A note describing an attestation role.

Property Value
Type Description
AttestationNote

Build

public BuildNote Build { get; set; }

A note describing build provenance for a verifiable build.

Property Value
Type Description
BuildNote

Compliance

public ComplianceNote Compliance { get; set; }

A note describing a compliance check.

Property Value
Type Description
ComplianceNote

CreateTime

public Timestamp CreateTime { get; set; }

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

Property Value
Type Description
Timestamp

Deployment

public DeploymentNote Deployment { get; set; }

A note describing something that can be deployed.

Property Value
Type Description
DeploymentNote

Discovery

public DiscoveryNote Discovery { get; set; }

A note describing the initial analysis of a resource.

Property Value
Type Description
DiscoveryNote

DsseAttestation

public DSSEAttestationNote DsseAttestation { get; set; }

A note describing a dsse attestation note.

Property Value
Type Description
DSSEAttestationNote

ExpirationTime

public Timestamp ExpirationTime { get; set; }

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

Property Value
Type Description
Timestamp

Image

public ImageNote Image { get; set; }

A note describing a base image.

Property Value
Type Description
ImageNote

Kind

public NoteKind Kind { get; set; }

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

Property Value
Type Description
NoteKind

LongDescription

public string LongDescription { get; set; }

A detailed description of this note.

Property Value
Type Description
string

Name

public string Name { get; set; }

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

Property Value
Type Description
string

NoteName

public NoteName NoteName { get; set; }

NoteName-typed view over the Name resource name property.

Property Value
Type Description
NoteName

Package

public PackageNote Package { get; set; }

A note describing a package hosted by various package managers.

Property Value
Type Description
PackageNote

RelatedNoteNames

public RepeatedField<string> RelatedNoteNames { get; }

Other notes related to this note.

Property Value
Type Description
RepeatedFieldstring

RelatedUrl

public RepeatedField<RelatedUrl> RelatedUrl { get; }

URLs associated with this note.

Property Value
Type Description
RepeatedFieldRelatedUrl

SbomReference

public SBOMReferenceNote SbomReference { get; set; }

A note describing an SBOM reference.

Property Value
Type Description
SBOMReferenceNote

ShortDescription

public string ShortDescription { get; set; }

A one sentence description of this note.

Property Value
Type Description
string

TypeCase

public Note.TypeOneofCase TypeCase { get; }
Property Value
Type Description
NoteTypeOneofCase

UpdateTime

public Timestamp UpdateTime { get; set; }

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

Property Value
Type Description
Timestamp

Upgrade

public UpgradeNote Upgrade { get; set; }

A note describing available package upgrades.

Property Value
Type Description
UpgradeNote

Vulnerability

public VulnerabilityNote Vulnerability { get; set; }

A note describing a package vulnerability.

Property Value
Type Description
VulnerabilityNote

VulnerabilityAssessment

public VulnerabilityAssessmentNote VulnerabilityAssessment { get; set; }

A note describing a vulnerability assessment.

Property Value
Type Description
VulnerabilityAssessmentNote