Class: Google::Apis::ContaineranalysisV1alpha1::PackageInfoNote

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

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.



4208
4209
4210
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4208

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) 


4109
4110
4111
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4109

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) 


4116
4117
4118
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4116

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) 


4123
4124
4125
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4123

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) 


4128
4129
4130
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4128

def copyright
  @copyright
end

#detailed_description ⇒ String

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

Returns:

  • (String) 


4133
4134
4135
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4133

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) 


4140
4141
4142
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4140

def download_location
  @download_location
end

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

ExternalRef Corresponds to the JSON property externalRefs

Returns:



4145
4146
4147
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4145

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


4153
4154
4155
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4153

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) 


4159
4160
4161
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4159

def home_page
  @home_page
end

#license_declared ⇒ Google::Apis::ContaineranalysisV1alpha1::License

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

Returns:



4165
4166
4167
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4165

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) 


4172
4173
4174
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4172

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) 


4177
4178
4179
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4177

def package_type
  @package_type
end

#summary_description ⇒ String

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

Returns:

  • (String) 


4182
4183
4184
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4182

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) 


4188
4189
4190
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4188

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) 


4193
4194
4195
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4193

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) 


4201
4202
4203
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4201

def verification_code
  @verification_code
end

#version ⇒ String

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

Returns:

  • (String) 


4206
4207
4208
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4206

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4213

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