Grafeas V1 API - Class Grafeas::V1::Note (v1.1.1)

Version 1.1.1

• 1.2.0 (latest)
• 1.1.1
• 1.0.0
• 0.16.1
• 0.15.0
• 0.14.2
• 0.13.0
• 0.12.1
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.1
• 0.5.0
• 0.4.0
• 0.3.1

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

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

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#attestation

def attestation() -> ::Grafeas::V1::AttestationNote

Returns

• (::Grafeas::V1::AttestationNote) — A note describing an attestation role.

#attestation=

def attestation=(value) -> ::Grafeas::V1::AttestationNote

Parameter

• value (::Grafeas::V1::AttestationNote) — A note describing an attestation role.

Returns

• (::Grafeas::V1::AttestationNote) — A note describing an attestation role.

#build

def build() -> ::Grafeas::V1::BuildNote

Returns

• (::Grafeas::V1::BuildNote) — A note describing build provenance for a verifiable build.

#build=

def build=(value) -> ::Grafeas::V1::BuildNote

Parameter

• value (::Grafeas::V1::BuildNote) — A note describing build provenance for a verifiable build.

Returns

• (::Grafeas::V1::BuildNote) — A note describing build provenance for a verifiable build.

#compliance

def compliance() -> ::Grafeas::V1::ComplianceNote

Returns

• (::Grafeas::V1::ComplianceNote) — A note describing a compliance check.

#compliance=

def compliance=(value) -> ::Grafeas::V1::ComplianceNote

Parameter

• value (::Grafeas::V1::ComplianceNote) — A note describing a compliance check.

Returns

• (::Grafeas::V1::ComplianceNote) — A note describing a compliance check.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Output only. The time this note was created. This field can be used as a filter in list requests.

#create_time=

def create_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

• value (::Google::Protobuf::Timestamp) — Output only. The time this note was created. This field can be used as a filter in list requests.

Returns

• (::Google::Protobuf::Timestamp) — Output only. The time this note was created. This field can be used as a filter in list requests.

#deployment

def deployment() -> ::Grafeas::V1::DeploymentNote

Returns

• (::Grafeas::V1::DeploymentNote) — A note describing something that can be deployed.

#deployment=

def deployment=(value) -> ::Grafeas::V1::DeploymentNote

Parameter

• value (::Grafeas::V1::DeploymentNote) — A note describing something that can be deployed.

Returns

• (::Grafeas::V1::DeploymentNote) — A note describing something that can be deployed.

#discovery

def discovery() -> ::Grafeas::V1::DiscoveryNote

Returns

• (::Grafeas::V1::DiscoveryNote) — A note describing the initial analysis of a resource.

#discovery=

def discovery=(value) -> ::Grafeas::V1::DiscoveryNote

Parameter

• value (::Grafeas::V1::DiscoveryNote) — A note describing the initial analysis of a resource.

Returns

• (::Grafeas::V1::DiscoveryNote) — A note describing the initial analysis of a resource.

#dsse_attestation

def dsse_attestation() -> ::Grafeas::V1::DSSEAttestationNote

Returns

• (::Grafeas::V1::DSSEAttestationNote) — A note describing a dsse attestation note.

#dsse_attestation=

def dsse_attestation=(value) -> ::Grafeas::V1::DSSEAttestationNote

Parameter

• value (::Grafeas::V1::DSSEAttestationNote) — A note describing a dsse attestation note.

Returns

• (::Grafeas::V1::DSSEAttestationNote) — A note describing a dsse attestation note.

#expiration_time

def expiration_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Time of expiration for this note. Empty if note does not expire.

#expiration_time=

def expiration_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

• value (::Google::Protobuf::Timestamp) — Time of expiration for this note. Empty if note does not expire.

Returns

• (::Google::Protobuf::Timestamp) — Time of expiration for this note. Empty if note does not expire.

#image

def image() -> ::Grafeas::V1::ImageNote

Returns

• (::Grafeas::V1::ImageNote) — A note describing a base image.

#image=

def image=(value) -> ::Grafeas::V1::ImageNote

Parameter

• value (::Grafeas::V1::ImageNote) — A note describing a base image.

Returns

• (::Grafeas::V1::ImageNote) — A note describing a base image.

#kind

def kind() -> ::Grafeas::V1::NoteKind

Returns

• (::Grafeas::V1::NoteKind) — Output only. The type of analysis. This field can be used as a filter in list requests.

#kind=

def kind=(value) -> ::Grafeas::V1::NoteKind

Parameter

• value (::Grafeas::V1::NoteKind) — Output only. The type of analysis. This field can be used as a filter in list requests.

Returns

• (::Grafeas::V1::NoteKind) — Output only. The type of analysis. This field can be used as a filter in list requests.

#long_description

def long_description() -> ::String

Returns

• (::String) — A detailed description of this note.

#long_description=

def long_description=(value) -> ::String

Parameter

• value (::String) — A detailed description of this note.

Returns

• (::String) — A detailed description of this note.

#name

def name() -> ::String

Returns

• (::String) — Output only. The name of the note in the form of projects/[PROVIDER_ID]/notes/[NOTE_ID].

#name=

def name=(value) -> ::String

Parameter

• value (::String) — Output only. The name of the note in the form of projects/[PROVIDER_ID]/notes/[NOTE_ID].

Returns

• (::String) — Output only. The name of the note in the form of projects/[PROVIDER_ID]/notes/[NOTE_ID].

#package

def package() -> ::Grafeas::V1::PackageNote

Returns

• (::Grafeas::V1::PackageNote) — A note describing a package hosted by various package managers.

#package=

def package=(value) -> ::Grafeas::V1::PackageNote

Parameter

• value (::Grafeas::V1::PackageNote) — A note describing a package hosted by various package managers.

Returns

• (::Grafeas::V1::PackageNote) — A note describing a package hosted by various package managers.

#related_note_names

def related_note_names() -> ::Array<::String>

Returns

• (::Array<::String>) — Other notes related to this note.

#related_note_names=

def related_note_names=(value) -> ::Array<::String>

Parameter

• value (::Array<::String>) — Other notes related to this note.

Returns

• (::Array<::String>) — Other notes related to this note.

#related_url

def related_url() -> ::Array<::Grafeas::V1::RelatedUrl>

Returns

• (::Array<::Grafeas::V1::RelatedUrl>) — URLs associated with this note.

#related_url=

def related_url=(value) -> ::Array<::Grafeas::V1::RelatedUrl>

Parameter

• value (::Array<::Grafeas::V1::RelatedUrl>) — URLs associated with this note.

Returns

• (::Array<::Grafeas::V1::RelatedUrl>) — URLs associated with this note.

#sbom_reference

def sbom_reference() -> ::Grafeas::V1::SBOMReferenceNote

Returns

• (::Grafeas::V1::SBOMReferenceNote) — A note describing an SBOM reference.

#sbom_reference=

def sbom_reference=(value) -> ::Grafeas::V1::SBOMReferenceNote

Parameter

• value (::Grafeas::V1::SBOMReferenceNote) — A note describing an SBOM reference.

Returns

• (::Grafeas::V1::SBOMReferenceNote) — A note describing an SBOM reference.

#short_description

def short_description() -> ::String

Returns

• (::String) — A one sentence description of this note.

#short_description=

def short_description=(value) -> ::String

Parameter

• value (::String) — A one sentence description of this note.

Returns

• (::String) — A one sentence description of this note.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Output only. The time this note was last updated. This field can be used as a filter in list requests.

#update_time=

def update_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

• value (::Google::Protobuf::Timestamp) — Output only. The time this note was last updated. This field can be used as a filter in list requests.

Returns

• (::Google::Protobuf::Timestamp) — Output only. The time this note was last updated. This field can be used as a filter in list requests.

#upgrade

def upgrade() -> ::Grafeas::V1::UpgradeNote

Returns

• (::Grafeas::V1::UpgradeNote) — A note describing available package upgrades.

#upgrade=

def upgrade=(value) -> ::Grafeas::V1::UpgradeNote

Parameter

• value (::Grafeas::V1::UpgradeNote) — A note describing available package upgrades.

Returns

• (::Grafeas::V1::UpgradeNote) — A note describing available package upgrades.

#vulnerability

def vulnerability() -> ::Grafeas::V1::VulnerabilityNote

Returns

• (::Grafeas::V1::VulnerabilityNote) — A note describing a package vulnerability.

#vulnerability=

def vulnerability=(value) -> ::Grafeas::V1::VulnerabilityNote

Parameter

• value (::Grafeas::V1::VulnerabilityNote) — A note describing a package vulnerability.

Returns

• (::Grafeas::V1::VulnerabilityNote) — A note describing a package vulnerability.

#vulnerability_assessment

def vulnerability_assessment() -> ::Grafeas::V1::VulnerabilityAssessmentNote

Returns

• (::Grafeas::V1::VulnerabilityAssessmentNote) — A note describing a vulnerability assessment.

#vulnerability_assessment=

def vulnerability_assessment=(value) -> ::Grafeas::V1::VulnerabilityAssessmentNote

Parameter

• value (::Grafeas::V1::VulnerabilityAssessmentNote) — A note describing a vulnerability assessment.

Returns

• (::Grafeas::V1::VulnerabilityAssessmentNote) — A note describing a vulnerability assessment.