Class: Cerbos::Output::CheckResources::Result::Output

Inherits:

Object

• Object
• Cerbos::Output::CheckResources::Result::Output

Defined in:

lib/cerbos/output/check_resources.rb

Overview

User-defined output from a policy rule evaluation.

Instance Attribute Summary

• #action ⇒ String readonly

  The action that was being evaluated when the output was produced.

• #error ⇒ String^? readonly

  Error encountered when evaluating the output expression (if any).

• #source ⇒ String readonly

  The identifier of the policy rule that produced the output.

• #value ⇒ String, ... readonly

  The result of evaluating the output expression.

Instance Attribute Details

#action ⇒ String (readonly)

The action that was being evaluated when the output was produced.

Requires the Cerbos policy decision point server to be at least v0.51.

Returns:

• (String)

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

CheckResources::Result::Output = Output.new_class(:action, :source, :value, :error) do
  # @!attribute [r] action
  #   The action that was being evaluated when the output was produced.
  #
  #   Requires the Cerbos policy decision point server to be at least v0.51.
  #
  #   @return [String]

  # @!attribute [r] source
  #   The identifier of the policy rule that produced the output.
  #
  #   @return [String]

  # @!attribute [r] value
  #   The result of evaluating the output expression.
  #
  #   @return [String, Numeric, Boolean, Array, Hash, nil]

  # @!attribute [r] error
  #   Error encountered when evaluating the output expression (if any).
  #
  #   @return [String, nil]

  def self.from_protobuf(output_entry)
    new(
      action: output_entry.action,
      source: output_entry.src,
      value: output_entry.val&.to_ruby(true),
      error: output_entry.error.empty? ? nil : output_entry.error
    )
  end
end

#error ⇒ String^? (readonly)

Error encountered when evaluating the output expression (if any).

Returns:

• (String, nil)

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

CheckResources::Result::Output = Output.new_class(:action, :source, :value, :error) do
  # @!attribute [r] action
  #   The action that was being evaluated when the output was produced.
  #
  #   Requires the Cerbos policy decision point server to be at least v0.51.
  #
  #   @return [String]

  # @!attribute [r] source
  #   The identifier of the policy rule that produced the output.
  #
  #   @return [String]

  # @!attribute [r] value
  #   The result of evaluating the output expression.
  #
  #   @return [String, Numeric, Boolean, Array, Hash, nil]

  # @!attribute [r] error
  #   Error encountered when evaluating the output expression (if any).
  #
  #   @return [String, nil]

  def self.from_protobuf(output_entry)
    new(
      action: output_entry.action,
      source: output_entry.src,
      value: output_entry.val&.to_ruby(true),
      error: output_entry.error.empty? ? nil : output_entry.error
    )
  end
end

#source ⇒ String (readonly)

The identifier of the policy rule that produced the output.

Returns:

• (String)

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

CheckResources::Result::Output = Output.new_class(:action, :source, :value, :error) do
  # @!attribute [r] action
  #   The action that was being evaluated when the output was produced.
  #
  #   Requires the Cerbos policy decision point server to be at least v0.51.
  #
  #   @return [String]

  # @!attribute [r] source
  #   The identifier of the policy rule that produced the output.
  #
  #   @return [String]

  # @!attribute [r] value
  #   The result of evaluating the output expression.
  #
  #   @return [String, Numeric, Boolean, Array, Hash, nil]

  # @!attribute [r] error
  #   Error encountered when evaluating the output expression (if any).
  #
  #   @return [String, nil]

  def self.from_protobuf(output_entry)
    new(
      action: output_entry.action,
      source: output_entry.src,
      value: output_entry.val&.to_ruby(true),
      error: output_entry.error.empty? ? nil : output_entry.error
    )
  end
end

#value ⇒ String, ... (readonly)

The result of evaluating the output expression.

Returns:

• (String, Numeric, Boolean, Array, Hash, nil)

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

CheckResources::Result::Output = Output.new_class(:action, :source, :value, :error) do
  # @!attribute [r] action
  #   The action that was being evaluated when the output was produced.
  #
  #   Requires the Cerbos policy decision point server to be at least v0.51.
  #
  #   @return [String]

  # @!attribute [r] source
  #   The identifier of the policy rule that produced the output.
  #
  #   @return [String]

  # @!attribute [r] value
  #   The result of evaluating the output expression.
  #
  #   @return [String, Numeric, Boolean, Array, Hash, nil]

  # @!attribute [r] error
  #   Error encountered when evaluating the output expression (if any).
  #
  #   @return [String, nil]

  def self.from_protobuf(output_entry)
    new(
      action: output_entry.action,
      source: output_entry.src,
      value: output_entry.val&.to_ruby(true),
      error: output_entry.error.empty? ? nil : output_entry.error
    )
  end
end