Class: Ansible::Ruby::Modules::Newrelic_deployment

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/extras/monitoring/newrelic_deployment.rb

Overview

Notify newrelic about app deployments (see docs.newrelic.com/docs/apm/new-relic-apm/maintenance/deployment-notifications#api)

Instance Method Summary

• #app_name ⇒ String^?

  (one of app_name or application_id are required) The value of app_name in the newrelic.yml file used by the application.

• #application_id ⇒ Object^?

  (one of app_name or application_id are required) The application id, found in the URL when viewing the application in RPM.

• #appname ⇒ Object^?

  Name of the application.

• #changelog ⇒ Object^?

  A list of changes for this deployment.

• #description ⇒ Object^?

  Text annotation for the deployment - notes for you.

• #environment ⇒ Object^?

  The environment for this deployment.

• #revision ⇒ String^?

  A revision number (e.g., git commit SHA).

• #token ⇒ String

  API token, to place in the x-api-key header.

• #user ⇒ String^?

  The name of the user/process that triggered this deployment.

• #validate_certs ⇒ :yes, ...

  If C(no), SSL certificates will not be validated.

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

#app_name ⇒ String^?

Returns (one of app_name or application_id are required) The value of app_name in the newrelic.yml file used by the application.

Returns:

• (String, nil) —

  (one of app_name or application_id are required) The value of app_name in the newrelic.yml file used by the application

# File 'lib/ansible/ruby/modules/generated/extras/monitoring/newrelic_deployment.rb', line 15

attribute :app_name

#application_id ⇒ Object^?

Returns (one of app_name or application_id are required) The application id, found in the URL when viewing the application in RPM.

Returns:

• (Object, nil) —

  (one of app_name or application_id are required) The application id, found in the URL when viewing the application in RPM

# File 'lib/ansible/ruby/modules/generated/extras/monitoring/newrelic_deployment.rb', line 19

attribute :application_id

#appname ⇒ Object^?

Returns Name of the application.

Returns:

• (Object, nil) —

  Name of the application

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

attribute :appname

#changelog ⇒ Object^?

Returns A list of changes for this deployment.

Returns:

• (Object, nil) —

  A list of changes for this deployment

# File 'lib/ansible/ruby/modules/generated/extras/monitoring/newrelic_deployment.rb', line 22

attribute :changelog

#description ⇒ Object^?

Returns Text annotation for the deployment - notes for you.

Returns:

• (Object, nil) —

  Text annotation for the deployment - notes for you

# File 'lib/ansible/ruby/modules/generated/extras/monitoring/newrelic_deployment.rb', line 25

attribute :description

#environment ⇒ Object^?

Returns The environment for this deployment.

Returns:

• (Object, nil) —

  The environment for this deployment

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

attribute :environment

#revision ⇒ String^?

Returns A revision number (e.g., git commit SHA).

Returns:

• (String, nil) —

  A revision number (e.g., git commit SHA)

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

attribute :revision

#token ⇒ String

Returns API token, to place in the x-api-key header.

Returns:

• (String) —

  API token, to place in the x-api-key header.

# File 'lib/ansible/ruby/modules/generated/extras/monitoring/newrelic_deployment.rb', line 11

attribute :token

#user ⇒ String^?

Returns The name of the user/process that triggered this deployment.

Returns:

• (String, nil) —

  The name of the user/process that triggered this deployment

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

attribute :user

#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.

# File 'lib/ansible/ruby/modules/generated/extras/monitoring/newrelic_deployment.rb', line 42

attribute :validate_certs