-
Notifications
You must be signed in to change notification settings - Fork 256
/
NodeLoadMetricInformation.xml
337 lines (337 loc) · 16.7 KB
/
NodeLoadMetricInformation.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
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
<Type Name="NodeLoadMetricInformation" FullName="System.Fabric.Query.NodeLoadMetricInformation">
<TypeSignature Language="C#" Value="public sealed class NodeLoadMetricInformation" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit NodeLoadMetricInformation extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.Fabric.Query.NodeLoadMetricInformation" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class NodeLoadMetricInformation" />
<TypeSignature Language="F#" Value="type NodeLoadMetricInformation = class" />
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
<para>Represents data structure that contains load information for a certain metric on a node.</para>
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public NodeLoadMetricInformation ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.Query.NodeLoadMetricInformation.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
<para>Initializes a new instance of the <see cref="T:System.Fabric.Query.NodeLoadMetricInformation" /> class.</para>
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="BufferedNodeCapacityRemaining">
<MemberSignature Language="C#" Value="public double BufferedNodeCapacityRemaining { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 BufferedNodeCapacityRemaining" />
<MemberSignature Language="DocId" Value="P:System.Fabric.Query.NodeLoadMetricInformation.BufferedNodeCapacityRemaining" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property BufferedNodeCapacityRemaining As Double" />
<MemberSignature Language="F#" Value="member this.BufferedNodeCapacityRemaining : double" Usage="System.Fabric.Query.NodeLoadMetricInformation.BufferedNodeCapacityRemaining" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>
<para>Gets a value that indicates the remaining capacity which is not reserved by NodeBufferPercentage.</para>
</summary>
<value>
<para>The remaining capacity which is not reserved by NodeBufferPercentage for this metric on the node.</para>
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CurrentNodeLoad">
<MemberSignature Language="C#" Value="public double CurrentNodeLoad { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 CurrentNodeLoad" />
<MemberSignature Language="DocId" Value="P:System.Fabric.Query.NodeLoadMetricInformation.CurrentNodeLoad" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property CurrentNodeLoad As Double" />
<MemberSignature Language="F#" Value="member this.CurrentNodeLoad : double" Usage="System.Fabric.Query.NodeLoadMetricInformation.CurrentNodeLoad" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>
<para>>Gets the current load on the node for a metric.</para>
</summary>
<value>
<para>The current load on the node for a metric.</para>
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsCapacityViolation">
<MemberSignature Language="C#" Value="public bool IsCapacityViolation { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsCapacityViolation" />
<MemberSignature Language="DocId" Value="P:System.Fabric.Query.NodeLoadMetricInformation.IsCapacityViolation" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsCapacityViolation As Boolean" />
<MemberSignature Language="F#" Value="member this.IsCapacityViolation : bool" Usage="System.Fabric.Query.NodeLoadMetricInformation.IsCapacityViolation" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
<para>Gets a value that indicates whether there is a capacity violation for the metric on the given node.</para>
</summary>
<value>
<para>
<languageKeyword>true</languageKeyword> if there is a capacity violation for the metric on the given node;
otherwise, <languageKeyword>false</languageKeyword>.</para>
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
<MemberSignature Language="DocId" Value="P:System.Fabric.Query.NodeLoadMetricInformation.Name" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Name As String" />
<MemberSignature Language="F#" Value="member this.Name : string" Usage="System.Fabric.Query.NodeLoadMetricInformation.Name" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
<para>Gets the name of the metric.</para>
</summary>
<value>
<para>The name of the metric.</para>
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="NodeBufferedCapacity">
<MemberSignature Language="C#" Value="public long NodeBufferedCapacity { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 NodeBufferedCapacity" />
<MemberSignature Language="DocId" Value="P:System.Fabric.Query.NodeLoadMetricInformation.NodeBufferedCapacity" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property NodeBufferedCapacity As Long" />
<MemberSignature Language="F#" Value="member this.NodeBufferedCapacity : int64" Usage="System.Fabric.Query.NodeLoadMetricInformation.NodeBufferedCapacity" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>
<para>Gets a value that indicates the capacity which is not reserved by NodeBufferPercentage.</para>
</summary>
<value>
<para>The capacity which is not reserved by NodeBufferPercentage for this metric on the node.</para>
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="NodeCapacity">
<MemberSignature Language="C#" Value="public long NodeCapacity { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 NodeCapacity" />
<MemberSignature Language="DocId" Value="P:System.Fabric.Query.NodeLoadMetricInformation.NodeCapacity" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property NodeCapacity As Long" />
<MemberSignature Language="F#" Value="member this.NodeCapacity : int64" Usage="System.Fabric.Query.NodeLoadMetricInformation.NodeCapacity" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>
<para>Gets the total capacity on the node for the metric.</para>
</summary>
<value>
<para>The total capacity on the node for the metric.</para>
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="NodeCapacityRemaining">
<MemberSignature Language="C#" Value="public double NodeCapacityRemaining { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 NodeCapacityRemaining" />
<MemberSignature Language="DocId" Value="P:System.Fabric.Query.NodeLoadMetricInformation.NodeCapacityRemaining" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property NodeCapacityRemaining As Double" />
<MemberSignature Language="F#" Value="member this.NodeCapacityRemaining : double" Usage="System.Fabric.Query.NodeLoadMetricInformation.NodeCapacityRemaining" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>
<para>Gets the remaining capacity on the node for the metric.</para>
</summary>
<value>
<para>The remaining capacity on the node for the metric.</para>
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="NodeLoad">
<MemberSignature Language="C#" Value="public long NodeLoad { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 NodeLoad" />
<MemberSignature Language="DocId" Value="P:System.Fabric.Query.NodeLoadMetricInformation.NodeLoad" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property NodeLoad As Long" />
<MemberSignature Language="F#" Value="member this.NodeLoad : int64" Usage="System.Fabric.Query.NodeLoadMetricInformation.NodeLoad" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>
<para>Gets the current load on the node for a metric.</para>
<para>
In future releases of Service Fabric this parameter will be deprecated in favor of
<see cref="P:System.Fabric.Query.NodeLoadMetricInformation.CurrentNodeLoad" />.
</para>
</summary>
<value>
<para>The current load on the node for a metric.</para>
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="NodeRemainingBufferedCapacity">
<MemberSignature Language="C#" Value="public long NodeRemainingBufferedCapacity { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 NodeRemainingBufferedCapacity" />
<MemberSignature Language="DocId" Value="P:System.Fabric.Query.NodeLoadMetricInformation.NodeRemainingBufferedCapacity" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property NodeRemainingBufferedCapacity As Long" />
<MemberSignature Language="F#" Value="member this.NodeRemainingBufferedCapacity : int64" Usage="System.Fabric.Query.NodeLoadMetricInformation.NodeRemainingBufferedCapacity" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>
<para>Gets a value that indicates the remaining capacity which is not reserved by NodeBufferPercentage.</para>
<para>
In future releases of Service Fabric this parameter will be deprecated in favor of
<see cref="P:System.Fabric.Query.NodeLoadMetricInformation.BufferedNodeCapacityRemaining" />.
</para>
</summary>
<value>
<para>The remaining capacity which is not reserved by NodeBufferPercentage for this metric on the node.</para>
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="NodeRemainingCapacity">
<MemberSignature Language="C#" Value="public long NodeRemainingCapacity { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 NodeRemainingCapacity" />
<MemberSignature Language="DocId" Value="P:System.Fabric.Query.NodeLoadMetricInformation.NodeRemainingCapacity" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property NodeRemainingCapacity As Long" />
<MemberSignature Language="F#" Value="member this.NodeRemainingCapacity : int64" Usage="System.Fabric.Query.NodeLoadMetricInformation.NodeRemainingCapacity" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>
<para>Gets the remaining capacity on the node for the metric.</para>
<para>
In future releases of Service Fabric this parameter will be deprecated in favor of
<see cref="P:System.Fabric.Query.NodeLoadMetricInformation.NodeCapacityRemaining" />.
</para>
</summary>
<value>
<para>The remaining capacity on the node for the metric.</para>
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PlannedNodeLoadRemoval">
<MemberSignature Language="C#" Value="public double PlannedNodeLoadRemoval { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 PlannedNodeLoadRemoval" />
<MemberSignature Language="DocId" Value="P:System.Fabric.Query.NodeLoadMetricInformation.PlannedNodeLoadRemoval" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property PlannedNodeLoadRemoval As Double" />
<MemberSignature Language="F#" Value="member this.PlannedNodeLoadRemoval : double" Usage="System.Fabric.Query.NodeLoadMetricInformation.PlannedNodeLoadRemoval" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>
<para>Gets the load of the replicas on the node that are planned to be removed in the future.</para>
</summary>
<value>
<para>
This value represents the load of the replicas on the node that are planned to be removed in the future.
There are two cases where "PlannedNodeLoadRemoval" kind of load will be reported:
1) Replicas that are currently being moving to other nodes
2) Replicas that are currently being dropped but still use the load on the source node.
</para>
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>