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

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/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, fix_inclusion, #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



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

attribute :api_key

#category ⇒ String

Returns Annotation Category.

Returns:

  • (String) —

    Annotation Category



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

attribute :category

#description ⇒ String

Returns Description of annotation.

Returns:

  • (String) —

    Description of annotation



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

attribute :description

#duration ⇒ Integer?

Returns Duration in seconds of annotation.

Returns:

  • (Integer, nil) —

    Duration in seconds of annotation



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

attribute :duration

#start ⇒ String?

Returns Unix timestamp of event start.

Returns:

  • (String, nil) —

    Unix timestamp of event start



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

attribute :start

#stop ⇒ String?

Returns Unix timestamp of event end.

Returns:

  • (String, nil) —

    Unix timestamp of event end



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

attribute :stop

#title ⇒ String

Returns Title of annotation.

Returns:

  • (String) —

    Title of annotation



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

attribute :title