Class: SBOM::CycloneDX::Record::ModelCard::Considerations

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

Overview

Schema name: Considerations

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

Returns a new instance of Considerations.

Parameters:

  • users: (Array[String], nil)
  • use_cases: (Array[String], nil)
  • technical_limitations: (Array[String], nil)
  • performance_tradeoffs: (Array[String], nil)
  • ethical_considerations: (Array[Risk], nil)
  • environmental_considerations: (EnvironmentalConsideration, nil)
  • fairness_assessments: (Array[FairnessAssessment], nil) 


6
 
# File 'sig/sbom/cyclone_dx/record/model_card.rbs', line 6

def initialize: (?users: Array[String]?, ?use_cases: Array[String]?, ?technical_limitations: Array[String]?, ?performance_tradeoffs: Array[String]?, ?ethical_considerations: Array[Risk]?, ?environmental_considerations: EnvironmentalConsideration?, ?fairness_assessments: Array[FairnessAssessment]?) -> void

Instance Method Details

#environmental_considerations ⇒ EnvironmentalConsideration?

Returns:



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

def environmental_considerations: () -> EnvironmentalConsideration?

#environmental_considerations= ⇒ EnvironmentalConsideration?

Parameters:

Returns:



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

def environmental_considerations=: (EnvironmentalConsideration?) -> EnvironmentalConsideration?

#environmental_considerations? ⇒ Boolean

Returns:

  • (Boolean) 


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

def environmental_considerations?: () -> bool

#environmental_considerations_valid? ⇒ Boolean

Returns:

  • (Boolean) 


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

def environmental_considerations_valid?: () -> bool

#ethical_considerations ⇒ Array[Risk]?

Returns:

  • (Array[Risk], nil) 


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

def ethical_considerations: () -> Array[Risk]?

#ethical_considerations= ⇒ Array[Risk]?

Parameters:

  • (Array[Risk], nil)

Returns:

  • (Array[Risk], nil) 


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

def ethical_considerations=: (Array[Risk]?) -> Array[Risk]?

#ethical_considerations? ⇒ Boolean

Returns:

  • (Boolean) 


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

def ethical_considerations?: () -> bool

#ethical_considerations_valid? ⇒ Boolean

Returns:

  • (Boolean) 


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

def ethical_considerations_valid?: () -> bool

#fairness_assessments ⇒ Array[FairnessAssessment]?

Returns:



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

def fairness_assessments: () -> Array[FairnessAssessment]?

#fairness_assessments= ⇒ Array[FairnessAssessment]?

Parameters:

Returns:



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

def fairness_assessments=: (Array[FairnessAssessment]?) -> Array[FairnessAssessment]?

#fairness_assessments? ⇒ Boolean

Returns:

  • (Boolean) 


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

def fairness_assessments?: () -> bool

#fairness_assessments_valid? ⇒ Boolean

Returns:

  • (Boolean) 


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

def fairness_assessments_valid?: () -> bool

#performance_tradeoffs ⇒ Array[String]?

Returns:

  • (Array[String], nil) 


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

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

#performance_tradeoffs= ⇒ Array[String]?

Parameters:

  • (Array[String], nil)

Returns:

  • (Array[String], nil) 


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

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

#performance_tradeoffs? ⇒ Boolean

Returns:

  • (Boolean) 


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

def performance_tradeoffs?: () -> bool

#performance_tradeoffs_valid? ⇒ Boolean

Returns:

  • (Boolean) 


26
 
# File 'sig/sbom/cyclone_dx/record/model_card.rbs', line 26

def performance_tradeoffs_valid?: () -> bool

#technical_limitations ⇒ Array[String]?

Returns:

  • (Array[String], nil) 


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

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

#technical_limitations= ⇒ Array[String]?

Parameters:

  • (Array[String], nil)

Returns:

  • (Array[String], nil) 


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

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

#technical_limitations? ⇒ Boolean

Returns:

  • (Boolean) 


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

def technical_limitations?: () -> bool

#technical_limitations_valid? ⇒ Boolean

Returns:

  • (Boolean) 


21
 
# File 'sig/sbom/cyclone_dx/record/model_card.rbs', line 21

def technical_limitations_valid?: () -> bool

#use_cases ⇒ Array[String]?

Returns:

  • (Array[String], nil) 


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

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

#use_cases= ⇒ Array[String]?

Parameters:

  • (Array[String], nil)

Returns:

  • (Array[String], nil) 


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

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

#use_cases? ⇒ Boolean

Returns:

  • (Boolean) 


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

def use_cases?: () -> bool

#use_cases_valid? ⇒ Boolean

Returns:

  • (Boolean) 


16
 
# File 'sig/sbom/cyclone_dx/record/model_card.rbs', line 16

def use_cases_valid?: () -> bool

#users ⇒ Array[String]?

Returns:

  • (Array[String], nil) 


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

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

#users= ⇒ Array[String]?

Parameters:

  • (Array[String], nil)

Returns:

  • (Array[String], nil) 


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

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

#users? ⇒ Boolean

Returns:

  • (Boolean) 


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

def users?: () -> bool

#users_valid? ⇒ Boolean

Returns:

  • (Boolean) 


11
 
# File 'sig/sbom/cyclone_dx/record/model_card.rbs', line 11

def users_valid?: () -> bool