/azure-docs-sdk-dotnet

Permalink
Switch branches/tags
Nothing to show
Find file
azure-docs-sdk-dotnet/xml/Microsoft.Azure.Documents/HashIndex.xml
Fetching contributors…
Cannot retrieve contributors at this time
Raw Blame History
275 lines (275 sloc) 13.6 KB
<Type Name="HashIndex" FullName="Microsoft.Azure.Documents.HashIndex">
<TypeSignature Language="C#" Value="public sealed class HashIndex : Microsoft.Azure.Documents.Index, ICloneable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit HashIndex extends Microsoft.Azure.Documents.Index implements class System.ICloneable" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Documents.HashIndex" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Azure.Documents.Index</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.ICloneable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
Represents details of the hash index setting in an Azure DocumentDB database service.
</summary>
<remarks>
Can be used to serve queries like: SELECT * FROM docs d WHERE d.prop = 5.
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HashIndex (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.HashIndex.#ctor(Microsoft.Azure.Documents.DataType)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.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.HashIndex" /> class with specified DataType for the Azure DocumentDB database service.
</summary>
<remarks>To be added.</remarks>
<altmember cref="P:Microsoft.Azure.Documents.HashIndex.DataType" />
<example>
Here is an example to instantiate HashIndex class passing in the DataType:
<code language="c#"><![CDATA[
HashIndex hashIndex = new HashIndex(DataType.String);
]]></code></example>
<example>
Here is an example to instantiate HashIndex class passing in the DataType:
<code language="c#"><![CDATA[
HashIndex hashIndex = new HashIndex(DataType.String);
]]></code></example>
<example>
Here is an example to instantiate HashIndex class passing in the DataType:
<code language="c#"><![CDATA[
HashIndex hashIndex = new HashIndex(DataType.String);
]]></code></example>
<example>
Here is an example to instantiate HashIndex class passing in the DataType:
<code language="c#"><![CDATA[
HashIndex hashIndex = new HashIndex(DataType.String);
]]></code></example>
<example>
Here is an example to instantiate HashIndex class passing in the DataType:
<code language="c#"><![CDATA[
HashIndex hashIndex = new HashIndex(DataType.String);
]]></code></example>
<example>
Here is an example to instantiate HashIndex class passing in the DataType:
<code language="c#"><![CDATA[
HashIndex hashIndex = new HashIndex(DataType.String);
]]></code></example>
<example>
Here is an example to instantiate HashIndex class passing in the DataType:
<code language="c#"><![CDATA[
HashIndex hashIndex = new HashIndex(DataType.String);
]]></code></example>
<example>
Here is an example to instantiate HashIndex class passing in the DataType:
<code language="c#"><![CDATA[
HashIndex hashIndex = new HashIndex(DataType.String);
]]></code></example>
<example>
Here is an example to instantiate HashIndex class passing in the DataType:
<code language="c#"><![CDATA[
HashIndex hashIndex = new HashIndex(DataType.String);
]]></code></example>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HashIndex (Microsoft.Azure.Documents.DataType dataType, short precision);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Microsoft.Azure.Documents.DataType dataType, int16 precision) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.HashIndex.#ctor(Microsoft.Azure.Documents.DataType,System.Int16)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="dataType" Type="Microsoft.Azure.Documents.DataType" />
<Parameter Name="precision" Type="System.Int16" />
</Parameters>
<Docs>
<param name="dataType">Specifies the target data type for the index path specification.</param>
<param name="precision">Specifies the precision to be used for the data type associated with this index.</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Azure.Documents.HashIndex" /> class with specified DataType and precision for the Azure DocumentDB database service.
</summary>
<remarks>To be added.</remarks>
<altmember cref="P:Microsoft.Azure.Documents.HashIndex.DataType" />
<example>
Here is an example to instantiate HashIndex class passing in the DataType and precision:
<code language="c#"><![CDATA[
HashIndex hashIndex = new HashIndex(DataType.String, 3);
]]></code></example>
<example>
Here is an example to instantiate HashIndex class passing in the DataType and precision:
<code language="c#"><![CDATA[
HashIndex hashIndex = new HashIndex(DataType.String, 3);
]]></code></example>
<example>
Here is an example to instantiate HashIndex class passing in the DataType and precision:
<code language="c#"><![CDATA[
HashIndex hashIndex = new HashIndex(DataType.String, 3);
]]></code></example>
<example>
Here is an example to instantiate HashIndex class passing in the DataType and precision:
<code language="c#"><![CDATA[
HashIndex hashIndex = new HashIndex(DataType.String, 3);
]]></code></example>
<example>
Here is an example to instantiate HashIndex class passing in the DataType and precision:
<code language="c#"><![CDATA[
HashIndex hashIndex = new HashIndex(DataType.String, 3);
]]></code></example>
<example>
Here is an example to instantiate HashIndex class passing in the DataType and precision:
<code language="c#"><![CDATA[
HashIndex hashIndex = new HashIndex(DataType.String, 3);
]]></code></example>
<example>
Here is an example to instantiate HashIndex class passing in the DataType and precision:
<code language="c#"><![CDATA[
HashIndex hashIndex = new HashIndex(DataType.String, 3);
]]></code></example>
<example>
Here is an example to instantiate HashIndex class passing in the DataType and precision:
<code language="c#"><![CDATA[
HashIndex hashIndex = new HashIndex(DataType.String, 3);
]]></code></example>
<example>
Here is an example to instantiate HashIndex class passing in the DataType and precision:
<code language="c#"><![CDATA[
HashIndex hashIndex = new HashIndex(DataType.String, 3);
]]></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.HashIndex.Clone" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Creates a copy of the hash index for the Azure DocumentDB database service.
</summary>
<returns>A clone of the hash 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.HashIndex.DataType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Newtonsoft.Json.JsonConverter(typeof(Newtonsoft.Json.Converters.StringEnumConverter))</AttributeName>
</Attribute>
<Attribute>
<AttributeName>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 DocumentDB database service.
</summary>
<value>
The data type for which this index should be applied.
</value>
<remarks>Refer to <a href="http://azure.microsoft.com/documentation/articles/documentdb-indexing-policies/#ConfigPolicy">Customizing the indexing policy of a collection</a> for valid ranges of values.</remarks>
</Docs>
</Member>
<Member MemberName="Precision">
<MemberSignature Language="C#" Value="public Nullable&lt;short&gt; Precision { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;int16&gt; Precision" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.HashIndex.Precision" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="precision")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable&lt;System.Int16&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the precision for this particular index in the Azure DocumentDB database service.
</summary>
<value>
The precision for this particular index. Returns null, if not set.
</value>
<remarks>Refer to <a href="http://azure.microsoft.com/documentation/articles/documentdb-indexing-policies/#ConfigPolicy">Customizing the indexing policy of a collection</a> for valid ranges of values.</remarks>
</Docs>
</Member>
</Members>
</Type>