Class: SBOM::CycloneDX::Record::Root

Inherits:

Base

• Object
• Base
• SBOM::CycloneDX::Record::Root

Defined in:

lib/sbom/cyclone_dx/record/root.rb,
sig/sbom/cyclone_dx/record/root.rbs

Overview

Schema name: Root

Constant Summary

Constants inherited from Base

Base::Record

Instance Attribute Summary

Attributes inherited from Base

#errors

Instance Method Summary

• #annotations ⇒ Array[Annotation]^?
• #annotations= ⇒ Array[Annotation]^?
• #annotations? ⇒ Boolean
• #annotations_valid? ⇒ Boolean
• #components ⇒ Array[Component]^?
• #components= ⇒ Array[Component]^?
• #components? ⇒ Boolean
• #components_valid? ⇒ Boolean
• #compositions ⇒ Array[Composition]^?
• #compositions= ⇒ Array[Composition]^?
• #compositions? ⇒ Boolean
• #compositions_valid? ⇒ Boolean
• #declarations ⇒ Declarations^?
• #declarations= ⇒ Declarations^?
• #declarations? ⇒ Boolean
• #declarations_valid? ⇒ Boolean
• #definitions ⇒ Definitions^?
• #definitions= ⇒ Definitions^?
• #definitions? ⇒ Boolean
• #definitions_valid? ⇒ Boolean
• #dependencies ⇒ Array[Dependency]^?
• #dependencies= ⇒ Array[Dependency]^?
• #dependencies? ⇒ Boolean
• #dependencies_valid? ⇒ Boolean
• #external_references ⇒ Array[ExternalReference]^?
• #external_references= ⇒ Array[ExternalReference]^?
• #external_references? ⇒ Boolean
• #external_references_valid? ⇒ Boolean
• #formulation ⇒ Array[Formula]^?
• #formulation= ⇒ Array[Formula]^?
• #formulation? ⇒ Boolean
• #formulation_valid? ⇒ Boolean
• #initialize ⇒ Root constructor

  A new instance of Root.

• #metadata ⇒ Metadata^?
• #metadata= ⇒ Metadata^?
• #metadata? ⇒ Boolean
• #metadata_valid? ⇒ Boolean
• #properties ⇒ Array[Property]^?
• #properties= ⇒ Array[Property]^?
• #properties? ⇒ Boolean
• #properties_valid? ⇒ Boolean
• #serial_number ⇒ String^?
• #serial_number= ⇒ String^?
• #serial_number? ⇒ Boolean
• #serial_number_valid? ⇒ Boolean
• #services ⇒ Array[Service]^?
• #services= ⇒ Array[Service]^?
• #services? ⇒ Boolean
• #services_valid? ⇒ Boolean
• #signature ⇒ Signature::signatureChoice^?
• #signature= ⇒ Signature::signatureChoice^?
• #signature? ⇒ Boolean
• #signature_valid? ⇒ Boolean
• #version ⇒ Integer
• #version= ⇒ Integer
• #version? ⇒ Boolean
• #version_valid? ⇒ Boolean
• #vulnerabilities ⇒ Array[Vulnerability]^?
• #vulnerabilities= ⇒ Array[Vulnerability]^?
• #vulnerabilities? ⇒ Boolean
• #vulnerabilities_valid? ⇒ Boolean

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 ⇒ Root

Returns a new instance of Root.

Parameters:

• serial_number: (String, nil)
• version: (Integer)
• metadata: (Metadata, nil)
• components: (Array[Component], nil)
• services: (Array[Service], nil)
• external_references: (Array[ExternalReference], nil)
• dependencies: (Array[Dependency], nil)
• compositions: (Array[Composition], nil)
• vulnerabilities: (Array[Vulnerability], nil)
• annotations: (Array[Annotation], nil)
• formulation: (Array[Formula], nil)
• declarations: (Declarations, nil)
• definitions: (Definitions, nil)
• properties: (Array[Property], nil)
• signature: (Signature::signatureChoice, nil)

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

def initialize: (?serial_number: String?, ?version: Integer, ?metadata: Metadata?, ?components: Array[Component]?, ?services: Array[Service]?, ?external_references: Array[ExternalReference]?, ?dependencies: Array[Dependency]?, ?compositions: Array[Composition]?, ?vulnerabilities: Array[Vulnerability]?, ?annotations: Array[Annotation]?, ?formulation: Array[Formula]?, ?declarations: Declarations?, ?definitions: Definitions?, ?properties: Array[Property]?, ?signature: Signature::signatureChoice?) -> void

Instance Method Details

#annotations ⇒ Array[Annotation]^?

Returns:

• (Array[Annotation], nil)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 52

def annotations: () -> Array[Annotation]?

#annotations= ⇒ Array[Annotation]^?

Parameters:

• (Array[Annotation], nil)

Returns:

• (Array[Annotation], nil)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 53

def annotations=: (Array[Annotation]?) -> Array[Annotation]?

#annotations? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 54

def annotations?: () -> bool

#annotations_valid? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 55

def annotations_valid?: () -> bool

#components ⇒ Array[Component]^?

Returns:

• (Array[Component], nil)

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

def components: () -> Array[Component]?

#components= ⇒ Array[Component]^?

Parameters:

• (Array[Component], nil)

Returns:

• (Array[Component], nil)

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

def components=: (Array[Component]?) -> Array[Component]?

#components? ⇒ Boolean

Returns:

• (Boolean)

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

def components?: () -> bool

#components_valid? ⇒ Boolean

Returns:

• (Boolean)

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

def components_valid?: () -> bool

#compositions ⇒ Array[Composition]^?

Returns:

• (Array[Composition], nil)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 42

def compositions: () -> Array[Composition]?

#compositions= ⇒ Array[Composition]^?

Parameters:

• (Array[Composition], nil)

Returns:

• (Array[Composition], nil)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 43

def compositions=: (Array[Composition]?) -> Array[Composition]?

#compositions? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 44

def compositions?: () -> bool

#compositions_valid? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 45

def compositions_valid?: () -> bool

#declarations ⇒ Declarations^?

Returns:

• (Declarations, nil)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 62

def declarations: () -> Declarations?

#declarations= ⇒ Declarations^?

Parameters:

• (Declarations, nil)

Returns:

• (Declarations, nil)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 63

def declarations=: (Declarations?) -> Declarations?

#declarations? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 64

def declarations?: () -> bool

#declarations_valid? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 65

def declarations_valid?: () -> bool

#definitions ⇒ Definitions^?

Returns:

• (Definitions, nil)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 67

def definitions: () -> Definitions?

#definitions= ⇒ Definitions^?

Parameters:

• (Definitions, nil)

Returns:

• (Definitions, nil)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 68

def definitions=: (Definitions?) -> Definitions?

#definitions? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 69

def definitions?: () -> bool

#definitions_valid? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 70

def definitions_valid?: () -> bool

#dependencies ⇒ Array[Dependency]^?

Returns:

• (Array[Dependency], nil)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 37

def dependencies: () -> Array[Dependency]?

#dependencies= ⇒ Array[Dependency]^?

Parameters:

• (Array[Dependency], nil)

Returns:

• (Array[Dependency], nil)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 38

def dependencies=: (Array[Dependency]?) -> Array[Dependency]?

#dependencies? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 39

def dependencies?: () -> bool

#dependencies_valid? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 40

def dependencies_valid?: () -> bool

#external_references ⇒ Array[ExternalReference]^?

Returns:

• (Array[ExternalReference], nil)

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

def external_references: () -> Array[ExternalReference]?

#external_references= ⇒ Array[ExternalReference]^?

Parameters:

• (Array[ExternalReference], nil)

Returns:

• (Array[ExternalReference], nil)

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

def external_references=: (Array[ExternalReference]?) -> Array[ExternalReference]?

#external_references? ⇒ Boolean

Returns:

• (Boolean)

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

def external_references?: () -> bool

#external_references_valid? ⇒ Boolean

Returns:

• (Boolean)

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

def external_references_valid?: () -> bool

#formulation ⇒ Array[Formula]^?

Returns:

• (Array[Formula], nil)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 57

def formulation: () -> Array[Formula]?

#formulation= ⇒ Array[Formula]^?

Parameters:

• (Array[Formula], nil)

Returns:

• (Array[Formula], nil)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 58

def formulation=: (Array[Formula]?) -> Array[Formula]?

#formulation? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 59

def formulation?: () -> bool

#formulation_valid? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 60

def formulation_valid?: () -> bool

#metadata ⇒ Metadata^?

Returns:

• (Metadata, nil)

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

def metadata: () -> Metadata?

#metadata= ⇒ Metadata^?

Parameters:

• (Metadata, nil)

Returns:

• (Metadata, nil)

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

def metadata=: (Metadata?) -> Metadata?

#metadata? ⇒ Boolean

Returns:

• (Boolean)

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

def metadata?: () -> bool

#metadata_valid? ⇒ Boolean

Returns:

• (Boolean)

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

def metadata_valid?: () -> bool

#properties ⇒ Array[Property]^?

Returns:

• (Array[Property], nil)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 72

def properties: () -> Array[Property]?

#properties= ⇒ Array[Property]^?

Parameters:

• (Array[Property], nil)

Returns:

• (Array[Property], nil)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 73

def properties=: (Array[Property]?) -> Array[Property]?

#properties? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 74

def properties?: () -> bool

#properties_valid? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 75

def properties_valid?: () -> bool

#serial_number ⇒ String^?

Returns:

• (String, nil)

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

def serial_number: () -> String?

#serial_number= ⇒ String^?

Parameters:

• (String, nil)

Returns:

• (String, nil)

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

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

#serial_number? ⇒ Boolean

Returns:

• (Boolean)

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

def serial_number?: () -> bool

#serial_number_valid? ⇒ Boolean

Returns:

• (Boolean)

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

def serial_number_valid?: () -> bool

#services ⇒ Array[Service]^?

Returns:

• (Array[Service], nil)

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

def services: () -> Array[Service]?

#services= ⇒ Array[Service]^?

Parameters:

• (Array[Service], nil)

Returns:

• (Array[Service], nil)

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

def services=: (Array[Service]?) -> Array[Service]?

#services? ⇒ Boolean

Returns:

• (Boolean)

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

def services?: () -> bool

#services_valid? ⇒ Boolean

Returns:

• (Boolean)

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

def services_valid?: () -> bool

#signature ⇒ Signature::signatureChoice^?

Returns:

• (Signature::signatureChoice, nil)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 77

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

#signature= ⇒ Signature::signatureChoice^?

Parameters:

• (Signature::signatureChoice, nil)

Returns:

• (Signature::signatureChoice, nil)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 78

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

#signature? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 79

def signature?: () -> bool

#signature_valid? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 80

def signature_valid?: () -> bool

#version ⇒ Integer

Returns:

• (Integer)

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

def version: () -> Integer

#version= ⇒ Integer

Parameters:

• (Integer)

Returns:

• (Integer)

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

def version=: (Integer) -> Integer

#version? ⇒ Boolean

Returns:

• (Boolean)

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

def version?: () -> bool

#version_valid? ⇒ Boolean

Returns:

• (Boolean)

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

def version_valid?: () -> bool

#vulnerabilities ⇒ Array[Vulnerability]^?

Returns:

• (Array[Vulnerability], nil)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 47

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

#vulnerabilities= ⇒ Array[Vulnerability]^?

Parameters:

• (Array[Vulnerability], nil)

Returns:

• (Array[Vulnerability], nil)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 48

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

#vulnerabilities? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 49

def vulnerabilities?: () -> bool

#vulnerabilities_valid? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/sbom/cyclone_dx/record/root.rbs', line 50

def vulnerabilities_valid?: () -> bool