Class: Arkaan::Monitoring::Service

Inherits:
Object
  • Object
show all
Includes:
Concerns::Activable, Concerns::Diagnosticable, Concerns::Premiumable, Mongoid::Document, Mongoid::Timestamps
Defined in:
lib/arkaan/monitoring/service.rb

Overview

A service is the representation of one of the applications composing the API.

Author:

Instance Attribute Summary collapse

Instance Attribute Details

#creator ⇒ Arkaan::Account

Returns the creator of this service.

Returns:



24
 
# File 'lib/arkaan/monitoring/service.rb', line 24

belongs_to :creator, class_name: 'Arkaan::Account', optional: true, inverse_of: :services

#instances ⇒ Array<Arkaan::Monitoring::Instance>

Returns the instances of this service currently deployed.

Returns:



27
 
# File 'lib/arkaan/monitoring/service.rb', line 27

embeds_many :instances, class_name: 'Arkaan::Monitoring::Instance', inverse_of: :service

#key ⇒ String

Returns the name, or title of the service, optionally given to identify it more easily.

Returns:

  • (String) —

    the name, or title of the service, optionally given to identify it more easily.



14
 
# File 'lib/arkaan/monitoring/service.rb', line 14

field :key, type: String

#path ⇒ String

Returns the path the service will be mapped on in the API.

Returns:

  • (String) —

    the path the service will be mapped on in the API.



17
 
# File 'lib/arkaan/monitoring/service.rb', line 17

field :path, type: String, default: '/'

#routes ⇒ Array<Arkaan::Monitoring::Route>

Returns the routes associated to this service, accessible from the gateway.

Returns:



30
 
# File 'lib/arkaan/monitoring/service.rb', line 30

has_many :routes, class_name: 'Arkaan::Monitoring::Route', inverse_of: :service

#test_mode ⇒ Boolean

Returns TRUE if the service is currently in test mode and thus the gateway shall only qurty local instances.

Returns:

  • (Boolean) —

    TRUE if the service is currently in test mode and thus the gateway shall only qurty local instances.



20
 
# File 'lib/arkaan/monitoring/service.rb', line 20

field :test_mode, type: Boolean, default: false