/
azure.storage.queue.models.QueueMessage.yml
59 lines (50 loc) · 1.73 KB
/
azure.storage.queue.models.QueueMessage.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
### YamlMime:PythonClass
uid: azure.storage.queue.models.QueueMessage
name: QueueMessage
fullName: azure.storage.queue.models.QueueMessage
module: azure.storage.queue.models
inheritances:
- builtins.object
summary: Queue message class.
constructor:
syntax: QueueMessage()
variables:
- description: 'A GUID value assigned to the message by the Queue service that
identifies the message in the queue. This value may be used together
with the value of pop_receipt to delete a message from the queue after
it has been retrieved with the get messages operation.'
name: id
types:
- <xref:str>
- description: A UTC date value representing the time the messages was inserted.
name: insertion_time
types:
- <xref:date>
- description: A UTC date value representing the time the message expires.
name: expiration_time
types:
- <xref:date>
- description: 'Begins with a value of 1 the first time the message is dequeued. This
value is incremented each time the message is subsequently dequeued.'
name: dequeue_count
types:
- <xref:int>
- description: 'The message content. Type is determined by the decode_function set
on
the service. Default is str.'
name: content
types:
- <xref:obj>
- description: 'A receipt str which can be used together with the message_id element
to
delete a message from the queue after it has been retrieved with the get
messages operation. Only returned by get messages operations. Set to
None for peek messages.'
name: pop_receipt
types:
- <xref:str>
- description: 'A UTC date value representing the time the message will next be visible.
Only returned by get messages operations. Set to None for peek messages.'
name: time_next_visible
types:
- <xref:date>