-
Notifications
You must be signed in to change notification settings - Fork 260
/
ThroughputResponse.xml
262 lines (262 loc) · 14 KB
/
ThroughputResponse.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
<Type Name="ThroughputResponse" FullName="Microsoft.Azure.Cosmos.ThroughputResponse">
<TypeSignature Language="C#" Value="public class ThroughputResponse : Microsoft.Azure.Cosmos.Response<Microsoft.Azure.Cosmos.ThroughputProperties>" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ThroughputResponse extends Microsoft.Azure.Cosmos.Response`1<class Microsoft.Azure.Cosmos.ThroughputProperties>" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Cosmos.ThroughputResponse" />
<TypeSignature Language="VB.NET" Value="Public Class ThroughputResponse
Inherits Response(Of ThroughputProperties)" />
<TypeSignature Language="F#" Value="type ThroughputResponse = class
 inherit Response<ThroughputProperties>" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.36.0.0</AssemblyVersion>
<AssemblyVersion>3.38.1.0</AssemblyVersion>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Azure.Cosmos.Response<Microsoft.Azure.Cosmos.ThroughputProperties></BaseTypeName>
<BaseTypeArguments>
<BaseTypeArgument TypeParamName="T">Microsoft.Azure.Cosmos.ThroughputProperties</BaseTypeArgument>
</BaseTypeArguments>
</Base>
<Interfaces />
<Docs>
<summary>
The cosmos throughput response
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ThroughputResponse ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.ThroughputResponse.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Create a <see cref="T:Microsoft.Azure.Cosmos.ThroughputResponse" /> as a no-op for mock testing
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ActivityId">
<MemberSignature Language="C#" Value="public override string ActivityId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ActivityId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.ThroughputResponse.ActivityId" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property ActivityId As String" />
<MemberSignature Language="F#" Value="member this.ActivityId : string" Usage="Microsoft.Azure.Cosmos.ThroughputResponse.ActivityId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="Diagnostics">
<MemberSignature Language="C#" Value="public override Microsoft.Azure.Cosmos.CosmosDiagnostics Diagnostics { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Cosmos.CosmosDiagnostics Diagnostics" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.ThroughputResponse.Diagnostics" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property Diagnostics As CosmosDiagnostics" />
<MemberSignature Language="F#" Value="member this.Diagnostics : Microsoft.Azure.Cosmos.CosmosDiagnostics" Usage="Microsoft.Azure.Cosmos.ThroughputResponse.Diagnostics" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Cosmos.CosmosDiagnostics</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="ETag">
<MemberSignature Language="C#" Value="public override string ETag { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ETag" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.ThroughputResponse.ETag" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property ETag As String" />
<MemberSignature Language="F#" Value="member this.ETag : string" Usage="Microsoft.Azure.Cosmos.ThroughputResponse.ETag" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="Headers">
<MemberSignature Language="C#" Value="public override Microsoft.Azure.Cosmos.Headers Headers { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Cosmos.Headers Headers" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.ThroughputResponse.Headers" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property Headers As Headers" />
<MemberSignature Language="F#" Value="member this.Headers : Microsoft.Azure.Cosmos.Headers" Usage="Microsoft.Azure.Cosmos.ThroughputResponse.Headers" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Cosmos.Headers</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="IsReplacePending">
<MemberSignature Language="C#" Value="public bool? IsReplacePending { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> IsReplacePending" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.ThroughputResponse.IsReplacePending" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsReplacePending As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.IsReplacePending : Nullable<bool>" Usage="Microsoft.Azure.Cosmos.ThroughputResponse.IsReplacePending" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the status whether offer replace is successful or pending.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MinThroughput">
<MemberSignature Language="C#" Value="public int? MinThroughput { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> MinThroughput" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.ThroughputResponse.MinThroughput" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property MinThroughput As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.MinThroughput : Nullable<int>" Usage="Microsoft.Azure.Cosmos.ThroughputResponse.MinThroughput" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets minimum throughput in measurement of request units per second in the Azure Cosmos service.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="op_Implicit">
<MemberSignature Language="C#" Value="public static implicit operator Microsoft.Azure.Cosmos.ThroughputProperties (Microsoft.Azure.Cosmos.ThroughputResponse response);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname class Microsoft.Azure.Cosmos.ThroughputProperties op_Implicit(class Microsoft.Azure.Cosmos.ThroughputResponse response) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.ThroughputResponse.op_Implicit(Microsoft.Azure.Cosmos.ThroughputResponse)~Microsoft.Azure.Cosmos.ThroughputProperties" />
<MemberSignature Language="VB.NET" Value="Public Shared Widening Operator CType (response As ThroughputResponse) As ThroughputProperties" />
<MemberSignature Language="F#" Value="static member op_Implicit : Microsoft.Azure.Cosmos.ThroughputResponse -> Microsoft.Azure.Cosmos.ThroughputProperties" Usage="Microsoft.Azure.Cosmos.ThroughputResponse.op_Implicit response" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Cosmos.ThroughputProperties</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="response" Type="Microsoft.Azure.Cosmos.ThroughputResponse" />
</Parameters>
<Docs>
<param name="response">Throughput response</param>
<summary>
Get <see cref="T:Microsoft.Azure.Cosmos.ThroughputProperties" /> implicitly from <see cref="T:Microsoft.Azure.Cosmos.ThroughputResponse" /></summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RequestCharge">
<MemberSignature Language="C#" Value="public override double RequestCharge { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 RequestCharge" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.ThroughputResponse.RequestCharge" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property RequestCharge As Double" />
<MemberSignature Language="F#" Value="member this.RequestCharge : double" Usage="Microsoft.Azure.Cosmos.ThroughputResponse.RequestCharge" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="Resource">
<MemberSignature Language="C#" Value="public override Microsoft.Azure.Cosmos.ThroughputProperties Resource { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Cosmos.ThroughputProperties Resource" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.ThroughputResponse.Resource" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property Resource As ThroughputProperties" />
<MemberSignature Language="F#" Value="member this.Resource : Microsoft.Azure.Cosmos.ThroughputProperties" Usage="Microsoft.Azure.Cosmos.ThroughputResponse.Resource" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Cosmos.ThroughputProperties</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="StatusCode">
<MemberSignature Language="C#" Value="public override System.Net.HttpStatusCode StatusCode { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Net.HttpStatusCode StatusCode" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.ThroughputResponse.StatusCode" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property StatusCode As HttpStatusCode" />
<MemberSignature Language="F#" Value="member this.StatusCode : System.Net.HttpStatusCode" Usage="Microsoft.Azure.Cosmos.ThroughputResponse.StatusCode" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Net.HttpStatusCode</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
</Type>