-
Notifications
You must be signed in to change notification settings - Fork 256
/
DeployedServicePackageHealthQueryDescription.xml
309 lines (309 loc) · 18.1 KB
/
DeployedServicePackageHealthQueryDescription.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
<Type Name="DeployedServicePackageHealthQueryDescription" FullName="System.Fabric.Description.DeployedServicePackageHealthQueryDescription">
<TypeSignature Language="C#" Value="public sealed class DeployedServicePackageHealthQueryDescription" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit DeployedServicePackageHealthQueryDescription extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.Fabric.Description.DeployedServicePackageHealthQueryDescription" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class DeployedServicePackageHealthQueryDescription" />
<TypeSignature Language="F#" Value="type DeployedServicePackageHealthQueryDescription = 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>Describes the query input for getting <see cref="T:System.Fabric.Health.DeployedServicePackageHealth" />. Used by
<see cref="M:System.Fabric.FabricClient.HealthClient.GetDeployedServicePackageHealthAsync(System.Fabric.Description.DeployedServicePackageHealthQueryDescription)" />.</para>
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DeployedServicePackageHealthQueryDescription (Uri applicationName, string nodeName, string serviceManifestName);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri applicationName, string nodeName, string serviceManifestName) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.Description.DeployedServicePackageHealthQueryDescription.#ctor(System.Uri,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (applicationName As Uri, nodeName As String, serviceManifestName As String)" />
<MemberSignature Language="F#" Value="new System.Fabric.Description.DeployedServicePackageHealthQueryDescription : Uri * string * string -> System.Fabric.Description.DeployedServicePackageHealthQueryDescription" Usage="new System.Fabric.Description.DeployedServicePackageHealthQueryDescription (applicationName, nodeName, serviceManifestName)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="applicationName" Type="System.Uri" />
<Parameter Name="nodeName" Type="System.String" />
<Parameter Name="serviceManifestName" Type="System.String" />
</Parameters>
<Docs>
<param name="applicationName">
<para>The application name. Cannot be null.</para>
</param>
<param name="nodeName">
<para>The node name. Cannot be null or empty.</para>
</param>
<param name="serviceManifestName">
<para>The service manifest name. Cannot be null or empty.</para>
</param>
<summary>
<para>Instantiates a <see cref="T:System.Fabric.Description.DeployedServicePackageHealthQueryDescription" /> class.</para>
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<para>A required parameter can't be null.</para>
</exception>
<exception cref="T:System.ArgumentException">
<para>A required parameter can't be empty.</para>
</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DeployedServicePackageHealthQueryDescription (Uri applicationName, string nodeName, string serviceManifestName, string servicePackageActivationId);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri applicationName, string nodeName, string serviceManifestName, string servicePackageActivationId) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.Description.DeployedServicePackageHealthQueryDescription.#ctor(System.Uri,System.String,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (applicationName As Uri, nodeName As String, serviceManifestName As String, servicePackageActivationId As String)" />
<MemberSignature Language="F#" Value="new System.Fabric.Description.DeployedServicePackageHealthQueryDescription : Uri * string * string * string -> System.Fabric.Description.DeployedServicePackageHealthQueryDescription" Usage="new System.Fabric.Description.DeployedServicePackageHealthQueryDescription (applicationName, nodeName, serviceManifestName, servicePackageActivationId)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="applicationName" Type="System.Uri" />
<Parameter Name="nodeName" Type="System.String" />
<Parameter Name="serviceManifestName" Type="System.String" />
<Parameter Name="servicePackageActivationId" Type="System.String" />
</Parameters>
<Docs>
<param name="applicationName">
<para>The application name. Cannot be null.</para>
</param>
<param name="nodeName">
<para>The node name. Cannot be null or empty.</para>
</param>
<param name="serviceManifestName">
<para>The service manifest name. Cannot be null or empty.</para>
</param>
<param name="servicePackageActivationId">
<para>
The <see cref="P:System.Fabric.Query.DeployedServicePackage.ServicePackageActivationId" /> of deployed service package.
ServicePackageActivationId of a deployed service package can obtained by using
<see cref="M:System.Fabric.FabricClient.QueryClient.GetDeployedServicePackageListAsync(System.String,System.Uri)" /> query.
</para>
<para>
If <see cref="T:System.Fabric.Description.ServicePackageActivationMode" /> specified at the time of creating the service is
<see cref="F:System.Fabric.Description.ServicePackageActivationMode.SharedProcess" /> (or if it is not specified, in
which case it defaults to <see cref="F:System.Fabric.Description.ServicePackageActivationMode.SharedProcess" />), then value of
<see cref="P:System.Fabric.Query.DeployedServicePackage.ServicePackageActivationId" /> is always an empty string.
For more details please see <see cref="T:System.Fabric.Description.ServicePackageActivationMode" />.
</para>
</param>
<summary>
<para>Instantiates a <see cref="T:System.Fabric.Description.DeployedServicePackageHealthQueryDescription" /> class.</para>
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<para>A required parameter can't be null.</para>
</exception>
<exception cref="T:System.ArgumentException">
<para>A required parameter can't be empty.</para>
</exception>
</Docs>
</Member>
<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.Description.DeployedServicePackageHealthQueryDescription.ApplicationName" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ApplicationName As Uri" />
<MemberSignature Language="F#" Value="member this.ApplicationName : Uri" Usage="System.Fabric.Description.DeployedServicePackageHealthQueryDescription.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 name of the application.</para>
</summary>
<value>
<para>The name of the application.</para>
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EventsFilter">
<MemberSignature Language="C#" Value="public System.Fabric.Health.HealthEventsFilter EventsFilter { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Fabric.Health.HealthEventsFilter EventsFilter" />
<MemberSignature Language="DocId" Value="P:System.Fabric.Description.DeployedServicePackageHealthQueryDescription.EventsFilter" />
<MemberSignature Language="VB.NET" Value="Public Property EventsFilter As HealthEventsFilter" />
<MemberSignature Language="F#" Value="member this.EventsFilter : System.Fabric.Health.HealthEventsFilter with get, set" Usage="System.Fabric.Description.DeployedServicePackageHealthQueryDescription.EventsFilter" />
<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.HealthEventsFilter</ReturnType>
</ReturnValue>
<Docs>
<summary>
<para>Gets or sets the filter for the collection of <see cref="T:System.Fabric.Health.HealthEvent" /> reported on the deployed service
package. Only events that match the filter will be returned. All events will be used to evaluate the aggregated health state.</para>
</summary>
<value>
<para>The <see cref="T:System.Fabric.Health.HealthEventsFilter" /> used to filter returned events.</para>
</value>
<remarks>
<para> Only events that match
the filter will be returned. All events will be used to evaluate the entity aggregated health state.
If the filter is not specified, all events are returned.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="HealthPolicy">
<MemberSignature Language="C#" Value="public System.Fabric.Health.ApplicationHealthPolicy HealthPolicy { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Fabric.Health.ApplicationHealthPolicy HealthPolicy" />
<MemberSignature Language="DocId" Value="P:System.Fabric.Description.DeployedServicePackageHealthQueryDescription.HealthPolicy" />
<MemberSignature Language="VB.NET" Value="Public Property HealthPolicy As ApplicationHealthPolicy" />
<MemberSignature Language="F#" Value="member this.HealthPolicy : System.Fabric.Health.ApplicationHealthPolicy with get, set" Usage="System.Fabric.Description.DeployedServicePackageHealthQueryDescription.HealthPolicy" />
<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.ApplicationHealthPolicy</ReturnType>
</ReturnValue>
<Docs>
<summary>
<para>Gets or sets the <see cref="T:System.Fabric.Health.ApplicationHealthPolicy" /> used to evaluate the health.</para>
</summary>
<value>
<para>The <see cref="T:System.Fabric.Health.ApplicationHealthPolicy" /> used to evaluate health.</para>
</value>
<remarks>If not specified, the health store uses the application health policy of the parent application
to evaluate the deployed service package health.</remarks>
</Docs>
</Member>
<Member MemberName="NodeName">
<MemberSignature Language="C#" Value="public string NodeName { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string NodeName" />
<MemberSignature Language="DocId" Value="P:System.Fabric.Description.DeployedServicePackageHealthQueryDescription.NodeName" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property NodeName As String" />
<MemberSignature Language="F#" Value="member this.NodeName : string" Usage="System.Fabric.Description.DeployedServicePackageHealthQueryDescription.NodeName" />
<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 node name.</para>
</summary>
<value>
<para>The <see cref="T:System.String" /> representing the node name.</para>
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ServiceManifestName">
<MemberSignature Language="C#" Value="public string ServiceManifestName { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ServiceManifestName" />
<MemberSignature Language="DocId" Value="P:System.Fabric.Description.DeployedServicePackageHealthQueryDescription.ServiceManifestName" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ServiceManifestName As String" />
<MemberSignature Language="F#" Value="member this.ServiceManifestName : string" Usage="System.Fabric.Description.DeployedServicePackageHealthQueryDescription.ServiceManifestName" />
<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 service manifest name.</para>
</summary>
<value>
<para>The <see cref="T:System.String" /> representing the service manifest name.</para>
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ServicePackageActivationId">
<MemberSignature Language="C#" Value="public string ServicePackageActivationId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ServicePackageActivationId" />
<MemberSignature Language="DocId" Value="P:System.Fabric.Description.DeployedServicePackageHealthQueryDescription.ServicePackageActivationId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ServicePackageActivationId As String" />
<MemberSignature Language="F#" Value="member this.ServicePackageActivationId : string" Usage="System.Fabric.Description.DeployedServicePackageHealthQueryDescription.ServicePackageActivationId" />
<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>
Gets the ActivationId of the service package.
</summary>
<value>
<para>
The <see cref="P:System.Fabric.Query.DeployedServicePackage.ServicePackageActivationId" /> of deployed service package.
ServicePackageActivationId of a deployed service package can obtained by using
<see cref="M:System.Fabric.FabricClient.QueryClient.GetDeployedServicePackageListAsync(System.String,System.Uri)" /> query.
</para>
<para>
If <see cref="T:System.Fabric.Description.ServicePackageActivationMode" /> specified at the time of creating the service is
<see cref="F:System.Fabric.Description.ServicePackageActivationMode.SharedProcess" /> (or if it is not specified, in which case
it defaults to <see cref="F:System.Fabric.Description.ServicePackageActivationMode.SharedProcess" />), then value of
<see cref="P:System.Fabric.Query.DeployedServicePackage.ServicePackageActivationId" /> is always an empty string.
For more details please see <see cref="T:System.Fabric.Description.ServicePackageActivationMode" />.
</para>
</value>
<remarks>To be added.</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.Description.DeployedServicePackageHealthQueryDescription.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="deployedServicePackageHealthQueryDescription.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 health query description.
</summary>
<returns>A string representation of the health query description.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>