-
Notifications
You must be signed in to change notification settings - Fork 260
/
CaptureDescription.xml
260 lines (260 loc) · 16.1 KB
/
CaptureDescription.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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
<Type Name="CaptureDescription" FullName="Microsoft.Azure.Management.EventHub.Models.CaptureDescription">
<TypeSignature Language="C#" Value="public class CaptureDescription" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CaptureDescription extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Management.EventHub.Models.CaptureDescription" />
<TypeSignature Language="VB.NET" Value="Public Class CaptureDescription" />
<TypeSignature Language="F#" Value="type CaptureDescription = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.EventHub</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Properties to configure capture description for eventhub
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CaptureDescription ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.EventHub.Models.CaptureDescription.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.EventHub</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the CaptureDescription class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CaptureDescription (bool? enabled = default, Microsoft.Azure.Management.EventHub.Models.EncodingCaptureDescription? encoding = default, int? intervalInSeconds = default, int? sizeLimitInBytes = default, Microsoft.Azure.Management.EventHub.Models.Destination destination = default, bool? skipEmptyArchives = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.Nullable`1<bool> enabled, valuetype System.Nullable`1<valuetype Microsoft.Azure.Management.EventHub.Models.EncodingCaptureDescription> encoding, valuetype System.Nullable`1<int32> intervalInSeconds, valuetype System.Nullable`1<int32> sizeLimitInBytes, class Microsoft.Azure.Management.EventHub.Models.Destination destination, valuetype System.Nullable`1<bool> skipEmptyArchives) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.EventHub.Models.CaptureDescription.#ctor(System.Nullable{System.Boolean},System.Nullable{Microsoft.Azure.Management.EventHub.Models.EncodingCaptureDescription},System.Nullable{System.Int32},System.Nullable{System.Int32},Microsoft.Azure.Management.EventHub.Models.Destination,System.Nullable{System.Boolean})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (Optional enabled As Nullable(Of Boolean) = Nothing, Optional encoding As Nullable(Of EncodingCaptureDescription) = Nothing, Optional intervalInSeconds As Nullable(Of Integer) = Nothing, Optional sizeLimitInBytes As Nullable(Of Integer) = Nothing, Optional destination As Destination = Nothing, Optional skipEmptyArchives As Nullable(Of Boolean) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Management.EventHub.Models.CaptureDescription : Nullable<bool> * Nullable<Microsoft.Azure.Management.EventHub.Models.EncodingCaptureDescription> * Nullable<int> * Nullable<int> * Microsoft.Azure.Management.EventHub.Models.Destination * Nullable<bool> -> Microsoft.Azure.Management.EventHub.Models.CaptureDescription" Usage="new Microsoft.Azure.Management.EventHub.Models.CaptureDescription (enabled, encoding, intervalInSeconds, sizeLimitInBytes, destination, skipEmptyArchives)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.EventHub</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="enabled" Type="System.Nullable<System.Boolean>" />
<Parameter Name="encoding" Type="System.Nullable<Microsoft.Azure.Management.EventHub.Models.EncodingCaptureDescription>" />
<Parameter Name="intervalInSeconds" Type="System.Nullable<System.Int32>" />
<Parameter Name="sizeLimitInBytes" Type="System.Nullable<System.Int32>" />
<Parameter Name="destination" Type="Microsoft.Azure.Management.EventHub.Models.Destination" />
<Parameter Name="skipEmptyArchives" Type="System.Nullable<System.Boolean>" />
</Parameters>
<Docs>
<param name="enabled">A value that indicates whether capture
description is enabled. </param>
<param name="encoding">Enumerates the possible values for the
encoding format of capture description. Note: 'AvroDeflate' will be
deprecated in New API Version. Possible values include: 'Avro',
'AvroDeflate'</param>
<param name="intervalInSeconds">The time window allows you to set
the frequency with which the capture to Azure Blobs will happen,
value should between 60 to 900 seconds</param>
<param name="sizeLimitInBytes">The size window defines the amount
of data built up in your Event Hub before an capture operation,
value should be between 10485760 to 524288000 bytes</param>
<param name="destination">Properties of Destination where capture
will be stored. (Storage Account, Blob Names)</param>
<param name="skipEmptyArchives">A value that indicates whether to
Skip Empty Archives</param>
<summary>
Initializes a new instance of the CaptureDescription class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Destination">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Management.EventHub.Models.Destination Destination { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Management.EventHub.Models.Destination Destination" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.EventHub.Models.CaptureDescription.Destination" />
<MemberSignature Language="VB.NET" Value="Public Property Destination As Destination" />
<MemberSignature Language="F#" Value="member this.Destination : Microsoft.Azure.Management.EventHub.Models.Destination with get, set" Usage="Microsoft.Azure.Management.EventHub.Models.CaptureDescription.Destination" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.EventHub</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="destination")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="destination")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Management.EventHub.Models.Destination</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets properties of Destination where capture will be
stored. (Storage Account, Blob Names)
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Enabled">
<MemberSignature Language="C#" Value="public bool? Enabled { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> Enabled" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.EventHub.Models.CaptureDescription.Enabled" />
<MemberSignature Language="VB.NET" Value="Public Property Enabled As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.Enabled : Nullable<bool> with get, set" Usage="Microsoft.Azure.Management.EventHub.Models.CaptureDescription.Enabled" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.EventHub</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="enabled")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="enabled")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a value that indicates whether capture description is
enabled.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Encoding">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Management.EventHub.Models.EncodingCaptureDescription? Encoding { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Microsoft.Azure.Management.EventHub.Models.EncodingCaptureDescription> Encoding" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.EventHub.Models.CaptureDescription.Encoding" />
<MemberSignature Language="VB.NET" Value="Public Property Encoding As Nullable(Of EncodingCaptureDescription)" />
<MemberSignature Language="F#" Value="member this.Encoding : Nullable<Microsoft.Azure.Management.EventHub.Models.EncodingCaptureDescription> with get, set" Usage="Microsoft.Azure.Management.EventHub.Models.CaptureDescription.Encoding" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.EventHub</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="encoding")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="encoding")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<Microsoft.Azure.Management.EventHub.Models.EncodingCaptureDescription></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets enumerates the possible values for the encoding format
of capture description. Note: 'AvroDeflate' will be deprecated in
New API Version. Possible values include: 'Avro', 'AvroDeflate'
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IntervalInSeconds">
<MemberSignature Language="C#" Value="public int? IntervalInSeconds { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> IntervalInSeconds" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.EventHub.Models.CaptureDescription.IntervalInSeconds" />
<MemberSignature Language="VB.NET" Value="Public Property IntervalInSeconds As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.IntervalInSeconds : Nullable<int> with get, set" Usage="Microsoft.Azure.Management.EventHub.Models.CaptureDescription.IntervalInSeconds" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.EventHub</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="intervalInSeconds")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="intervalInSeconds")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the time window allows you to set the frequency with
which the capture to Azure Blobs will happen, value should between
60 to 900 seconds
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SizeLimitInBytes">
<MemberSignature Language="C#" Value="public int? SizeLimitInBytes { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> SizeLimitInBytes" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.EventHub.Models.CaptureDescription.SizeLimitInBytes" />
<MemberSignature Language="VB.NET" Value="Public Property SizeLimitInBytes As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.SizeLimitInBytes : Nullable<int> with get, set" Usage="Microsoft.Azure.Management.EventHub.Models.CaptureDescription.SizeLimitInBytes" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.EventHub</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="sizeLimitInBytes")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="sizeLimitInBytes")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the size window defines the amount of data built up in
your Event Hub before an capture operation, value should be between
10485760 to 524288000 bytes
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SkipEmptyArchives">
<MemberSignature Language="C#" Value="public bool? SkipEmptyArchives { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> SkipEmptyArchives" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.EventHub.Models.CaptureDescription.SkipEmptyArchives" />
<MemberSignature Language="VB.NET" Value="Public Property SkipEmptyArchives As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.SkipEmptyArchives : Nullable<bool> with get, set" Usage="Microsoft.Azure.Management.EventHub.Models.CaptureDescription.SkipEmptyArchives" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.EventHub</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="skipEmptyArchives")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="skipEmptyArchives")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a value that indicates whether to Skip Empty Archives
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>