Class: Ansible::Ruby::Modules::Pagerduty_alert

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Pagerduty_alert

Defined in:

lib/ansible/ruby/modules/generated/monitoring/pagerduty_alert.rb

Overview

This module will let you trigger, acknowledge or resolve a PagerDuty incident by sending events

Instance Method Summary

• #api_key ⇒ String

  The pagerduty API key (readonly access), generated on the pagerduty site.

• #client ⇒ String^?

  The name of the monitoring client that is triggering this event.

• #client_url ⇒ String^?

  The URL of the monitoring client that is triggering this event.

• #desc ⇒ String^?

  For C(triggered) I(state) - Required.

• #incident_key ⇒ String^?

  Identifies the incident to which this I(state) should be applied.,For C(triggered) I(state) - If there’s no open (i.e. unresolved) incident with this key, a new one will be created.

• #integration_key ⇒ String

  The GUID of one of your “Generic API” services.,This is the “integration key” listed on a “Integrations” tab of PagerDuty service.

• #name ⇒ String^?

  PagerDuty unique subdomain.

• #service_id ⇒ String

  ID of PagerDuty service when incidents will be triggered, acknowledged or resolved.

• #service_key ⇒ Object^?

  The GUID of one of your “Generic API” services.

• #state ⇒ :triggered, ...

  Type of event to be sent.

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

# File 'lib/ansible/ruby/modules/generated/monitoring/pagerduty_alert.rb', line 31

attribute :api_key

#client ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/monitoring/pagerduty_alert.rb', line 43

attribute :client

#client_url ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/monitoring/pagerduty_alert.rb', line 47

attribute :client_url

#desc ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/monitoring/pagerduty_alert.rb', line 35

attribute :desc

#incident_key ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/monitoring/pagerduty_alert.rb', line 39

attribute :incident_key

#integration_key ⇒ String

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

attribute :integration_key

#name ⇒ String^?

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

attribute :name

#service_id ⇒ String

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

attribute :service_id

#service_key ⇒ Object^?

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

attribute :service_key

#state ⇒ :triggered, ...

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

attribute :state