|
|||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||
public interface AmazonSQSAsync
Interface for accessing AmazonSQS asynchronously. Each asynchronous method will return a Java Future object, and users are also allowed to provide a callback handler. Amazon Simple Queue Service
Amazon Simple Queue Service (Amazon SQS) offers a reliable, highly scalable, hosted queue for storing messages as they travel between computers. By using Amazon SQS, developers can simply move data between distributed components of their applications that perform different tasks, without losing messages or requiring each component to be always available. Amazon SQS makes it easy to build an automated workflow, working in close conjunction with the Amazon Elastic Compute Cloud (Amazon EC2) and the other AWS infrastructure web services.
Amazon SQS works by exposing Amazon's web-scale messaging infrastructure as a web service. Any computer on the Internet can add or read messages without any installed software or special firewall configurations. Components of applications using Amazon SQS can run independently, and do not need to be on the same network, developed with the same technologies, or running at the same time.
Visit http://aws.amazon.com/sqs/ for more information.
| Method Summary | |
|---|---|
Future<Void> |
addPermissionAsync(AddPermissionRequest addPermissionRequest)
The AddPermission action adds a permission to a queue for a specific principal . |
Future<Void> |
addPermissionAsync(AddPermissionRequest addPermissionRequest,
AsyncHandler<AddPermissionRequest,Void> asyncHandler)
The AddPermission action adds a permission to a queue for a specific principal . |
Future<Void> |
changeMessageVisibilityAsync(ChangeMessageVisibilityRequest changeMessageVisibilityRequest)
The ChangeMessageVisibility action changes the visibility
timeout of a specified message in a queue to a new value. |
Future<Void> |
changeMessageVisibilityAsync(ChangeMessageVisibilityRequest changeMessageVisibilityRequest,
AsyncHandler<ChangeMessageVisibilityRequest,Void> asyncHandler)
The ChangeMessageVisibility action changes the visibility
timeout of a specified message in a queue to a new value. |
Future<ChangeMessageVisibilityBatchResult> |
changeMessageVisibilityBatchAsync(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest)
This is a batch version of ChangeMessageVisibility. |
Future<ChangeMessageVisibilityBatchResult> |
changeMessageVisibilityBatchAsync(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest,
AsyncHandler<ChangeMessageVisibilityBatchRequest,ChangeMessageVisibilityBatchResult> asyncHandler)
This is a batch version of ChangeMessageVisibility. |
Future<CreateQueueResult> |
createQueueAsync(CreateQueueRequest createQueueRequest)
The CreateQueue action creates a new queue, or returns
the URL of an existing one. |
Future<CreateQueueResult> |
createQueueAsync(CreateQueueRequest createQueueRequest,
AsyncHandler<CreateQueueRequest,CreateQueueResult> asyncHandler)
The CreateQueue action creates a new queue, or returns
the URL of an existing one. |
Future<Void> |
deleteMessageAsync(DeleteMessageRequest deleteMessageRequest)
The DeleteMessage action unconditionally removes the
specified message from the specified queue. |
Future<Void> |
deleteMessageAsync(DeleteMessageRequest deleteMessageRequest,
AsyncHandler<DeleteMessageRequest,Void> asyncHandler)
The DeleteMessage action unconditionally removes the
specified message from the specified queue. |
Future<DeleteMessageBatchResult> |
deleteMessageBatchAsync(DeleteMessageBatchRequest deleteMessageBatchRequest)
This is a batch version of DeleteMessage. |
Future<DeleteMessageBatchResult> |
deleteMessageBatchAsync(DeleteMessageBatchRequest deleteMessageBatchRequest,
AsyncHandler<DeleteMessageBatchRequest,DeleteMessageBatchResult> asyncHandler)
This is a batch version of DeleteMessage. |
Future<Void> |
deleteQueueAsync(DeleteQueueRequest deleteQueueRequest)
This action unconditionally deletes the queue specified by the queue URL. |
Future<Void> |
deleteQueueAsync(DeleteQueueRequest deleteQueueRequest,
AsyncHandler<DeleteQueueRequest,Void> asyncHandler)
This action unconditionally deletes the queue specified by the queue URL. |
Future<GetQueueAttributesResult> |
getQueueAttributesAsync(GetQueueAttributesRequest getQueueAttributesRequest)
Gets attributes for the specified queue. |
Future<GetQueueAttributesResult> |
getQueueAttributesAsync(GetQueueAttributesRequest getQueueAttributesRequest,
AsyncHandler<GetQueueAttributesRequest,GetQueueAttributesResult> asyncHandler)
Gets attributes for the specified queue. |
Future<GetQueueUrlResult> |
getQueueUrlAsync(GetQueueUrlRequest getQueueUrlRequest)
The GetQueueUrl action returns the URL of an existing
queue. |
Future<GetQueueUrlResult> |
getQueueUrlAsync(GetQueueUrlRequest getQueueUrlRequest,
AsyncHandler<GetQueueUrlRequest,GetQueueUrlResult> asyncHandler)
The GetQueueUrl action returns the URL of an existing
queue. |
Future<ListQueuesResult> |
listQueuesAsync(ListQueuesRequest listQueuesRequest)
Returns a list of your queues. |
Future<ListQueuesResult> |
listQueuesAsync(ListQueuesRequest listQueuesRequest,
AsyncHandler<ListQueuesRequest,ListQueuesResult> asyncHandler)
Returns a list of your queues. |
Future<ReceiveMessageResult> |
receiveMessageAsync(ReceiveMessageRequest receiveMessageRequest)
Retrieves one or more messages from the specified queue, including the message body and message ID of each message. |
Future<ReceiveMessageResult> |
receiveMessageAsync(ReceiveMessageRequest receiveMessageRequest,
AsyncHandler<ReceiveMessageRequest,ReceiveMessageResult> asyncHandler)
Retrieves one or more messages from the specified queue, including the message body and message ID of each message. |
Future<Void> |
removePermissionAsync(RemovePermissionRequest removePermissionRequest)
The RemovePermission action revokes any permissions in
the queue policy that matches the specified Label
parameter. |
Future<Void> |
removePermissionAsync(RemovePermissionRequest removePermissionRequest,
AsyncHandler<RemovePermissionRequest,Void> asyncHandler)
The RemovePermission action revokes any permissions in
the queue policy that matches the specified Label
parameter. |
Future<SendMessageResult> |
sendMessageAsync(SendMessageRequest sendMessageRequest)
The SendMessage action delivers a message to the
specified queue. |
Future<SendMessageResult> |
sendMessageAsync(SendMessageRequest sendMessageRequest,
AsyncHandler<SendMessageRequest,SendMessageResult> asyncHandler)
The SendMessage action delivers a message to the
specified queue. |
Future<SendMessageBatchResult> |
sendMessageBatchAsync(SendMessageBatchRequest sendMessageBatchRequest)
This is a batch version of SendMessage. |
Future<SendMessageBatchResult> |
sendMessageBatchAsync(SendMessageBatchRequest sendMessageBatchRequest,
AsyncHandler<SendMessageBatchRequest,SendMessageBatchResult> asyncHandler)
This is a batch version of SendMessage. |
Future<Void> |
setQueueAttributesAsync(SetQueueAttributesRequest setQueueAttributesRequest)
Sets an attribute of a queue. |
Future<Void> |
setQueueAttributesAsync(SetQueueAttributesRequest setQueueAttributesRequest,
AsyncHandler<SetQueueAttributesRequest,Void> asyncHandler)
Sets an attribute of a queue. |
| Methods inherited from interface com.amazonaws.services.sqs.AmazonSQS |
|---|
addPermission, changeMessageVisibility, changeMessageVisibilityBatch, createQueue, deleteMessage, deleteMessageBatch, deleteQueue, getCachedResponseMetadata, getQueueAttributes, getQueueUrl, listQueues, listQueues, receiveMessage, removePermission, sendMessage, sendMessageBatch, setEndpoint, setQueueAttributes, shutdown |
| Method Detail |
|---|
Future<Void> setQueueAttributesAsync(SetQueueAttributesRequest setQueueAttributesRequest)
throws AmazonServiceException,
AmazonClientException
Sets an attribute of a queue. The set of attributes that can be set are - DelaySeconds, MessageRetentionPeriod, MaximumMessageSize, VisibilityTimeout and Policy.
setQueueAttributesRequest - Container for the necessary
parameters to execute the SetQueueAttributes operation on AmazonSQS.
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server side issue.
Future<Void> setQueueAttributesAsync(SetQueueAttributesRequest setQueueAttributesRequest,
AsyncHandler<SetQueueAttributesRequest,Void> asyncHandler)
throws AmazonServiceException,
AmazonClientException
Sets an attribute of a queue. The set of attributes that can be set are - DelaySeconds, MessageRetentionPeriod, MaximumMessageSize, VisibilityTimeout and Policy.
setQueueAttributesRequest - Container for the necessary
parameters to execute the SetQueueAttributes operation on AmazonSQS.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server side issue.
Future<ChangeMessageVisibilityBatchResult> changeMessageVisibilityBatchAsync(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest)
throws AmazonServiceException,
AmazonClientException
This is a batch version of ChangeMessageVisibility. It takes multiple receipt handles and performs the operation on each of the them. The result of the operation on each message is reported individually in the response.
changeMessageVisibilityBatchRequest - Container for the necessary
parameters to execute the ChangeMessageVisibilityBatch operation on
AmazonSQS.
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server side issue.
Future<ChangeMessageVisibilityBatchResult> changeMessageVisibilityBatchAsync(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest,
AsyncHandler<ChangeMessageVisibilityBatchRequest,ChangeMessageVisibilityBatchResult> asyncHandler)
throws AmazonServiceException,
AmazonClientException
This is a batch version of ChangeMessageVisibility. It takes multiple receipt handles and performs the operation on each of the them. The result of the operation on each message is reported individually in the response.
changeMessageVisibilityBatchRequest - Container for the necessary
parameters to execute the ChangeMessageVisibilityBatch operation on
AmazonSQS.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server side issue.
Future<Void> changeMessageVisibilityAsync(ChangeMessageVisibilityRequest changeMessageVisibilityRequest)
throws AmazonServiceException,
AmazonClientException
The ChangeMessageVisibility action changes the visibility
timeout of a specified message in a queue to a new value. The maximum
allowed timeout value you can set the value to is 12 hours. This means
you can't extend the timeout of a message in an existing queue to more
than a total visibility timeout of 12 hours. (For more information
visibility timeout, see
Visibility Timeout in the Amazon SQS Developer Guide.)
For example, let's say you have a message and its default message
visibility timeout is 30 minutes. You could call
ChangeMessageVisiblity with a value of two hours and the
effective timeout would be two hours and 30 minutes. When that time
comes near you could again extend the time out by calling
ChangeMessageVisiblity, but this time the maximum allowed timeout
would be 9 hours and 30 minutes.
IMPORTANT:If you attempt to set the VisibilityTimeout to an amount more than the maximum time left, Amazon SQS returns an error. It will not automatically recalculate and increase the timeout to the maximum time remaining.
IMPORTANT:Unlike with a queue, when you change the visibility timeout for a specific message, that timeout value is applied immediately but is not saved in memory for that message. If you don't delete a message after it is received, the visibility timeout for the message the next time it is received reverts to the original timeout value, not the value you set with the ChangeMessageVisibility action.
changeMessageVisibilityRequest - Container for the necessary
parameters to execute the ChangeMessageVisibility operation on
AmazonSQS.
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server side issue.
Future<Void> changeMessageVisibilityAsync(ChangeMessageVisibilityRequest changeMessageVisibilityRequest,
AsyncHandler<ChangeMessageVisibilityRequest,Void> asyncHandler)
throws AmazonServiceException,
AmazonClientException
The ChangeMessageVisibility action changes the visibility
timeout of a specified message in a queue to a new value. The maximum
allowed timeout value you can set the value to is 12 hours. This means
you can't extend the timeout of a message in an existing queue to more
than a total visibility timeout of 12 hours. (For more information
visibility timeout, see
Visibility Timeout in the Amazon SQS Developer Guide.)
For example, let's say you have a message and its default message
visibility timeout is 30 minutes. You could call
ChangeMessageVisiblity with a value of two hours and the
effective timeout would be two hours and 30 minutes. When that time
comes near you could again extend the time out by calling
ChangeMessageVisiblity, but this time the maximum allowed timeout
would be 9 hours and 30 minutes.
IMPORTANT:If you attempt to set the VisibilityTimeout to an amount more than the maximum time left, Amazon SQS returns an error. It will not automatically recalculate and increase the timeout to the maximum time remaining.
IMPORTANT:Unlike with a queue, when you change the visibility timeout for a specific message, that timeout value is applied immediately but is not saved in memory for that message. If you don't delete a message after it is received, the visibility timeout for the message the next time it is received reverts to the original timeout value, not the value you set with the ChangeMessageVisibility action.
changeMessageVisibilityRequest - Container for the necessary
parameters to execute the ChangeMessageVisibility operation on
AmazonSQS.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server side issue.
Future<GetQueueUrlResult> getQueueUrlAsync(GetQueueUrlRequest getQueueUrlRequest)
throws AmazonServiceException,
AmazonClientException
The GetQueueUrl action returns the URL of an existing
queue.
getQueueUrlRequest - Container for the necessary parameters to
execute the GetQueueUrl operation on AmazonSQS.
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server side issue.
Future<GetQueueUrlResult> getQueueUrlAsync(GetQueueUrlRequest getQueueUrlRequest,
AsyncHandler<GetQueueUrlRequest,GetQueueUrlResult> asyncHandler)
throws AmazonServiceException,
AmazonClientException
The GetQueueUrl action returns the URL of an existing
queue.
getQueueUrlRequest - Container for the necessary parameters to
execute the GetQueueUrl operation on AmazonSQS.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server side issue.
Future<Void> removePermissionAsync(RemovePermissionRequest removePermissionRequest)
throws AmazonServiceException,
AmazonClientException
The RemovePermission action revokes any permissions in
the queue policy that matches the specified Label
parameter. Only the owner of the queue can remove permissions.
removePermissionRequest - Container for the necessary parameters
to execute the RemovePermission operation on AmazonSQS.
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server side issue.
Future<Void> removePermissionAsync(RemovePermissionRequest removePermissionRequest,
AsyncHandler<RemovePermissionRequest,Void> asyncHandler)
throws AmazonServiceException,
AmazonClientException
The RemovePermission action revokes any permissions in
the queue policy that matches the specified Label
parameter. Only the owner of the queue can remove permissions.
removePermissionRequest - Container for the necessary parameters
to execute the RemovePermission operation on AmazonSQS.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server side issue.
Future<GetQueueAttributesResult> getQueueAttributesAsync(GetQueueAttributesRequest getQueueAttributesRequest)
throws AmazonServiceException,
AmazonClientException
Gets attributes for the specified queue. The following attributes are supported:
All - returns all values.ApproximateNumberOfMessages - returns the
approximate number of visible messages in a queue. For more
information, see Resources Required to Process Messages in the Amazon
SQS Developer Guide.ApproximateNumberOfMessagesNotVisible - returns the
approximate number of messages that are not timed-out and not deleted.
For more information, see Resources Required to Process Messages in
the Amazon SQS Developer Guide.VisibilityTimeout - returns the visibility timeout
for the queue. For more information about visibility timeout, see
Visibility Timeout in the Amazon SQS Developer Guide.CreatedTimestamp - returns the time when the queue
was created (epoch time in seconds).LastModifiedTimestamp - returns the time when the
queue was last changed (epoch time in seconds).Policy - returns the queue's policy.MaximumMessageSize - returns the limit of how many
bytes a message can contain before Amazon SQS rejects it.MessageRetentionPeriod - returns the number of
seconds Amazon SQS retains a message.QueueArn - returns the queue's Amazon resource name
(ARN).ApproximateNumberOfMessagesDelayed - returns the
approximate number of messages that are pending to be added to the
queue.DelaySeconds - returns the default delay on the
queue in seconds.
getQueueAttributesRequest - Container for the necessary
parameters to execute the GetQueueAttributes operation on AmazonSQS.
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server side issue.
Future<GetQueueAttributesResult> getQueueAttributesAsync(GetQueueAttributesRequest getQueueAttributesRequest,
AsyncHandler<GetQueueAttributesRequest,GetQueueAttributesResult> asyncHandler)
throws AmazonServiceException,
AmazonClientException
Gets attributes for the specified queue. The following attributes are supported:
All - returns all values.ApproximateNumberOfMessages - returns the
approximate number of visible messages in a queue. For more
information, see Resources Required to Process Messages in the Amazon
SQS Developer Guide.ApproximateNumberOfMessagesNotVisible - returns the
approximate number of messages that are not timed-out and not deleted.
For more information, see Resources Required to Process Messages in
the Amazon SQS Developer Guide.VisibilityTimeout - returns the visibility timeout
for the queue. For more information about visibility timeout, see
Visibility Timeout in the Amazon SQS Developer Guide.CreatedTimestamp - returns the time when the queue
was created (epoch time in seconds).LastModifiedTimestamp - returns the time when the
queue was last changed (epoch time in seconds).Policy - returns the queue's policy.MaximumMessageSize - returns the limit of how many
bytes a message can contain before Amazon SQS rejects it.MessageRetentionPeriod - returns the number of
seconds Amazon SQS retains a message.QueueArn - returns the queue's Amazon resource name
(ARN).ApproximateNumberOfMessagesDelayed - returns the
approximate number of messages that are pending to be added to the
queue.DelaySeconds - returns the default delay on the
queue in seconds.
getQueueAttributesRequest - Container for the necessary
parameters to execute the GetQueueAttributes operation on AmazonSQS.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server side issue.
Future<SendMessageBatchResult> sendMessageBatchAsync(SendMessageBatchRequest sendMessageBatchRequest)
throws AmazonServiceException,
AmazonClientException
This is a batch version of SendMessage. It takes multiple messages and adds each of them to the queue. The result of each add operation is reported individually in the response.
sendMessageBatchRequest - Container for the necessary parameters
to execute the SendMessageBatch operation on AmazonSQS.
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server side issue.
Future<SendMessageBatchResult> sendMessageBatchAsync(SendMessageBatchRequest sendMessageBatchRequest,
AsyncHandler<SendMessageBatchRequest,SendMessageBatchResult> asyncHandler)
throws AmazonServiceException,
AmazonClientException
This is a batch version of SendMessage. It takes multiple messages and adds each of them to the queue. The result of each add operation is reported individually in the response.
sendMessageBatchRequest - Container for the necessary parameters
to execute the SendMessageBatch operation on AmazonSQS.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server side issue.
Future<Void> deleteQueueAsync(DeleteQueueRequest deleteQueueRequest)
throws AmazonServiceException,
AmazonClientException
This action unconditionally deletes the queue specified by the queue URL. Use this operation WITH CARE! The queue is deleted even if it is NOT empty.
Once a queue has been deleted, the queue name is unavailable for use with new queues for 60 seconds.
deleteQueueRequest - Container for the necessary parameters to
execute the DeleteQueue operation on AmazonSQS.
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server side issue.
Future<Void> deleteQueueAsync(DeleteQueueRequest deleteQueueRequest,
AsyncHandler<DeleteQueueRequest,Void> asyncHandler)
throws AmazonServiceException,
AmazonClientException
This action unconditionally deletes the queue specified by the queue URL. Use this operation WITH CARE! The queue is deleted even if it is NOT empty.
Once a queue has been deleted, the queue name is unavailable for use with new queues for 60 seconds.
deleteQueueRequest - Container for the necessary parameters to
execute the DeleteQueue operation on AmazonSQS.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server side issue.
Future<SendMessageResult> sendMessageAsync(SendMessageRequest sendMessageRequest)
throws AmazonServiceException,
AmazonClientException
The SendMessage action delivers a message to the
specified queue.
sendMessageRequest - Container for the necessary parameters to
execute the SendMessage operation on AmazonSQS.
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server side issue.
Future<SendMessageResult> sendMessageAsync(SendMessageRequest sendMessageRequest,
AsyncHandler<SendMessageRequest,SendMessageResult> asyncHandler)
throws AmazonServiceException,
AmazonClientException
The SendMessage action delivers a message to the
specified queue.
sendMessageRequest - Container for the necessary parameters to
execute the SendMessage operation on AmazonSQS.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server side issue.
Future<ReceiveMessageResult> receiveMessageAsync(ReceiveMessageRequest receiveMessageRequest)
throws AmazonServiceException,
AmazonClientException
Retrieves one or more messages from the specified queue, including the
message body and message ID of each message. Messages returned by this
action stay in the queue until you delete them. However, once a
message is returned to a
ReceiveMessage request, it is not
returned on subsequent ReceiveMessage requests for the
duration of the VisibilityTimeout . If you do not specify
a VisibilityTimeout in the request, the overall
visibility timeout for the queue is used for the returned messages.
receiveMessageRequest - Container for the necessary parameters to
execute the ReceiveMessage operation on AmazonSQS.
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server side issue.
Future<ReceiveMessageResult> receiveMessageAsync(ReceiveMessageRequest receiveMessageRequest,
AsyncHandler<ReceiveMessageRequest,ReceiveMessageResult> asyncHandler)
throws AmazonServiceException,
AmazonClientException
Retrieves one or more messages from the specified queue, including the
message body and message ID of each message. Messages returned by this
action stay in the queue until you delete them. However, once a
message is returned to a
ReceiveMessage request, it is not
returned on subsequent ReceiveMessage requests for the
duration of the VisibilityTimeout . If you do not specify
a VisibilityTimeout in the request, the overall
visibility timeout for the queue is used for the returned messages.
receiveMessageRequest - Container for the necessary parameters to
execute the ReceiveMessage operation on AmazonSQS.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server side issue.
Future<ListQueuesResult> listQueuesAsync(ListQueuesRequest listQueuesRequest)
throws AmazonServiceException,
AmazonClientException
Returns a list of your queues.
listQueuesRequest - Container for the necessary parameters to
execute the ListQueues operation on AmazonSQS.
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server side issue.
Future<ListQueuesResult> listQueuesAsync(ListQueuesRequest listQueuesRequest,
AsyncHandler<ListQueuesRequest,ListQueuesResult> asyncHandler)
throws AmazonServiceException,
AmazonClientException
Returns a list of your queues.
listQueuesRequest - Container for the necessary parameters to
execute the ListQueues operation on AmazonSQS.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server side issue.
Future<DeleteMessageBatchResult> deleteMessageBatchAsync(DeleteMessageBatchRequest deleteMessageBatchRequest)
throws AmazonServiceException,
AmazonClientException
This is a batch version of DeleteMessage. It takes multiple receipt handles and deletes each one of the messages. The result of the delete operation on each message is reported individually in the response.
deleteMessageBatchRequest - Container for the necessary
parameters to execute the DeleteMessageBatch operation on AmazonSQS.
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server side issue.
Future<DeleteMessageBatchResult> deleteMessageBatchAsync(DeleteMessageBatchRequest deleteMessageBatchRequest,
AsyncHandler<DeleteMessageBatchRequest,DeleteMessageBatchResult> asyncHandler)
throws AmazonServiceException,
AmazonClientException
This is a batch version of DeleteMessage. It takes multiple receipt handles and deletes each one of the messages. The result of the delete operation on each message is reported individually in the response.
deleteMessageBatchRequest - Container for the necessary
parameters to execute the DeleteMessageBatch operation on AmazonSQS.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server side issue.
Future<CreateQueueResult> createQueueAsync(CreateQueueRequest createQueueRequest)
throws AmazonServiceException,
AmazonClientException
The CreateQueue action creates a new queue, or returns
the URL of an existing one. When you request CreateQueue
, you provide a name for the queue. To successfully create a new
queue, you must provide a name that is unique within the scope of your
own queues.
You may pass one or more attributes in the request. If you do not provide a value for any attribute, the queue will have the default value for that attribute. Permitted attributes are the same that can be set using SetQueueAttributes.
If you provide the name of an existing queue, a new queue isn't
created. If the values of attributes provided with the request match
up with those on the existing queue, the queue URL is returned.
Otherwise, a QueueNameExists error is returned.
createQueueRequest - Container for the necessary parameters to
execute the CreateQueue operation on AmazonSQS.
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server side issue.
Future<CreateQueueResult> createQueueAsync(CreateQueueRequest createQueueRequest,
AsyncHandler<CreateQueueRequest,CreateQueueResult> asyncHandler)
throws AmazonServiceException,
AmazonClientException
The CreateQueue action creates a new queue, or returns
the URL of an existing one. When you request CreateQueue
, you provide a name for the queue. To successfully create a new
queue, you must provide a name that is unique within the scope of your
own queues.
You may pass one or more attributes in the request. If you do not provide a value for any attribute, the queue will have the default value for that attribute. Permitted attributes are the same that can be set using SetQueueAttributes.
If you provide the name of an existing queue, a new queue isn't
created. If the values of attributes provided with the request match
up with those on the existing queue, the queue URL is returned.
Otherwise, a QueueNameExists error is returned.
createQueueRequest - Container for the necessary parameters to
execute the CreateQueue operation on AmazonSQS.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server side issue.
Future<Void> addPermissionAsync(AddPermissionRequest addPermissionRequest)
throws AmazonServiceException,
AmazonClientException
The AddPermission action adds a permission to a queue for a specific principal . This allows for sharing access to the queue.
When you create a queue, you have full control access rights for the queue. Only you (as owner of the queue) can grant or deny permissions to the queue. For more information about these permissions, see Shared Queues in the Amazon SQS Developer Guide.
AddPermission writes an SQS-generated policy. If you
want to write your own policy, use SetQueueAttributes to upload your
policy. For more information about writing your own policy, see
Appendix: The Access Policy Language in the Amazon SQS Developer
Guide.
addPermissionRequest - Container for the necessary parameters to
execute the AddPermission operation on AmazonSQS.
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server side issue.
Future<Void> addPermissionAsync(AddPermissionRequest addPermissionRequest,
AsyncHandler<AddPermissionRequest,Void> asyncHandler)
throws AmazonServiceException,
AmazonClientException
The AddPermission action adds a permission to a queue for a specific principal . This allows for sharing access to the queue.
When you create a queue, you have full control access rights for the queue. Only you (as owner of the queue) can grant or deny permissions to the queue. For more information about these permissions, see Shared Queues in the Amazon SQS Developer Guide.
AddPermission writes an SQS-generated policy. If you
want to write your own policy, use SetQueueAttributes to upload your
policy. For more information about writing your own policy, see
Appendix: The Access Policy Language in the Amazon SQS Developer
Guide.
addPermissionRequest - Container for the necessary parameters to
execute the AddPermission operation on AmazonSQS.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server side issue.
Future<Void> deleteMessageAsync(DeleteMessageRequest deleteMessageRequest)
throws AmazonServiceException,
AmazonClientException
The DeleteMessage action unconditionally removes the
specified message from the specified queue. Even if the message is
locked by another reader due to the visibility timeout setting, it is
still deleted from the queue.
deleteMessageRequest - Container for the necessary parameters to
execute the DeleteMessage operation on AmazonSQS.
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server side issue.
Future<Void> deleteMessageAsync(DeleteMessageRequest deleteMessageRequest,
AsyncHandler<DeleteMessageRequest,Void> asyncHandler)
throws AmazonServiceException,
AmazonClientException
The DeleteMessage action unconditionally removes the
specified message from the specified queue. Even if the message is
locked by another reader due to the visibility timeout setting, it is
still deleted from the queue.
deleteMessageRequest - Container for the necessary parameters to
execute the DeleteMessage operation on AmazonSQS.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server side issue.
|
|||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||