Class: Ansible::Ruby::Modules::Rabbitmq_queue

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/messaging/rabbitmq_queue.rb

Overview

This module uses rabbitMQ Rest API to create/delete queues

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

#arguments ⇒ Object?

Returns extra arguments for queue. If defined this argument is a key/value dictionary.

Returns:

  • (Object, nil) —

    extra arguments for queue. If defined this argument is a key/value dictionary



69
 
# File 'lib/ansible/ruby/modules/generated/messaging/rabbitmq_queue.rb', line 69

attribute :arguments

#auto_delete ⇒ :yes, ...

Returns if the queue should delete itself after all queues/queues unbound from it.

Returns:

  • (:yes, :no, nil) —

    if the queue should delete itself after all queues/queues unbound from it



44
 
# File 'lib/ansible/ruby/modules/generated/messaging/rabbitmq_queue.rb', line 44

attribute :auto_delete

#auto_expires ⇒ String?

Returns How long a queue can be unused before it is automatically deleted (milliseconds).

Returns:

  • (String, nil) —

    How long a queue can be unused before it is automatically deleted (milliseconds)



52
 
# File 'lib/ansible/ruby/modules/generated/messaging/rabbitmq_queue.rb', line 52

attribute :auto_expires

#dead_letter_exchange ⇒ Object?

Returns Optional name of an exchange to which messages will be republished if they,are rejected or expire.

Returns:

  • (Object, nil) —

    Optional name of an exchange to which messages will be republished if they,are rejected or expire



60
 
# File 'lib/ansible/ruby/modules/generated/messaging/rabbitmq_queue.rb', line 60

attribute :dead_letter_exchange

#dead_letter_routing_key ⇒ Object?

Returns Optional replacement routing key to use when a message is dead-lettered.,Original routing key will be used if unset.

Returns:

  • (Object, nil) —

    Optional replacement routing key to use when a message is dead-lettered.,Original routing key will be used if unset



63
 
# File 'lib/ansible/ruby/modules/generated/messaging/rabbitmq_queue.rb', line 63

attribute :dead_letter_routing_key

#durable ⇒ :yes, ...

Returns whether queue is durable or not.

Returns:

  • (:yes, :no, nil) —

    whether queue is durable or not



40
 
# File 'lib/ansible/ruby/modules/generated/messaging/rabbitmq_queue.rb', line 40

attribute :durable

#login_host ⇒ String?

Returns rabbitMQ host for connection.

Returns:

  • (String, nil) —

    rabbitMQ host for connection



28
 
# File 'lib/ansible/ruby/modules/generated/messaging/rabbitmq_queue.rb', line 28

attribute :login_host

#login_password ⇒ :yes, ...

Returns rabbitMQ password for connection.

Returns:

  • (:yes, :no, nil) —

    rabbitMQ password for connection



24
 
# File 'lib/ansible/ruby/modules/generated/messaging/rabbitmq_queue.rb', line 24

attribute :login_password

#login_port ⇒ Integer?

Returns rabbitMQ management api port.

Returns:

  • (Integer, nil) —

    rabbitMQ management api port



32
 
# File 'lib/ansible/ruby/modules/generated/messaging/rabbitmq_queue.rb', line 32

attribute :login_port

#login_user ⇒ String?

Returns rabbitMQ user for connection.

Returns:

  • (String, nil) —

    rabbitMQ user for connection



20
 
# File 'lib/ansible/ruby/modules/generated/messaging/rabbitmq_queue.rb', line 20

attribute :login_user

#max_length ⇒ String?

Returns How many messages can the queue contain before it starts rejecting.

Returns:

  • (String, nil) —

    How many messages can the queue contain before it starts rejecting



56
 
# File 'lib/ansible/ruby/modules/generated/messaging/rabbitmq_queue.rb', line 56

attribute :max_length

#max_priority ⇒ Object?

Returns Maximum number of priority levels for the queue to support.,If not set, the queue will not support message priorities.,Larger numbers indicate higher priority.

Returns:

  • (Object, nil) —

    Maximum number of priority levels for the queue to support.,If not set, the queue will not support message priorities.,Larger numbers indicate higher priority.



66
 
# File 'lib/ansible/ruby/modules/generated/messaging/rabbitmq_queue.rb', line 66

attribute :max_priority

#message_ttl ⇒ String?

Returns How long a message can live in queue before it is discarded (milliseconds).

Returns:

  • (String, nil) —

    How long a message can live in queue before it is discarded (milliseconds)



48
 
# File 'lib/ansible/ruby/modules/generated/messaging/rabbitmq_queue.rb', line 48

attribute :message_ttl

#name ⇒ String

Returns Name of the queue to create.

Returns:

  • (String) —

    Name of the queue to create



12
 
# File 'lib/ansible/ruby/modules/generated/messaging/rabbitmq_queue.rb', line 12

attribute :name

#state ⇒ :present, ...

Returns Whether the queue should be present or absent,Only present implemented atm.

Returns:

  • (:present, :absent, nil) —

    Whether the queue should be present or absent,Only present implemented atm



16
 
# File 'lib/ansible/ruby/modules/generated/messaging/rabbitmq_queue.rb', line 16

attribute :state

#vhost ⇒ String?

Returns rabbitMQ virtual host.

Returns:

  • (String, nil) —

    rabbitMQ virtual host



36
 
# File 'lib/ansible/ruby/modules/generated/messaging/rabbitmq_queue.rb', line 36

attribute :vhost