Class: Cerbos::Output::CheckResources::Result::Metadata::Effect

Inherits:

Object

• Object
• Cerbos::Output::CheckResources::Result::Metadata::Effect

Defined in:

lib/cerbos/output/check_resources.rb

Overview

Additional information about how a policy decision was reached.

Instance Attribute Summary

• #matched_policy ⇒ String readonly

  The policy that was used to make the decision.

• #matched_scope ⇒ String readonly

  The policy scope that was used to make the decision.

Instance Attribute Details

#matched_policy ⇒ String (readonly)

The policy that was used to make the decision.

Returns:

• (String)

# File 'lib/cerbos/output/check_resources.rb', line 214

CheckResources::Result::Metadata::Effect = Output.new_class(:matched_policy, :matched_scope) do
  # @!attribute [r] matched_policy
  #   The policy that was used to make the decision.
  #
  #   @return [String]

  # @!attribute [r] matched_scope
  #   The policy scope that was used to make the decision.
  #
  #   @return [String]
  #
  #   @see https://docs.cerbos.dev/cerbos/latest/policies/scoped_policies.html Scoped policies

  def self.from_protobuf(effect_meta)
    new(
      matched_policy: effect_meta.matched_policy,
      matched_scope: effect_meta.matched_scope
    )
  end
end

#matched_scope ⇒ String (readonly)

The policy scope that was used to make the decision.

Returns:

• (String)

See Also:

• Scoped policies

# File 'lib/cerbos/output/check_resources.rb', line 214

CheckResources::Result::Metadata::Effect = Output.new_class(:matched_policy, :matched_scope) do
  # @!attribute [r] matched_policy
  #   The policy that was used to make the decision.
  #
  #   @return [String]

  # @!attribute [r] matched_scope
  #   The policy scope that was used to make the decision.
  #
  #   @return [String]
  #
  #   @see https://docs.cerbos.dev/cerbos/latest/policies/scoped_policies.html Scoped policies

  def self.from_protobuf(effect_meta)
    new(
      matched_policy: effect_meta.matched_policy,
      matched_scope: effect_meta.matched_scope
    )
  end
end