Class: Cerbos::Output::HealthCheck

Inherits:
Object
  • Object
show all
Defined in:
lib/cerbos/output/health_check.rb

Overview

Health of a service provided by the Cerbos policy decision point server.

Instance Attribute Summary collapse

Instance Attribute Details

#status ⇒ :SERVING, ... (readonly)

The status of the service.

Returns:

  • (:SERVING) —

    if the server is up and serving requests for the specified service.

  • (:NOT_SERVING) —

    if the server is shutting down.

  • (:DISABLED) —

    if the service is disabled in the server configuration.



6
7
8
9
10
11
12
13
14
15
16
17
 
# File 'lib/cerbos/output/health_check.rb', line 6

HealthCheck = Output.new_class(:status) do
  # @!attribute [r] status
  #   The status of the service.
  #
  #   @return [:SERVING] if the server is up and serving requests for the specified service.
  #   @return [:NOT_SERVING] if the server is shutting down.
  #   @return [:DISABLED] if the service is disabled in the server configuration.

  def self.from_protobuf(health_check)
    new(status: health_check.status)
  end
end