-
Notifications
You must be signed in to change notification settings - Fork 180
/
QueueReceiveMessageOptions.yml
108 lines (108 loc) · 4.22 KB
/
QueueReceiveMessageOptions.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
### YamlMime:TSType
name: QueueReceiveMessageOptions
uid: '@azure/storage-queue.QueueReceiveMessageOptions'
package: '@azure/storage-queue'
summary: >-
Options to configure
[receiveMessages](xref:@azure/storage-queue.QueueClient.receiveMessages)
operation
fullName: QueueReceiveMessageOptions
remarks: ''
isDeprecated: false
type: interface
inheritedProperties:
- name: numberOfMessages
uid: '@azure/storage-queue.QueueReceiveMessageOptions.numberOfMessages'
package: '@azure/storage-queue'
summary: >-
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.
fullName: numberOfMessages
remarks: ''
isDeprecated: false
syntax:
content: 'numberOfMessages?: number'
return:
description: ''
type: number
inheritanceDescription: >-
<b>Inherited From</b>
[MessagesDequeueOptionalParams.numberOfMessages](xref:@azure/storage-queue.MessagesDequeueOptionalParams.numberOfMessages)
- name: requestId
uid: '@azure/storage-queue.QueueReceiveMessageOptions.requestId'
package: '@azure/storage-queue'
summary: >-
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.
fullName: requestId
remarks: ''
isDeprecated: false
syntax:
content: 'requestId?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[MessagesDequeueOptionalParams.requestId](xref:@azure/storage-queue.MessagesDequeueOptionalParams.requestId)
- name: timeoutInSeconds
uid: '@azure/storage-queue.QueueReceiveMessageOptions.timeoutInSeconds'
package: '@azure/storage-queue'
summary: >-
The The timeout parameter is expressed in seconds. For more information,
see <a
href="https://docs.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations">Setting
Timeouts for Queue Service Operations.</a>
fullName: timeoutInSeconds
remarks: ''
isDeprecated: false
syntax:
content: 'timeoutInSeconds?: number'
return:
description: ''
type: number
inheritanceDescription: >-
<b>Inherited From</b>
[MessagesDequeueOptionalParams.timeoutInSeconds](xref:@azure/storage-queue.MessagesDequeueOptionalParams.timeoutInSeconds)
- name: tracingOptions
uid: '@azure/storage-queue.QueueReceiveMessageOptions.tracingOptions'
package: '@azure/storage-queue'
summary: Options to configure spans created when tracing is enabled.
fullName: tracingOptions
remarks: ''
isDeprecated: false
syntax:
content: 'tracingOptions?: OperationTracingOptions'
return:
description: ''
type: <xref uid="@azure/core-tracing.OperationTracingOptions" />
inheritanceDescription: >-
<b>Inherited From</b>
[CommonOptions.tracingOptions](xref:@azure/storage-queue.CommonOptions.tracingOptions)
- name: visibilityTimeout
uid: '@azure/storage-queue.QueueReceiveMessageOptions.visibilityTimeout'
package: '@azure/storage-queue'
summary: >-
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.
fullName: visibilityTimeout
remarks: ''
isDeprecated: false
syntax:
content: 'visibilityTimeout?: number'
return:
description: ''
type: number
inheritanceDescription: >-
<b>Inherited From</b>
[MessagesDequeueOptionalParams.visibilityTimeout](xref:@azure/storage-queue.MessagesDequeueOptionalParams.visibilityTimeout)
extends: >-
<xref uid="@azure/storage-queue.MessagesDequeueOptionalParams" />,<xref
uid="@azure/storage-queue.CommonOptions" />