Class: Openlayer::Models::Governance::FrameworkUpdateParams

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

Overview

See Also:

  • Openlayer::Resources::Governance::Frameworks#update

Defined Under Namespace

Classes: Avatar, ProjectSelector

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::Openlayer

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

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



46
 
# File 'sig/openlayer/models/governance/framework_update_params.rbs', line 46

def initialize: (

Instance Attribute Details

#avatar ⇒ Openlayer::Models::Governance::FrameworkUpdateParams::Avatar?

The icon shown for the framework.

Parameters:

  • value (Openlayer::Governance::FrameworkUpdateParams::Avatar, nil)

Returns:



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

optional :avatar, -> { Openlayer::Governance::FrameworkUpdateParams::Avatar }, nil?: true

#description ⇒ String?

A short description of the framework.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

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.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


33
 
# File 'lib/openlayer/models/governance/framework_update_params.rb', line 33

optional :enabled, Openlayer::Internal::Type::Boolean

#extended_description ⇒ Hash{Symbol=>Object}?

A longer, rich-text description, as a TipTap JSON document.

Parameters:

  • value (::Hash[Symbol, top], nil)

Returns:

  • (Hash{Symbol=>Object}, nil) 


39
40
41
42
 
# File 'lib/openlayer/models/governance/framework_update_params.rb', line 39

optional :extended_description,
Openlayer::Internal::Type::HashOf[Openlayer::Internal::Type::Unknown],
api_name: :extendedDescription,
nil?: true

#framework_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


14
 
# File 'lib/openlayer/models/governance/framework_update_params.rb', line 14

required :framework_id, String

#href ⇒ String?

A link to the external standard or regulation the framework is based on.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


48
 
# File 'lib/openlayer/models/governance/framework_update_params.rb', line 48

optional :href, String, nil?: true

#name ⇒ String?

The framework name.

Parameters:

  • (String)

Returns:

  • (String, nil) 


54
 
# File 'lib/openlayer/models/governance/framework_update_params.rb', line 54

optional :name, String

#project_selector ⇒ Openlayer::Models::Governance::FrameworkUpdateParams::ProjectSelector?

Determines which projects the framework applies to. An empty or null match array applies the framework to every project in the workspace.

Parameters:

  • value (Openlayer::Governance::FrameworkUpdateParams::ProjectSelector, nil)

Returns:



61
62
63
64
 
# File 'lib/openlayer/models/governance/framework_update_params.rb', line 61

optional :project_selector,
-> { Openlayer::Governance::FrameworkUpdateParams::ProjectSelector },
api_name: :projectSelector,
nil?: true

#tags ⇒ Array<String>?

Free-form labels on the framework.

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


70
 
# File 'lib/openlayer/models/governance/framework_update_params.rb', line 70

optional :tags, Openlayer::Internal::Type::ArrayOf[String]

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openlayer/models/governance/framework_update_params.rb', line 121

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


59
 
# File 'sig/openlayer/models/governance/framework_update_params.rbs', line 59

def to_hash: -> {