Class Note (2.45.0)

public final class Note extends GeneratedMessageV3 implements NoteOrBuilder

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

Protobuf type grafeas.v1.Note

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Note

Implements

NoteOrBuilder

Static Fields

ATTESTATION_FIELD_NUMBER

public static final int ATTESTATION_FIELD_NUMBER
Field Value
Type Description
int

BUILD_FIELD_NUMBER

public static final int BUILD_FIELD_NUMBER
Field Value
Type Description
int

COMPLIANCE_FIELD_NUMBER

public static final int COMPLIANCE_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DEPLOYMENT_FIELD_NUMBER

public static final int DEPLOYMENT_FIELD_NUMBER
Field Value
Type Description
int

DISCOVERY_FIELD_NUMBER

public static final int DISCOVERY_FIELD_NUMBER
Field Value
Type Description
int

DSSE_ATTESTATION_FIELD_NUMBER

public static final int DSSE_ATTESTATION_FIELD_NUMBER
Field Value
Type Description
int

EXPIRATION_TIME_FIELD_NUMBER

public static final int EXPIRATION_TIME_FIELD_NUMBER
Field Value
Type Description
int

IMAGE_FIELD_NUMBER

public static final int IMAGE_FIELD_NUMBER
Field Value
Type Description
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
Type Description
int

LONG_DESCRIPTION_FIELD_NUMBER

public static final int LONG_DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PACKAGE_FIELD_NUMBER

public static final int PACKAGE_FIELD_NUMBER
Field Value
Type Description
int 
public static final int RELATED_NOTE_NAMES_FIELD_NUMBER
Field Value
Type Description
int 
public static final int RELATED_URL_FIELD_NUMBER
Field Value
Type Description
int

SBOM_REFERENCE_FIELD_NUMBER

public static final int SBOM_REFERENCE_FIELD_NUMBER
Field Value
Type Description
int

SHORT_DESCRIPTION_FIELD_NUMBER

public static final int SHORT_DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

UPGRADE_FIELD_NUMBER

public static final int UPGRADE_FIELD_NUMBER
Field Value
Type Description
int

VULNERABILITY_ASSESSMENT_FIELD_NUMBER

public static final int VULNERABILITY_ASSESSMENT_FIELD_NUMBER
Field Value
Type Description
int

VULNERABILITY_FIELD_NUMBER

public static final int VULNERABILITY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Note getDefaultInstance()
Returns
Type Description
Note

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Note.Builder newBuilder()
Returns
Type Description
Note.Builder

newBuilder(Note prototype)

public static Note.Builder newBuilder(Note prototype)
Parameter
Name Description
prototype Note
Returns
Type Description
Note.Builder

parseDelimitedFrom(InputStream input)

public static Note parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Note
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Note parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Note
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Note parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Note
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Note parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Note
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Note parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Note
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Note parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Note
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Note parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Note
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Note parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Note
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Note parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Note
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Note parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Note
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Note parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Note
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Note parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Note
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Note> parser()
Returns
Type Description
Parser<Note>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAttestation()

public AttestationNote getAttestation()

A note describing an attestation role.

.grafeas.v1.AttestationNote attestation = 16;

Returns
Type Description
AttestationNote

The attestation.

getAttestationOrBuilder()

public AttestationNoteOrBuilder getAttestationOrBuilder()

A note describing an attestation role.

.grafeas.v1.AttestationNote attestation = 16;

Returns
Type Description
AttestationNoteOrBuilder

getBuild()

public BuildNote getBuild()

A note describing build provenance for a verifiable build.

.grafeas.v1.BuildNote build = 11;

Returns
Type Description
BuildNote

The build.

getBuildOrBuilder()

public BuildNoteOrBuilder getBuildOrBuilder()

A note describing build provenance for a verifiable build.

.grafeas.v1.BuildNote build = 11;

Returns
Type Description
BuildNoteOrBuilder

getCompliance()

public ComplianceNote getCompliance()

A note describing a compliance check.

.grafeas.v1.ComplianceNote compliance = 18;

Returns
Type Description
ComplianceNote

The compliance.

getComplianceOrBuilder()

public ComplianceNoteOrBuilder getComplianceOrBuilder()

A note describing a compliance check.

.grafeas.v1.ComplianceNote compliance = 18;

Returns
Type Description
ComplianceNoteOrBuilder

getCreateTime()

public Timestamp getCreateTime()

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

.google.protobuf.Timestamp create_time = 7;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

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

.google.protobuf.Timestamp create_time = 7;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Note getDefaultInstanceForType()
Returns
Type Description
Note

getDeployment()

public DeploymentNote getDeployment()

A note describing something that can be deployed.

.grafeas.v1.DeploymentNote deployment = 14;

Returns
Type Description
DeploymentNote

The deployment.

getDeploymentOrBuilder()

public DeploymentNoteOrBuilder getDeploymentOrBuilder()

A note describing something that can be deployed.

.grafeas.v1.DeploymentNote deployment = 14;

Returns
Type Description
DeploymentNoteOrBuilder

getDiscovery()

public DiscoveryNote getDiscovery()

A note describing the initial analysis of a resource.

.grafeas.v1.DiscoveryNote discovery = 15;

Returns
Type Description
DiscoveryNote

The discovery.

getDiscoveryOrBuilder()

public DiscoveryNoteOrBuilder getDiscoveryOrBuilder()

A note describing the initial analysis of a resource.

.grafeas.v1.DiscoveryNote discovery = 15;

Returns
Type Description
DiscoveryNoteOrBuilder

getDsseAttestation()

public DSSEAttestationNote getDsseAttestation()

A note describing a dsse attestation note.

.grafeas.v1.DSSEAttestationNote dsse_attestation = 19;

Returns
Type Description
DSSEAttestationNote

The dsseAttestation.

getDsseAttestationOrBuilder()

public DSSEAttestationNoteOrBuilder getDsseAttestationOrBuilder()

A note describing a dsse attestation note.

.grafeas.v1.DSSEAttestationNote dsse_attestation = 19;

Returns
Type Description
DSSEAttestationNoteOrBuilder

getExpirationTime()

public Timestamp getExpirationTime()

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

.google.protobuf.Timestamp expiration_time = 6;

Returns
Type Description
Timestamp

The expirationTime.

getExpirationTimeOrBuilder()

public TimestampOrBuilder getExpirationTimeOrBuilder()

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

.google.protobuf.Timestamp expiration_time = 6;

Returns
Type Description
TimestampOrBuilder

getImage()

public ImageNote getImage()

A note describing a base image.

.grafeas.v1.ImageNote image = 12;

Returns
Type Description
ImageNote

The image.

getImageOrBuilder()

public ImageNoteOrBuilder getImageOrBuilder()

A note describing a base image.

.grafeas.v1.ImageNote image = 12;

Returns
Type Description
ImageNoteOrBuilder

getKind()

public NoteKind getKind()

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

.grafeas.v1.NoteKind kind = 4;

Returns
Type Description
NoteKind

The kind.

getKindValue()

public int getKindValue()

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

.grafeas.v1.NoteKind kind = 4;

Returns
Type Description
int

The enum numeric value on the wire for kind.

getLongDescription()

public String getLongDescription()

A detailed description of this note.

string long_description = 3;

Returns
Type Description
String

The longDescription.

getLongDescriptionBytes()

public ByteString getLongDescriptionBytes()

A detailed description of this note.

string long_description = 3;

Returns
Type Description
ByteString

The bytes for longDescription.

getName()

public String getName()

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

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getPackage()

public PackageNote getPackage()

A note describing a package hosted by various package managers.

.grafeas.v1.PackageNote package = 13;

Returns
Type Description
PackageNote

The package.

getPackageOrBuilder()

public PackageNoteOrBuilder getPackageOrBuilder()

A note describing a package hosted by various package managers.

.grafeas.v1.PackageNote package = 13;

Returns
Type Description
PackageNoteOrBuilder

getParserForType()

public Parser<Note> getParserForType()
Returns
Type Description
Parser<Note>
Overrides

getRelatedNoteNames(int index)

public String getRelatedNoteNames(int index)

Other notes related to this note.

repeated string related_note_names = 9;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The relatedNoteNames at the given index.

getRelatedNoteNamesBytes(int index)

public ByteString getRelatedNoteNamesBytes(int index)

Other notes related to this note.

repeated string related_note_names = 9;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the relatedNoteNames at the given index.

getRelatedNoteNamesCount()

public int getRelatedNoteNamesCount()

Other notes related to this note.

repeated string related_note_names = 9;

Returns
Type Description
int

The count of relatedNoteNames.

getRelatedNoteNamesList()

public ProtocolStringList getRelatedNoteNamesList()

Other notes related to this note.

repeated string related_note_names = 9;

Returns
Type Description
ProtocolStringList

A list containing the relatedNoteNames.

getRelatedUrl(int index)

public RelatedUrl getRelatedUrl(int index)

URLs associated with this note.

repeated .grafeas.v1.RelatedUrl related_url = 5;

Parameter
Name Description
index int
Returns
Type Description
RelatedUrl

getRelatedUrlCount()

public int getRelatedUrlCount()

URLs associated with this note.

repeated .grafeas.v1.RelatedUrl related_url = 5;

Returns
Type Description
int

getRelatedUrlList()

public List<RelatedUrl> getRelatedUrlList()

URLs associated with this note.

repeated .grafeas.v1.RelatedUrl related_url = 5;

Returns
Type Description
List<RelatedUrl>

getRelatedUrlOrBuilder(int index)

public RelatedUrlOrBuilder getRelatedUrlOrBuilder(int index)

URLs associated with this note.

repeated .grafeas.v1.RelatedUrl related_url = 5;

Parameter
Name Description
index int
Returns
Type Description
RelatedUrlOrBuilder

getRelatedUrlOrBuilderList()

public List<? extends RelatedUrlOrBuilder> getRelatedUrlOrBuilderList()

URLs associated with this note.

repeated .grafeas.v1.RelatedUrl related_url = 5;

Returns
Type Description
List<? extends io.grafeas.v1.RelatedUrlOrBuilder>

getSbomReference()

public SBOMReferenceNote getSbomReference()

A note describing an SBOM reference.

.grafeas.v1.SBOMReferenceNote sbom_reference = 21;

Returns
Type Description
SBOMReferenceNote

The sbomReference.

getSbomReferenceOrBuilder()

public SBOMReferenceNoteOrBuilder getSbomReferenceOrBuilder()

A note describing an SBOM reference.

.grafeas.v1.SBOMReferenceNote sbom_reference = 21;

Returns
Type Description
SBOMReferenceNoteOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getShortDescription()

public String getShortDescription()

A one sentence description of this note.

string short_description = 2;

Returns
Type Description
String

The shortDescription.

getShortDescriptionBytes()

public ByteString getShortDescriptionBytes()

A one sentence description of this note.

string short_description = 2;

Returns
Type Description
ByteString

The bytes for shortDescription.

getTypeCase()

public Note.TypeCase getTypeCase()
Returns
Type Description
Note.TypeCase

getUpdateTime()

public Timestamp getUpdateTime()

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

.google.protobuf.Timestamp update_time = 8;

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

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

.google.protobuf.Timestamp update_time = 8;

Returns
Type Description
TimestampOrBuilder

getUpgrade()

public UpgradeNote getUpgrade()

A note describing available package upgrades.

.grafeas.v1.UpgradeNote upgrade = 17;

Returns
Type Description
UpgradeNote

The upgrade.

getUpgradeOrBuilder()

public UpgradeNoteOrBuilder getUpgradeOrBuilder()

A note describing available package upgrades.

.grafeas.v1.UpgradeNote upgrade = 17;

Returns
Type Description
UpgradeNoteOrBuilder

getVulnerability()

public VulnerabilityNote getVulnerability()

A note describing a package vulnerability.

.grafeas.v1.VulnerabilityNote vulnerability = 10;

Returns
Type Description
VulnerabilityNote

The vulnerability.

getVulnerabilityAssessment()

public VulnerabilityAssessmentNote getVulnerabilityAssessment()

A note describing a vulnerability assessment.

.grafeas.v1.VulnerabilityAssessmentNote vulnerability_assessment = 20;

Returns
Type Description
VulnerabilityAssessmentNote

The vulnerabilityAssessment.

getVulnerabilityAssessmentOrBuilder()

public VulnerabilityAssessmentNoteOrBuilder getVulnerabilityAssessmentOrBuilder()

A note describing a vulnerability assessment.

.grafeas.v1.VulnerabilityAssessmentNote vulnerability_assessment = 20;

Returns
Type Description
VulnerabilityAssessmentNoteOrBuilder

getVulnerabilityOrBuilder()

public VulnerabilityNoteOrBuilder getVulnerabilityOrBuilder()

A note describing a package vulnerability.

.grafeas.v1.VulnerabilityNote vulnerability = 10;

Returns
Type Description
VulnerabilityNoteOrBuilder

hasAttestation()

public boolean hasAttestation()

A note describing an attestation role.

.grafeas.v1.AttestationNote attestation = 16;

Returns
Type Description
boolean

Whether the attestation field is set.

hasBuild()

public boolean hasBuild()

A note describing build provenance for a verifiable build.

.grafeas.v1.BuildNote build = 11;

Returns
Type Description
boolean

Whether the build field is set.

hasCompliance()

public boolean hasCompliance()

A note describing a compliance check.

.grafeas.v1.ComplianceNote compliance = 18;

Returns
Type Description
boolean

Whether the compliance field is set.

hasCreateTime()

public boolean hasCreateTime()

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

.google.protobuf.Timestamp create_time = 7;

Returns
Type Description
boolean

Whether the createTime field is set.

hasDeployment()

public boolean hasDeployment()

A note describing something that can be deployed.

.grafeas.v1.DeploymentNote deployment = 14;

Returns
Type Description
boolean

Whether the deployment field is set.

hasDiscovery()

public boolean hasDiscovery()

A note describing the initial analysis of a resource.

.grafeas.v1.DiscoveryNote discovery = 15;

Returns
Type Description
boolean

Whether the discovery field is set.

hasDsseAttestation()

public boolean hasDsseAttestation()

A note describing a dsse attestation note.

.grafeas.v1.DSSEAttestationNote dsse_attestation = 19;

Returns
Type Description
boolean

Whether the dsseAttestation field is set.

hasExpirationTime()

public boolean hasExpirationTime()

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

.google.protobuf.Timestamp expiration_time = 6;

Returns
Type Description
boolean

Whether the expirationTime field is set.

hasImage()

public boolean hasImage()

A note describing a base image.

.grafeas.v1.ImageNote image = 12;

Returns
Type Description
boolean

Whether the image field is set.

hasPackage()

public boolean hasPackage()

A note describing a package hosted by various package managers.

.grafeas.v1.PackageNote package = 13;

Returns
Type Description
boolean

Whether the package field is set.

hasSbomReference()

public boolean hasSbomReference()

A note describing an SBOM reference.

.grafeas.v1.SBOMReferenceNote sbom_reference = 21;

Returns
Type Description
boolean

Whether the sbomReference field is set.

hasUpdateTime()

public boolean hasUpdateTime()

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

.google.protobuf.Timestamp update_time = 8;

Returns
Type Description
boolean

Whether the updateTime field is set.

hasUpgrade()

public boolean hasUpgrade()

A note describing available package upgrades.

.grafeas.v1.UpgradeNote upgrade = 17;

Returns
Type Description
boolean

Whether the upgrade field is set.

hasVulnerability()

public boolean hasVulnerability()

A note describing a package vulnerability.

.grafeas.v1.VulnerabilityNote vulnerability = 10;

Returns
Type Description
boolean

Whether the vulnerability field is set.

hasVulnerabilityAssessment()

public boolean hasVulnerabilityAssessment()

A note describing a vulnerability assessment.

.grafeas.v1.VulnerabilityAssessmentNote vulnerability_assessment = 20;

Returns
Type Description
boolean

Whether the vulnerabilityAssessment field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Note.Builder newBuilderForType()
Returns
Type Description
Note.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Note.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Note.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Note.Builder toBuilder()
Returns
Type Description
Note.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException