public class PeekMessagesOptions extends QueueServiceOptions
peekMessages
request. These options include a server response timeout for the request and
the number of messages to peek from the queue.| Constructor and Description |
|---|
PeekMessagesOptions() |
| Modifier and Type | Method and Description |
|---|---|
Integer |
getNumberOfMessages()
Gets the number of messages to return in the response to a
peekMessages request specified in this instance. |
PeekMessagesOptions |
setNumberOfMessages(Integer numberOfMessages)
Sets the number of messages to return in the response to a
peekMessages request. |
PeekMessagesOptions |
setTimeout(Integer timeout)
Sets the server request timeout value associated with this
PeekMessagesOptions instance. |
getTimeoutpublic PeekMessagesOptions setTimeout(Integer timeout)
PeekMessagesOptions instance.
The timeout value only affects calls made on methods where this
PeekMessagesOptions instance is passed as a parameter.
setTimeout in class QueueServiceOptionstimeout - The server request timeout value to set in milliseconds.PeekMessagesOptions instance.public Integer getNumberOfMessages()
peekMessages request specified in this instance.public PeekMessagesOptions setNumberOfMessages(Integer numberOfMessages)
peekMessages request.
The numberOfMessages value only affects calls made on methods
where this PeekMessagesOptions instance is passed as a parameter.
numberOfMessages - The number of messages to return in the response. This value
must be in the range from 0 to 32.PeekMessagesOptions 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.
*/