Skip to content
This repository has been archived by the owner on Nov 20, 2018. It is now read-only.

Commit

Permalink
Now grouping Queue attribute methods in the docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
trevorrowe committed Oct 20, 2014
1 parent b6a600a commit dc62ff1
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions aws-sdk-resources/lib/aws-sdk-resources/sqs.rb
Original file line number Diff line number Diff line change
Expand Up @@ -36,48 +36,61 @@ def attr_name(method_name)

end

# @group Queue Attributes
# @return [String] the queue's policy.
queue_str_attr :policy

# @group Queue Attributes
# @return [Integer] the visibility timeout for the queue. For more information about visibility timeout, see [Visibility Timeout](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html) in the Amazon SQS Developer Guide.
queue_int_attr :visibility_timeout

# @group Queue Attributes
# @return [Integer] the limit of how many bytes a message can contain before
# Amazon SQS rejects it.
queue_int_attr :maximum_message_size

# @group Queue Attributes
# @return [Integer] the number of seconds Amazon SQS retains a message.
queue_int_attr :message_retention_period

# @group Queue Attributes
# @return [Integer] the approximate number of visible messages in a queue.
# For more information, see [Resources Required to Process Messages](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ApproximateNumber.html) in the Amazon SQS Developer Guide.
queue_int_attr :approximate_number_of_messages

# @group Queue Attributes
# @return [Integer] returns the approximate number of messages that are not timed-out and not deleted. For more information, see [Resources Required to Process Messages](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ApproximateNumber.html) in the Amazon SQS Developer Guide.
queue_int_attr :approximate_number_of_messages_not_visible

# @group Queue Attributes
# @return [Time] the time when the queue was created.
queue_time_attr :created_timestamp

# @group Queue Attributes
# @return [Time] the time when the queue was last changed.
queue_time_attr :last_modified_timestamp

# @group Queue Attributes
# @return [String] the queue's Amazon resource name (ARN).
queue_str_attr :arn, name: 'QueueArn'

alias queue_arn arn

# @group Queue Attributes
# @return [Integer] returns the approximate number of messages that
# are pending to be added to the queue.
queue_int_attr :approximate_number_of_messages_delayed

# @group Queue Attributes
# @return [Integer] the default delay on the queue in seconds.
queue_int_attr :delay_seconds

# @group Queue Attributes
# @return [Integer] the time for which a {Client#receive_message} call
# will wait for a message to arrive.
queue_int_attr :receive_message_wait_time_seconds

# @group Queue Attributes
# @return [String] the parameters for dead letter queue functionality of
# the source queue. For more information about RedrivePolicy and dead
# letter queues, see [Using Amazon SQS Dead Letter Queues](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSDeadLetterQueue.html)
Expand Down

0 comments on commit dc62ff1

Please sign in to comment.