Class: Ansible::Ruby::Modules::Tower_job_cancel

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_cancel.rb

Overview

Cancel Ansible Tower jobs. See U(www.ansible.com/tower) for an overview.

Instance Method Summary

• #fail_if_not_running ⇒ Boolean^?

  Fail loudly if the I(job_id) does not reference a running job.

• #job_id ⇒ String

  ID of the job to cancel.

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

#fail_if_not_running ⇒ Boolean^?

Returns Fail loudly if the I(job_id) does not reference a running job.

Returns:

• (Boolean, nil) —

  Fail loudly if the I(job_id) does not reference a running job.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_cancel.rb', line 16

attribute :fail_if_not_running

#job_id ⇒ String

Returns ID of the job to cancel.

Returns:

• (String) —

  ID of the job to cancel

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_cancel.rb', line 12

attribute :job_id