Class: Openlayer::Models::Governance::FrameworkRetrieveResponse::RuleStats

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openlayer/models/governance/framework_retrieve_response.rb,
sig/openlayer/models/governance/framework_retrieve_response.rbs

Overview

See Also:

  • Openlayer::Models::Governance::FrameworkRetrieveResponse#rule_stats

Defined Under Namespace

Classes: ProjectCompletion, RuleResults

Instance Attribute Summary collapse

Instance Method Summary collapse

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(high:, low:, mid:) ⇒ Object

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.

Parameters:

  • high (Integer) —

    Projects at 80% completion or above.

  • low (Integer) —

    Projects below 20% completion.

  • mid (Integer) —

    Projects at or above 20% but below 80% completion.




# File 'lib/openlayer/models/governance/framework_retrieve_response.rb', line 284

Instance Attribute Details

#project_completion ⇒ Openlayer::Models::Governance::FrameworkRetrieveResponse::RuleStats::ProjectCompletion

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.

Parameters:

Returns:



270
271
272
 
# File 'lib/openlayer/models/governance/framework_retrieve_response.rb', line 270

required :project_completion,
-> { Openlayer::Models::Governance::FrameworkRetrieveResponse::RuleStats::ProjectCompletion },
api_name: :projectCompletion

#rule_results ⇒ Openlayer::Models::Governance::FrameworkRetrieveResponse::RuleStats::RuleResults

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.

Parameters:

Returns:



280
281
282
 
# File 'lib/openlayer/models/governance/framework_retrieve_response.rb', line 280

required :rule_results,
-> { Openlayer::Models::Governance::FrameworkRetrieveResponse::RuleStats::RuleResults },
api_name: :ruleResults

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


218
 
# File 'sig/openlayer/models/governance/framework_retrieve_response.rbs', line 218

def to_hash: -> {