public class ListMessagesOptions extends QueueServiceOptions
listMessages request. These options include a server response timeout for the request, the number of messages to
retrieve from the queue, and the visibility timeout to set on the retrieved messages.| Constructor and Description |
|---|
ListMessagesOptions() |
| Modifier and Type | Method and Description |
|---|---|
Integer |
getNumberOfMessages()
Gets the number of messages to request from the queue with this
ListMessagesOptions instance. |
Integer |
getVisibilityTimeoutInSeconds()
Gets the visibility timeout to set on the messages requested from the queue with this
ListMessagesOptions
instance. |
ListMessagesOptions |
setNumberOfMessages(Integer numberOfMessages)
Sets the number of messages to request from the queue with this
ListMessagesOptions instance. |
ListMessagesOptions |
setTimeout(Integer timeout)
Sets the server request timeout value associated with this
ListMessagesOptions instance. |
ListMessagesOptions |
setVisibilityTimeoutInSeconds(Integer visibilityTimeoutInSeconds)
Sets the visibility timeout value to set on the messages requested from the queue with this
ListMessagesOptions instance. |
getTimeoutpublic ListMessagesOptions setTimeout(Integer timeout)
ListMessagesOptions instance.
The timeout value only affects calls made on methods where this ListMessagesOptions instance is
passed as a parameter.
setTimeout in class QueueServiceOptionstimeout - The server request timeout value to set in milliseconds.ListMessagesOptions instance.public Integer getNumberOfMessages()
ListMessagesOptions instance.public ListMessagesOptions setNumberOfMessages(Integer numberOfMessages)
ListMessagesOptions instance.
The numberOfMessages value is only used for requests where this ListMessagesOptions instance is
passed as a parameter.
numberOfMessages - The number of messages to request. The valid range of values is 0 to 32.ListMessagesOptions instance.public Integer getVisibilityTimeoutInSeconds()
ListMessagesOptions
instance.public ListMessagesOptions setVisibilityTimeoutInSeconds(Integer visibilityTimeoutInSeconds)
ListMessagesOptions instance.
The visibilityTimeoutInSeconds value is only used for requests where this ListMessagesOptions
instance is passed as a parameter.
visibilityTimeoutInSeconds - The visibility timeout to set on the messages requested from the queue. The valid range of values is 0
to 604800 seconds.ListMessagesOptions instance./**
* Copyright Microsoft Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/