Class: Openlayer::Models::Governance::FrameworkCreateResponse

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

Overview

See Also:

  • Openlayer::Resources::Governance::Frameworks#create

Defined Under Namespace

Classes: Avatar, ProjectSelector, RuleStats

Instance Attribute Summary collapse

Class Method 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(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::FrameworkCreateResponse for more details.

`iso_

Parameters:

  • id (String) —

    The framework id.

  • date_created (Time) —

    The creation date.

  • date_updated (Time) —

    The last update date.

  • enabled (Boolean) —

    Whether the framework is active. Rules of a disabled framework are not evaluated

  • name (String) —

    The framework name.

  • tags (Array<String>) —

    Free-form labels on the framework.

  • workspace_id (String) —

    The id of the workspace the framework belongs to.

  • avatar (Openlayer::Models::Governance::FrameworkCreateResponse::Avatar, nil) (defaults to: nil) —

    The icon shown for the framework.

  • built_in_slug (String, nil) (defaults to: nil) —

    Identifies a framework that ships with Openlayer, for example eu_ai_act,

  • creator_id (String, nil) (defaults to: nil) —

    The user who created the framework. null for built-in frameworks.

  • description (String, nil) (defaults to: nil) —

    A short description of the framework.

  • extended_description (Hash{Symbol=>Object}, nil) (defaults to: nil) —

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

  • href (String, nil) (defaults to: nil) —

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

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

    Whether the framework definition is managed by Openlayer and cannot be edited.

  • project_selector (Openlayer::Models::Governance::FrameworkCreateResponse::ProjectSelector, nil) (defaults to: nil) —

    Determines which projects the framework applies to. An empty or null match a

  • rule_stats (Openlayer::Models::Governance::FrameworkCreateResponse::RuleStats) (defaults to: nil) —

    Compliance roll-up for the framework. Present only on `GET /workspaces/{workspac




# File 'lib/openlayer/models/governance/framework_create_response.rb', line 120

Instance Attribute Details

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

The icon shown for the framework.

Parameters:

Returns:



31
 
# File 'lib/openlayer/models/governance/framework_create_response.rb', line 31

optional :avatar, -> { Openlayer::Models::Governance::FrameworkCreateResponse::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.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


39
 
# File 'lib/openlayer/models/governance/framework_create_response.rb', line 39

optional :built_in_slug, String, api_name: :builtInSlug, nil?: true

#creator_id ⇒ String?

Returns the value of attribute creator_id.

Returns:

  • (String, nil) 


51
52
53
 
# File 'sig/openlayer/models/governance/framework_create_response.rbs', line 51

def creator_id
  @creator_id
end

#date_created ⇒ Time

Returns the value of attribute date_created.

Returns:

  • (Time) 


45
46
47
 
# File 'sig/openlayer/models/governance/framework_create_response.rbs', line 45

def date_created
  @date_created
end

#date_updated ⇒ Time

Returns the value of attribute date_updated.

Returns:

  • (Time) 


47
48
49
 
# File 'sig/openlayer/models/governance/framework_create_response.rbs', line 47

def date_updated
  @date_updated
end

#description ⇒ String?

A short description of the framework.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


45
 
# File 'lib/openlayer/models/governance/framework_create_response.rb', line 45

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:

  • value (Boolean)

Returns:

  • (Boolean) 


13
 
# File 'lib/openlayer/models/governance/framework_create_response.rb', line 13

required :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) 


51
52
53
54
 
# File 'lib/openlayer/models/governance/framework_create_response.rb', line 51

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.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


60
 
# File 'lib/openlayer/models/governance/framework_create_response.rb', line 60

optional :href, String, nil?: true

#id ⇒ String

Returns the value of attribute id.

Returns:

  • (String) 


43
44
45
 
# File 'sig/openlayer/models/governance/framework_create_response.rbs', line 43

def id
  @id
end

#immutable ⇒ Boolean? (readonly)

Returns the value of attribute immutable.

Returns:

  • (Boolean, nil) 


53
54
55
 
# File 'sig/openlayer/models/governance/framework_create_response.rbs', line 53

def immutable
  @immutable
end

#name ⇒ String

The framework name.

Parameters:

  • value (String)

Returns:

  • (String) 


19
 
# File 'lib/openlayer/models/governance/framework_create_response.rb', line 19

required :name, String

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

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

Parameters:

Returns:



67
68
69
70
 
# File 'lib/openlayer/models/governance/framework_create_response.rb', line 67

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

#rule_stats ⇒ Openlayer::Models::Governance::FrameworkCreateResponse::RuleStats? (readonly)

Returns the value of attribute rule_stats.

Returns:



57
58
59
 
# File 'sig/openlayer/models/governance/framework_create_response.rbs', line 57

def rule_stats
  @rule_stats
end

#tags ⇒ Array<String>

Free-form labels on the framework.

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


25
 
# File 'lib/openlayer/models/governance/framework_create_response.rb', line 25

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

#workspace_id ⇒ String

Returns the value of attribute workspace_id.

Returns:

  • (String) 


49
50
51
 
# File 'sig/openlayer/models/governance/framework_create_response.rbs', line 49

def workspace_id
  @workspace_id
end

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openlayer/models/governance/framework_create_response.rb', line 183

Instance Method Details

#immutable= ⇒ Boolean (readonly)

Parameters:

  • (Boolean)

Returns:

  • (Boolean) 


55
 
# File 'sig/openlayer/models/governance/framework_create_response.rbs', line 55

def immutable=: (bool) -> bool

#rule_stats= ⇒ Object (readonly) 



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

def rule_stats=: (

#to_hash ⇒ {

Returns:

  • ({) 


82
 
# File 'sig/openlayer/models/governance/framework_create_response.rbs', line 82

def to_hash: -> {