Class: Google::Apis::ContaineranalysisV1alpha1::PackageNote

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

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.



2837
2838
2839
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 2837

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) 


2744
2745
2746
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 2744

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) 


2751
2752
2753
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 2751

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) 


2758
2759
2760
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 2758

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) 


2763
2764
2765
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 2763

def copyright
  @copyright
end

#detailed_description ⇒ String

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

Returns:

  • (String) 


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

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) 


2775
2776
2777
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 2775

def download_location
  @download_location
end

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

ExternalRef Corresponds to the JSON property externalRefs

Returns:



2780
2781
2782
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 2780

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>) 


2788
2789
2790
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 2788

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) 


2794
2795
2796
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 2794

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) 


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

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) 


2806
2807
2808
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 2806

def originator
  @originator
end

#summary_description ⇒ String

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

Returns:

  • (String) 


2811
2812
2813
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 2811

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) 


2817
2818
2819
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 2817

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) 


2822
2823
2824
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 2822

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) 


2830
2831
2832
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 2830

def verification_code
  @verification_code
end

#version ⇒ String

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

Returns:

  • (String) 


2835
2836
2837
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 2835

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 2842

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