/
ResolvedServicePartition.xml
185 lines (185 loc) · 10 KB
/
ResolvedServicePartition.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
<Type Name="ResolvedServicePartition" FullName="System.Fabric.ResolvedServicePartition">
<TypeSignature Language="C#" Value="public sealed class ResolvedServicePartition" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit ResolvedServicePartition extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.Fabric.ResolvedServicePartition" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class ResolvedServicePartition" />
<TypeSignature Language="F#" Value="type ResolvedServicePartition = 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>
Contains information about the partition of the service that was resolved
and the set of endpoints that can be used to access the partition.</para>
</summary>
<remarks>
<para>
The resolved service partition is obtained as a result of calling
<see cref="M:System.Fabric.FabricClient.ServiceManagementClient.ResolveServicePartitionAsync(System.Uri)" /> and the other overloads.
</para>
</remarks>
</Docs>
<Members>
<Member MemberName="CompareVersion">
<MemberSignature Language="C#" Value="public int CompareVersion (System.Fabric.ResolvedServicePartition other);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance int32 CompareVersion(class System.Fabric.ResolvedServicePartition other) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.ResolvedServicePartition.CompareVersion(System.Fabric.ResolvedServicePartition)" />
<MemberSignature Language="VB.NET" Value="Public Function CompareVersion (other As ResolvedServicePartition) As Integer" />
<MemberSignature Language="F#" Value="member this.CompareVersion : System.Fabric.ResolvedServicePartition -> int" Usage="resolvedServicePartition.CompareVersion other" />
<MemberType>Method</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>
<Parameters>
<Parameter Name="other" Type="System.Fabric.ResolvedServicePartition" />
</Parameters>
<Docs>
<param name="other">
<para>The other resolved service partition to compare.</para>
</param>
<summary>
<para>Compares two resolved service partitions and identifies which is newer. </para>
</summary>
<returns>
<para>Returns <see cref="T:System.Int32" />.</para>
</returns>
<remarks>
<para>The <see cref="M:System.Fabric.ResolvedServicePartition.CompareVersion(System.Fabric.ResolvedServicePartition)" /> method takes in a
resolved service partition (RSP) argument with the parameter <paramref name="other" /> to enable the user to identify which RSP is more
up-to-date. A returned value of 0 indicates that the two RSPs have the same version. 1 indicates that the other RSP has an older version.
-1 indicates that the other RSP has a newer version. </para>
</remarks>
<exception cref="T:System.Fabric.FabricException">
<para>The two <see cref="T:System.Fabric.ResolvedServicePartition" /> objects are from different service partitions. This can happen if the
service is deleted and re-created with the same name and partitioning between two resolve calls.</para>
</exception>
</Docs>
</Member>
<Member MemberName="Endpoints">
<MemberSignature Language="C#" Value="public System.Collections.Generic.ICollection<System.Fabric.ResolvedServiceEndpoint> Endpoints { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.ICollection`1<class System.Fabric.ResolvedServiceEndpoint> Endpoints" />
<MemberSignature Language="DocId" Value="P:System.Fabric.ResolvedServicePartition.Endpoints" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Endpoints As ICollection(Of ResolvedServiceEndpoint)" />
<MemberSignature Language="F#" Value="member this.Endpoints : System.Collections.Generic.ICollection<System.Fabric.ResolvedServiceEndpoint>" Usage="System.Fabric.ResolvedServicePartition.Endpoints" />
<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.ICollection<System.Fabric.ResolvedServiceEndpoint></ReturnType>
</ReturnValue>
<Docs>
<summary>
<para>Gets the endpoints of the service partition.</para>
</summary>
<value>
<para>A collection of <see cref="T:System.Fabric.ResolvedServiceEndpoint" />
for the specified service partition.</para>
</value>
<remarks>
<para>A resolved service endpoint contains the role of the
stateful service replica or stateless service instance
and the address where this replica can be reached.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="GetEndpoint">
<MemberSignature Language="C#" Value="public System.Fabric.ResolvedServiceEndpoint GetEndpoint ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Fabric.ResolvedServiceEndpoint GetEndpoint() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.ResolvedServicePartition.GetEndpoint" />
<MemberSignature Language="VB.NET" Value="Public Function GetEndpoint () As ResolvedServiceEndpoint" />
<MemberSignature Language="F#" Value="member this.GetEndpoint : unit -> System.Fabric.ResolvedServiceEndpoint" Usage="resolvedServicePartition.GetEndpoint " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Fabric.ResolvedServiceEndpoint</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para>Returns a single endpoint, instead of a collection of all endpoints. </para>
</summary>
<returns>
<para>Returns <see cref="T:System.Fabric.ResolvedServiceEndpoint" />.</para>
</returns>
<remarks>
<para>Many times, you only need a single endpoint instead of all the endpoints. If the service is stateless, it returns a random endpoint.
If the service is a stateful service, than it returns the endpoint to which the Primary replica of the service partition listens. Note that if
the Primary replica currently does not exist, it throws <see cref="T:System.Fabric.FabricException" />.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Info">
<MemberSignature Language="C#" Value="public System.Fabric.ServicePartitionInformation Info { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Fabric.ServicePartitionInformation Info" />
<MemberSignature Language="DocId" Value="P:System.Fabric.ResolvedServicePartition.Info" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Info As ServicePartitionInformation" />
<MemberSignature Language="F#" Value="member this.Info : System.Fabric.ServicePartitionInformation" Usage="System.Fabric.ResolvedServicePartition.Info" />
<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.ServicePartitionInformation</ReturnType>
</ReturnValue>
<Docs>
<summary>
<para>Gets information about the partition of the service that was resolved.</para>
</summary>
<value>The information about the partition of the service that was resolved.</value>
<remarks>
<para>
The service partition can be of different <see cref="T:System.Fabric.ServicePartitionKind" />.
You can cast the service partition information to the correct derived type
to get detailed information about the partition.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="ServiceName">
<MemberSignature Language="C#" Value="public Uri ServiceName { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Uri ServiceName" />
<MemberSignature Language="DocId" Value="P:System.Fabric.ResolvedServicePartition.ServiceName" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ServiceName As Uri" />
<MemberSignature Language="F#" Value="member this.ServiceName : Uri" Usage="System.Fabric.ResolvedServicePartition.ServiceName" />
<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 service instance.</para>
</summary>
<value>
<para>The name of the service instance.</para>
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>