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

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/extras/messaging/rabbitmq_queue.rb

Instance Method Summary

• #arguments ⇒ Object^?

  Extra arguments for queue.

• #auto_delete ⇒ Boolean^?

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

• #auto_expires ⇒ String^?

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

• #dead_letter_exchange ⇒ Object^?

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

• #dead_letter_routing_key ⇒ Object^?

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

• #durable ⇒ Boolean^?

  Whether queue is durable or not.

• #login_host ⇒ String^?

  RabbitMQ host for connection.

• #login_password ⇒ Boolean^?

  RabbitMQ password for connection.

• #login_port ⇒ Integer^?

  RabbitMQ management api port.

• #login_user ⇒ String^?

  RabbitMQ user for connection.

• #max_length ⇒ String^?

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

• #message_ttl ⇒ String^?

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

• #name ⇒ String

  Name of the queue to create.

• #state ⇒ :present, ...

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

• #vhost ⇒ String^?

  RabbitMQ virtual host.

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, #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

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

attribute :arguments

#auto_delete ⇒ Boolean^?

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

Returns:

• (Boolean, nil) —

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

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

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)

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

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

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

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

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

attribute :dead_letter_routing_key

#durable ⇒ Boolean^?

Returns whether queue is durable or not.

Returns:

• (Boolean, nil) —

  whether queue is durable or not

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

attribute :durable

#login_host ⇒ String^?

Returns rabbitMQ host for connection.

Returns:

• (String, nil) —

  rabbitMQ host for connection

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

attribute :login_host

#login_password ⇒ Boolean^?

Returns rabbitMQ password for connection.

Returns:

• (Boolean, nil) —

  rabbitMQ password for connection

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

attribute :login_password

#login_port ⇒ Integer^?

Returns rabbitMQ management api port.

Returns:

• (Integer, nil) —

  rabbitMQ management api port

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

attribute :login_port

#login_user ⇒ String^?

Returns rabbitMQ user for connection.

Returns:

• (String, nil) —

  rabbitMQ user for connection

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

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

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

attribute :max_length

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

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

attribute :message_ttl

#name ⇒ String

Returns Name of the queue to create.

Returns:

• (String) —

  Name of the queue to create

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

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

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

attribute :state

#vhost ⇒ String^?

Returns rabbitMQ virtual host.

Returns:

• (String, nil) —

  rabbitMQ virtual host

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

attribute :vhost