Class: Arkaan::Monitoring::Route
- Inherits:
-
Object
- Object
- Arkaan::Monitoring::Route
- Includes:
- Concerns::Activable, Concerns::Premiumable, Mongoid::Document, Mongoid::Timestamps
- Defined in:
- lib/arkaan/monitoring/route.rb
Overview
A route is an endpoint accessible in a service. Each route has to have an associated endpoint in the deployed instances.
Instance Attribute Summary collapse
-
#authenticated ⇒ Boolean
If true, the session_id is needed for this route, if false it is not.
-
#groups ⇒ Array<Arkaan::Permissions::Group>
The groups having permission to access this route.
-
#path ⇒ String
The path (URI) of the route in the service?.
-
#service ⇒ Arkaan::Monitoring::Service
The service in which this route is declared.
-
#verb ⇒ String
The verb (HTTP method) of this route in the service.
Instance Attribute Details
#authenticated ⇒ Boolean
Returns if true, the session_id is needed for this route, if false it is not.
19 |
# File 'lib/arkaan/monitoring/route.rb', line 19 field :authenticated, type: Boolean, default: true |
#groups ⇒ Array<Arkaan::Permissions::Group>
Returns the groups having permission to access this route.
27 |
# File 'lib/arkaan/monitoring/route.rb', line 27 has_and_belongs_to_many :groups, class_name: 'Arkaan::Permissions::Group', inverse_of: :groups |
#path ⇒ String
Returns the path (URI) of the route in the service?.
13 |
# File 'lib/arkaan/monitoring/route.rb', line 13 field :path, type: String, default: '/' |
#service ⇒ Arkaan::Monitoring::Service
Returns the service in which this route is declared.
23 |
# File 'lib/arkaan/monitoring/route.rb', line 23 belongs_to :service, class_name: 'Arkaan::Monitoring::Service', inverse_of: :routes |
#verb ⇒ String
Returns the verb (HTTP method) of this route in the service.
16 |
# File 'lib/arkaan/monitoring/route.rb', line 16 field :verb, type: String, default: 'get' |