Class: SBOM::CycloneDX::Record::Annotation

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

Overview

Schema name: Annotation

Defined Under Namespace

Classes: Annotator

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

Returns a new instance of Annotation.

Parameters:

  • bom_ref: (String, nil)
  • subjects: (Array[String])
  • annotator: (Annotator)
  • timestamp: (dateTime)
  • text: (String)
  • signature: (Signature::signatureChoice, nil) 


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

def initialize: (?bom_ref: String?, subjects: Array[String], annotator: Annotator, timestamp: dateTime, text: String, ?signature: Signature::signatureChoice?) -> void

Instance Method Details

#annotator ⇒ Annotator

Returns:



41
 
# File 'sig/sbom/cyclone_dx/record/annotation.rbs', line 41

def annotator: () -> Annotator

#annotator= ⇒ Annotator

Parameters:

Returns:



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

def annotator=: (Annotator) -> Annotator

#annotator? ⇒ Boolean

Returns:

  • (Boolean) 


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

def annotator?: () -> bool

#annotator_valid? ⇒ Boolean

Returns:

  • (Boolean) 


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

def annotator_valid?: () -> bool

#bom_ref ⇒ String?

Returns:

  • (String, nil) 


31
 
# File 'sig/sbom/cyclone_dx/record/annotation.rbs', line 31

def bom_ref: () -> String?

#bom_ref= ⇒ String?

Parameters:

  • (String, nil)

Returns:

  • (String, nil) 


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

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

#bom_ref? ⇒ Boolean

Returns:

  • (Boolean) 


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

def bom_ref?: () -> bool

#bom_ref_valid? ⇒ Boolean

Returns:

  • (Boolean) 


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

def bom_ref_valid?: () -> bool

#signature ⇒ Signature::signatureChoice?

Returns:

  • (Signature::signatureChoice, nil) 


56
 
# File 'sig/sbom/cyclone_dx/record/annotation.rbs', line 56

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

#signature= ⇒ Signature::signatureChoice?

Parameters:

  • (Signature::signatureChoice, nil)

Returns:

  • (Signature::signatureChoice, nil) 


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

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

#signature? ⇒ Boolean

Returns:

  • (Boolean) 


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

def signature?: () -> bool

#signature_valid? ⇒ Boolean

Returns:

  • (Boolean) 


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

def signature_valid?: () -> bool

#subjects ⇒ Array[String]

Returns:

  • (Array[String]) 


36
 
# File 'sig/sbom/cyclone_dx/record/annotation.rbs', line 36

def subjects: () -> Array[String]

#subjects= ⇒ Array[String]

Parameters:

  • (Array[String])

Returns:

  • (Array[String]) 


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

def subjects=: (Array[String]) -> Array[String]

#subjects? ⇒ Boolean

Returns:

  • (Boolean) 


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

def subjects?: () -> bool

#subjects_valid? ⇒ Boolean

Returns:

  • (Boolean) 


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

def subjects_valid?: () -> bool

#text ⇒ String

Returns:

  • (String) 


51
 
# File 'sig/sbom/cyclone_dx/record/annotation.rbs', line 51

def text: () -> String

#text= ⇒ String

Parameters:

  • (String)

Returns:

  • (String) 


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

def text=: (String) -> String

#text? ⇒ Boolean

Returns:

  • (Boolean) 


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

def text?: () -> bool

#text_valid? ⇒ Boolean

Returns:

  • (Boolean) 


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

def text_valid?: () -> bool

#timestamp ⇒ dateTime

Returns:

  • (dateTime) 


46
 
# File 'sig/sbom/cyclone_dx/record/annotation.rbs', line 46

def timestamp: () -> dateTime

#timestamp= ⇒ dateTime

Parameters:

  • (dateTime)

Returns:

  • (dateTime) 


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

def timestamp=: (dateTime) -> dateTime

#timestamp? ⇒ Boolean

Returns:

  • (Boolean) 


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

def timestamp?: () -> bool

#timestamp_valid? ⇒ Boolean

Returns:

  • (Boolean) 


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

def timestamp_valid?: () -> bool