Class: Google::Apis::ContaineranalysisV1beta1::PackageInfoNote

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

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

Returns a new instance of PackageInfoNote.



4054
4055
4056
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4054

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) 


3955
3956
3957
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 3955

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) 


3962
3963
3964
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 3962

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) 


3969
3970
3971
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 3969

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) 


3974
3975
3976
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 3974

def copyright
  @copyright
end

#detailed_description ⇒ String

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

Returns:

  • (String) 


3979
3980
3981
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 3979

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) 


3986
3987
3988
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 3986

def download_location
  @download_location
end

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

ExternalRef Corresponds to the JSON property externalRefs

Returns:



3991
3992
3993
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 3991

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


3999
4000
4001
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 3999

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) 


4005
4006
4007
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4005

def home_page
  @home_page
end

#license_declared ⇒ Google::Apis::ContaineranalysisV1beta1::License

License information: https://spdx.github.io/spdx-spec/3-package-information/# 315-declared-license Corresponds to the JSON property licenseDeclared

Returns:



4011
4012
4013
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4011

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) 


4018
4019
4020
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4018

def originator
  @originator
end

#package_type ⇒ String

The type of package: OS, MAVEN, GO, GO_STDLIB, etc. Corresponds to the JSON property packageType

Returns:

  • (String) 


4023
4024
4025
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4023

def package_type
  @package_type
end

#summary_description ⇒ String

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

Returns:

  • (String) 


4028
4029
4030
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4028

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) 


4034
4035
4036
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4034

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) 


4039
4040
4041
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4039

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) 


4047
4048
4049
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4047

def verification_code
  @verification_code
end

#version ⇒ String

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

Returns:

  • (String) 


4052
4053
4054
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4052

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 4059

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)
  @package_type = args[:package_type] if args.key?(:package_type)
  @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