Class: Ansible::Ruby::Modules::Hipchat

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/notification/hipchat.rb

Overview

Send a message to a Hipchat room, with options to control the formatting.

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 ⇒ String?

Returns API url if using a self-hosted hipchat server. For Hipchat API version 2 use the default URI with C(/v2) instead of C(/v1).

Returns:

  • (String, nil) —

    API url if using a self-hosted hipchat server. For Hipchat API version 2 use the default URI with C(/v2) instead of C(/v1).



44
 
# File 'lib/ansible/ruby/modules/generated/notification/hipchat.rb', line 44

attribute :api

#color ⇒ :yellow, ...

Returns Background color for the message.

Returns:

  • (:yellow, :red, :green, :purple, :gray, :random, nil) —

    Background color for the message.



28
 
# File 'lib/ansible/ruby/modules/generated/notification/hipchat.rb', line 28

attribute :color

#from ⇒ String?

Returns Name the message will appear to be sent from. Max length is 15 characters - above this it will be truncated.

Returns:

  • (String, nil) —

    Name the message will appear to be sent from. Max length is 15 characters - above this it will be truncated.



20
 
# File 'lib/ansible/ruby/modules/generated/notification/hipchat.rb', line 20

attribute :from

#msg ⇒ String

Returns The message body.

Returns:

  • (String) —

    The message body.



24
 
# File 'lib/ansible/ruby/modules/generated/notification/hipchat.rb', line 24

attribute :msg

#msg_format ⇒ :text, ...

Returns Message format.

Returns:

  • (:text, :html, nil) —

    Message format.



32
 
# File 'lib/ansible/ruby/modules/generated/notification/hipchat.rb', line 32

attribute :msg_format

#notify ⇒ :yes, ...

Returns If true, a notification will be triggered for users in the room.

Returns:

  • (:yes, :no, nil) —

    If true, a notification will be triggered for users in the room.



36
 
# File 'lib/ansible/ruby/modules/generated/notification/hipchat.rb', line 36

attribute :notify

#room ⇒ String

Returns ID or name of the room.

Returns:

  • (String) —

    ID or name of the room.



16
 
# File 'lib/ansible/ruby/modules/generated/notification/hipchat.rb', line 16

attribute :room

#token ⇒ String

Returns API token.

Returns:

  • (String) —

    API token.



12
 
# File 'lib/ansible/ruby/modules/generated/notification/hipchat.rb', line 12

attribute :token

#validate_certs ⇒ :yes, ...

Returns If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Returns:

  • (:yes, :no, nil) —

    If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.



40
 
# File 'lib/ansible/ruby/modules/generated/notification/hipchat.rb', line 40

attribute :validate_certs