Class: Grafeas::V1::Note

Inherits:

Object

• Object
• Grafeas::V1::Note

Defined in:

lib/grafeas/v1/doc/grafeas/v1/grafeas.rb

Overview

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

Instance Attribute Summary

• #attestation ⇒ Grafeas::V1::AttestationNote

  A note describing an attestation role.

• #build ⇒ Grafeas::V1::BuildNote

  A note describing build provenance for a verifiable build.

• #create_time ⇒ Google::Protobuf::Timestamp

  Output only.

• #deployment ⇒ Grafeas::V1::DeploymentNote

  A note describing something that can be deployed.

• #discovery ⇒ Grafeas::V1::DiscoveryNote

  A note describing the initial analysis of a resource.

• #expiration_time ⇒ Google::Protobuf::Timestamp

  Time of expiration for this note.

• #image ⇒ Grafeas::V1::ImageNote

  A note describing a base image.

• #kind ⇒ Grafeas::V1::NoteKind

  Output only.

• #long_description ⇒ String

  A detailed description of this note.

• #name ⇒ String

  Output only.

• #package ⇒ Grafeas::V1::PackageNote

  A note describing a package hosted by various package managers.

• #related_note_names ⇒ Array<String>

  Other notes related to this note.

• #related_url ⇒ Array<Grafeas::V1::RelatedUrl>

  URLs associated with this note.

• #short_description ⇒ String

  A one sentence description of this note.

• #update_time ⇒ Google::Protobuf::Timestamp

  Output only.

• #upgrade ⇒ Grafeas::V1::UpgradeNote

  A note describing available package upgrades.

• #vulnerability ⇒ Grafeas::V1::VulnerabilityNote

  A note describing a package vulnerability.

Instance Attribute Details

#attestation ⇒ Grafeas::V1::AttestationNote

Returns A note describing an attestation role.

Returns:

• (Grafeas::V1::AttestationNote) —

  A note describing an attestation role.

# File 'lib/grafeas/v1/doc/grafeas/v1/grafeas.rb', line 129

class Note; end

#build ⇒ Grafeas::V1::BuildNote

Returns A note describing build provenance for a verifiable build.

Returns:

• (Grafeas::V1::BuildNote) —

  A note describing build provenance for a verifiable build.

# File 'lib/grafeas/v1/doc/grafeas/v1/grafeas.rb', line 129

class Note; end

#create_time ⇒ Google::Protobuf::Timestamp

Returns 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.

# File 'lib/grafeas/v1/doc/grafeas/v1/grafeas.rb', line 129

class Note; end

#deployment ⇒ Grafeas::V1::DeploymentNote

Returns A note describing something that can be deployed.

Returns:

• (Grafeas::V1::DeploymentNote) —

  A note describing something that can be deployed.

# File 'lib/grafeas/v1/doc/grafeas/v1/grafeas.rb', line 129

class Note; end

#discovery ⇒ Grafeas::V1::DiscoveryNote

Returns A note describing the initial analysis of a resource.

Returns:

• (Grafeas::V1::DiscoveryNote) —

  A note describing the initial analysis of a resource.

# File 'lib/grafeas/v1/doc/grafeas/v1/grafeas.rb', line 129

class Note; end

#expiration_time ⇒ Google::Protobuf::Timestamp

Returns 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.

# File 'lib/grafeas/v1/doc/grafeas/v1/grafeas.rb', line 129

class Note; end

#image ⇒ Grafeas::V1::ImageNote

Returns A note describing a base image.

Returns:

• (Grafeas::V1::ImageNote) —

  A note describing a base image.

# File 'lib/grafeas/v1/doc/grafeas/v1/grafeas.rb', line 129

class Note; end

#kind ⇒ Grafeas::V1::NoteKind

Returns 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.

# File 'lib/grafeas/v1/doc/grafeas/v1/grafeas.rb', line 129

class Note; end

#long_description ⇒ String

Returns A detailed description of this note.

Returns:

• (String) —

  A detailed description of this note.

# File 'lib/grafeas/v1/doc/grafeas/v1/grafeas.rb', line 129

class Note; end

#name ⇒ String

Returns 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].

# File 'lib/grafeas/v1/doc/grafeas/v1/grafeas.rb', line 129

class Note; end

#package ⇒ Grafeas::V1::PackageNote

Returns A note describing a package hosted by various package managers.

Returns:

• (Grafeas::V1::PackageNote) —

  A note describing a package hosted by various package managers.

# File 'lib/grafeas/v1/doc/grafeas/v1/grafeas.rb', line 129

class Note; end

#related_note_names ⇒ Array<String>

Returns Other notes related to this note.

Returns:

• (Array<String>) —

  Other notes related to this note.

# File 'lib/grafeas/v1/doc/grafeas/v1/grafeas.rb', line 129

class Note; end

#related_url ⇒ Array<Grafeas::V1::RelatedUrl>

Returns URLs associated with this note.

Returns:

• (Array<Grafeas::V1::RelatedUrl>) —

  URLs associated with this note.

# File 'lib/grafeas/v1/doc/grafeas/v1/grafeas.rb', line 129

class Note; end

#short_description ⇒ String

Returns A one sentence description of this note.

Returns:

• (String) —

  A one sentence description of this note.

# File 'lib/grafeas/v1/doc/grafeas/v1/grafeas.rb', line 129

class Note; end

#update_time ⇒ Google::Protobuf::Timestamp

Returns 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.

# File 'lib/grafeas/v1/doc/grafeas/v1/grafeas.rb', line 129

class Note; end

#upgrade ⇒ Grafeas::V1::UpgradeNote

Returns A note describing available package upgrades.

Returns:

• (Grafeas::V1::UpgradeNote) —

  A note describing available package upgrades.

# File 'lib/grafeas/v1/doc/grafeas/v1/grafeas.rb', line 129

class Note; end

#vulnerability ⇒ Grafeas::V1::VulnerabilityNote

Returns A note describing a package vulnerability.

Returns:

• (Grafeas::V1::VulnerabilityNote) —

  A note describing a package vulnerability.

# File 'lib/grafeas/v1/doc/grafeas/v1/grafeas.rb', line 129

class Note; end