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.



4349
4350
4351
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4349

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) 


4251
4252
4253
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4251

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) 


4258
4259
4260
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4258

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) 


4265
4266
4267
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4265

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) 


4270
4271
4272
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4270

def copyright
  @copyright
end

#detailed_description ⇒ String

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

Returns:

  • (String) 


4275
4276
4277
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4275

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) 


4282
4283
4284
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4282

def download_location
  @download_location
end

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

ExternalRef Corresponds to the JSON property externalRefs

Returns:



4287
4288
4289
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4287

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


4295
4296
4297
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4295

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) 


4301
4302
4303
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4301

def home_page
  @home_page
end

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

License information. Corresponds to the JSON property licenseDeclared

Returns:



4306
4307
4308
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4306

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) 


4313
4314
4315
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4313

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) 


4318
4319
4320
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4318

def package_type
  @package_type
end

#summary_description ⇒ String

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

Returns:

  • (String) 


4323
4324
4325
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4323

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) 


4329
4330
4331
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4329

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) 


4334
4335
4336
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4334

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) 


4342
4343
4344
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4342

def verification_code
  @verification_code
end

#version ⇒ String

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

Returns:

  • (String) 


4347
4348
4349
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4347

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 4354

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