Class: Google::Apis::ContaineranalysisV1beta1::PackageNote

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

PackageNote represents an SPDX Package Information section: https://spdx. github.io/spdx-spec/3-package-information/

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PackageNote

Returns a new instance of PackageNote.



2799
2800
2801
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 2799

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

Instance Attribute Details

#analyzed ⇒ Boolean Also known as: analyzed?

Indicates whether the file content of this package has been available for or subjected to analysis when creating the SPDX document Corresponds to the JSON property analyzed

Returns:

  • (Boolean) 


2706
2707
2708
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 2706

def analyzed
  @analyzed
end

#attribution ⇒ String

A place for the SPDX data creator to record, at the package level, acknowledgements that may be needed to be communicated in some contexts Corresponds to the JSON property attribution

Returns:

  • (String) 


2713
2714
2715
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 2713

def attribution
  @attribution
end

#checksum ⇒ String

Provide an independently reproducible mechanism that permits unique identification of a specific package that correlates to the data in this SPDX file Corresponds to the JSON property checksum

Returns:

  • (String) 


2720
2721
2722
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 2720

def checksum
  @checksum
end

#copyright ⇒ String

Identify the copyright holders of the package, as well as any dates present Corresponds to the JSON property copyright

Returns:

  • (String) 


2725
2726
2727
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 2725

def copyright
  @copyright
end

#detailed_description ⇒ String

A more detailed description of the package Corresponds to the JSON property detailedDescription

Returns:

  • (String) 


2730
2731
2732
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 2730

def detailed_description
  @detailed_description
end

#download_location ⇒ String

This section identifies the download Universal Resource Locator (URL), or a specific location within a version control system (VCS) for the package at the time that the SPDX file was created Corresponds to the JSON property downloadLocation

Returns:

  • (String) 


2737
2738
2739
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 2737

def download_location
  @download_location
end

#external_refs ⇒ Array<Google::Apis::ContaineranalysisV1beta1::ExternalRef>

ExternalRef Corresponds to the JSON property externalRefs

Returns:



2742
2743
2744
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 2742

def external_refs
  @external_refs
end

#files_license_info ⇒ Array<String>

Contain the license the SPDX file creator has concluded as governing the This field is to contain a list of all licenses found in the package. The relationship between licenses (i.e., conjunctive, disjunctive) is not specified in this field – it is simply a listing of all licenses found Corresponds to the JSON property filesLicenseInfo

Returns:

  • (Array<String>) 


2750
2751
2752
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 2750

def files_license_info
  @files_license_info
end

#home_page ⇒ String

Provide a place for the SPDX file creator to record a web site that serves as the package's home page Corresponds to the JSON property homePage

Returns:

  • (String) 


2756
2757
2758
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 2756

def home_page
  @home_page
end

#license_declared ⇒ String

List the licenses that have been declared by the authors of the package Corresponds to the JSON property licenseDeclared

Returns:

  • (String) 


2761
2762
2763
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 2761

def license_declared
  @license_declared
end

#originator ⇒ String

If the package identified in the SPDX file originated from a different person or organization than identified as Package Supplier, this field identifies from where or whom the package originally came Corresponds to the JSON property originator

Returns:

  • (String) 


2768
2769
2770
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 2768

def originator
  @originator
end

#summary_description ⇒ String

A short description of the package Corresponds to the JSON property summaryDescription

Returns:

  • (String) 


2773
2774
2775
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 2773

def summary_description
  @summary_description
end

#supplier ⇒ String

Identify the actual distribution source for the package/directory identified in the SPDX file Corresponds to the JSON property supplier

Returns:

  • (String) 


2779
2780
2781
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 2779

def supplier
  @supplier
end

#title ⇒ String

Identify the full name of the package as given by the Package Originator Corresponds to the JSON property title

Returns:

  • (String) 


2784
2785
2786
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 2784

def title
  @title
end

#verification_code ⇒ String

This field provides an independently reproducible mechanism identifying specific contents of a package based on the actual files (except the SPDX file itself, if it is included in the package) that make up each package and that correlates to the data in this SPDX file Corresponds to the JSON property verificationCode

Returns:

  • (String) 


2792
2793
2794
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 2792

def verification_code
  @verification_code
end

#version ⇒ String

Identify the version of the package Corresponds to the JSON property version

Returns:

  • (String) 


2797
2798
2799
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 2797

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 2804

def update!(**args)
  @analyzed = args[:analyzed] if args.key?(:analyzed)
  @attribution = args[:attribution] if args.key?(:attribution)
  @checksum = args[:checksum] if args.key?(:checksum)
  @copyright = args[:copyright] if args.key?(:copyright)
  @detailed_description = args[:detailed_description] if args.key?(:detailed_description)
  @download_location = args[:download_location] if args.key?(:download_location)
  @external_refs = args[:external_refs] if args.key?(:external_refs)
  @files_license_info = args[:files_license_info] if args.key?(:files_license_info)
  @home_page = args[:home_page] if args.key?(:home_page)
  @license_declared = args[:license_declared] if args.key?(:license_declared)
  @originator = args[:originator] if args.key?(:originator)
  @summary_description = args[:summary_description] if args.key?(:summary_description)
  @supplier = args[:supplier] if args.key?(:supplier)
  @title = args[:title] if args.key?(:title)
  @verification_code = args[:verification_code] if args.key?(:verification_code)
  @version = args[:version] if args.key?(:version)
end