Class: Openlayer::Models::Governance::FrameworkListResponse::Item
- Inherits:
-
Internal::Type::BaseModel
- Object
- Internal::Type::BaseModel
- Openlayer::Models::Governance::FrameworkListResponse::Item
- Defined in:
- lib/openlayer/models/governance/framework_list_response.rb,
sig/openlayer/models/governance/framework_list_response.rbs
Defined Under Namespace
Classes: Avatar, ProjectSelector, RuleStats
Instance Attribute Summary collapse
-
#avatar ⇒ Openlayer::Models::Governance::FrameworkListResponse::Item::Avatar?
The icon shown for the framework.
-
#built_in_slug ⇒ String?
Identifies a framework that ships with Openlayer, for example
eu_ai_act,iso_42001,nist_ai_rmf, ortraiga. -
#creator_id ⇒ String?
Returns the value of attribute creator_id.
-
#date_created ⇒ Time
Returns the value of attribute date_created.
-
#date_updated ⇒ Time
Returns the value of attribute date_updated.
-
#description ⇒ String?
A short description of the framework.
-
#enabled ⇒ Boolean
Whether the framework is active.
-
#extended_description ⇒ Hash{Symbol=>Object}?
A longer, rich-text description, as a TipTap JSON document.
-
#href ⇒ String?
A link to the external standard or regulation the framework is based on.
-
#id ⇒ String
Returns the value of attribute id.
-
#immutable ⇒ Boolean?
readonly
Returns the value of attribute immutable.
-
#name ⇒ String
The framework name.
-
#project_selector ⇒ Openlayer::Models::Governance::FrameworkListResponse::Item::ProjectSelector?
Determines which projects the framework applies to.
-
#rule_stats ⇒ Openlayer::Models::Governance::FrameworkListResponse::Item::RuleStats?
readonly
Returns the value of attribute rule_stats.
-
#tags ⇒ Array<String>
Free-form labels on the framework.
-
#workspace_id ⇒ String
Returns the value of attribute workspace_id.
Class Method Summary collapse
Instance Method Summary collapse
- #immutable ⇒ Boolean readonly
-
#initialize(id:, date_created:, date_updated:, enabled:, name:, tags:, workspace_id:, avatar: nil, built_in_slug: nil, creator_id: nil, description: nil, extended_description: nil, href: nil, immutable: nil, project_selector: nil, rule_stats: nil) ⇒ Object
constructor
Some parameter documentations has been truncated, see Item for more details.
- #rule_stats ⇒ Object readonly
- #to_hash ⇒ {
Methods inherited from Internal::Type::BaseModel
==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml
Methods included from Internal::Type::Converter
#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info
Methods included from Internal::Util::SorbetRuntimeSupport
#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type
Constructor Details
#initialize(id:, date_created:, date_updated:, enabled:, name:, tags:, workspace_id:, avatar: nil, built_in_slug: nil, creator_id: nil, description: nil, extended_description: nil, href: nil, immutable: nil, project_selector: nil, rule_stats: nil) ⇒ Object
Some parameter documentations has been truncated, see Openlayer::Models::Governance::FrameworkListResponse::Item for more details.
`iso_
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 |
# File 'lib/openlayer/models/governance/framework_list_response.rb', line 17 class Item < Openlayer::Internal::Type::BaseModel # @!attribute enabled # Whether the framework is active. Rules of a disabled framework are not evaluated # and do not count towards compliance. # # @return [Boolean] required :enabled, Openlayer::Internal::Type::Boolean # @!attribute name # The framework name. # # @return [String] required :name, String # @!attribute tags # Free-form labels on the framework. # # @return [Array<String>] required :tags, Openlayer::Internal::Type::ArrayOf[String] # @!attribute avatar # The icon shown for the framework. # # @return [Openlayer::Models::Governance::FrameworkListResponse::Item::Avatar, nil] optional :avatar, -> { Openlayer::Models::Governance::FrameworkListResponse::Item::Avatar }, nil?: true # @!attribute built_in_slug # Identifies a framework that ships with Openlayer, for example `eu_ai_act`, # `iso_42001`, `nist_ai_rmf`, or `traiga`. `null` for frameworks you create # yourself. # # @return [String, nil] optional :built_in_slug, String, api_name: :builtInSlug, nil?: true # @!attribute description # A short description of the framework. # # @return [String, nil] optional :description, String, nil?: true # @!attribute extended_description # A longer, rich-text description, as a TipTap JSON document. # # @return [Hash{Symbol=>Object}, nil] optional :extended_description, Openlayer::Internal::Type::HashOf[Openlayer::Internal::Type::Unknown], api_name: :extendedDescription, nil?: true # @!attribute href # A link to the external standard or regulation the framework is based on. # # @return [String, nil] optional :href, String, nil?: true # @!attribute project_selector # Determines which projects the framework applies to. An empty or `null` `match` # array applies the framework to every project in the workspace. # # @return [Openlayer::Models::Governance::FrameworkListResponse::Item::ProjectSelector, nil] optional :project_selector, -> { Openlayer::Models::Governance::FrameworkListResponse::Item::ProjectSelector }, api_name: :projectSelector, nil?: true response_only do # @!attribute id # The framework id. # # @return [String] required :id, String # @!attribute date_created # The creation date. # # @return [Time] required :date_created, Time, api_name: :dateCreated # @!attribute date_updated # The last update date. # # @return [Time] required :date_updated, Time, api_name: :dateUpdated # @!attribute workspace_id # The id of the workspace the framework belongs to. # # @return [String] required :workspace_id, String, api_name: :workspaceId # @!attribute creator_id # The user who created the framework. `null` for built-in frameworks. # # @return [String, nil] optional :creator_id, String, api_name: :creatorId, nil?: true # @!attribute immutable # Whether the framework definition is managed by Openlayer and cannot be edited. # # @return [Boolean, nil] optional :immutable, Openlayer::Internal::Type::Boolean # @!attribute rule_stats # Compliance roll-up for the framework. Present only on # `GET /workspaces/{workspaceId}/frameworks` when the request sets # `includeRuleStats=true`. # # @return [Openlayer::Models::Governance::FrameworkListResponse::Item::RuleStats, nil] optional :rule_stats, -> { Openlayer::Models::Governance::FrameworkListResponse::Item::RuleStats }, api_name: :ruleStats end # @!method initialize(id:, date_created:, date_updated:, enabled:, name:, tags:, workspace_id:, avatar: nil, built_in_slug: nil, creator_id: nil, description: nil, extended_description: nil, href: nil, immutable: nil, project_selector: nil, rule_stats: nil) # Some parameter documentations has been truncated, see # {Openlayer::Models::Governance::FrameworkListResponse::Item} for more details. # # @param id [String] The framework id. # # @param date_created [Time] The creation date. # # @param date_updated [Time] The last update date. # # @param enabled [Boolean] Whether the framework is active. Rules of a disabled framework are not evaluated # # @param name [String] The framework name. # # @param tags [Array<String>] Free-form labels on the framework. # # @param workspace_id [String] The id of the workspace the framework belongs to. # # @param avatar [Openlayer::Models::Governance::FrameworkListResponse::Item::Avatar, nil] The icon shown for the framework. # # @param built_in_slug [String, nil] Identifies a framework that ships with Openlayer, for example `eu_ai_act`, # `iso\_ # # @param creator_id [String, nil] The user who created the framework. `null` for built-in frameworks. # # @param description [String, nil] A short description of the framework. # # @param extended_description [Hash{Symbol=>Object}, nil] A longer, rich-text description, as a TipTap JSON document. # # @param href [String, nil] A link to the external standard or regulation the framework is based on. # # @param immutable [Boolean] Whether the framework definition is managed by Openlayer and cannot be edited. # # @param project_selector [Openlayer::Models::Governance::FrameworkListResponse::Item::ProjectSelector, nil] Determines which projects the framework applies to. An empty or `null` `match` a # # @param rule_stats [Openlayer::Models::Governance::FrameworkListResponse::Item::RuleStats] Compliance roll-up for the framework. Present only on `GET /workspaces/{workspac # @see Openlayer::Models::Governance::FrameworkListResponse::Item#avatar class Avatar < Openlayer::Internal::Type::BaseModel # @!attribute type # # @return [Symbol, Openlayer::Models::Governance::FrameworkListResponse::Item::Avatar::Type] required :type, enum: -> { Openlayer::Models::Governance::FrameworkListResponse::Item::Avatar::Type } # @!attribute value # # @return [String] required :value, String # @!method initialize(type:, value:) # The icon shown for the framework. # # @param type [Symbol, Openlayer::Models::Governance::FrameworkListResponse::Item::Avatar::Type] # @param value [String] # @see Openlayer::Models::Governance::FrameworkListResponse::Item::Avatar#type module Type extend Openlayer::Internal::Type::Enum EMOJI = :emoji IMAGE_URL = :imageUrl BUILTIN_IMAGE = :builtinImage # @!method self.values # @return [Array<Symbol>] end end # @see Openlayer::Models::Governance::FrameworkListResponse::Item#project_selector class ProjectSelector < Openlayer::Internal::Type::BaseModel # @!attribute match # Match criteria, ANDed together. # # @return [Array<Openlayer::Models::Governance::FrameworkListResponse::Item::ProjectSelector::Match>, nil] optional :match, -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::FrameworkListResponse::Item::ProjectSelector::Match] }, nil?: true # @!method initialize(match: nil) # Determines which projects the framework applies to. An empty or `null` `match` # array applies the framework to every project in the workspace. # # @param match [Array<Openlayer::Models::Governance::FrameworkListResponse::Item::ProjectSelector::Match>, nil] Match criteria, ANDed together. class Match < Openlayer::Internal::Type::BaseModel # @!attribute property # The project property to match against. # # @return [Symbol, Openlayer::Models::Governance::FrameworkListResponse::Item::ProjectSelector::Match::Property] required :property, enum: -> { Openlayer::Models::Governance::FrameworkListResponse::Item::ProjectSelector::Match::Property } # @!attribute value # The value to match against. Pass an array to match any of several values, or # `null` to match projects where the property is unset. Omit it for `exists` and # `notExists`. # # @return [Object] required :value, Openlayer::Internal::Type::Unknown # @!attribute operator # How to compare the project property with `value`. One of `equals`, `notEquals`, # `contains`, `notContains`, `startsWith`, `endsWith`, `in`, `notIn`, # `greaterThan`, `greaterThanOrEqual`, `lessThan`, `lessThanOrEqual`, # `equalsIgnoreCase`, `containsIgnoreCase`, `matches`, `exists`, or `notExists`. # # @return [String, nil] optional :operator, String # @!method initialize(property:, value:, operator: nil) # Some parameter documentations has been truncated, see # {Openlayer::Models::Governance::FrameworkListResponse::Item::ProjectSelector::Match} # for more details. # # @param property [Symbol, Openlayer::Models::Governance::FrameworkListResponse::Item::ProjectSelector::Match::Property] The project property to match against. # # @param value [Object] The value to match against. Pass an array to match any of several values, or `nu # # @param operator [String] How to compare the project property with `value`. One of `equals`, `notEquals`, # The project property to match against. # # @see Openlayer::Models::Governance::FrameworkListResponse::Item::ProjectSelector::Match#property module Property extend Openlayer::Internal::Type::Enum TASK_TYPE = :taskType RISK_LEVEL = :riskLevel RISK_TOTAL_SCORE = :riskTotalScore NAME = :name OWNER_ID = :ownerId MODEL_TYPES = :modelTypes # @!method self.values # @return [Array<Symbol>] end end end # @see Openlayer::Models::Governance::FrameworkListResponse::Item#rule_stats class RuleStats < Openlayer::Internal::Type::BaseModel # @!attribute project_completion # How many of the framework's projects fall into each completion band, where a # project's completion is the share of its rule results that are passing or # skipped. Projects with no evaluated results count as `low`. # # Zeroed when the request carries `projectId`: the bands compare a framework's # projects against each other, which says nothing about a single project. # # @return [Openlayer::Models::Governance::FrameworkListResponse::Item::RuleStats::ProjectCompletion] required :project_completion, -> { Openlayer::Models::Governance::FrameworkListResponse::Item::RuleStats::ProjectCompletion }, api_name: :projectCompletion # @!attribute rule_results # Rule result counts by status for this framework, matching what # `/workspaces/{workspaceId}/rule-stats?frameworkId=<id>` reports. Narrowed to a # single project when the request also carries `projectId`. # # @return [Openlayer::Models::Governance::FrameworkListResponse::Item::RuleStats::RuleResults] required :rule_results, -> { Openlayer::Models::Governance::FrameworkListResponse::Item::RuleStats::RuleResults }, api_name: :ruleResults # @!method initialize(project_completion:, rule_results:) # Some parameter documentations has been truncated, see # {Openlayer::Models::Governance::FrameworkListResponse::Item::RuleStats} for more # details. # # Compliance roll-up for the framework. Present only on # `GET /workspaces/{workspaceId}/frameworks` when the request sets # `includeRuleStats=true`. # # @param project_completion [Openlayer::Models::Governance::FrameworkListResponse::Item::RuleStats::ProjectCompletion] How many of the framework's projects fall into each completion band, where a pro # # @param rule_results [Openlayer::Models::Governance::FrameworkListResponse::Item::RuleStats::RuleResults] Rule result counts by status for this framework, matching what `/workspaces/{wor # @see Openlayer::Models::Governance::FrameworkListResponse::Item::RuleStats#project_completion class ProjectCompletion < Openlayer::Internal::Type::BaseModel # @!attribute high # Projects at 80% completion or above. # # @return [Integer] required :high, Integer # @!attribute low # Projects below 20% completion. # # @return [Integer] required :low, Integer # @!attribute mid # Projects at or above 20% but below 80% completion. # # @return [Integer] required :mid, Integer # @!method initialize(high:, low:, mid:) # How many of the framework's projects fall into each completion band, where a # project's completion is the share of its rule results that are passing or # skipped. Projects with no evaluated results count as `low`. # # Zeroed when the request carries `projectId`: the bands compare a framework's # projects against each other, which says nothing about a single project. # # @param high [Integer] Projects at 80% completion or above. # # @param low [Integer] Projects below 20% completion. # # @param mid [Integer] Projects at or above 20% but below 80% completion. end # @see Openlayer::Models::Governance::FrameworkListResponse::Item::RuleStats#rule_results class RuleResults < Openlayer::Internal::Type::BaseModel # @!attribute total # The total number of rule results. # # @return [Integer] required :total, Integer # @!attribute total_due_soon # The number of rule results whose evidence is about to expire. # # @return [Integer] required :total_due_soon, Integer, api_name: :totalDueSoon # @!attribute total_error # The number of rule results that errored during evaluation. # # @return [Integer] required :total_error, Integer, api_name: :totalError # @!attribute total_failing # The number of failing rule results. # # @return [Integer] required :total_failing, Integer, api_name: :totalFailing # @!attribute total_passing # The number of passing rule results. # # @return [Integer] required :total_passing, Integer, api_name: :totalPassing # @!attribute total_pending # The number of rule results that have not been satisfied yet. # # @return [Integer] required :total_pending, Integer, api_name: :totalPending # @!attribute total_running # The number of rule results currently being evaluated. # # @return [Integer] required :total_running, Integer, api_name: :totalRunning # @!attribute total_skipped # The number of skipped rule results. # # @return [Integer] required :total_skipped, Integer, api_name: :totalSkipped # @!method initialize(total:, total_due_soon:, total_error:, total_failing:, total_passing:, total_pending:, total_running:, total_skipped:) # Rule result counts by status for this framework, matching what # `/workspaces/{workspaceId}/rule-stats?frameworkId=<id>` reports. Narrowed to a # single project when the request also carries `projectId`. # # @param total [Integer] The total number of rule results. # # @param total_due_soon [Integer] The number of rule results whose evidence is about to expire. # # @param total_error [Integer] The number of rule results that errored during evaluation. # # @param total_failing [Integer] The number of failing rule results. # # @param total_passing [Integer] The number of passing rule results. # # @param total_pending [Integer] The number of rule results that have not been satisfied yet. # # @param total_running [Integer] The number of rule results currently being evaluated. # # @param total_skipped [Integer] The number of skipped rule results. end end end |
Instance Attribute Details
#avatar ⇒ Openlayer::Models::Governance::FrameworkListResponse::Item::Avatar?
The icon shown for the framework.
41 |
# File 'lib/openlayer/models/governance/framework_list_response.rb', line 41 optional :avatar, -> { Openlayer::Models::Governance::FrameworkListResponse::Item::Avatar }, nil?: true |
#built_in_slug ⇒ String?
Identifies a framework that ships with Openlayer, for example eu_ai_act,
iso_42001, nist_ai_rmf, or traiga. null for frameworks you create
yourself.
49 |
# File 'lib/openlayer/models/governance/framework_list_response.rb', line 49 optional :built_in_slug, String, api_name: :builtInSlug, nil?: true |
#creator_id ⇒ String?
Returns the value of attribute creator_id.
67 68 69 |
# File 'sig/openlayer/models/governance/framework_list_response.rbs', line 67 def creator_id @creator_id end |
#date_created ⇒ Time
Returns the value of attribute date_created.
61 62 63 |
# File 'sig/openlayer/models/governance/framework_list_response.rbs', line 61 def date_created @date_created end |
#date_updated ⇒ Time
Returns the value of attribute date_updated.
63 64 65 |
# File 'sig/openlayer/models/governance/framework_list_response.rbs', line 63 def date_updated @date_updated end |
#description ⇒ String?
A short description of the framework.
55 |
# File 'lib/openlayer/models/governance/framework_list_response.rb', line 55 optional :description, String, nil?: true |
#enabled ⇒ Boolean
Whether the framework is active. Rules of a disabled framework are not evaluated and do not count towards compliance.
23 |
# File 'lib/openlayer/models/governance/framework_list_response.rb', line 23 required :enabled, Openlayer::Internal::Type::Boolean |
#extended_description ⇒ Hash{Symbol=>Object}?
A longer, rich-text description, as a TipTap JSON document.
61 62 63 64 |
# File 'lib/openlayer/models/governance/framework_list_response.rb', line 61 optional :extended_description, Openlayer::Internal::Type::HashOf[Openlayer::Internal::Type::Unknown], api_name: :extendedDescription, nil?: true |
#href ⇒ String?
A link to the external standard or regulation the framework is based on.
70 |
# File 'lib/openlayer/models/governance/framework_list_response.rb', line 70 optional :href, String, nil?: true |
#id ⇒ String
Returns the value of attribute id.
59 60 61 |
# File 'sig/openlayer/models/governance/framework_list_response.rbs', line 59 def id @id end |
#immutable ⇒ Boolean? (readonly)
Returns the value of attribute immutable.
69 70 71 |
# File 'sig/openlayer/models/governance/framework_list_response.rbs', line 69 def immutable @immutable end |
#name ⇒ String
The framework name.
29 |
# File 'lib/openlayer/models/governance/framework_list_response.rb', line 29 required :name, String |
#project_selector ⇒ Openlayer::Models::Governance::FrameworkListResponse::Item::ProjectSelector?
Determines which projects the framework applies to. An empty or null match
array applies the framework to every project in the workspace.
77 78 79 80 |
# File 'lib/openlayer/models/governance/framework_list_response.rb', line 77 optional :project_selector, -> { Openlayer::Models::Governance::FrameworkListResponse::Item::ProjectSelector }, api_name: :projectSelector, nil?: true |
#rule_stats ⇒ Openlayer::Models::Governance::FrameworkListResponse::Item::RuleStats? (readonly)
Returns the value of attribute rule_stats.
73 74 75 |
# File 'sig/openlayer/models/governance/framework_list_response.rbs', line 73 def rule_stats @rule_stats end |
#tags ⇒ Array<String>
Free-form labels on the framework.
35 |
# File 'lib/openlayer/models/governance/framework_list_response.rb', line 35 required :tags, Openlayer::Internal::Type::ArrayOf[String] |
#workspace_id ⇒ String
Returns the value of attribute workspace_id.
65 66 67 |
# File 'sig/openlayer/models/governance/framework_list_response.rbs', line 65 def workspace_id @workspace_id end |
Class Method Details
.values ⇒ Array<Symbol>
|
|
# File 'lib/openlayer/models/governance/framework_list_response.rb', line 193
|
Instance Method Details
#immutable= ⇒ Boolean (readonly)
71 |
# File 'sig/openlayer/models/governance/framework_list_response.rbs', line 71
def immutable=: (bool) -> bool
|
#rule_stats= ⇒ Object (readonly)
75 |
# File 'sig/openlayer/models/governance/framework_list_response.rbs', line 75
def rule_stats=: (
|
#to_hash ⇒ {
98 |
# File 'sig/openlayer/models/governance/framework_list_response.rbs', line 98
def to_hash: -> {
|