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.



5576
5577
5578
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 5576

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) 


5478
5479
5480
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 5478

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) 


5485
5486
5487
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 5485

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) 


5492
5493
5494
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 5492

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) 


5497
5498
5499
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 5497

def copyright
  @copyright
end

#detailed_description ⇒ String

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

Returns:

  • (String) 


5502
5503
5504
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 5502

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) 


5509
5510
5511
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 5509

def download_location
  @download_location
end

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

ExternalRef Corresponds to the JSON property externalRefs

Returns:



5514
5515
5516
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 5514

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


5522
5523
5524
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 5522

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) 


5528
5529
5530
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 5528

def home_page
  @home_page
end

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

License information. Corresponds to the JSON property licenseDeclared

Returns:



5533
5534
5535
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 5533

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) 


5540
5541
5542
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 5540

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) 


5545
5546
5547
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 5545

def package_type
  @package_type
end

#summary_description ⇒ String

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

Returns:

  • (String) 


5550
5551
5552
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 5550

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) 


5556
5557
5558
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 5556

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) 


5561
5562
5563
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 5561

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) 


5569
5570
5571
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 5569

def verification_code
  @verification_code
end

#version ⇒ String

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

Returns:

  • (String) 


5574
5575
5576
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 5574

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 5581

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