Class: Ansible::Ruby::Modules::Stackdriver

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

Overview

Send code deploy and annotation events to Stackdriver

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

#annotated_by ⇒ String?

Returns The person or robot who the annotation should be attributed to.

Returns:

  • (String, nil) —

    The person or robot who the annotation should be attributed to.



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

attribute :annotated_by

#deployed_by ⇒ String?

Returns The person or robot responsible for deploying the code.

Returns:

  • (String, nil) —

    The person or robot responsible for deploying the code



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

attribute :deployed_by

#deployed_to ⇒ String?

Returns The environment code was deployed to. (ie: development, staging, production).

Returns:

  • (String, nil) —

    The environment code was deployed to. (ie: development, staging, production)



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

attribute :deployed_to

#event ⇒ :annotation, ...

Returns The type of event to send, either annotation or deploy.

Returns:

  • (:annotation, :deploy, nil) —

    The type of event to send, either annotation or deploy



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

attribute :event

#event_epoch ⇒ Object?

Returns Unix timestamp of where the event should appear in the timeline, defaults to now. Be careful with this.

Returns:

  • (Object, nil) —

    Unix timestamp of where the event should appear in the timeline, defaults to now. Be careful with this.



52
 
# File 'lib/ansible/ruby/modules/generated/monitoring/stackdriver.rb', line 52

attribute :event_epoch

#instance_id ⇒ String?

Returns id of an EC2 instance that this event should be attached to, which will limit the contexts where this event is shown.

Returns:

  • (String, nil) —

    id of an EC2 instance that this event should be attached to, which will limit the contexts where this event is shown



48
 
# File 'lib/ansible/ruby/modules/generated/monitoring/stackdriver.rb', line 48

attribute :instance_id

#key ⇒ String

Returns API key.

Returns:

  • (String) —

    API key.



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

attribute :key

#level ⇒ :INFO, ...

Returns one of INFO/WARN/ERROR, defaults to INFO if not supplied.  May affect display.

Returns:

  • (:INFO, :WARN, :ERROR, nil) —

    one of INFO/WARN/ERROR, defaults to INFO if not supplied.  May affect display.



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

attribute :level

#msg ⇒ String?

Returns The contents of the annotation message, in plain text.  Limited to 256 characters. Required for annotation.

Returns:

  • (String, nil) —

    The contents of the annotation message, in plain text.  Limited to 256 characters. Required for annotation.



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

attribute :msg

#repository ⇒ String?

Returns The repository (or project) deployed.

Returns:

  • (String, nil) —

    The repository (or project) deployed



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

attribute :repository

#revision_id ⇒ String?

Returns The revision of the code that was deployed. Required for deploy events.

Returns:

  • (String, nil) —

    The revision of the code that was deployed. Required for deploy events



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

attribute :revision_id