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.



4762
4763
4764
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4762

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

Instance Attribute Details

#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:



4635
4636
4637
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4635

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:



4642
4643
4644
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4642

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:



4648
4649
4650
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4648

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) 


4654
4655
4656
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4654

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:



4659
4660
4661
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4659

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:



4666
4667
4668
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4666

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) 


4671
4672
4673
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4671

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:



4677
4678
4679
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4677

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) 


4683
4684
4685
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4683

def kind
  @kind
end

#long_description ⇒ String

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

Returns:

  • (String) 


4688
4689
4690
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4688

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) 


4694
4695
4696
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4694

def name
  @name
end

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

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

Returns:



4699
4700
4701
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4699

def package
  @package
end

#related_note_names ⇒ Array<String>

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

Returns:

  • (Array<String>) 


4704
4705
4706
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4704

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:



4709
4710
4711
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4709

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/v2.3/document-creation-information/ Corresponds to the JSON property sbom

Returns:



4715
4716
4717
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4715

def sbom
  @sbom
end

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

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

Returns:



4720
4721
4722
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4720

def sbom_reference
  @sbom_reference
end

#short_description ⇒ String

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

Returns:

  • (String) 


4725
4726
4727
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4725

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:



4731
4732
4733
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4731

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:



4737
4738
4739
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4737

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:



4743
4744
4745
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4743

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) 


4749
4750
4751
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4749

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:



4754
4755
4756
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4754

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:



4760
4761
4762
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4760

def vulnerability_assessment
  @vulnerability_assessment
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4767

def update!(**args)
  @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)
  @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