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

Inherits:

Object

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

Defined in:

lib/cerbos/output/check_resources.rb

Overview

A resource that was checked.

Instance Attribute Summary

• #id ⇒ String readonly

  The unique identifier of the resource.

• #kind ⇒ String readonly

  The type of resource.

• #policy_version ⇒ String readonly

  The policy version against which the check was performed.

• #scope ⇒ String readonly

  The policy scope against which the check was performed.

Instance Attribute Details

#id ⇒ String (readonly)

The unique identifier of the resource.

Returns:

• (String)

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

CheckResources::Result::Resource = Output.new_class(:kind, :id, :policy_version, :scope) do
  # @!attribute [r] kind
  #   The type of resource.
  #
  #   @return [String]

  # @!attribute [r] id
  #   The unique identifier of the resource.
  #
  #   @return [String]

  # @!attribute [r] policy_version
  #   The policy version against which the check was performed.
  #
  #   @return [String]

  # @!attribute [r] scope
  #   The policy scope against which the check was performed.
  #
  #   @return [String]
  #
  #   @see https://docs.cerbos.dev/cerbos/latest/policies/scoped_policies.html Scoped policies

  def self.from_protobuf(resource)
    new(
      kind: resource.kind,
      id: resource.id,
      policy_version: resource.policy_version,
      scope: resource.scope
    )
  end
end

#kind ⇒ String (readonly)

The type of resource.

Returns:

• (String)

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

CheckResources::Result::Resource = Output.new_class(:kind, :id, :policy_version, :scope) do
  # @!attribute [r] kind
  #   The type of resource.
  #
  #   @return [String]

  # @!attribute [r] id
  #   The unique identifier of the resource.
  #
  #   @return [String]

  # @!attribute [r] policy_version
  #   The policy version against which the check was performed.
  #
  #   @return [String]

  # @!attribute [r] scope
  #   The policy scope against which the check was performed.
  #
  #   @return [String]
  #
  #   @see https://docs.cerbos.dev/cerbos/latest/policies/scoped_policies.html Scoped policies

  def self.from_protobuf(resource)
    new(
      kind: resource.kind,
      id: resource.id,
      policy_version: resource.policy_version,
      scope: resource.scope
    )
  end
end

#policy_version ⇒ String (readonly)

The policy version against which the check was performed.

Returns:

• (String)

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

CheckResources::Result::Resource = Output.new_class(:kind, :id, :policy_version, :scope) do
  # @!attribute [r] kind
  #   The type of resource.
  #
  #   @return [String]

  # @!attribute [r] id
  #   The unique identifier of the resource.
  #
  #   @return [String]

  # @!attribute [r] policy_version
  #   The policy version against which the check was performed.
  #
  #   @return [String]

  # @!attribute [r] scope
  #   The policy scope against which the check was performed.
  #
  #   @return [String]
  #
  #   @see https://docs.cerbos.dev/cerbos/latest/policies/scoped_policies.html Scoped policies

  def self.from_protobuf(resource)
    new(
      kind: resource.kind,
      id: resource.id,
      policy_version: resource.policy_version,
      scope: resource.scope
    )
  end
end

#scope ⇒ String (readonly)

The policy scope against which the check was performed.

Returns:

• (String)

See Also:

• Scoped policies

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

CheckResources::Result::Resource = Output.new_class(:kind, :id, :policy_version, :scope) do
  # @!attribute [r] kind
  #   The type of resource.
  #
  #   @return [String]

  # @!attribute [r] id
  #   The unique identifier of the resource.
  #
  #   @return [String]

  # @!attribute [r] policy_version
  #   The policy version against which the check was performed.
  #
  #   @return [String]

  # @!attribute [r] scope
  #   The policy scope against which the check was performed.
  #
  #   @return [String]
  #
  #   @see https://docs.cerbos.dev/cerbos/latest/policies/scoped_policies.html Scoped policies

  def self.from_protobuf(resource)
    new(
      kind: resource.kind,
      id: resource.id,
      policy_version: resource.policy_version,
      scope: resource.scope
    )
  end
end