class Aws::SQS::Message
def attributes
-
(Hash
-)
def attributes data[:attributes] end
def body
-
(String)
-
def body data[:body] end
def change_visibility(options = {})
-
(EmptyStructure)
-
Options Hash:
(**options)
-
:visibility_timeout
(required, Integer
) --
Parameters:
-
options
(Hash
) -- ({})
Other tags:
- Example: Request syntax with placeholder values -
def change_visibility(options = {}) options = options.merge( queue_url: @queue_url, receipt_handle: @receipt_handle ) resp = @client.change_message_visibility(options) resp.data end
def client
-
(Client)
-
def client @client end
def data
-
(Types::Message)
-
Raises:
-
(NotImplementedError)
- Raises when {#data_loaded?} is `false`.
def data load unless @data @data end
def data_loaded?
-
(Boolean)
-
def data_loaded? !!@data end
def delete(options = {})
-
(EmptyStructure)
-
Parameters:
-
options
(Hash
) -- ({})
Other tags:
- Example: Request syntax with placeholder values -
def delete(options = {}) options = options.merge( queue_url: @queue_url, receipt_handle: @receipt_handle ) resp = @client.delete_message(options) resp.data end
def extract_queue_url(args, options)
def extract_queue_url(args, options) value = args[0] || options.delete(:queue_url) case value when String then value when nil then raise ArgumentError, "missing required option :queue_url" else msg = "expected :queue_url to be a String, got #{value.class}" raise ArgumentError, msg end end
def extract_receipt_handle(args, options)
def extract_receipt_handle(args, options) value = args[1] || options.delete(:receipt_handle) case value when String then value when nil then raise ArgumentError, "missing required option :receipt_handle" else msg = "expected :receipt_handle to be a String, got #{value.class}" raise ArgumentError, msg end end
def identifiers
- Api: - private
Deprecated:
def identifiers { queue_url: @queue_url, receipt_handle: @receipt_handle } end
def initialize(*args)
(**options)
-
:client
(Client
) -- -
:receipt_handle
(required, String
) -- -
:queue_url
(required, String
) -- -
:client
(Client
) --
Overloads:
-
def initialize(options = {})
-
def initialize(queue_url, receipt_handle, options = {})
Parameters:
-
receipt_handle
(String
) -- -
queue_url
(String
) --
def initialize(*args) options = Hash === args.last ? args.pop.dup : {} @queue_url = extract_queue_url(args, options) @receipt_handle = extract_receipt_handle(args, options) @data = options.delete(:data) @client = options.delete(:client) || Client.new(options) @waiter_block_warned = false end
def load
- Api: - private
Raises:
-
(NotImplementedError)
-
def load msg = "#load is not implemented, data only available via enumeration" raise NotImplementedError, msg end
def md5_of_body
-
(String)
-
def md5_of_body data[:md5_of_body] end
def md5_of_message_attributes
-
(String)
-
def md5_of_message_attributes data[:md5_of_message_attributes] end
def message_attributes
-
(Hash
-)
def message_attributes data[:message_attributes] end
def message_id
-
(String)
-
def message_id data[:message_id] end
def queue
-
(Queue)
-
def queue Queue.new( url: @queue_url, client: @client ) end
def queue_url
-
(String)
-
def queue_url @queue_url end
def receipt_handle
-
(String)
-
def receipt_handle @receipt_handle end