-
Notifications
You must be signed in to change notification settings - Fork 255
/
DedicatedGatewayRequestOptions.xml
109 lines (107 loc) · 5.85 KB
/
DedicatedGatewayRequestOptions.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
<Type Name="DedicatedGatewayRequestOptions" FullName="Microsoft.Azure.Cosmos.DedicatedGatewayRequestOptions">
<TypeSignature Language="C#" Value="public class DedicatedGatewayRequestOptions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit DedicatedGatewayRequestOptions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Cosmos.DedicatedGatewayRequestOptions" />
<TypeSignature Language="VB.NET" Value="Public Class DedicatedGatewayRequestOptions" />
<TypeSignature Language="F#" Value="type DedicatedGatewayRequestOptions = class" />
<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>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
The Dedicated Gateway request options
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DedicatedGatewayRequestOptions ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.DedicatedGatewayRequestOptions.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="BypassIntegratedCache">
<MemberSignature Language="C#" Value="public bool? BypassIntegratedCache { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> BypassIntegratedCache" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.DedicatedGatewayRequestOptions.BypassIntegratedCache" />
<MemberSignature Language="VB.NET" Value="Public Property BypassIntegratedCache As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.BypassIntegratedCache : Nullable<bool> with get, set" Usage="Microsoft.Azure.Cosmos.DedicatedGatewayRequestOptions.BypassIntegratedCache" />
<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 or sets if bypass the integrated cache or not associated with the request in the Azure Cosmos DB service.
When set this value to true, the request will not be served from the integrated cache, and the response will not be cached either.
</summary>
<value>Default value is false.</value>
<remarks>To be added.</remarks>
<example>
<code language="c#"><![CDATA[
DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions = new DedicatedGatewayRequestOptions
{
BypassIntegratedCache = true
};
// For ItemRequestOptions
ItemRequestOptions requestOptions = new ItemRequestOptions
{
DedicatedGatewayRequestOptions = dedicatedGatewayRequestOptions
};
// For QueryRequestOptions
QueryRequestOptions requestOptions = new QueryRequestOptions
{
DedicatedGatewayRequestOptions = dedicatedGatewayRequestOptions
};
]]></code>
</example>
</Docs>
</Member>
<Member MemberName="MaxIntegratedCacheStaleness">
<MemberSignature Language="C#" Value="public TimeSpan? MaxIntegratedCacheStaleness { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.TimeSpan> MaxIntegratedCacheStaleness" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.DedicatedGatewayRequestOptions.MaxIntegratedCacheStaleness" />
<MemberSignature Language="VB.NET" Value="Public Property MaxIntegratedCacheStaleness As Nullable(Of TimeSpan)" />
<MemberSignature Language="F#" Value="member this.MaxIntegratedCacheStaleness : Nullable<TimeSpan> with get, set" Usage="Microsoft.Azure.Cosmos.DedicatedGatewayRequestOptions.MaxIntegratedCacheStaleness" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.TimeSpan></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the staleness value associated with the request in the Azure Cosmos DB service.
</summary>
<value>Default value is null.</value>
<remarks>
For requests where the <see cref="T:Microsoft.Azure.Cosmos.ConsistencyLevel" /> is <see cref="F:Microsoft.Azure.Cosmos.ConsistencyLevel.Eventual" /> or <see cref="F:Microsoft.Azure.Cosmos.ConsistencyLevel.Session" />, responses from the integrated cache are guaranteed to be no staler than value indicated by this MaxIntegratedCacheStaleness.
Cache Staleness is supported in milliseconds granularity. Anything smaller than milliseconds will be ignored.
</remarks>
</Docs>
</Member>
</Members>
</Type>