QueueReceiveMessageOptions interface
Options to configure receiveMessages operation
- Extends
Inherited Properties
abort |
Signal of an abort controller. Can be used to abort both sending a network request and waiting for a response. |
custom |
will be applied before the request is sent. |
number |
Optional. A nonzero integer value that specifies the number of messages to retrieve from the queue, up to a maximum of 32. If fewer are visible, the visible messages are returned. By default, a single message is retrieved from the queue with this operation. |
on |
Callback which fires upon download progress. |
on |
Callback which fires upon upload progress. |
request |
Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. |
serializer |
Options to override XML parsing/building behavior. |
should |
Whether or not the HttpOperationResponse should be deserialized. If this is undefined, then the HttpOperationResponse should be deserialized. |
timeout | The number of milliseconds a request can take before automatically being terminated.
If the request is terminated, an |
timeout |
The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations. |
tracing |
Tracing: Context used when creating spans. |
tracing |
Options to configure spans created when tracing is enabled. |
visibility |
Optional. Specifies the new visibility timeout value, in seconds, relative to server time. The default value is 30 seconds. A specified value must be larger than or equal to 1 second, and cannot be larger than 7 days, or larger than 2 hours on REST protocol versions prior to version 2011-08-18. The visibility timeout of a message can be set to a value later than the expiry time. |
Inherited Property Details
abortSignal
Signal of an abort controller. Can be used to abort both sending a network request and waiting for a response.
abortSignal?: AbortSignalLike
Property Value
Inherited From MessagesDequeueOptionalParams.abortSignal
customHeaders
will be applied before the request is sent.
customHeaders?: {[key: string]: string}
Property Value
{[key: string]: string}
Inherited From MessagesDequeueOptionalParams.customHeaders
numberOfMessages
Optional. A nonzero integer value that specifies the number of messages to retrieve from the queue, up to a maximum of 32. If fewer are visible, the visible messages are returned. By default, a single message is retrieved from the queue with this operation.
numberOfMessages?: number
Property Value
number
Inherited From MessagesDequeueOptionalParams.numberOfMessages
onDownloadProgress
Callback which fires upon download progress.
onDownloadProgress?: (progress: TransferProgressEvent) => void
Property Value
(progress: TransferProgressEvent) => void
Inherited From MessagesDequeueOptionalParams.onDownloadProgress
onUploadProgress
Callback which fires upon upload progress.
onUploadProgress?: (progress: TransferProgressEvent) => void
Property Value
(progress: TransferProgressEvent) => void
Inherited From MessagesDequeueOptionalParams.onUploadProgress
requestId
Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.
requestId?: string
Property Value
string
Inherited From MessagesDequeueOptionalParams.requestId
serializerOptions
Options to override XML parsing/building behavior.
serializerOptions?: SerializerOptions
Property Value
Inherited From MessagesDequeueOptionalParams.serializerOptions
shouldDeserialize
Whether or not the HttpOperationResponse should be deserialized. If this is undefined, then the HttpOperationResponse should be deserialized.
shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean
Property Value
boolean | (response: HttpOperationResponse) => boolean
Inherited From MessagesDequeueOptionalParams.shouldDeserialize
timeout
The number of milliseconds a request can take before automatically being terminated.
If the request is terminated, an AbortError
is thrown.
timeout?: number
Property Value
number
Inherited From MessagesDequeueOptionalParams.timeout
timeoutInSeconds
The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations.
timeoutInSeconds?: number
Property Value
number
Inherited From MessagesDequeueOptionalParams.timeoutInSeconds
tracingContext
Tracing: Context used when creating spans.
tracingContext?: Context
Property Value
Inherited From MessagesDequeueOptionalParams.tracingContext
tracingOptions
Options to configure spans created when tracing is enabled.
tracingOptions?: OperationTracingOptions
Property Value
Inherited From CommonOptions.tracingOptions
visibilityTimeout
Optional. Specifies the new visibility timeout value, in seconds, relative to server time. The default value is 30 seconds. A specified value must be larger than or equal to 1 second, and cannot be larger than 7 days, or larger than 2 hours on REST protocol versions prior to version 2011-08-18. The visibility timeout of a message can be set to a value later than the expiry time.
visibilityTimeout?: number
Property Value
number
Inherited From MessagesDequeueOptionalParams.visibilityTimeout