-
Notifications
You must be signed in to change notification settings - Fork 256
/
EventData.xml
202 lines (202 loc) · 11.1 KB
/
EventData.xml
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
<Type Name="EventData" FullName="Microsoft.Azure.EventHubs.EventData">
<TypeSignature Language="C#" Value="public class EventData : IDisposable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit EventData extends System.Object implements class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.EventHubs.EventData" />
<TypeSignature Language="VB.NET" Value="Public Class EventData
Implements IDisposable" />
<TypeSignature Language="F#" Value="type EventData = class
 interface IDisposable" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.EventHubs</AssemblyName>
<AssemblyVersion>4.3.1.0</AssemblyVersion>
<AssemblyVersion>4.3.2.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
The data structure encapsulating the Event being sent-to and received-from EventHubs.
Each EventHubs partition can be visualized as a Stream of EventData.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public EventData (ArraySegment<byte> arraySegment);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.ArraySegment`1<unsigned int8> arraySegment) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.EventHubs.EventData.#ctor(System.ArraySegment{System.Byte})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (arraySegment As ArraySegment(Of Byte))" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.EventHubs.EventData : ArraySegment<byte> -> Microsoft.Azure.EventHubs.EventData" Usage="new Microsoft.Azure.EventHubs.EventData arraySegment" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.EventHubs</AssemblyName>
<AssemblyVersion>4.3.2.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="arraySegment" Type="System.ArraySegment<System.Byte>" />
</Parameters>
<Docs>
<param name="arraySegment">The payload bytes, offset and length to be sent to the EventHub.</param>
<summary>
Construct EventData to send to EventHub.
Typical pattern to create a Sending EventData is:
<para>i. Serialize the sending ApplicationEvent to be sent to EventHub into bytes.</para><para>ii. If complex serialization logic is involved (for example: multiple types of data) - add a Hint using the <see cref="P:Microsoft.Azure.EventHubs.EventData.Properties" /> for the Consumer.</para></summary>
<remarks>To be added.</remarks>
<example>Sample Code:
<code>
EventData eventData = new EventData(new ArraySegment<byte>(eventBytes, offset, count));
eventData.Properties["eventType"] = "com.microsoft.azure.monitoring.EtlEvent";
await partitionSender.SendAsync(eventData);
</code></example>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public EventData (byte[] array);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(unsigned int8[] array) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.EventHubs.EventData.#ctor(System.Byte[])" />
<MemberSignature Language="VB.NET" Value="Public Sub New (array As Byte())" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.EventHubs.EventData : byte[] -> Microsoft.Azure.EventHubs.EventData" Usage="new Microsoft.Azure.EventHubs.EventData array" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.EventHubs</AssemblyName>
<AssemblyVersion>4.3.2.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="array" Type="System.Byte[]" />
</Parameters>
<Docs>
<param name="array">The actual payload of data in bytes to be sent to the EventHub.</param>
<summary>
Construct EventData to send to EventHub.
Typical pattern to create a Sending EventData is:
<para>i. Serialize the sending ApplicationEvent to be sent to EventHubs into bytes.</para><para>ii. If complex serialization logic is involved (for example: multiple types of data) - add a Hint using the <see cref="P:Microsoft.Azure.EventHubs.EventData.Properties" /> for the Consumer.</para></summary>
<remarks>To be added.</remarks>
<example>Sample Code:
<code>
EventData eventData = new EventData(telemetryEventBytes);
eventData.Properties["eventType"] = "com.microsoft.azure.monitoring.EtlEvent";
await partitionSender.SendAsync(eventData);
</code></example>
</Docs>
</Member>
<Member MemberName="Body">
<MemberSignature Language="C#" Value="public ArraySegment<byte> Body { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.ArraySegment`1<unsigned int8> Body" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.EventHubs.EventData.Body" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Body As ArraySegment(Of Byte)" />
<MemberSignature Language="F#" Value="member this.Body : ArraySegment<byte>" Usage="Microsoft.Azure.EventHubs.EventData.Body" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.EventHubs</AssemblyName>
<AssemblyVersion>4.3.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ArraySegment<System.Byte></ReturnType>
</ReturnValue>
<Docs>
<summary>
Get the actual Payload/Data wrapped by EventData.
This is intended to be used after receiving EventData using <see cref="T:Microsoft.Azure.EventHubs.PartitionReceiver" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ContentType">
<MemberSignature Language="C#" Value="public string ContentType { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ContentType" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.EventHubs.EventData.ContentType" />
<MemberSignature Language="VB.NET" Value="Public Property ContentType As String" />
<MemberSignature Language="F#" Value="member this.ContentType : string with get, set" Usage="Microsoft.Azure.EventHubs.EventData.ContentType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.EventHubs</AssemblyName>
<AssemblyVersion>4.3.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets and sets type of the content.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="public void Dispose ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.EventHubs.EventData.Dispose" />
<MemberSignature Language="VB.NET" Value="Public Sub Dispose ()" />
<MemberSignature Language="F#" Value="abstract member Dispose : unit -> unit
override this.Dispose : unit -> unit" Usage="eventData.Dispose " />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.IDisposable.Dispose</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.EventHubs</AssemblyName>
<AssemblyVersion>4.3.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Disposes resources attached to an Event Data
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Properties">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IDictionary<string,object> Properties { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IDictionary`2<string, object> Properties" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.EventHubs.EventData.Properties" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Properties As IDictionary(Of String, Object)" />
<MemberSignature Language="F#" Value="member this.Properties : System.Collections.Generic.IDictionary<string, obj>" Usage="Microsoft.Azure.EventHubs.EventData.Properties" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.EventHubs</AssemblyName>
<AssemblyVersion>4.3.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IDictionary<System.String,System.Object></ReturnType>
</ReturnValue>
<Docs>
<summary>
Application property bag
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SystemProperties">
<MemberSignature Language="C#" Value="public Microsoft.Azure.EventHubs.EventData.SystemPropertiesCollection SystemProperties { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.EventHubs.EventData/SystemPropertiesCollection SystemProperties" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.EventHubs.EventData.SystemProperties" />
<MemberSignature Language="VB.NET" Value="Public Property SystemProperties As EventData.SystemPropertiesCollection" />
<MemberSignature Language="F#" Value="member this.SystemProperties : Microsoft.Azure.EventHubs.EventData.SystemPropertiesCollection with get, set" Usage="Microsoft.Azure.EventHubs.EventData.SystemProperties" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.EventHubs</AssemblyName>
<AssemblyVersion>4.3.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.EventHubs.EventData+SystemPropertiesCollection</ReturnType>
</ReturnValue>
<Docs>
<summary>
SystemProperties that are populated by EventHubService.
As these are populated by Service, they are only present on a Received EventData.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>