Class: Arkaan::Monitoring::Action

Inherits:

Object

• Object
• Arkaan::Monitoring::Action

Includes:

Concerns::Enumerable, Mongoid::Document, Mongoid::Timestamps

Defined in:

lib/arkaan/monitoring/action.rb

Overview

An action is made by an authorized user on the instance of a server to perform a task.

Author:

• Vincent Courtois <courtois.vincent@outlook.com>

Instance Attribute Summary

• #instance ⇒ Arkaan::Monitoring::Instance

  The instance of a service on which the action is performed.

• #success ⇒ Boolean

  TRUE if the action succeeded (or at least was successfully launched), FALSE otherwise.

• #type ⇒ Symbol

  The type of action you’re making on this instance.

• #user ⇒ Arkaan::Account

  The user performing the action on the instance.

Instance Attribute Details

#instance ⇒ Arkaan::Monitoring::Instance

Returns the instance of a service on which the action is performed.

Returns:

• (Arkaan::Monitoring::Instance) —

  the instance of a service on which the action is performed.

# File 'lib/arkaan/monitoring/action.rb', line 22

embedded_in :instance, class_name: 'Arkaan::Monitoring::Instance', inverse_of: :actions

#success ⇒ Boolean

Returns TRUE if the action succeeded (or at least was successfully launched), FALSE otherwise.

Returns:

• (Boolean) —

  TRUE if the action succeeded (or at least was successfully launched), FALSE otherwise.

# File 'lib/arkaan/monitoring/action.rb', line 15

field :success, type: Boolean, default: false

#type ⇒ Symbol

Returns the type of action you’re making on this instance.

Returns:

• (Symbol) —

  the type of action you’re making on this instance

# File 'lib/arkaan/monitoring/action.rb', line 12

enum_field :type, [:restart]

#user ⇒ Arkaan::Account

Returns the user performing the action on the instance.

Returns:

• (Arkaan::Account) —

  the user performing the action on the instance.

# File 'lib/arkaan/monitoring/action.rb', line 19

belongs_to :user, class_name: 'Arkaan::Account'