Class: Aws::SQS::Queue
- Inherits:
-
Object
- Object
- Aws::SQS::Queue
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-sqs/queue.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#attributes ⇒ Hash<String,String>
A map of attributes to their respective values.
- #url ⇒ String
Actions collapse
- #add_permission(options = {}) ⇒ EmptyStructure
- #change_message_visibility_batch(options = {}) ⇒ Types::ChangeMessageVisibilityBatchResult
- #delete(options = {}) ⇒ EmptyStructure
- #delete_messages(options = {}) ⇒ Types::DeleteMessageBatchResult
- #purge(options = {}) ⇒ EmptyStructure
- #receive_messages(options = {}) ⇒ Message::Collection
- #remove_permission(options = {}) ⇒ EmptyStructure
- #send_message(options = {}) ⇒ Types::SendMessageResult
- #send_messages(options = {}) ⇒ Types::SendMessageBatchResult
- #set_attributes(options = {}) ⇒ EmptyStructure
Associations collapse
- #dead_letter_source_queues(options = {}) ⇒ Queue::Collection
- #identifiers ⇒ Object deprecated private Deprecated.
- #message(receipt_handle) ⇒ Message
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::GetQueueAttributesResult
Returns the data for this Queue.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ Queue
constructor
A new instance of Queue.
- #load ⇒ self (also: #reload)
Constructor Details
#initialize(url, options = {}) ⇒ Queue #initialize(options = {}) ⇒ Queue
Returns a new instance of Queue.
19 20 21 22 23 24 |
# File 'lib/aws-sdk-sqs/queue.rb', line 19 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @url = extract_url(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() end |
Instance Method Details
#add_permission(options = {}) ⇒ EmptyStructure
134 135 136 137 138 |
# File 'lib/aws-sdk-sqs/queue.rb', line 134 def ( = {}) = .merge(queue_url: @url) resp = @client.() resp.data end |
#attributes ⇒ Hash<String,String>
A map of attributes to their respective values.
35 36 37 |
# File 'lib/aws-sdk-sqs/queue.rb', line 35 def attributes data[:attributes] end |
#change_message_visibility_batch(options = {}) ⇒ Types::ChangeMessageVisibilityBatchResult
156 157 158 159 160 |
# File 'lib/aws-sdk-sqs/queue.rb', line 156 def ( = {}) = .merge(queue_url: @url) resp = @client.() resp.data end |
#data ⇒ Types::GetQueueAttributesResult
Returns the data for this Aws::SQS::Queue. Calls Client#get_queue_attributes if #data_loaded? is ‘false`.
65 66 67 68 |
# File 'lib/aws-sdk-sqs/queue.rb', line 65 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
73 74 75 |
# File 'lib/aws-sdk-sqs/queue.rb', line 73 def data_loaded? !!@data end |
#dead_letter_source_queues(options = {}) ⇒ Queue::Collection
751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 |
# File 'lib/aws-sdk-sqs/queue.rb', line 751 def dead_letter_source_queues( = {}) batches = Enumerator.new do |y| batch = [] = .merge(queue_url: @url) resp = @client.list_dead_letter_source_queues() resp.data.queue_urls.each do |q| batch << Queue.new( url: q, client: @client ) end y.yield(batch) end Queue::Collection.new(batches) end |
#delete(options = {}) ⇒ EmptyStructure
167 168 169 170 171 |
# File 'lib/aws-sdk-sqs/queue.rb', line 167 def delete( = {}) = .merge(queue_url: @url) resp = @client.delete_queue() resp.data end |
#delete_messages(options = {}) ⇒ Types::DeleteMessageBatchResult
187 188 189 190 191 |
# File 'lib/aws-sdk-sqs/queue.rb', line 187 def ( = {}) = .merge(queue_url: @url) resp = @client.() resp.data end |
#identifiers ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Deprecated.
779 780 781 |
# File 'lib/aws-sdk-sqs/queue.rb', line 779 def identifiers { url: @url } end |
#load ⇒ self Also known as: reload
Loads, or reloads #data for the current Aws::SQS::Queue. Returns ‘self` making it possible to chain methods.
queue.reload.data
52 53 54 55 56 57 58 59 |
# File 'lib/aws-sdk-sqs/queue.rb', line 52 def load resp = @client.get_queue_attributes( queue_url: @url, attribute_names: ["All"] ) @data = resp.data self end |
#message(receipt_handle) ⇒ Message
769 770 771 772 773 774 775 |
# File 'lib/aws-sdk-sqs/queue.rb', line 769 def (receipt_handle) Message.new( queue_url: @url, receipt_handle: receipt_handle, client: @client ) end |
#purge(options = {}) ⇒ EmptyStructure
198 199 200 201 202 |
# File 'lib/aws-sdk-sqs/queue.rb', line 198 def purge( = {}) = .merge(queue_url: @url) resp = @client.purge_queue() resp.data end |
#receive_messages(options = {}) ⇒ Message::Collection
384 385 386 387 388 389 390 391 392 393 394 395 396 397 |
# File 'lib/aws-sdk-sqs/queue.rb', line 384 def ( = {}) batch = [] = .merge(queue_url: @url) resp = @client.() resp.data..each do |m| batch << Message.new( queue_url: @url, receipt_handle: m.receipt_handle, data: m, client: @client ) end Message::Collection.new([batch], size: batch.size) end |
#remove_permission(options = {}) ⇒ EmptyStructure
409 410 411 412 413 |
# File 'lib/aws-sdk-sqs/queue.rb', line 409 def ( = {}) = .merge(queue_url: @url) resp = @client.() resp.data end |
#send_message(options = {}) ⇒ Types::SendMessageResult
559 560 561 562 563 |
# File 'lib/aws-sdk-sqs/queue.rb', line 559 def ( = {}) = .merge(queue_url: @url) resp = @client.() resp.data end |
#send_messages(options = {}) ⇒ Types::SendMessageBatchResult
591 592 593 594 595 |
# File 'lib/aws-sdk-sqs/queue.rb', line 591 def ( = {}) = .merge(queue_url: @url) resp = @client.() resp.data end |
#set_attributes(options = {}) ⇒ EmptyStructure
738 739 740 741 742 |
# File 'lib/aws-sdk-sqs/queue.rb', line 738 def set_attributes( = {}) = .merge(queue_url: @url) resp = @client.set_queue_attributes() resp.data end |
#url ⇒ String
29 30 31 |
# File 'lib/aws-sdk-sqs/queue.rb', line 29 def url @url end |