Class: Google::Apis::ContaineranalysisV1beta1::Note

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/containeranalysis_v1beta1/classes.rb,
lib/google/apis/containeranalysis_v1beta1/representations.rb,
lib/google/apis/containeranalysis_v1beta1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Note

Returns a new instance of Note.



5741
5742
5743
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5741

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#ai_skill_analysis ⇒ Google::Apis::ContaineranalysisV1beta1::AiSkillAnalysisNote

AISkillAnalysisNote provides the metadata of an AI-based skill analysis. Corresponds to the JSON property aiSkillAnalysis

Returns:



5597
5598
5599
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5597

def ai_skill_analysis
  @ai_skill_analysis
end

#attestation_authority ⇒ Google::Apis::ContaineranalysisV1beta1::Authority

Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one Authority for "QA" and one for " build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. Corresponds to the JSON property attestationAuthority

Returns:



5609
5610
5611
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5609

def attestation_authority
  @attestation_authority
end

#base_image ⇒ Google::Apis::ContaineranalysisV1beta1::Basis

Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g. a tag of the resource_url. Corresponds to the JSON property baseImage

Returns:



5616
5617
5618
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5616

def base_image
  @base_image
end

#build ⇒ Google::Apis::ContaineranalysisV1beta1::Build

Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. Corresponds to the JSON property build

Returns:



5622
5623
5624
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5622

def build
  @build
end

#create_time ⇒ String

Output only. The time this note was created. This field can be used as a filter in list requests. Corresponds to the JSON property createTime

Returns:

  • (String) 


5628
5629
5630
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5628

def create_time
  @create_time
end

#deployable ⇒ Google::Apis::ContaineranalysisV1beta1::Deployable

An artifact that can be deployed in some runtime. Corresponds to the JSON property deployable

Returns:



5633
5634
5635
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5633

def deployable
  @deployable
end

#discovery ⇒ Google::Apis::ContaineranalysisV1beta1::Discovery

A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A Discovery occurrence is created in a consumer's project at the start of analysis. Corresponds to the JSON property discovery

Returns:



5640
5641
5642
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5640

def discovery
  @discovery
end

#expiration_time ⇒ String

Time of expiration for this note. Empty if note does not expire. Corresponds to the JSON property expirationTime

Returns:

  • (String) 


5645
5646
5647
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5645

def expiration_time
  @expiration_time
end

#intoto ⇒ Google::Apis::ContaineranalysisV1beta1::InToto

This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note. Corresponds to the JSON property intoto

Returns:



5651
5652
5653
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5651

def intoto
  @intoto
end

#kind ⇒ String

Output only. The type of analysis. This field can be used as a filter in list requests. Corresponds to the JSON property kind

Returns:

  • (String) 


5657
5658
5659
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5657

def kind
  @kind
end

#long_description ⇒ String

A detailed description of this note. Corresponds to the JSON property longDescription

Returns:

  • (String) 


5662
5663
5664
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5662

def long_description
  @long_description
end

#name ⇒ String

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

Returns:

  • (String) 


5668
5669
5670
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5668

def name
  @name
end

#package ⇒ Google::Apis::ContaineranalysisV1beta1::Package

Package represents a particular package version. Corresponds to the JSON property package

Returns:



5673
5674
5675
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5673

def package
  @package
end

#related_note_names ⇒ Array<String>

Other notes related to this note. Corresponds to the JSON property relatedNoteNames

Returns:

  • (Array<String>) 


5678
5679
5680
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5678

def related_note_names
  @related_note_names
end

#related_url ⇒ Array<Google::Apis::ContaineranalysisV1beta1::RelatedUrl>

URLs associated with this note. Corresponds to the JSON property relatedUrl

Returns:



5683
5684
5685
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5683

def related_url
  @related_url
end

#sbom ⇒ Google::Apis::ContaineranalysisV1beta1::DocumentNote

DocumentNote represents an SPDX Document Creation Information section: https:// spdx.github.io/spdx-spec/2-document-creation-information/ Corresponds to the JSON property sbom

Returns:



5689
5690
5691
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5689

def sbom
  @sbom
end

#sbom_reference ⇒ Google::Apis::ContaineranalysisV1beta1::SbomReferenceNote

The note representing an SBOM reference. Corresponds to the JSON property sbomReference

Returns:



5694
5695
5696
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5694

def sbom_reference
  @sbom_reference
end

#secret ⇒ Google::Apis::ContaineranalysisV1beta1::SecretNote

The note representing a secret. Corresponds to the JSON property secret

Returns:



5699
5700
5701
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5699

def secret
  @secret
end

#short_description ⇒ String

A one sentence description of this note. Corresponds to the JSON property shortDescription

Returns:

  • (String) 


5704
5705
5706
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5704

def short_description
  @short_description
end

#spdx_file ⇒ Google::Apis::ContaineranalysisV1beta1::FileNote

FileNote represents an SPDX File Information section: https://spdx.github.io/ spdx-spec/4-file-information/ Corresponds to the JSON property spdxFile

Returns:



5710
5711
5712
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5710

def spdx_file
  @spdx_file
end

#spdx_package ⇒ Google::Apis::ContaineranalysisV1beta1::PackageInfoNote

PackageInfoNote represents an SPDX Package Information section: https://spdx. github.io/spdx-spec/3-package-information/ Corresponds to the JSON property spdxPackage

Returns:



5716
5717
5718
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5716

def spdx_package
  @spdx_package
end

#spdx_relationship ⇒ Google::Apis::ContaineranalysisV1beta1::RelationshipNote

RelationshipNote represents an SPDX Relationship section: https://spdx.github. io/spdx-spec/7-relationships-between-SPDX-elements/ Corresponds to the JSON property spdxRelationship

Returns:



5722
5723
5724
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5722

def spdx_relationship
  @spdx_relationship
end

#update_time ⇒ String

Output only. The time this note was last updated. This field can be used as a filter in list requests. Corresponds to the JSON property updateTime

Returns:

  • (String) 


5728
5729
5730
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5728

def update_time
  @update_time
end

#vulnerability ⇒ Google::Apis::ContaineranalysisV1beta1::Vulnerability

Vulnerability provides metadata about a security vulnerability in a Note. Corresponds to the JSON property vulnerability

Returns:



5733
5734
5735
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5733

def vulnerability
  @vulnerability
end

#vulnerability_assessment ⇒ Google::Apis::ContaineranalysisV1beta1::VulnerabilityAssessmentNote

A single VulnerabilityAssessmentNote represents one particular product's vulnerability assessment for one CVE. Corresponds to the JSON property vulnerabilityAssessment

Returns:



5739
5740
5741
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5739

def vulnerability_assessment
  @vulnerability_assessment
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5746

def update!(**args)
  @ai_skill_analysis = args[:ai_skill_analysis] if args.key?(:ai_skill_analysis)
  @attestation_authority = args[:attestation_authority] if args.key?(:attestation_authority)
  @base_image = args[:base_image] if args.key?(:base_image)
  @build = args[:build] if args.key?(:build)
  @create_time = args[:create_time] if args.key?(:create_time)
  @deployable = args[:deployable] if args.key?(:deployable)
  @discovery = args[:discovery] if args.key?(:discovery)
  @expiration_time = args[:expiration_time] if args.key?(:expiration_time)
  @intoto = args[:intoto] if args.key?(:intoto)
  @kind = args[:kind] if args.key?(:kind)
  @long_description = args[:long_description] if args.key?(:long_description)
  @name = args[:name] if args.key?(:name)
  @package = args[:package] if args.key?(:package)
  @related_note_names = args[:related_note_names] if args.key?(:related_note_names)
  @related_url = args[:related_url] if args.key?(:related_url)
  @sbom = args[:sbom] if args.key?(:sbom)
  @sbom_reference = args[:sbom_reference] if args.key?(:sbom_reference)
  @secret = args[:secret] if args.key?(:secret)
  @short_description = args[:short_description] if args.key?(:short_description)
  @spdx_file = args[:spdx_file] if args.key?(:spdx_file)
  @spdx_package = args[:spdx_package] if args.key?(:spdx_package)
  @spdx_relationship = args[:spdx_relationship] if args.key?(:spdx_relationship)
  @update_time = args[:update_time] if args.key?(:update_time)
  @vulnerability = args[:vulnerability] if args.key?(:vulnerability)
  @vulnerability_assessment = args[:vulnerability_assessment] if args.key?(:vulnerability_assessment)
end