create_claim.rb in fog-1.19.0

- old
+ new
@@ -1,8 +1,23 @@
 module Fog
   module Rackspace
     class Queues
       class Real
+
+        # This operation claims a set of messages (up to the value of the limit parameter) from oldest to newest and skips any messages that are already claimed.
+        # If no unclaimed messages are available, the API returns a 204 No Content message.
+        #
+        # @param [String] queue_name Specifies the name of the queue.
+        # @param [Integer] ttl The ttl attribute specifies how long the server waits before releasing the claim. The ttl value must be between 60 and 43200 seconds (12 hours).
+        # @param [Integer] grace The grace attribute specifies the message grace period in seconds. The value of grace value must be between 60 and 43200 seconds (12 hours).
+        # @param [Hash] options
+        # @option options [Integer] :limit - Specifies the number of messages to return, up to 20 messages. If limit is not specified, limit defaults to 10.
+        # @return [Excon::Response] response
+        # @raise [Fog::Rackspace::Queues::NotFound] - HTTP 404
+        # @raise [Fog::Rackspace::Queues::BadRequest] - HTTP 400
+        # @raise [Fog::Rackspace::Queues::InternalServerError] - HTTP 500
+        # @raise [Fog::Rackspace::Queues::ServiceError]
+        # @see http://docs.rackspace.com/queues/api/v1.0/cq-devguide/content/POST_claimMessages__version__queues__queue_name__claims_claims-operations-dle001.html
         def create_claim(queue_name, ttl, grace, options = {})
           body = {
             :ttl => ttl,
             :grace => grace
           }