Class: SBOM::CycloneDX::Record::Composition

Inherits:
Base
  • Object
show all
Defined in:
lib/sbom/cyclone_dx/record/composition.rb,
sig/sbom/cyclone_dx/record/composition.rbs

Overview

Schema name: Composition

Constant Summary

Constants inherited from Base

Base::Record

Instance Attribute Summary

Attributes inherited from Base

#errors

Instance Method Summary collapse

Methods inherited from Base

#<=>, const, custom_validators, fields, #formatted_errors, json_create, json_name, prop, #valid!, #valid?, validate

Methods included from _Klass

#const, #const_names, #create, #create!, #custom_validators, #fields, #json_name, #prop, #prop_names, #validate

Methods included from _Instance

#as_json, #errors, #formatted_errors, #to_json, #valid?

Constructor Details

#initialize ⇒ Composition

Returns a new instance of Composition.

Parameters:

  • bom_ref: (String, nil)
  • aggregate: (String, nil)
  • assemblies: (Array[String], nil)
  • dependencies: (Array[Component | Service], nil)
  • vulnerabilities: (Array[Vulnerability], nil)
  • signature: (Signature::signatureChoice, nil) 


5
 
# File 'sig/sbom/cyclone_dx/record/composition.rbs', line 5

def initialize: (?bom_ref: String?, ?aggregate: String?, ?assemblies: Array[String]?, ?dependencies: Array[Component | Service]?, ?vulnerabilities: Array[Vulnerability]?, ?signature: Signature::signatureChoice?) -> void

Instance Method Details

#aggregate ⇒ String?

Returns:

  • (String, nil) 


12
 
# File 'sig/sbom/cyclone_dx/record/composition.rbs', line 12

def aggregate: () -> String?

#aggregate= ⇒ String?

Parameters:

  • (String, nil)

Returns:

  • (String, nil) 


13
 
# File 'sig/sbom/cyclone_dx/record/composition.rbs', line 13

def aggregate=: (String?) -> String?

#aggregate? ⇒ Boolean

Returns:

  • (Boolean) 


14
 
# File 'sig/sbom/cyclone_dx/record/composition.rbs', line 14

def aggregate?: () -> bool

#aggregate_valid? ⇒ Boolean

Returns:

  • (Boolean) 


15
 
# File 'sig/sbom/cyclone_dx/record/composition.rbs', line 15

def aggregate_valid?: () -> bool

#assemblies ⇒ Array[String]?

Returns:

  • (Array[String], nil) 


17
 
# File 'sig/sbom/cyclone_dx/record/composition.rbs', line 17

def assemblies: () -> Array[String]?

#assemblies= ⇒ Array[String]?

Parameters:

  • (Array[String], nil)

Returns:

  • (Array[String], nil) 


18
 
# File 'sig/sbom/cyclone_dx/record/composition.rbs', line 18

def assemblies=: (Array[String]?) -> Array[String]?

#assemblies? ⇒ Boolean

Returns:

  • (Boolean) 


19
 
# File 'sig/sbom/cyclone_dx/record/composition.rbs', line 19

def assemblies?: () -> bool

#assemblies_valid? ⇒ Boolean

Returns:

  • (Boolean) 


20
 
# File 'sig/sbom/cyclone_dx/record/composition.rbs', line 20

def assemblies_valid?: () -> bool

#bom_ref ⇒ String?

Returns:

  • (String, nil) 


7
 
# File 'sig/sbom/cyclone_dx/record/composition.rbs', line 7

def bom_ref: () -> String?

#bom_ref= ⇒ String?

Parameters:

  • (String, nil)

Returns:

  • (String, nil) 


8
 
# File 'sig/sbom/cyclone_dx/record/composition.rbs', line 8

def bom_ref=: (String?) -> String?

#bom_ref? ⇒ Boolean

Returns:

  • (Boolean) 


9
 
# File 'sig/sbom/cyclone_dx/record/composition.rbs', line 9

def bom_ref?: () -> bool

#bom_ref_valid? ⇒ Boolean

Returns:

  • (Boolean) 


10
 
# File 'sig/sbom/cyclone_dx/record/composition.rbs', line 10

def bom_ref_valid?: () -> bool

#dependencies ⇒ Array[Component | Service]?

Returns:



22
 
# File 'sig/sbom/cyclone_dx/record/composition.rbs', line 22

def dependencies: () -> (Array[Component | Service])?

#dependencies= ⇒ Array[Component | Service]?

Parameters:

Returns:



23
 
# File 'sig/sbom/cyclone_dx/record/composition.rbs', line 23

def dependencies=: (Array[Component | Service]?) -> (Array[Component | Service])?

#dependencies? ⇒ Boolean

Returns:

  • (Boolean) 


24
 
# File 'sig/sbom/cyclone_dx/record/composition.rbs', line 24

def dependencies?: () -> bool

#dependencies_valid? ⇒ Boolean

Returns:

  • (Boolean) 


25
 
# File 'sig/sbom/cyclone_dx/record/composition.rbs', line 25

def dependencies_valid?: () -> bool

#signature ⇒ Signature::signatureChoice?

Returns:

  • (Signature::signatureChoice, nil) 


32
 
# File 'sig/sbom/cyclone_dx/record/composition.rbs', line 32

def signature: () -> Signature::signatureChoice?

#signature= ⇒ Signature::signatureChoice?

Parameters:

  • (Signature::signatureChoice, nil)

Returns:

  • (Signature::signatureChoice, nil) 


33
 
# File 'sig/sbom/cyclone_dx/record/composition.rbs', line 33

def signature=: (Signature::signatureChoice?) -> Signature::signatureChoice?

#signature? ⇒ Boolean

Returns:

  • (Boolean) 


34
 
# File 'sig/sbom/cyclone_dx/record/composition.rbs', line 34

def signature?: () -> bool

#signature_valid? ⇒ Boolean

Returns:

  • (Boolean) 


35
 
# File 'sig/sbom/cyclone_dx/record/composition.rbs', line 35

def signature_valid?: () -> bool

#vulnerabilities ⇒ Array[Vulnerability]?

Returns:



27
 
# File 'sig/sbom/cyclone_dx/record/composition.rbs', line 27

def vulnerabilities: () -> Array[Vulnerability]?

#vulnerabilities= ⇒ Array[Vulnerability]?

Parameters:

Returns:



28
 
# File 'sig/sbom/cyclone_dx/record/composition.rbs', line 28

def vulnerabilities=: (Array[Vulnerability]?) -> Array[Vulnerability]?

#vulnerabilities? ⇒ Boolean

Returns:

  • (Boolean) 


29
 
# File 'sig/sbom/cyclone_dx/record/composition.rbs', line 29

def vulnerabilities?: () -> bool

#vulnerabilities_valid? ⇒ Boolean

Returns:

  • (Boolean) 


30
 
# File 'sig/sbom/cyclone_dx/record/composition.rbs', line 30

def vulnerabilities_valid?: () -> bool