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.



2987
2988
2989
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 2987

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) 


2894
2895
2896
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 2894

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) 


2901
2902
2903
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 2901

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) 


2908
2909
2910
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 2908

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) 


2913
2914
2915
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 2913

def copyright
  @copyright
end

#detailed_description ⇒ String

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

Returns:

  • (String) 


2918
2919
2920
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 2918

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) 


2925
2926
2927
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 2925

def download_location
  @download_location
end

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

ExternalRef Corresponds to the JSON property externalRefs

Returns:



2930
2931
2932
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 2930

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


2938
2939
2940
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 2938

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) 


2944
2945
2946
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 2944

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) 


2949
2950
2951
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 2949

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) 


2956
2957
2958
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 2956

def originator
  @originator
end

#summary_description ⇒ String

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

Returns:

  • (String) 


2961
2962
2963
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 2961

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) 


2967
2968
2969
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 2967

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) 


2972
2973
2974
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 2972

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) 


2980
2981
2982
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 2980

def verification_code
  @verification_code
end

#version ⇒ String

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

Returns:

  • (String) 


2985
2986
2987
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 2985

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 2992

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