-
Notifications
You must be signed in to change notification settings - Fork 255
/
MetricLoadDescription.xml
127 lines (127 loc) · 6.82 KB
/
MetricLoadDescription.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
<Type Name="MetricLoadDescription" FullName="System.Fabric.Description.MetricLoadDescription">
<TypeSignature Language="C#" Value="public sealed class MetricLoadDescription" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit MetricLoadDescription extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.Fabric.Description.MetricLoadDescription" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class MetricLoadDescription" />
<TypeSignature Language="F#" Value="type MetricLoadDescription = 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>Specifies metric load information.</para>
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public MetricLoadDescription (string metricName, long? currentLoad = default, long? predictedLoad = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string metricName, valuetype System.Nullable`1<int64> currentLoad, valuetype System.Nullable`1<int64> predictedLoad) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.Description.MetricLoadDescription.#ctor(System.String,System.Nullable{System.Int64},System.Nullable{System.Int64})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (metricName As String, Optional currentLoad As Nullable(Of Long) = Nothing, Optional predictedLoad As Nullable(Of Long) = Nothing)" />
<MemberSignature Language="F#" Value="new System.Fabric.Description.MetricLoadDescription : string * Nullable<int64> * Nullable<int64> -> System.Fabric.Description.MetricLoadDescription" Usage="new System.Fabric.Description.MetricLoadDescription (metricName, currentLoad, predictedLoad)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="metricName" Type="System.String" />
<Parameter Name="currentLoad" Type="System.Nullable<System.Int64>" />
<Parameter Name="predictedLoad" Type="System.Nullable<System.Int64>" />
</Parameters>
<Docs>
<param name="metricName">Metric name</param>
<param name="currentLoad">Current load, can be null</param>
<param name="predictedLoad">Predicted load, can be null</param>
<summary>
Constructor for MetricLoadDescription where at least one out of current and predicted load values should be specified.
Predicted metric load values is currently a preview feature. It allows predicted load values to be reported and used at the Service Fabric side, but that feature is currently not enabled.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CurrentLoad">
<MemberSignature Language="C#" Value="public long? CurrentLoad { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int64> CurrentLoad" />
<MemberSignature Language="DocId" Value="P:System.Fabric.Description.MetricLoadDescription.CurrentLoad" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property CurrentLoad As Nullable(Of Long)" />
<MemberSignature Language="F#" Value="member this.CurrentLoad : Nullable<int64>" Usage="System.Fabric.Description.MetricLoadDescription.CurrentLoad" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Int64></ReturnType>
</ReturnValue>
<Docs>
<summary>
<para> The current value of the metric. </para>
</summary>
<value>
<para>Returns <see cref="T:System.UInt64" />.</para>
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MetricName">
<MemberSignature Language="C#" Value="public string MetricName { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string MetricName" />
<MemberSignature Language="DocId" Value="P:System.Fabric.Description.MetricLoadDescription.MetricName" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property MetricName As String" />
<MemberSignature Language="F#" Value="member this.MetricName : string" Usage="System.Fabric.Description.MetricLoadDescription.MetricName" />
<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> The name of the metric. </para>
</summary>
<value>
<para>Returns <see cref="T:System.String" />.</para>
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PredictedLoad">
<MemberSignature Language="C#" Value="public long? PredictedLoad { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int64> PredictedLoad" />
<MemberSignature Language="DocId" Value="P:System.Fabric.Description.MetricLoadDescription.PredictedLoad" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property PredictedLoad As Nullable(Of Long)" />
<MemberSignature Language="F#" Value="member this.PredictedLoad : Nullable<int64>" Usage="System.Fabric.Description.MetricLoadDescription.PredictedLoad" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Int64></ReturnType>
</ReturnValue>
<Docs>
<summary>
<para> The predicted value of the metric. </para>
</summary>
<value>
<para>Returns <see cref="T:System.UInt64" />.</para>
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>