Index.xml

<Type Name="Index" FullName="Microsoft.Azure.Documents.Index">
  <TypeSignature Language="C#" Value="public abstract class Index : Microsoft.Azure.Documents.JsonSerializable" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit Index extends Microsoft.Azure.Documents.JsonSerializable" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Azure.Documents.Index" />
  <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.JsonSerializable</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute>
      <AttributeName>Newtonsoft.Json.JsonConverter(typeof(Microsoft.Azure.Documents.IndexJsonConverter))</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>
            Base class for IndexingPolicy Indexes in the Azure DocumentDB database service, you should use a concrete Index like HashIndex or RangeIndex.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected Index (Microsoft.Azure.Documents.IndexKind kind);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(valuetype Microsoft.Azure.Documents.IndexKind kind) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Index.#ctor(Microsoft.Azure.Documents.IndexKind)" />
      <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="kind" Type="Microsoft.Azure.Documents.IndexKind" />
      </Parameters>
      <Docs>
        <param name="kind">To be added.</param>
        <summary>
            Initializes a new instance of the <see cref="T:Microsoft.Azure.Documents.Index" /> class for the Azure DocumentDB database service.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Hash">
      <MemberSignature Language="C#" Value="public static Microsoft.Azure.Documents.HashIndex Hash (Microsoft.Azure.Documents.DataType dataType);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Documents.HashIndex Hash(valuetype Microsoft.Azure.Documents.DataType dataType) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Index.Hash(Microsoft.Azure.Documents.DataType)" />
      <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>Microsoft.Azure.Documents.HashIndex</ReturnType>
      </ReturnValue>
      <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>
            Returns an instance of the <see cref="T:Microsoft.Azure.Documents.HashIndex" /> class with specified DataType for the Azure DocumentDB database service.
            </summary>
        <returns>An instance of <see cref="T:Microsoft.Azure.Documents.HashIndex" /> type.</returns>
        <remarks>To be added.</remarks>
        <altmember cref="T:Microsoft.Azure.Documents.DataType" />
        <example>
            Here is an example to create HashIndex instance passing in the DataType:
            <code language="c#"><![CDATA[
            HashIndex hashIndex = Index.Hash(DataType.String);
            ]]></code></example>
        <example>
            Here is an example to create HashIndex instance passing in the DataType:
            <code language="c#"><![CDATA[
            HashIndex hashIndex = Index.Hash(DataType.String);
            ]]></code></example>
        <example>
            Here is an example to create HashIndex instance passing in the DataType:
            <code language="c#"><![CDATA[
            HashIndex hashIndex = Index.Hash(DataType.String);
            ]]></code></example>
        <example>
            Here is an example to create HashIndex instance passing in the DataType:
            <code language="c#"><![CDATA[
            HashIndex hashIndex = Index.Hash(DataType.String);
            ]]></code></example>
        <example>
            Here is an example to create HashIndex instance passing in the DataType:
            <code language="c#"><![CDATA[
            HashIndex hashIndex = Index.Hash(DataType.String);
            ]]></code></example>
        <example>
            Here is an example to create HashIndex instance passing in the DataType:
            <code language="c#"><![CDATA[
            HashIndex hashIndex = Index.Hash(DataType.String);
            ]]></code></example>
        <example>
            Here is an example to create HashIndex instance passing in the DataType:
            <code language="c#"><![CDATA[
            HashIndex hashIndex = Index.Hash(DataType.String);
            ]]></code></example>
        <example>
            Here is an example to create HashIndex instance passing in the DataType:
            <code language="c#"><![CDATA[
            HashIndex hashIndex = Index.Hash(DataType.String);
            ]]></code></example>
        <example>
            Here is an example to create HashIndex instance passing in the DataType:
            <code language="c#"><![CDATA[
            HashIndex hashIndex = Index.Hash(DataType.String);
            ]]></code></example>
      </Docs>
    </Member>
    <Member MemberName="Hash">
      <MemberSignature Language="C#" Value="public static Microsoft.Azure.Documents.HashIndex Hash (Microsoft.Azure.Documents.DataType dataType, short precision);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Documents.HashIndex Hash(valuetype Microsoft.Azure.Documents.DataType dataType, int16 precision) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Index.Hash(Microsoft.Azure.Documents.DataType,System.Int16)" />
      <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>Microsoft.Azure.Documents.HashIndex</ReturnType>
      </ReturnValue>
      <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>
            Returns an instance of the <see cref="T:Microsoft.Azure.Documents.HashIndex" /> class with specified DataType and precision for the Azure DocumentDB database service.
            </summary>
        <returns>An instance of <see cref="T:Microsoft.Azure.Documents.HashIndex" /> type.</returns>
        <remarks>To be added.</remarks>
        <altmember cref="T:Microsoft.Azure.Documents.DataType" />
        <example>
            Here is an example to create HashIndex instance passing in the DataType and precision:
            <code language="c#"><![CDATA[
            HashIndex hashIndex = Index.Hash(DataType.String, 3);
            ]]></code></example>
        <example>
            Here is an example to create HashIndex instance passing in the DataType and precision:
            <code language="c#"><![CDATA[
            HashIndex hashIndex = Index.Hash(DataType.String, 3);
            ]]></code></example>
        <example>
            Here is an example to create HashIndex instance passing in the DataType and precision:
            <code language="c#"><![CDATA[
            HashIndex hashIndex = Index.Hash(DataType.String, 3);
            ]]></code></example>
        <example>
            Here is an example to create HashIndex instance passing in the DataType and precision:
            <code language="c#"><![CDATA[
            HashIndex hashIndex = Index.Hash(DataType.String, 3);
            ]]></code></example>
        <example>
            Here is an example to create HashIndex instance passing in the DataType and precision:
            <code language="c#"><![CDATA[
            HashIndex hashIndex = Index.Hash(DataType.String, 3);
            ]]></code></example>
        <example>
            Here is an example to create HashIndex instance passing in the DataType and precision:
            <code language="c#"><![CDATA[
            HashIndex hashIndex = Index.Hash(DataType.String, 3);
            ]]></code></example>
        <example>
            Here is an example to create HashIndex instance passing in the DataType and precision:
            <code language="c#"><![CDATA[
            HashIndex hashIndex = Index.Hash(DataType.String, 3);
            ]]></code></example>
        <example>
            Here is an example to create HashIndex instance passing in the DataType and precision:
            <code language="c#"><![CDATA[
            HashIndex hashIndex = Index.Hash(DataType.String, 3);
            ]]></code></example>
        <example>
            Here is an example to create HashIndex instance passing in the DataType and precision:
            <code language="c#"><![CDATA[
            HashIndex hashIndex = Index.Hash(DataType.String, 3);
            ]]></code></example>
      </Docs>
    </Member>
    <Member MemberName="Kind">
      <MemberSignature Language="C#" Value="public Microsoft.Azure.Documents.IndexKind Kind { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.Documents.IndexKind Kind" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Index.Kind" />
      <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="kind")</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Microsoft.Azure.Documents.IndexKind</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the kind of indexing to be applied in the Azure DocumentDB database service.
            </summary>
        <value>
            One of the values of the <see cref="T:Microsoft.Azure.Documents.IndexKind" /> enumeration.
            </value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Range">
      <MemberSignature Language="C#" Value="public static Microsoft.Azure.Documents.RangeIndex Range (Microsoft.Azure.Documents.DataType dataType);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Documents.RangeIndex Range(valuetype Microsoft.Azure.Documents.DataType dataType) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Index.Range(Microsoft.Azure.Documents.DataType)" />
      <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>Microsoft.Azure.Documents.RangeIndex</ReturnType>
      </ReturnValue>
      <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>
            Returns an instance of the <see cref="T:Microsoft.Azure.Documents.RangeIndex" /> class with specified DataType for the Azure DocumentDB database service.
            </summary>
        <returns>An instance of <see cref="T:Microsoft.Azure.Documents.RangeIndex" /> type.</returns>
        <remarks>To be added.</remarks>
        <altmember cref="T:Microsoft.Azure.Documents.DataType" />
        <example>
            Here is an example to create RangeIndex instance passing in the DataType:
            <code language="c#"><![CDATA[
            RangeIndex rangeIndex = Index.Range(DataType.Number);
            ]]></code></example>
        <example>
            Here is an example to create RangeIndex instance passing in the DataType:
            <code language="c#"><![CDATA[
            RangeIndex rangeIndex = Index.Range(DataType.Number);
            ]]></code></example>
        <example>
            Here is an example to create RangeIndex instance passing in the DataType:
            <code language="c#"><![CDATA[
            RangeIndex rangeIndex = Index.Range(DataType.Number);
            ]]></code></example>
        <example>
            Here is an example to create RangeIndex instance passing in the DataType:
            <code language="c#"><![CDATA[
            RangeIndex rangeIndex = Index.Range(DataType.Number);
            ]]></code></example>
        <example>
            Here is an example to create RangeIndex instance passing in the DataType:
            <code language="c#"><![CDATA[
            RangeIndex rangeIndex = Index.Range(DataType.Number);
            ]]></code></example>
        <example>
            Here is an example to create RangeIndex instance passing in the DataType:
            <code language="c#"><![CDATA[
            RangeIndex rangeIndex = Index.Range(DataType.Number);
            ]]></code></example>
        <example>
            Here is an example to create RangeIndex instance passing in the DataType:
            <code language="c#"><![CDATA[
            RangeIndex rangeIndex = Index.Range(DataType.Number);
            ]]></code></example>
        <example>
            Here is an example to create RangeIndex instance passing in the DataType:
            <code language="c#"><![CDATA[
            RangeIndex rangeIndex = Index.Range(DataType.Number);
            ]]></code></example>
        <example>
            Here is an example to create RangeIndex instance passing in the DataType:
            <code language="c#"><![CDATA[
            RangeIndex rangeIndex = Index.Range(DataType.Number);
            ]]></code></example>
      </Docs>
    </Member>
    <Member MemberName="Range">
      <MemberSignature Language="C#" Value="public static Microsoft.Azure.Documents.RangeIndex Range (Microsoft.Azure.Documents.DataType dataType, short precision);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Documents.RangeIndex Range(valuetype Microsoft.Azure.Documents.DataType dataType, int16 precision) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Index.Range(Microsoft.Azure.Documents.DataType,System.Int16)" />
      <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>Microsoft.Azure.Documents.RangeIndex</ReturnType>
      </ReturnValue>
      <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>
            Returns an instance of the <see cref="T:Microsoft.Azure.Documents.RangeIndex" /> class with specified DataType and precision for the Azure DocumentDB database service.
            </summary>
        <returns>An instance of <see cref="T:Microsoft.Azure.Documents.RangeIndex" /> type.</returns>
        <remarks>To be added.</remarks>
        <altmember cref="T:Microsoft.Azure.Documents.DataType" />
        <example>
            Here is an example to create RangeIndex instance passing in the DataType and precision:
            <code language="c#"><![CDATA[
            RangeIndex rangeIndex = Index.Range(DataType.Number, -1);
            ]]></code></example>
        <example>
            Here is an example to create RangeIndex instance passing in the DataType and precision:
            <code language="c#"><![CDATA[
            RangeIndex rangeIndex = Index.Range(DataType.Number, -1);
            ]]></code></example>
        <example>
            Here is an example to create RangeIndex instance passing in the DataType and precision:
            <code language="c#"><![CDATA[
            RangeIndex rangeIndex = Index.Range(DataType.Number, -1);
            ]]></code></example>
        <example>
            Here is an example to create RangeIndex instance passing in the DataType and precision:
            <code language="c#"><![CDATA[
            RangeIndex rangeIndex = Index.Range(DataType.Number, -1);
            ]]></code></example>
        <example>
            Here is an example to create RangeIndex instance passing in the DataType and precision:
            <code language="c#"><![CDATA[
            RangeIndex rangeIndex = Index.Range(DataType.Number, -1);
            ]]></code></example>
        <example>
            Here is an example to create RangeIndex instance passing in the DataType and precision:
            <code language="c#"><![CDATA[
            RangeIndex rangeIndex = Index.Range(DataType.Number, -1);
            ]]></code></example>
        <example>
            Here is an example to create RangeIndex instance passing in the DataType and precision:
            <code language="c#"><![CDATA[
            RangeIndex rangeIndex = Index.Range(DataType.Number, -1);
            ]]></code></example>
        <example>
            Here is an example to create RangeIndex instance passing in the DataType and precision:
            <code language="c#"><![CDATA[
            RangeIndex rangeIndex = Index.Range(DataType.Number, -1);
            ]]></code></example>
        <example>
            Here is an example to create RangeIndex instance passing in the DataType and precision:
            <code language="c#"><![CDATA[
            RangeIndex rangeIndex = Index.Range(DataType.Number, -1);
            ]]></code></example>
      </Docs>
    </Member>
    <Member MemberName="Spatial">
      <MemberSignature Language="C#" Value="public static Microsoft.Azure.Documents.SpatialIndex Spatial (Microsoft.Azure.Documents.DataType dataType);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Documents.SpatialIndex Spatial(valuetype Microsoft.Azure.Documents.DataType dataType) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Index.Spatial(Microsoft.Azure.Documents.DataType)" />
      <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>Microsoft.Azure.Documents.SpatialIndex</ReturnType>
      </ReturnValue>
      <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>
            Returns an instance of the <see cref="T:Microsoft.Azure.Documents.SpatialIndex" /> class with specified DataType for the Azure DocumentDB database service.
            </summary>
        <returns>An instance of <see cref="T:Microsoft.Azure.Documents.SpatialIndex" /> type.</returns>
        <remarks>To be added.</remarks>
        <altmember cref="T:Microsoft.Azure.Documents.DataType" />
        <example>
            Here is an example to create SpatialIndex instance passing in the DataType:
            <code language="c#"><![CDATA[
            SpatialIndex spatialIndex = Index.Spatial(DataType.Point);
            ]]></code></example>
        <example>
            Here is an example to create SpatialIndex instance passing in the DataType:
            <code language="c#"><![CDATA[
            SpatialIndex spatialIndex = Index.Spatial(DataType.Point);
            ]]></code></example>
        <example>
            Here is an example to create SpatialIndex instance passing in the DataType:
            <code language="c#"><![CDATA[
            SpatialIndex spatialIndex = Index.Spatial(DataType.Point);
            ]]></code></example>
        <example>
            Here is an example to create SpatialIndex instance passing in the DataType:
            <code language="c#"><![CDATA[
            SpatialIndex spatialIndex = Index.Spatial(DataType.Point);
            ]]></code></example>
        <example>
            Here is an example to create SpatialIndex instance passing in the DataType:
            <code language="c#"><![CDATA[
            SpatialIndex spatialIndex = Index.Spatial(DataType.Point);
            ]]></code></example>
        <example>
            Here is an example to create SpatialIndex instance passing in the DataType:
            <code language="c#"><![CDATA[
            SpatialIndex spatialIndex = Index.Spatial(DataType.Point);
            ]]></code></example>
        <example>
            Here is an example to create SpatialIndex instance passing in the DataType:
            <code language="c#"><![CDATA[
            SpatialIndex spatialIndex = Index.Spatial(DataType.Point);
            ]]></code></example>
        <example>
            Here is an example to create SpatialIndex instance passing in the DataType:
            <code language="c#"><![CDATA[
            SpatialIndex spatialIndex = Index.Spatial(DataType.Point);
            ]]></code></example>
        <example>
            Here is an example to create SpatialIndex instance passing in the DataType:
            <code language="c#"><![CDATA[
            SpatialIndex spatialIndex = Index.Spatial(DataType.Point);
            ]]></code></example>
      </Docs>
    </Member>
  </Members>
</Type>