Class: Google::Apis::ContaineranalysisV1alpha1::Note

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

Overview

Provides a detailed description of a Note.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Note

Returns a new instance of Note.



4994
4995
4996
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4994

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

Instance Attribute Details

#attestation_authority ⇒ Google::Apis::ContaineranalysisV1alpha1::AttestationAuthority

Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one AttestationAuthority 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:



4856
4857
4858
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4856

def attestation_authority
  @attestation_authority
end

#base_image ⇒ Google::Apis::ContaineranalysisV1alpha1::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:



4863
4864
4865
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4863

def base_image
  @base_image
end

#build_type ⇒ Google::Apis::ContaineranalysisV1alpha1::BuildType

Note holding the version of the provider's builder and the signature of the provenance message in linked BuildDetails. Corresponds to the JSON property buildType

Returns:



4869
4870
4871
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4869

def build_type
  @build_type
end

#compliance ⇒ Google::Apis::ContaineranalysisV1alpha1::ComplianceNote

ComplianceNote encapsulates all information about a specific compliance check. Corresponds to the JSON property compliance

Returns:



4874
4875
4876
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4874

def compliance
  @compliance
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) 


4880
4881
4882
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4880

def create_time
  @create_time
end

#deployable ⇒ Google::Apis::ContaineranalysisV1alpha1::Deployable

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

Returns:



4885
4886
4887
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4885

def deployable
  @deployable
end

#discovery ⇒ Google::Apis::ContaineranalysisV1alpha1::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. The occurrence's operation will indicate the status of the analysis. Absence of an occurrence linked to this note for a resource indicates that analysis hasn't started. Corresponds to the JSON property discovery

Returns:



4894
4895
4896
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4894

def discovery
  @discovery
end

#dsse_attestation ⇒ Google::Apis::ContaineranalysisV1alpha1::DsseAttestationNote

A note describing an attestation Corresponds to the JSON property dsseAttestation

Returns:



4899
4900
4901
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4899

def dsse_attestation
  @dsse_attestation
end

#expiration_time ⇒ String

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

Returns:

  • (String) 


4904
4905
4906
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4904

def expiration_time
  @expiration_time
end

#kind ⇒ String

Output only. This explicitly denotes which kind of note is specified. This field can be used as a filter in list requests. Corresponds to the JSON property kind

Returns:

  • (String) 


4910
4911
4912
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4910

def kind
  @kind
end

#long_description ⇒ String

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

Returns:

  • (String) 


4915
4916
4917
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4915

def long_description
  @long_description
end

#name ⇒ String

The name of the note in the form "projects/provider_project_id/notes/ NOTE_ID" Corresponds to the JSON property name

Returns:

  • (String) 


4921
4922
4923
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4921

def name
  @name
end

#package ⇒ Google::Apis::ContaineranalysisV1alpha1::Package

This represents a particular package that is distributed over various channels. e.g. glibc (aka libc6) is distributed by many, at various versions. Corresponds to the JSON property package

Returns:



4927
4928
4929
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4927

def package
  @package
end

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

URLs associated with this note Corresponds to the JSON property relatedUrl

Returns:



4932
4933
4934
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4932

def related_url
  @related_url
end

#sbom ⇒ Google::Apis::ContaineranalysisV1alpha1::DocumentNote

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

Returns:



4938
4939
4940
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4938

def sbom
  @sbom
end

#sbom_reference ⇒ Google::Apis::ContaineranalysisV1alpha1::SbomReferenceNote

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

Returns:



4943
4944
4945
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4943

def sbom_reference
  @sbom_reference
end

#short_description ⇒ String

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

Returns:

  • (String) 


4948
4949
4950
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4948

def short_description
  @short_description
end

#spdx_file ⇒ Google::Apis::ContaineranalysisV1alpha1::FileNote

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

Returns:



4954
4955
4956
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4954

def spdx_file
  @spdx_file
end

#spdx_package ⇒ Google::Apis::ContaineranalysisV1alpha1::PackageInfoNote

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

Returns:



4960
4961
4962
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4960

def spdx_package
  @spdx_package
end

#spdx_relationship ⇒ Google::Apis::ContaineranalysisV1alpha1::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:



4966
4967
4968
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4966

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) 


4972
4973
4974
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4972

def update_time
  @update_time
end

#upgrade ⇒ Google::Apis::ContaineranalysisV1alpha1::UpgradeNote

An Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be a Upgrade Note. Corresponds to the JSON property upgrade

Returns:



4979
4980
4981
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4979

def upgrade
  @upgrade
end

#vulnerability_assessment ⇒ Google::Apis::ContaineranalysisV1alpha1::VulnerabilityAssessmentNote

A single VulnerabilityAssessmentNote represents one particular product's vulnerability assessment for one CVE. Multiple VulnerabilityAssessmentNotes together form a Vex statement. Please go/sds-vex-example for a sample Vex statement in the CSAF format. Corresponds to the JSON property vulnerabilityAssessment

Returns:



4987
4988
4989
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4987

def vulnerability_assessment
  @vulnerability_assessment
end

#vulnerability_type ⇒ Google::Apis::ContaineranalysisV1alpha1::VulnerabilityType

VulnerabilityType provides metadata about a security vulnerability. Corresponds to the JSON property vulnerabilityType

Returns:



4992
4993
4994
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4992

def vulnerability_type
  @vulnerability_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4999

def update!(**args)
  @attestation_authority = args[:attestation_authority] if args.key?(:attestation_authority)
  @base_image = args[:base_image] if args.key?(:base_image)
  @build_type = args[:build_type] if args.key?(:build_type)
  @compliance = args[:compliance] if args.key?(:compliance)
  @create_time = args[:create_time] if args.key?(:create_time)
  @deployable = args[:deployable] if args.key?(:deployable)
  @discovery = args[:discovery] if args.key?(:discovery)
  @dsse_attestation = args[:dsse_attestation] if args.key?(:dsse_attestation)
  @expiration_time = args[:expiration_time] if args.key?(:expiration_time)
  @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_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)
  @upgrade = args[:upgrade] if args.key?(:upgrade)
  @vulnerability_assessment = args[:vulnerability_assessment] if args.key?(:vulnerability_assessment)
  @vulnerability_type = args[:vulnerability_type] if args.key?(:vulnerability_type)
end