-
Notifications
You must be signed in to change notification settings - Fork 261
/
SpatialIndex.xml
144 lines (144 loc) · 7.42 KB
/
SpatialIndex.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
<Type Name="SpatialIndex" FullName="Microsoft.Azure.Documents.SpatialIndex">
<TypeSignature Language="C#" Value="public sealed class SpatialIndex : Microsoft.Azure.Documents.Index" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit SpatialIndex extends Microsoft.Azure.Documents.Index" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Documents.SpatialIndex" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class SpatialIndex
Inherits Index" />
<TypeSignature Language="F#" Value="type SpatialIndex = class
 inherit Index" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>2.14.0.0</AssemblyVersion>
<AssemblyVersion>2.14.1.0</AssemblyVersion>
<AssemblyVersion>2.15.0.0</AssemblyVersion>
<AssemblyVersion>2.16.0.0</AssemblyVersion>
<AssemblyVersion>2.16.1.0</AssemblyVersion>
<AssemblyVersion>2.16.2.0</AssemblyVersion>
<AssemblyVersion>2.17.0.0</AssemblyVersion>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>2.14.0.0</AssemblyVersion>
<AssemblyVersion>2.14.1.0</AssemblyVersion>
<AssemblyVersion>2.15.0.0</AssemblyVersion>
<AssemblyVersion>2.16.0.0</AssemblyVersion>
<AssemblyVersion>2.16.1.0</AssemblyVersion>
<AssemblyVersion>2.16.2.0</AssemblyVersion>
<AssemblyVersion>2.17.0.0</AssemblyVersion>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Azure.Documents.Index</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.ICloneable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
Specifies an instance of the <see cref="T:Microsoft.Azure.Documents.SpatialIndex" /> class in the Azure Cosmos DB service.
</summary>
<remarks>
Can be used to serve spatial queries.
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SpatialIndex (Microsoft.Azure.Documents.DataType dataType);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Microsoft.Azure.Documents.DataType dataType) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.SpatialIndex.#ctor(Microsoft.Azure.Documents.DataType)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (dataType As DataType)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Documents.SpatialIndex : Microsoft.Azure.Documents.DataType -> Microsoft.Azure.Documents.SpatialIndex" Usage="new Microsoft.Azure.Documents.SpatialIndex dataType" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="dataType" Type="Microsoft.Azure.Documents.DataType" />
</Parameters>
<Docs>
<param name="dataType">Specifies the target data type for the index path specification</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Azure.Documents.SpatialIndex" /> class for the Azure Cosmos DB service.
</summary>
<remarks>To be added.</remarks>
<altmember cref="P:Microsoft.Azure.Documents.SpatialIndex.DataType" />
<example>
Here is an example to instantiate SpatialIndex class passing in the DataType
<code language="c#"><![CDATA[
SpatialIndex spatialIndex = new SpatialIndex(DataType.Point);
]]></code></example>
</Docs>
</Member>
<Member MemberName="Clone">
<MemberSignature Language="C#" Value="public object Clone ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance object Clone() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.SpatialIndex.Clone" />
<MemberSignature Language="VB.NET" Value="Public Function Clone () As Object" />
<MemberSignature Language="F#" Value="abstract member Clone : unit -> obj
override this.Clone : unit -> obj" Usage="spatialIndex.Clone " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Creates a copy of the spatial index for the Azure Cosmos DB service.
</summary>
<returns>A clone of the spatial index.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DataType">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Documents.DataType DataType { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.Documents.DataType DataType" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.SpatialIndex.DataType" />
<MemberSignature Language="VB.NET" Value="Public Property DataType As DataType" />
<MemberSignature Language="F#" Value="member this.DataType : Microsoft.Azure.Documents.DataType with get, set" Usage="Microsoft.Azure.Documents.SpatialIndex.DataType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonConverter(typeof(Newtonsoft.Json.Converters.StringEnumConverter))]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonConverter(typeof(Newtonsoft.Json.Converters.StringEnumConverter))>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="dataType")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="dataType")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Documents.DataType</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the data type for which this index should be applied in the Azure Cosmos DB service.
</summary>
<value>
The data type for which this index should be applied.
</value>
<remarks>Refer to http://azure.microsoft.com/documentation/articles/documentdb-indexing-policies/#ConfigPolicy for valid ranges of values.</remarks>
</Docs>
</Member>
</Members>
</Type>