-
Notifications
You must be signed in to change notification settings - Fork 260
/
ApplicationHealth.xml
161 lines (161 loc) · 9.82 KB
/
ApplicationHealth.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
<Type Name="ApplicationHealth" FullName="System.Fabric.Health.ApplicationHealth">
<TypeSignature Language="C#" Value="public sealed class ApplicationHealth : System.Fabric.Health.EntityHealth" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit ApplicationHealth extends System.Fabric.Health.EntityHealth" />
<TypeSignature Language="DocId" Value="T:System.Fabric.Health.ApplicationHealth" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class ApplicationHealth
Inherits EntityHealth" />
<TypeSignature Language="F#" Value="type ApplicationHealth = class
 inherit EntityHealth" />
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Fabric.Health.EntityHealth</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
<para>Describes the health of an application as returned by
<see cref="M:System.Fabric.FabricClient.HealthClient.GetApplicationHealthAsync(System.Fabric.Description.ApplicationHealthQueryDescription)" />.</para>
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="ApplicationName">
<MemberSignature Language="C#" Value="public Uri ApplicationName { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Uri ApplicationName" />
<MemberSignature Language="DocId" Value="P:System.Fabric.Health.ApplicationHealth.ApplicationName" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ApplicationName As Uri" />
<MemberSignature Language="F#" Value="member this.ApplicationName : Uri" Usage="System.Fabric.Health.ApplicationHealth.ApplicationName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Uri</ReturnType>
</ReturnValue>
<Docs>
<summary>
<para>Gets the application name, which uniquely identifies the application . </para>
</summary>
<value>
<para>The application name.</para>
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DeployedApplicationHealthStates">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<System.Fabric.Health.DeployedApplicationHealthState> DeployedApplicationHealthStates { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class System.Fabric.Health.DeployedApplicationHealthState> DeployedApplicationHealthStates" />
<MemberSignature Language="DocId" Value="P:System.Fabric.Health.ApplicationHealth.DeployedApplicationHealthStates" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property DeployedApplicationHealthStates As IList(Of DeployedApplicationHealthState)" />
<MemberSignature Language="F#" Value="member this.DeployedApplicationHealthStates : System.Collections.Generic.IList<System.Fabric.Health.DeployedApplicationHealthState>" Usage="System.Fabric.Health.ApplicationHealth.DeployedApplicationHealthStates" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.Fabric.Health.DeployedApplicationHealthState></ReturnType>
</ReturnValue>
<Docs>
<summary>
<para>Gets the deployed application health states for the current application as found in the health store.</para>
</summary>
<value>
<para>deployed applications for the current application as found in the health store.</para>
</value>
<remarks>To be added.</remarks>
<para>Only deployed applications that respect the <see cref="P:System.Fabric.Description.ApplicationHealthQueryDescription.DeployedApplicationsFilter" /> (if specified) are returned.
If the input filter is not specified, all deployed applications are returned.</para>
<para>All deployed applications are evaluated to determine the application aggregated health.</para>
</Docs>
</Member>
<Member MemberName="HealthStatistics">
<MemberSignature Language="C#" Value="public System.Fabric.Health.HealthStatistics HealthStatistics { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Fabric.Health.HealthStatistics HealthStatistics" />
<MemberSignature Language="DocId" Value="P:System.Fabric.Health.ApplicationHealth.HealthStatistics" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property HealthStatistics As HealthStatistics" />
<MemberSignature Language="F#" Value="member this.HealthStatistics : System.Fabric.Health.HealthStatistics" Usage="System.Fabric.Health.ApplicationHealth.HealthStatistics" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Fabric.Health.HealthStatistics</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the application health statistics, which contain information about how many entities of the application are in
<see cref="F:System.Fabric.Health.HealthState.Ok" />, <see cref="F:System.Fabric.Health.HealthState.Warning" />, and <see cref="F:System.Fabric.Health.HealthState.Error" /> state.
</summary>
<value>The application health statistics.</value>
<remarks>
<para>
The application health statistics contain information about how many services, partitions, replicas, deployed applications, and deployed service packages are in
<see cref="F:System.Fabric.Health.HealthState.Ok" />, <see cref="F:System.Fabric.Health.HealthState.Warning" />, and <see cref="F:System.Fabric.Health.HealthState.Error" /> state.
It can be null or empty if the query that returns the <see cref="T:System.Fabric.Health.ApplicationHealth" />
specified <see cref="T:System.Fabric.Health.ApplicationHealthStatisticsFilter" /> to exclude health statistics.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="ServiceHealthStates">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<System.Fabric.Health.ServiceHealthState> ServiceHealthStates { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class System.Fabric.Health.ServiceHealthState> ServiceHealthStates" />
<MemberSignature Language="DocId" Value="P:System.Fabric.Health.ApplicationHealth.ServiceHealthStates" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ServiceHealthStates As IList(Of ServiceHealthState)" />
<MemberSignature Language="F#" Value="member this.ServiceHealthStates : System.Collections.Generic.IList<System.Fabric.Health.ServiceHealthState>" Usage="System.Fabric.Health.ApplicationHealth.ServiceHealthStates" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.Fabric.Health.ServiceHealthState></ReturnType>
</ReturnValue>
<Docs>
<summary>
<para>Gets the service health states for the current application as found in the health store.</para>
</summary>
<value>
<para>The services of the current application as found in the health store.</para>
</value>
<remarks>To be added.</remarks>
<para>Only services that respect the <see cref="P:System.Fabric.Description.ApplicationHealthQueryDescription.ServicesFilter" /> (if specified) are returned.
If the input filter is not specified, all services are returned.</para>
<para>All services are evaluated to determine the application aggregated health.</para>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.Health.ApplicationHealth.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="applicationHealth.ToString " />
<MemberType>Method</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>
<Parameters />
<Docs>
<summary>
Gets a string representation of the <see cref="T:System.Fabric.Health.ApplicationHealth" />.
</summary>
<returns>A string representation of the <see cref="T:System.Fabric.Health.ApplicationHealth" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>