Class: Ansible::Ruby::Modules::Tower_job_wait

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_wait.rb

Overview

Wait for Ansible Tower job to finish and report success or failure. See U(www.ansible.com/tower) for an overview.

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

#job_id ⇒ String

Returns ID of the job to monitor.

Returns:

  • (String) —

    ID of the job to monitor.



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

attribute :job_id

#max_interval ⇒ Integer?

Returns Maximum interval in seconds, to request an update from Tower.

Returns:

  • (Integer, nil) —

    Maximum interval in seconds, to request an update from Tower.



20
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_wait.rb', line 20

attribute :max_interval

#min_interval ⇒ Integer?

Returns Minimum interval in seconds, to request an update from Tower.

Returns:

  • (Integer, nil) —

    Minimum interval in seconds, to request an update from Tower.



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

attribute :min_interval

#timeout ⇒ Integer?

Returns Maximum time in seconds to wait for a job to finish.

Returns:

  • (Integer, nil) —

    Maximum time in seconds to wait for a job to finish.



24
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_job_wait.rb', line 24

attribute :timeout