Class: SBOM::CycloneDX::Record::ReleaseNotes

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

Overview

Schema name: ReleaseNotes

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

Returns a new instance of ReleaseNotes.

Parameters:

  • type: (String)
  • title: (String, nil)
  • featured_image: (uri, nil)
  • social_image: (uri, nil)
  • description: (String, nil)
  • timestamp: (dateTime, nil)
  • aliases: (Array[String], nil)
  • tags: (Array[String], nil)
  • resolves: (Array[Issue], nil)
  • notes: (Array[Note], nil)
  • properties: (Array[Property], nil) 


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

def initialize: (type: String, ?title: String?, ?featured_image: uri?, ?social_image: uri?, ?description: String?, ?timestamp: dateTime?, ?aliases: Array[String]?, ?tags: Array[String]?, ?resolves: Array[Issue]?, ?notes: Array[Note]?, ?properties: Array[Property]?) -> void

Instance Method Details

#aliases ⇒ Array[String]?

Returns:

  • (Array[String], nil) 


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

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

#aliases= ⇒ Array[String]?

Parameters:

  • (Array[String], nil)

Returns:

  • (Array[String], nil) 


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

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

#aliases? ⇒ Boolean

Returns:

  • (Boolean) 


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

def aliases?: () -> bool

#aliases_valid? ⇒ Boolean

Returns:

  • (Boolean) 


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

def aliases_valid?: () -> bool

#description ⇒ String?

Returns:

  • (String, nil) 


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

def description: () -> String?

#description= ⇒ String?

Parameters:

  • (String, nil)

Returns:

  • (String, nil) 


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

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

#description? ⇒ Boolean

Returns:

  • (Boolean) 


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

def description?: () -> bool

#description_valid? ⇒ Boolean

Returns:

  • (Boolean) 


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

def description_valid?: () -> bool

#featured_image ⇒ uri?

Returns:

  • (uri, nil) 


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

def featured_image: () -> uri?

#featured_image= ⇒ uri?

Parameters:

  • (uri, nil)

Returns:

  • (uri, nil) 


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

def featured_image=: (uri?) -> uri?

#featured_image? ⇒ Boolean

Returns:

  • (Boolean) 


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

def featured_image?: () -> bool

#featured_image_valid? ⇒ Boolean

Returns:

  • (Boolean) 


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

def featured_image_valid?: () -> bool

#notes ⇒ Array[Note]?

Returns:

  • (Array[Note], nil) 


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

def notes: () -> Array[Note]?

#notes= ⇒ Array[Note]?

Parameters:

  • (Array[Note], nil)

Returns:

  • (Array[Note], nil) 


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

def notes=: (Array[Note]?) -> Array[Note]?

#notes? ⇒ Boolean

Returns:

  • (Boolean) 


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

def notes?: () -> bool

#notes_valid? ⇒ Boolean

Returns:

  • (Boolean) 


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

def notes_valid?: () -> bool

#properties ⇒ Array[Property]?

Returns:



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

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

#properties= ⇒ Array[Property]?

Parameters:

Returns:



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

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

#properties? ⇒ Boolean

Returns:

  • (Boolean) 


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

def properties?: () -> bool

#properties_valid? ⇒ Boolean

Returns:

  • (Boolean) 


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

def properties_valid?: () -> bool

#resolves ⇒ Array[Issue]?

Returns:



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

def resolves: () -> Array[Issue]?

#resolves= ⇒ Array[Issue]?

Parameters:

Returns:



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

def resolves=: (Array[Issue]?) -> Array[Issue]?

#resolves? ⇒ Boolean

Returns:

  • (Boolean) 


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

def resolves?: () -> bool

#resolves_valid? ⇒ Boolean

Returns:

  • (Boolean) 


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

def resolves_valid?: () -> bool

#social_image ⇒ uri?

Returns:

  • (uri, nil) 


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

def social_image: () -> uri?

#social_image= ⇒ uri?

Parameters:

  • (uri, nil)

Returns:

  • (uri, nil) 


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

def social_image=: (uri?) -> uri?

#social_image? ⇒ Boolean

Returns:

  • (Boolean) 


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

def social_image?: () -> bool

#social_image_valid? ⇒ Boolean

Returns:

  • (Boolean) 


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

def social_image_valid?: () -> bool

#tags ⇒ Array[String]?

Returns:

  • (Array[String], nil) 


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

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

#tags= ⇒ Array[String]?

Parameters:

  • (Array[String], nil)

Returns:

  • (Array[String], nil) 


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

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

#tags? ⇒ Boolean

Returns:

  • (Boolean) 


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

def tags?: () -> bool

#tags_valid? ⇒ Boolean

Returns:

  • (Boolean) 


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

def tags_valid?: () -> bool

#timestamp ⇒ dateTime?

Returns:

  • (dateTime, nil) 


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

def timestamp: () -> dateTime?

#timestamp= ⇒ dateTime?

Parameters:

  • (dateTime, nil)

Returns:

  • (dateTime, nil) 


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

def timestamp=: (dateTime?) -> dateTime?

#timestamp? ⇒ Boolean

Returns:

  • (Boolean) 


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

def timestamp?: () -> bool

#timestamp_valid? ⇒ Boolean

Returns:

  • (Boolean) 


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

def timestamp_valid?: () -> bool

#title ⇒ String?

Returns:

  • (String, nil) 


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

def title: () -> String?

#title= ⇒ String?

Parameters:

  • (String, nil)

Returns:

  • (String, nil) 


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

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

#title? ⇒ Boolean

Returns:

  • (Boolean) 


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

def title?: () -> bool

#title_valid? ⇒ Boolean

Returns:

  • (Boolean) 


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

def title_valid?: () -> bool

#type ⇒ String

Returns:

  • (String) 


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

def type: () -> String

#type= ⇒ String

Parameters:

  • (String)

Returns:

  • (String) 


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

def type=: (String) -> String

#type? ⇒ Boolean

Returns:

  • (Boolean) 


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

def type?: () -> bool

#type_valid? ⇒ Boolean

Returns:

  • (Boolean) 


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

def type_valid?: () -> bool