Class: Openlayer::Models::Governance::Frameworks::SectionListRulesParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/openlayer/models/governance/frameworks/section_list_rules_params.rb,
sig/openlayer/models/governance/frameworks/section_list_rules_params.rbs

Overview

See Also:

  • Openlayer::Resources::Governance::Frameworks::Sections#list_rules

Defined Under Namespace

Modules: Status

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::Openlayer

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(framework_id:, section_id:, include_results: nil, include_subsection_rules: nil, page: nil, per_page: nil, project_id: nil, status: nil, request_options: {}) ⇒ Object

Parameters:

  • framework_id (String)
  • section_id (String)
  • include_results (Boolean) (defaults to: nil) —

    Whether to include each rule's results inline, in a results array.

  • include_subsection_rules (Boolean) (defaults to: nil) —

    Whether to also include the rules mapped to the section's subsections.

  • page (Integer) (defaults to: nil) —

    The page to return in a paginated query.

  • per_page (Integer) (defaults to: nil) —

    Maximum number of items to return per page.

  • project_id (String) (defaults to: nil) —

    Only include items that apply to this project.

  • status (Symbol, Openlayer::Models::Governance::Frameworks::SectionListRulesParams::Status) (defaults to: nil) —

    Only include items whose rule result has this compliance status.

  • request_options (Openlayer::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/openlayer/models/governance/frameworks/section_list_rules_params.rb', line 58

Instance Attribute Details

#framework_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


15
 
# File 'lib/openlayer/models/governance/frameworks/section_list_rules_params.rb', line 15

required :framework_id, String

#include_results ⇒ Boolean?

Whether to include each rule's results inline, in a results array.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


26
 
# File 'lib/openlayer/models/governance/frameworks/section_list_rules_params.rb', line 26

optional :include_results, Openlayer::Internal::Type::Boolean

#include_subsection_rules ⇒ Boolean?

Whether to also include the rules mapped to the section's subsections.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


32
 
# File 'lib/openlayer/models/governance/frameworks/section_list_rules_params.rb', line 32

optional :include_subsection_rules, Openlayer::Internal::Type::Boolean

#page ⇒ Integer?

The page to return in a paginated query.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


38
 
# File 'lib/openlayer/models/governance/frameworks/section_list_rules_params.rb', line 38

optional :page, Integer

#per_page ⇒ Integer?

Maximum number of items to return per page.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


44
 
# File 'lib/openlayer/models/governance/frameworks/section_list_rules_params.rb', line 44

optional :per_page, Integer

#project_id ⇒ String?

Only include items that apply to this project.

Parameters:

  • (String)

Returns:

  • (String, nil) 


50
 
# File 'lib/openlayer/models/governance/frameworks/section_list_rules_params.rb', line 50

optional :project_id, String

#section_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


20
 
# File 'lib/openlayer/models/governance/frameworks/section_list_rules_params.rb', line 20

required :section_id, String

#status ⇒ Symbol, ...

Only include items whose rule result has this compliance status.

Returns:



56
 
# File 'lib/openlayer/models/governance/frameworks/section_list_rules_params.rb', line 56

optional :status, enum: -> { Openlayer::Governance::Frameworks::SectionListRulesParams::Status }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


64
 
# File 'sig/openlayer/models/governance/frameworks/section_list_rules_params.rbs', line 64

def to_hash: -> {