-
Notifications
You must be signed in to change notification settings - Fork 262
/
ApplicationHealthStatisticsFilter.xml
99 lines (99 loc) · 5.38 KB
/
ApplicationHealthStatisticsFilter.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
<Type Name="ApplicationHealthStatisticsFilter" FullName="System.Fabric.Health.ApplicationHealthStatisticsFilter">
<TypeSignature Language="C#" Value="public sealed class ApplicationHealthStatisticsFilter" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit ApplicationHealthStatisticsFilter extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.Fabric.Health.ApplicationHealthStatisticsFilter" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class ApplicationHealthStatisticsFilter" />
<TypeSignature Language="F#" Value="type ApplicationHealthStatisticsFilter = 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 the filter for <see cref="T:System.Fabric.Health.HealthStatistics" />.</para>
</summary>
<remarks>The filter can be used in <see cref="T:System.Fabric.Description.ApplicationHealthQueryDescription" />
to specify whether the health statistics should be returned as part of <see cref="T:System.Fabric.Health.ApplicationHealth" />.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ApplicationHealthStatisticsFilter ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.Health.ApplicationHealthStatisticsFilter.#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.Health.ApplicationHealthStatisticsFilter" /> class.</para>
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ExcludeHealthStatistics">
<MemberSignature Language="C#" Value="public bool ExcludeHealthStatistics { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool ExcludeHealthStatistics" />
<MemberSignature Language="DocId" Value="P:System.Fabric.Health.ApplicationHealthStatisticsFilter.ExcludeHealthStatistics" />
<MemberSignature Language="VB.NET" Value="Public Property ExcludeHealthStatistics As Boolean" />
<MemberSignature Language="F#" Value="member this.ExcludeHealthStatistics : bool with get, set" Usage="System.Fabric.Health.ApplicationHealthStatisticsFilter.ExcludeHealthStatistics" />
<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>
Gets or sets a flag that indicates whether the health statistics should be included in query result.
</summary>
<value>A flag that indicates whether the health statistics should be included in query result.</value>
<remarks>
<para>
If ExcludeHealthStatistics is set to <languageKeyword>true</languageKeyword>, the health statistics are not returned as part of the query result.
Otherwise, the query result includes the application health statistics, which contain information about how many
services, partitions and replicas of this 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.
Defaults to <languageKeyword>false</languageKeyword>.
</para>
</remarks>
</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.ApplicationHealthStatisticsFilter.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="applicationHealthStatisticsFilter.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>
Returns a string representation of the filter.
</summary>
<returns>A string representation of the filter.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>