Class: WavefrontCommandEvent

Inherits:
WavefrontCommandBase show all
Defined in:
lib/wavefront-cli/commands/event.rb

Overview

Define the event command.

Instance Method Summary collapse

Methods inherited from WavefrontCommandBase

#commands, #common_options, #docopt, #global_options, #opt_row, #option_column_width, #options, #sdk_class, #sdk_file, #tag_commands, #word

Instance Method Details

#_commands ⇒ Object 



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/wavefront-cli/commands/event.rb', line 10

def _commands
  ["list #{CMN} [-l] [-f format] [-s start] [-e end] [-L limit] " \
    '[-o cursor]',
   "describe #{CMN} [-f format] <id>",
   "create #{CMN} [-d description] [-s time] [-i | -e time] " \
   '[-S severity] [-T type] [-H host...] [-g tag...] [-N] <event>',
   "close #{CMN} [<id>]",
   "delete #{CMN} <id>",
   "update #{CMN} <key=value> <id>",
   "search #{CMN} [-f format] [-o offset] [-L limit] [-l] <condition>...",
   "wrap #{CMN} [-C command] [-d description] [-S severity] [-T type] " \
   '[-H host...] [-g tag...] <event>',
   tag_commands,
   'show [-D]']
end

#_options ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/wavefront-cli/commands/event.rb', line 26

def _options
  [common_options,
   '-l, --long                list events in detail',
   '-o, --cursor=EVENT        start listing from given event',
   '-L, --limit=COUNT         number of events to list',
   '-s, --start=TIME          time at which event begins',
   '-e, --end=TIME            time at which event ends',
   '-S, --severity=SEVERITY   severity of event',
   '-i, --instant             create an instantaneous event',
   '-T, --type=TYPE           type of event',
   '-d, --desc=STRING         description of event',
   '-H, --host=STRING         source to which event applies',
   '-N, --nostate             do not create a local file recording ' \
   'the event',
   '-g, --evtag=TAG           event tag',
   '-C, --command=COMMAND     command to run',
   '-f, --format=STRING       output format']
end

#description ⇒ Object 



6
7
8
 
# File 'lib/wavefront-cli/commands/event.rb', line 6

def description
  'open, close, view, and manage events'
end

#postscript ⇒ Object 



45
46
47
48
 
# File 'lib/wavefront-cli/commands/event.rb', line 45

def postscript
  "View events in detail using the 'query' command with the " \
    "'events()' function."
end