-
Notifications
You must be signed in to change notification settings - Fork 257
/
StatelessServiceDescription.xml
237 lines (237 loc) · 15.7 KB
/
StatelessServiceDescription.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
<Type Name="StatelessServiceDescription" FullName="System.Fabric.Description.StatelessServiceDescription">
<TypeSignature Language="C#" Value="public sealed class StatelessServiceDescription : System.Fabric.Description.ServiceDescription" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit StatelessServiceDescription extends System.Fabric.Description.ServiceDescription" />
<TypeSignature Language="DocId" Value="T:System.Fabric.Description.StatelessServiceDescription" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class StatelessServiceDescription
Inherits ServiceDescription" />
<TypeSignature Language="F#" Value="type StatelessServiceDescription = class
 inherit ServiceDescription" />
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Fabric.Description.ServiceDescription</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
<para>Extends <see cref="T:System.Fabric.Description.ServiceDescription" /> to provide additional necessary information to create a stateless service. </para>
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public StatelessServiceDescription ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.Description.StatelessServiceDescription.#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 an instance of the <see cref="T:System.Fabric.Description.StatelessServiceDescription" /> class.</para>
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="InstanceCloseDelayDuration">
<MemberSignature Language="C#" Value="public TimeSpan? InstanceCloseDelayDuration { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.TimeSpan> InstanceCloseDelayDuration" />
<MemberSignature Language="DocId" Value="P:System.Fabric.Description.StatelessServiceDescription.InstanceCloseDelayDuration" />
<MemberSignature Language="VB.NET" Value="Public Property InstanceCloseDelayDuration As Nullable(Of TimeSpan)" />
<MemberSignature Language="F#" Value="member this.InstanceCloseDelayDuration : Nullable<TimeSpan> with get, set" Usage="System.Fabric.Description.StatelessServiceDescription.InstanceCloseDelayDuration" />
<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.TimeSpan></ReturnType>
</ReturnValue>
<Docs>
<summary>
<para>Gets or sets the duration for which the close of a replica is delayed.</para>
</summary>
<value>
<para>The duration for which the close of a replica is delayed.</para>
</value>
<remarks>
<para>The <see cref="P:System.Fabric.Description.StatelessServiceDescription.InstanceCloseDelayDuration" /> property indicates the duration for which the
graceful close of a stateless instance is delayed. This would be effective when the instance is closing during the application/cluster upgrade and disabling node.
The endpoint exposed on this instance is removed prior to starting the delay, which prevents new connections to this instance. In addition,
clients that have subscribed to <see href="https://docs.microsoft.com/en-us/dotnet/api/system.fabric.fabricclient.servicemanagementclient.registerservicenotificationfilterasync">
service endpoint change events</see> can do the following upon receiving the endpoint removal notification:
- Stop sending new requests to this instance
- Close existing connections after in-flight requests have completed
- Connect to a different instance of the service partition for future requests.
Note, the default value of <see cref="P:System.Fabric.Description.StatelessServiceDescription.InstanceCloseDelayDuration" /> is TimeSpan.Zero, which indicates
that there won't be any delay or removal of the endpoint prior to closing the instance.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="InstanceCount">
<MemberSignature Language="C#" Value="public int InstanceCount { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 InstanceCount" />
<MemberSignature Language="DocId" Value="P:System.Fabric.Description.StatelessServiceDescription.InstanceCount" />
<MemberSignature Language="VB.NET" Value="Public Property InstanceCount As Integer" />
<MemberSignature Language="F#" Value="member this.InstanceCount : int with get, set" Usage="System.Fabric.Description.StatelessServiceDescription.InstanceCount" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
<para>Gets or sets the instance count of this service partition. </para>
</summary>
<value>
<para>The instance count of this service partition. </para>
</value>
<remarks>
<para>The <see cref="P:System.Fabric.Description.StatelessServiceDescription.InstanceCount" /> property indicates the number of instances to be
created for this service. The specified number of instances will be maintained by Service Fabric. For a partitioned stateless service,
<see cref="P:System.Fabric.Description.StatelessServiceDescription.InstanceCount" /> indicates the number of instances to be kept per partition.</para>
Note, -1 is a special value for <see cref="P:System.Fabric.Description.StatelessServiceDescription.InstanceCount" />. If <see cref="P:System.Fabric.Description.StatelessServiceDescription.InstanceCount" />
is set to -1, the number of instances to be kept per partition is equal to the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service.
</remarks>
</Docs>
</Member>
<Member MemberName="InstanceLifecycleDescription">
<MemberSignature Language="C#" Value="public System.Fabric.Description.InstanceLifecycleDescription InstanceLifecycleDescription { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Fabric.Description.InstanceLifecycleDescription InstanceLifecycleDescription" />
<MemberSignature Language="DocId" Value="P:System.Fabric.Description.StatelessServiceDescription.InstanceLifecycleDescription" />
<MemberSignature Language="VB.NET" Value="Public Property InstanceLifecycleDescription As InstanceLifecycleDescription" />
<MemberSignature Language="F#" Value="member this.InstanceLifecycleDescription : System.Fabric.Description.InstanceLifecycleDescription with get, set" Usage="System.Fabric.Description.StatelessServiceDescription.InstanceLifecycleDescription" />
<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.Description.InstanceLifecycleDescription</ReturnType>
</ReturnValue>
<Docs>
<summary>
<para>Defines how instance will behave during its lifecycle.</para>
</summary>
<value>
<para>Defines how instance will behave during its lifecycle.</para>
</value>
<remarks>
<para>InstanceLifecycleDescription is the section which allows user to granually controle how instances will behave during their lifecycle.
If some configuration in this section is not specified, the default value is taken from the cluster parameter of the same name (if existing).</para>
</remarks>
</Docs>
</Member>
<Member MemberName="InstanceRestartWaitDuration">
<MemberSignature Language="C#" Value="public TimeSpan? InstanceRestartWaitDuration { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.TimeSpan> InstanceRestartWaitDuration" />
<MemberSignature Language="DocId" Value="P:System.Fabric.Description.StatelessServiceDescription.InstanceRestartWaitDuration" />
<MemberSignature Language="VB.NET" Value="Public Property InstanceRestartWaitDuration As Nullable(Of TimeSpan)" />
<MemberSignature Language="F#" Value="member this.InstanceRestartWaitDuration : Nullable<TimeSpan> with get, set" Usage="System.Fabric.Description.StatelessServiceDescription.InstanceRestartWaitDuration" />
<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.TimeSpan></ReturnType>
</ReturnValue>
<Docs>
<summary>
<para>Gets or sets the duration between when an instance goes down and when a new replacement instance is created.</para>
</summary>
<value>
<para>The duration as a <see cref="T:System.TimeSpan" /> object.</para>
</value>
<remarks>
<para>When a stateless instance goes down, this timer starts. When it expires Service Fabric will create a new instance on any node in the
cluster. This configuration is to reduce unnecessary creation of a new instance in situations where the instance going down is likely to recover in a short time. For example, during an upgrade.</para>
<para>The default value is TimeSpan.Zero, which indicates that when stateless instance goes down, Service Fabric will immediately start building its replacement.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="MinInstanceCount">
<MemberSignature Language="C#" Value="public int MinInstanceCount { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MinInstanceCount" />
<MemberSignature Language="DocId" Value="P:System.Fabric.Description.StatelessServiceDescription.MinInstanceCount" />
<MemberSignature Language="VB.NET" Value="Public Property MinInstanceCount As Integer" />
<MemberSignature Language="F#" Value="member this.MinInstanceCount : int with get, set" Usage="System.Fabric.Description.StatelessServiceDescription.MinInstanceCount" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
<para>Gets or sets the minimum instance count. </para>
</summary>
<value>
<para>The minimum instance count. Defaults to 1 if not provided.</para>
</value>
<remarks>
<para>The <see cref="P:System.Fabric.Description.StatelessServiceDescription.MinInstanceCount" /> property indicates the minimum number of
instances that must be up to meet the <see href="https://docs.microsoft.com/en-us/rest/api/servicefabric/sfclient-model-ensureavailabilitysafetycheck">EnsureAvailability safety check</see> during operations like upgrade or deactivate node.
The actual number that is used is max(
<see cref="P:System.Fabric.Description.StatelessServiceDescription.MinInstanceCount" />,
ceil( <see cref="P:System.Fabric.Description.StatelessServiceDescription.MinInstancePercentage" />/100.0 * <see cref="P:System.Fabric.Description.StatelessServiceDescription.InstanceCount" />)
). </para>
Note, if <see cref="P:System.Fabric.Description.StatelessServiceDescription.InstanceCount" /> is set to -1, during MinInstanceCount computation -1 is first converted
into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service.
</remarks>
</Docs>
</Member>
<Member MemberName="MinInstancePercentage">
<MemberSignature Language="C#" Value="public int MinInstancePercentage { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MinInstancePercentage" />
<MemberSignature Language="DocId" Value="P:System.Fabric.Description.StatelessServiceDescription.MinInstancePercentage" />
<MemberSignature Language="VB.NET" Value="Public Property MinInstancePercentage As Integer" />
<MemberSignature Language="F#" Value="member this.MinInstancePercentage : int with get, set" Usage="System.Fabric.Description.StatelessServiceDescription.MinInstancePercentage" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
<para>Gets or sets the minimum instance percentage. </para>
</summary>
<value>
<para>The minimum instance percentage. Defaults to 0 if not provided. Note that the MinInstanceCount parameter must always be greater than 0, so
defaulting to 0 guarantees MinInstancePercentage has no effect because MinInstanceCount will have precedence. </para>
</value>
<remarks>
<para>The <see cref="P:System.Fabric.Description.StatelessServiceDescription.MinInstancePercentage" /> property is the minimum percentage of
<see cref="P:System.Fabric.Description.StatelessServiceDescription.InstanceCount" /> that must be up to meet the
<see href="https://docs.microsoft.com/en-us/rest/api/servicefabric/sfclient-model-ensureavailabilitysafetycheck">EnsureAvailability safety check</see> during operations like upgrade or deactivate node.
The actual number that is used is max(
<see cref="P:System.Fabric.Description.StatelessServiceDescription.MinInstanceCount" />,
ceil( <see cref="P:System.Fabric.Description.StatelessServiceDescription.MinInstancePercentage" />/100.0 * <see cref="P:System.Fabric.Description.StatelessServiceDescription.InstanceCount" />)
). </para>
Note, if <see cref="P:System.Fabric.Description.StatelessServiceDescription.InstanceCount" /> is set to -1, during MinInstancePercentage computation, -1 is first converted
into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service.
</remarks>
</Docs>
</Member>
</Members>
</Type>