Class: Ansible::Ruby::Modules::Librato_annotation

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

Overview

Create an annotation event on the given annotation stream :name. If the annotation stream does not exist, it will be created automatically

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 Librato account api key.

Returns:

  • (String) —

    Librato account api key



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

attribute :api_key

#description ⇒ String?

Returns The description contains extra meta-data about a particular annotation,The description should contain specifics on the individual annotation e.g. Deployed 9b562b2 shipped new feature foo!.

Returns:

  • (String, nil) —

    The description contains extra meta-data about a particular annotation,The description should contain specifics on the individual annotation e.g. Deployed 9b562b2 shipped new feature foo!



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

attribute :description

#end_time ⇒ Integer?

Returns The unix timestamp indicating the time at which the event referenced by this annotation ended,For events that have a duration, this is a useful way to annotate the duration of the event.

Returns:

  • (Integer, nil) —

    The unix timestamp indicating the time at which the event referenced by this annotation ended,For events that have a duration, this is a useful way to annotate the duration of the event



40
 
# File 'lib/ansible/ruby/modules/generated/monitoring/librato_annotation.rb', line 40

attribute :end_time

#links ⇒ Array<Hash>, Hash

Returns See examples.

Returns:

  • (Array<Hash>, Hash) —

    See examples



44
 
# File 'lib/ansible/ruby/modules/generated/monitoring/librato_annotation.rb', line 44

attribute :links

#name ⇒ String?

Returns The annotation stream name,If the annotation stream does not exist, it will be created automatically.

Returns:

  • (String, nil) —

    The annotation stream name,If the annotation stream does not exist, it will be created automatically



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

attribute :name

#source ⇒ String?

Returns A string which describes the originating source of an annotation when that annotation is tracked across multiple members of a population.

Returns:

  • (String, nil) —

    A string which describes the originating source of an annotation when that annotation is tracked across multiple members of a population



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

attribute :source

#start_time ⇒ Integer?

Returns The unix timestamp indicating the time at which the event referenced by this annotation started.

Returns:

  • (Integer, nil) —

    The unix timestamp indicating the time at which the event referenced by this annotation started



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

attribute :start_time

#title ⇒ String

Returns The title of an annotation is a string and may contain spaces,The title should be a short, high-level summary of the annotation e.g. v45 Deployment.

Returns:

  • (String) —

    The title of an annotation is a string and may contain spaces,The title should be a short, high-level summary of the annotation e.g. v45 Deployment



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

attribute :title

#user ⇒ String

Returns Librato account username.

Returns:

  • (String) —

    Librato account username



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

attribute :user