Class: Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section

Defined in:

lib/openlayer/models/governance/frameworks/document_retrieve_response.rb,
sig/openlayer/models/governance/frameworks/document_retrieve_response.rbs

Defined Under Namespace

Classes: Rule, Subsection

Instance Attribute Summary

• #document_id ⇒ String

  Returns the value of attribute document_id.

• #id ⇒ String

  Returns the value of attribute id.

• #number ⇒ String

  The section number as it appears in the source standard.

• #rule_count ⇒ Integer^? readonly

  Returns the value of attribute rule_count.

• #rules ⇒ ::Array[Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule]^? readonly

  Returns the value of attribute rules.

• #sort_order ⇒ Integer

  The position of the section within the document.

• #subsections ⇒ ::Array[Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection]^? readonly

  Returns the value of attribute subsections.

• #text ⇒ String^?

  The section text.

• #title ⇒ String

  The section title.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(id:, date_created:, date_updated:, framework_id:, title:, sections: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse for more details.

• #rule_count ⇒ Integer readonly
• #rules ⇒ Object readonly
• #subsections ⇒ 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:, framework_id:, title:, sections: nil) ⇒ Object

Some parameter documentations has been truncated, see Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse for more details.

Parameters:

• id (String) —

  The document id.

• date_created (Time) —

  The creation date.

• date_updated (Time) —

  The last update date.

• framework_id (String) —

  The framework the document belongs to.

• title (String) —

  The document title.

• sections (Array<Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section>) (defaults to: nil) —

  The document's sections, in display order. Only returned when retrieving a singl

# File 'lib/openlayer/models/governance/frameworks/document_retrieve_response.rb', line 66

class Section < Openlayer::Internal::Type::BaseModel
  # @!attribute number
  #   The section number as it appears in the source standard.
  #
  #   @return [String]
  required :number, String

  # @!attribute sort_order
  #   The position of the section within the document.
  #
  #   @return [Integer]
  required :sort_order, Integer, api_name: :sortOrder

  # @!attribute title
  #   The section title.
  #
  #   @return [String]
  required :title, String

  # @!attribute text
  #   The section text.
  #
  #   @return [String, nil]
  optional :text, String, nil?: true

  response_only do
    # @!attribute id
    #   The section id.
    #
    #   @return [String]
    required :id, String

    # @!attribute document_id
    #   The document the section belongs to.
    #
    #   @return [String]
    required :document_id, String, api_name: :documentId

    # @!attribute rule_count
    #   How many rules are linked to this section, including its subsections. Use it to
    #   decide whether to fetch the section's rules.
    #
    #   @return [Integer, nil]
    optional :rule_count, Integer, api_name: :ruleCount

    # @!attribute rules
    #   The rules linked directly to this section.
    #
    #   @return [Array<Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule>, nil]
    optional :rules,
             -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule] }

    # @!attribute subsections
    #   The section's subsections, in display order.
    #
    #   @return [Array<Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection>, nil]
    optional :subsections,
             -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection] }
  end

  # @!method initialize(id:, document_id:, number:, sort_order:, title:, rule_count: nil, rules: nil, subsections: nil, text: nil)
  #   Some parameter documentations has been truncated, see
  #   {Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section}
  #   for more details.
  #
  #   @param id [String] The section id.
  #
  #   @param document_id [String] The document the section belongs to.
  #
  #   @param number [String] The section number as it appears in the source standard.
  #
  #   @param sort_order [Integer] The position of the section within the document.
  #
  #   @param title [String] The section title.
  #
  #   @param rule_count [Integer] How many rules are linked to this section, including its subsections. Use it to
  #
  #   @param rules [Array<Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule>] The rules linked directly to this section.
  #
  #   @param subsections [Array<Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection>] The section's subsections, in display order.
  #
  #   @param text [String, nil] The section text.

  class Rule < Openlayer::Internal::Type::BaseModel
    # @!attribute name
    #   The rule name.
    #
    #   @return [String]
    required :name, String

    # @!attribute scope
    #   Whether the rule is evaluated once for the whole workspace, or once per project
    #   the rule's frameworks apply to.
    #
    #   @return [Symbol, Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule::Scope]
    required :scope,
             enum: -> { Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule::Scope }

    # @!attribute type
    #   `platform` rules are evaluated automatically from the state of your Openlayer
    #   workspace. `evidence` rules are satisfied by attaching evidence.
    #
    #   @return [Symbol, Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule::Type]
    required :type,
             enum: -> { Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule::Type }

    # @!attribute automation_params
    #   Configuration for the platform check, when the automation takes parameters.
    #
    #   @return [Hash{Symbol=>Object}, nil]
    optional :automation_params,
             Openlayer::Internal::Type::HashOf[Openlayer::Internal::Type::Unknown],
             api_name: :automationParams,
             nil?: true

    # @!attribute automation_type
    #   Which workspace signal a platform rule checks, for example
    #   `monitoring_mode_enabled`, `test_setup`, or `project_owner_set`. `null` for
    #   evidence rules.
    #
    #   @return [String, nil]
    optional :automation_type, String, api_name: :automationType, nil?: true

    # @!attribute deactivated
    #   Whether the rule is excluded from compliance calculations.
    #
    #   @return [Boolean, nil]
    optional :deactivated, Openlayer::Internal::Type::Boolean

    # @!attribute description
    #   What the rule requires.
    #
    #   @return [String, nil]
    optional :description, String, nil?: true

    # @!attribute evidence_type
    #   The kind of evidence that satisfies the rule. `null` for platform rules.
    #
    #   @return [Symbol, Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule::EvidenceType, nil]
    optional :evidence_type,
             enum: -> { Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule::EvidenceType },
             api_name: :evidenceType,
             nil?: true

    # @!attribute renewal_cadence_days
    #   How often evidence must be renewed, in days. Once evidence is older than this,
    #   the rule result becomes `due_soon` and then `failing`.
    #
    #   @return [Integer, nil]
    optional :renewal_cadence_days, Integer, api_name: :renewalCadenceDays, nil?: true

    response_only do
      # @!attribute id
      #   The rule id.
      #
      #   @return [String]
      required :id, String

      # @!attribute date_created
      #   The creation date.
      #
      #   @return [Time, nil]
      optional :date_created, Time, api_name: :dateCreated

      # @!attribute date_updated
      #   The last update date.
      #
      #   @return [Time, nil]
      optional :date_updated, Time, api_name: :dateUpdated

      # @!attribute immutable
      #   Whether the rule is managed by Openlayer and cannot be edited.
      #
      #   @return [Boolean, nil]
      optional :immutable, Openlayer::Internal::Type::Boolean
    end

    # @!method initialize(id:, name:, scope:, type:, automation_params: nil, automation_type: nil, date_created: nil, date_updated: nil, deactivated: nil, description: nil, evidence_type: nil, immutable: nil, renewal_cadence_days: nil)
    #   Some parameter documentations has been truncated, see
    #   {Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule}
    #   for more details.
    #
    #   @param id [String] The rule id.
    #
    #   @param name [String] The rule name.
    #
    #   @param scope [Symbol, Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule::Scope] Whether the rule is evaluated once for the whole workspace, or once per project
    #
    #   @param type [Symbol, Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule::Type] `platform` rules are evaluated automatically from the state of your Openlayer wo
    #
    #   @param automation_params [Hash{Symbol=>Object}, nil] Configuration for the platform check, when the automation takes parameters.
    #
    #   @param automation_type [String, nil] Which workspace signal a platform rule checks, for example `monitoring_mode_enab
    #
    #   @param date_created [Time] The creation date.
    #
    #   @param date_updated [Time] The last update date.
    #
    #   @param deactivated [Boolean] Whether the rule is excluded from compliance calculations.
    #
    #   @param description [String, nil] What the rule requires.
    #
    #   @param evidence_type [Symbol, Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule::EvidenceType, nil] The kind of evidence that satisfies the rule. `null` for platform rules.
    #
    #   @param immutable [Boolean] Whether the rule is managed by Openlayer and cannot be edited.
    #
    #   @param renewal_cadence_days [Integer, nil] How often evidence must be renewed, in days. Once evidence is older than this, t

    # Whether the rule is evaluated once for the whole workspace, or once per project
    # the rule's frameworks apply to.
    #
    # @see Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule#scope
    module Scope
      extend Openlayer::Internal::Type::Enum

      PROJECT = :project
      WORKSPACE = :workspace

      # @!method self.values
      #   @return [Array<Symbol>]
    end

    # `platform` rules are evaluated automatically from the state of your Openlayer
    # workspace. `evidence` rules are satisfied by attaching evidence.
    #
    # @see Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule#type
    module Type
      extend Openlayer::Internal::Type::Enum

      PLATFORM = :platform
      EVIDENCE = :evidence

      # @!method self.values
      #   @return [Array<Symbol>]
    end

    # The kind of evidence that satisfies the rule. `null` for platform rules.
    #
    # @see Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule#evidence_type
    module EvidenceType
      extend Openlayer::Internal::Type::Enum

      DOCUMENT = :document
      TEXT = :text
      URL = :url
      CATEGORY_VALUE = :categoryValue

      # @!method self.values
      #   @return [Array<Symbol>]
    end
  end

  class Subsection < Openlayer::Internal::Type::BaseModel
    # @!attribute number
    #   The subsection number as it appears in the source standard.
    #
    #   @return [String]
    required :number, String

    # @!attribute sort_order
    #   The position of the subsection within its section.
    #
    #   @return [Integer]
    required :sort_order, Integer, api_name: :sortOrder

    # @!attribute title
    #   The subsection title.
    #
    #   @return [String]
    required :title, String

    # @!attribute text
    #   The subsection text. This is the requirement your rules are mapped against.
    #
    #   @return [String, nil]
    optional :text, String, nil?: true

    response_only do
      # @!attribute id
      #   The subsection id.
      #
      #   @return [String]
      required :id, String

      # @!attribute section_id
      #   The section the subsection belongs to.
      #
      #   @return [String]
      required :section_id, String, api_name: :sectionId

      # @!attribute rule_count
      #   How many rules are linked to this subsection.
      #
      #   @return [Integer, nil]
      optional :rule_count, Integer, api_name: :ruleCount

      # @!attribute rules
      #   The rules linked to this subsection.
      #
      #   @return [Array<Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection::Rule>, nil]
      optional :rules,
               -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection::Rule] }
    end

    # @!method initialize(id:, number:, section_id:, sort_order:, title:, rule_count: nil, rules: nil, text: nil)
    #   @param id [String] The subsection id.
    #
    #   @param number [String] The subsection number as it appears in the source standard.
    #
    #   @param section_id [String] The section the subsection belongs to.
    #
    #   @param sort_order [Integer] The position of the subsection within its section.
    #
    #   @param title [String] The subsection title.
    #
    #   @param rule_count [Integer] How many rules are linked to this subsection.
    #
    #   @param rules [Array<Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection::Rule>] The rules linked to this subsection.
    #
    #   @param text [String, nil] The subsection text. This is the requirement your rules are mapped against.

    class Rule < Openlayer::Internal::Type::BaseModel
      # @!attribute name
      #   The rule name.
      #
      #   @return [String]
      required :name, String

      # @!attribute scope
      #   Whether the rule is evaluated once for the whole workspace, or once per project
      #   the rule's frameworks apply to.
      #
      #   @return [Symbol, Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection::Rule::Scope]
      required :scope,
               enum: -> { Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection::Rule::Scope }

      # @!attribute type
      #   `platform` rules are evaluated automatically from the state of your Openlayer
      #   workspace. `evidence` rules are satisfied by attaching evidence.
      #
      #   @return [Symbol, Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection::Rule::Type]
      required :type,
               enum: -> { Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection::Rule::Type }

      # @!attribute automation_params
      #   Configuration for the platform check, when the automation takes parameters.
      #
      #   @return [Hash{Symbol=>Object}, nil]
      optional :automation_params,
               Openlayer::Internal::Type::HashOf[Openlayer::Internal::Type::Unknown],
               api_name: :automationParams,
               nil?: true

      # @!attribute automation_type
      #   Which workspace signal a platform rule checks, for example
      #   `monitoring_mode_enabled`, `test_setup`, or `project_owner_set`. `null` for
      #   evidence rules.
      #
      #   @return [String, nil]
      optional :automation_type, String, api_name: :automationType, nil?: true

      # @!attribute deactivated
      #   Whether the rule is excluded from compliance calculations.
      #
      #   @return [Boolean, nil]
      optional :deactivated, Openlayer::Internal::Type::Boolean

      # @!attribute description
      #   What the rule requires.
      #
      #   @return [String, nil]
      optional :description, String, nil?: true

      # @!attribute evidence_type
      #   The kind of evidence that satisfies the rule. `null` for platform rules.
      #
      #   @return [Symbol, Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection::Rule::EvidenceType, nil]
      optional :evidence_type,
               enum: -> { Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection::Rule::EvidenceType },
               api_name: :evidenceType,
               nil?: true

      # @!attribute renewal_cadence_days
      #   How often evidence must be renewed, in days. Once evidence is older than this,
      #   the rule result becomes `due_soon` and then `failing`.
      #
      #   @return [Integer, nil]
      optional :renewal_cadence_days, Integer, api_name: :renewalCadenceDays, nil?: true

      response_only do
        # @!attribute id
        #   The rule id.
        #
        #   @return [String]
        required :id, String

        # @!attribute date_created
        #   The creation date.
        #
        #   @return [Time, nil]
        optional :date_created, Time, api_name: :dateCreated

        # @!attribute date_updated
        #   The last update date.
        #
        #   @return [Time, nil]
        optional :date_updated, Time, api_name: :dateUpdated

        # @!attribute immutable
        #   Whether the rule is managed by Openlayer and cannot be edited.
        #
        #   @return [Boolean, nil]
        optional :immutable, Openlayer::Internal::Type::Boolean
      end

      # @!method initialize(id:, name:, scope:, type:, automation_params: nil, automation_type: nil, date_created: nil, date_updated: nil, deactivated: nil, description: nil, evidence_type: nil, immutable: nil, renewal_cadence_days: nil)
      #   Some parameter documentations has been truncated, see
      #   {Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection::Rule}
      #   for more details.
      #
      #   @param id [String] The rule id.
      #
      #   @param name [String] The rule name.
      #
      #   @param scope [Symbol, Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection::Rule::Scope] Whether the rule is evaluated once for the whole workspace, or once per project
      #
      #   @param type [Symbol, Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection::Rule::Type] `platform` rules are evaluated automatically from the state of your Openlayer wo
      #
      #   @param automation_params [Hash{Symbol=>Object}, nil] Configuration for the platform check, when the automation takes parameters.
      #
      #   @param automation_type [String, nil] Which workspace signal a platform rule checks, for example `monitoring_mode_enab
      #
      #   @param date_created [Time] The creation date.
      #
      #   @param date_updated [Time] The last update date.
      #
      #   @param deactivated [Boolean] Whether the rule is excluded from compliance calculations.
      #
      #   @param description [String, nil] What the rule requires.
      #
      #   @param evidence_type [Symbol, Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection::Rule::EvidenceType, nil] The kind of evidence that satisfies the rule. `null` for platform rules.
      #
      #   @param immutable [Boolean] Whether the rule is managed by Openlayer and cannot be edited.
      #
      #   @param renewal_cadence_days [Integer, nil] How often evidence must be renewed, in days. Once evidence is older than this, t

      # Whether the rule is evaluated once for the whole workspace, or once per project
      # the rule's frameworks apply to.
      #
      # @see Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection::Rule#scope
      module Scope
        extend Openlayer::Internal::Type::Enum

        PROJECT = :project
        WORKSPACE = :workspace

        # @!method self.values
        #   @return [Array<Symbol>]
      end

      # `platform` rules are evaluated automatically from the state of your Openlayer
      # workspace. `evidence` rules are satisfied by attaching evidence.
      #
      # @see Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection::Rule#type
      module Type
        extend Openlayer::Internal::Type::Enum

        PLATFORM = :platform
        EVIDENCE = :evidence

        # @!method self.values
        #   @return [Array<Symbol>]
      end

      # The kind of evidence that satisfies the rule. `null` for platform rules.
      #
      # @see Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection::Rule#evidence_type
      module EvidenceType
        extend Openlayer::Internal::Type::Enum

        DOCUMENT = :document
        TEXT = :text
        URL = :url
        CATEGORY_VALUE = :categoryValue

        # @!method self.values
        #   @return [Array<Symbol>]
      end
    end
  end
end

Instance Attribute Details

#document_id ⇒ String

Returns the value of attribute document_id.

Returns:

• (String)

# File 'sig/openlayer/models/governance/frameworks/document_retrieve_response.rbs', line 74

def document_id
  @document_id
end

#id ⇒ String

Returns the value of attribute id.

Returns:

• (String)

# File 'sig/openlayer/models/governance/frameworks/document_retrieve_response.rbs', line 72

def id
  @id
end

#number ⇒ String

The section number as it appears in the source standard.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/openlayer/models/governance/frameworks/document_retrieve_response.rb', line 71

required :number, String

#rule_count ⇒ Integer^? (readonly)

Returns the value of attribute rule_count.

Returns:

• (Integer, nil)

# File 'sig/openlayer/models/governance/frameworks/document_retrieve_response.rbs', line 76

def rule_count
  @rule_count
end

#rules ⇒ ::Array[Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule]^? (readonly)

Returns the value of attribute rules.

Returns:

• (::Array[Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule], nil)

# File 'sig/openlayer/models/governance/frameworks/document_retrieve_response.rbs', line 80

def rules
  @rules
end

#sort_order ⇒ Integer

The position of the section within the document.

Parameters:

• value (Integer)

Returns:

• (Integer)

# File 'lib/openlayer/models/governance/frameworks/document_retrieve_response.rb', line 77

required :sort_order, Integer, api_name: :sortOrder

#subsections ⇒ ::Array[Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection]^? (readonly)

Returns the value of attribute subsections.

Returns:

• (::Array[Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection], nil)

# File 'sig/openlayer/models/governance/frameworks/document_retrieve_response.rbs', line 86

def subsections
  @subsections
end

#text ⇒ String^?

The section text.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/openlayer/models/governance/frameworks/document_retrieve_response.rb', line 89

optional :text, String, nil?: true

#title ⇒ String

The section title.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/openlayer/models/governance/frameworks/document_retrieve_response.rb', line 83

required :title, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/openlayer/models/governance/frameworks/document_retrieve_response.rb', line 313

Instance Method Details

#rule_count= ⇒ Integer (readonly)

Parameters:

• (Integer)

Returns:

• (Integer)

# File 'sig/openlayer/models/governance/frameworks/document_retrieve_response.rbs', line 78

def rule_count=: (Integer) -> Integer

#rules= ⇒ Object (readonly)

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

def rules=: (

#subsections= ⇒ Object (readonly)

# File 'sig/openlayer/models/governance/frameworks/document_retrieve_response.rbs', line 88

def subsections=: (

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/openlayer/models/governance/frameworks/document_retrieve_response.rbs', line 104

def to_hash: -> {