Class: Ansible::Ruby::Modules::Circonus_annotation

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/extras/monitoring/circonus_annotation.rb

Overview

Create an annotation event with a given category, title and description. Optionally start, end or durations can be provided

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#api_key ⇒ String

Returns Circonus API key.

Returns:

  • (String) —

    Circonus API key



11
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/circonus_annotation.rb', line 11

attribute :api_key

#category ⇒ String

Returns Annotation Category.

Returns:

  • (String) —

    Annotation Category



15
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/circonus_annotation.rb', line 15

attribute :category

#description ⇒ String

Returns Description of annotation.

Returns:

  • (String) —

    Description of annotation



19
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/circonus_annotation.rb', line 19

attribute :description

#duration ⇒ Integer?

Returns Duration in seconds of annotation, defaults to 0.

Returns:

  • (Integer, nil) —

    Duration in seconds of annotation, defaults to 0



33
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/circonus_annotation.rb', line 33

attribute :duration

#start ⇒ Object?

Returns Unix timestamp of event start, defaults to now.

Returns:

  • (Object, nil) —

    Unix timestamp of event start, defaults to now



27
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/circonus_annotation.rb', line 27

attribute :start

#stop ⇒ Object?

Returns Unix timestamp of event end, defaults to now + duration.

Returns:

  • (Object, nil) —

    Unix timestamp of event end, defaults to now + duration



30
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/circonus_annotation.rb', line 30

attribute :stop

#title ⇒ String

Returns Title of annotation.

Returns:

  • (String) —

    Title of annotation



23
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/circonus_annotation.rb', line 23

attribute :title