|
| 1 | +### YamlMime:UniversalReference |
| 2 | +api_name: [] |
| 3 | +items: |
| 4 | +- children: |
| 5 | + - azure.eventhub.EventData.body |
| 6 | + - azure.eventhub.EventData.body_as_json |
| 7 | + - azure.eventhub.EventData.body_as_str |
| 8 | + - azure.eventhub.EventData.enqueued_time |
| 9 | + - azure.eventhub.EventData.offset |
| 10 | + - azure.eventhub.EventData.partition_key |
| 11 | + - azure.eventhub.EventData.properties |
| 12 | + - azure.eventhub.EventData.sequence_number |
| 13 | + - azure.eventhub.EventData.system_properties |
| 14 | + class: azure.eventhub.EventData |
| 15 | + fullName: azure.eventhub.EventData |
| 16 | + inheritance: |
| 17 | + - type: builtins.object |
| 18 | + langs: |
| 19 | + - python |
| 20 | + module: azure.eventhub |
| 21 | + name: EventData |
| 22 | + summary: The EventData class is a container for event content. |
| 23 | + syntax: |
| 24 | + content: EventData(body=None) |
| 25 | + parameters: |
| 26 | + - description: The data to send in a single message. body can be type of str or |
| 27 | + bytes. |
| 28 | + id: body |
| 29 | + type: |
| 30 | + - str |
| 31 | + - bytes |
| 32 | + type: class |
| 33 | + uid: azure.eventhub.EventData |
| 34 | +- class: azure.eventhub.EventData |
| 35 | + fullName: azure.eventhub.EventData.body |
| 36 | + langs: |
| 37 | + - python |
| 38 | + module: azure.eventhub |
| 39 | + name: body |
| 40 | + summary: The content of the event. |
| 41 | + syntax: |
| 42 | + return: |
| 43 | + type: |
| 44 | + - bytes |
| 45 | + - Generator[bytes] |
| 46 | + type: attribute |
| 47 | + uid: azure.eventhub.EventData.body |
| 48 | +- class: azure.eventhub.EventData |
| 49 | + fullName: azure.eventhub.EventData.body_as_json |
| 50 | + langs: |
| 51 | + - python |
| 52 | + module: azure.eventhub |
| 53 | + name: body_as_json(encoding='UTF-8') |
| 54 | + summary: The content of the event loaded as a JSON object, if the data is compatible. |
| 55 | + syntax: |
| 56 | + content: body_as_json(encoding='UTF-8') |
| 57 | + parameters: |
| 58 | + - defaultValue: UTF-8 |
| 59 | + description: 'The encoding to use for decoding event data. |
| 60 | +
|
| 61 | + Default is ''UTF-8''' |
| 62 | + id: encoding |
| 63 | + return: |
| 64 | + type: |
| 65 | + - dict |
| 66 | + type: method |
| 67 | + uid: azure.eventhub.EventData.body_as_json |
| 68 | +- class: azure.eventhub.EventData |
| 69 | + fullName: azure.eventhub.EventData.body_as_str |
| 70 | + langs: |
| 71 | + - python |
| 72 | + module: azure.eventhub |
| 73 | + name: body_as_str(encoding='UTF-8') |
| 74 | + summary: The content of the event as a string, if the data is of a compatible type. |
| 75 | + syntax: |
| 76 | + content: body_as_str(encoding='UTF-8') |
| 77 | + parameters: |
| 78 | + - defaultValue: UTF-8 |
| 79 | + description: 'The encoding to use for decoding event data. |
| 80 | +
|
| 81 | + Default is ''UTF-8''' |
| 82 | + id: encoding |
| 83 | + return: |
| 84 | + type: |
| 85 | + - str |
| 86 | + type: method |
| 87 | + uid: azure.eventhub.EventData.body_as_str |
| 88 | +- class: azure.eventhub.EventData |
| 89 | + fullName: azure.eventhub.EventData.enqueued_time |
| 90 | + langs: |
| 91 | + - python |
| 92 | + module: azure.eventhub |
| 93 | + name: enqueued_time |
| 94 | + summary: The enqueued timestamp of the event. |
| 95 | + syntax: |
| 96 | + return: |
| 97 | + type: |
| 98 | + - datetime.datetime |
| 99 | + type: attribute |
| 100 | + uid: azure.eventhub.EventData.enqueued_time |
| 101 | +- class: azure.eventhub.EventData |
| 102 | + fullName: azure.eventhub.EventData.offset |
| 103 | + langs: |
| 104 | + - python |
| 105 | + module: azure.eventhub |
| 106 | + name: offset |
| 107 | + summary: The offset of the event. |
| 108 | + syntax: |
| 109 | + return: |
| 110 | + type: |
| 111 | + - str |
| 112 | + type: attribute |
| 113 | + uid: azure.eventhub.EventData.offset |
| 114 | +- class: azure.eventhub.EventData |
| 115 | + fullName: azure.eventhub.EventData.partition_key |
| 116 | + langs: |
| 117 | + - python |
| 118 | + module: azure.eventhub |
| 119 | + name: partition_key |
| 120 | + summary: The partition key of the event. |
| 121 | + syntax: |
| 122 | + return: |
| 123 | + type: |
| 124 | + - bytes |
| 125 | + type: attribute |
| 126 | + uid: azure.eventhub.EventData.partition_key |
| 127 | +- class: azure.eventhub.EventData |
| 128 | + fullName: azure.eventhub.EventData.properties |
| 129 | + langs: |
| 130 | + - python |
| 131 | + module: azure.eventhub |
| 132 | + name: properties |
| 133 | + summary: Application-defined properties on the event. |
| 134 | + syntax: |
| 135 | + return: |
| 136 | + type: |
| 137 | + - dict |
| 138 | + type: attribute |
| 139 | + uid: azure.eventhub.EventData.properties |
| 140 | +- class: azure.eventhub.EventData |
| 141 | + fullName: azure.eventhub.EventData.sequence_number |
| 142 | + langs: |
| 143 | + - python |
| 144 | + module: azure.eventhub |
| 145 | + name: sequence_number |
| 146 | + summary: The sequence number of the event. |
| 147 | + syntax: |
| 148 | + return: |
| 149 | + type: |
| 150 | + - int |
| 151 | + - long |
| 152 | + type: attribute |
| 153 | + uid: azure.eventhub.EventData.sequence_number |
| 154 | +- class: azure.eventhub.EventData |
| 155 | + fullName: azure.eventhub.EventData.system_properties |
| 156 | + langs: |
| 157 | + - python |
| 158 | + module: azure.eventhub |
| 159 | + name: system_properties |
| 160 | + summary: Metadata set by the Event Hubs Service associated with the event |
| 161 | + syntax: |
| 162 | + return: |
| 163 | + type: |
| 164 | + - dict |
| 165 | + type: attribute |
| 166 | + uid: azure.eventhub.EventData.system_properties |
| 167 | +references: |
| 168 | +- fullName: azure.eventhub.EventData.body |
| 169 | + isExternal: false |
| 170 | + name: body |
| 171 | + parent: azure.eventhub.EventData |
| 172 | + uid: azure.eventhub.EventData.body |
| 173 | +- fullName: azure.eventhub.EventData.body_as_json |
| 174 | + isExternal: false |
| 175 | + name: body_as_json(encoding='UTF-8') |
| 176 | + parent: azure.eventhub.EventData |
| 177 | + uid: azure.eventhub.EventData.body_as_json |
| 178 | +- fullName: azure.eventhub.EventData.body_as_str |
| 179 | + isExternal: false |
| 180 | + name: body_as_str(encoding='UTF-8') |
| 181 | + parent: azure.eventhub.EventData |
| 182 | + uid: azure.eventhub.EventData.body_as_str |
| 183 | +- fullName: azure.eventhub.EventData.enqueued_time |
| 184 | + isExternal: false |
| 185 | + name: enqueued_time |
| 186 | + parent: azure.eventhub.EventData |
| 187 | + uid: azure.eventhub.EventData.enqueued_time |
| 188 | +- fullName: azure.eventhub.EventData.offset |
| 189 | + isExternal: false |
| 190 | + name: offset |
| 191 | + parent: azure.eventhub.EventData |
| 192 | + uid: azure.eventhub.EventData.offset |
| 193 | +- fullName: azure.eventhub.EventData.partition_key |
| 194 | + isExternal: false |
| 195 | + name: partition_key |
| 196 | + parent: azure.eventhub.EventData |
| 197 | + uid: azure.eventhub.EventData.partition_key |
| 198 | +- fullName: azure.eventhub.EventData.properties |
| 199 | + isExternal: false |
| 200 | + name: properties |
| 201 | + parent: azure.eventhub.EventData |
| 202 | + uid: azure.eventhub.EventData.properties |
| 203 | +- fullName: azure.eventhub.EventData.sequence_number |
| 204 | + isExternal: false |
| 205 | + name: sequence_number |
| 206 | + parent: azure.eventhub.EventData |
| 207 | + uid: azure.eventhub.EventData.sequence_number |
| 208 | +- fullName: azure.eventhub.EventData.system_properties |
| 209 | + isExternal: false |
| 210 | + name: system_properties |
| 211 | + parent: azure.eventhub.EventData |
| 212 | + uid: azure.eventhub.EventData.system_properties |
| 213 | +- fullName: Generator[bytes] |
| 214 | + name: Generator[bytes] |
| 215 | + spec.python: |
| 216 | + - fullName: Generator |
| 217 | + name: Generator |
| 218 | + uid: Generator |
| 219 | + - fullName: '[' |
| 220 | + name: '[' |
| 221 | + - fullName: bytes |
| 222 | + name: bytes |
| 223 | + uid: bytes |
| 224 | + - fullName: ']' |
| 225 | + name: ']' |
| 226 | + uid: Generator[bytes] |
0 commit comments