SpatialPath.xml

<Type Name="SpatialPath" FullName="Azure.Cosmos.Spatial.SpatialPath">
  <TypeSignature Language="C#" Value="public sealed class SpatialPath" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit SpatialPath extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Azure.Cosmos.Spatial.SpatialPath" />
  <TypeSignature Language="VB.NET" Value="Public NotInheritable Class SpatialPath" />
  <TypeSignature Language="F#" Value="type SpatialPath = class" />
  <AssemblyInfo>
    <AssemblyName>Azure.Cosmos</AssemblyName>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute>
      <AttributeName Language="C#">[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Cosmos.TextJsonSpatialPathConverter))]</AttributeName>
      <AttributeName Language="F#">[&lt;System.Text.Json.Serialization.JsonConverter(typeof(Azure.Cosmos.TextJsonSpatialPathConverter))&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>
            Spatial index specification
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public SpatialPath ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Cosmos.Spatial.SpatialPath.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Cosmos</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Path">
      <MemberSignature Language="C#" Value="public string Path { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Path" />
      <MemberSignature Language="DocId" Value="P:Azure.Cosmos.Spatial.SpatialPath.Path" />
      <MemberSignature Language="VB.NET" Value="Public Property Path As String" />
      <MemberSignature Language="F#" Value="member this.Path : string with get, set" Usage="Azure.Cosmos.Spatial.SpatialPath.Path" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Cosmos</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Path in JSON document to index
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="SpatialTypes">
      <MemberSignature Language="C#" Value="public System.Collections.ObjectModel.Collection&lt;Azure.Cosmos.Spatial.SpatialType&gt; SpatialTypes { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.ObjectModel.Collection`1&lt;valuetype Azure.Cosmos.Spatial.SpatialType&gt; SpatialTypes" />
      <MemberSignature Language="DocId" Value="P:Azure.Cosmos.Spatial.SpatialPath.SpatialTypes" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property SpatialTypes As Collection(Of SpatialType)" />
      <MemberSignature Language="F#" Value="member this.SpatialTypes : System.Collections.ObjectModel.Collection&lt;Azure.Cosmos.Spatial.SpatialType&gt;" Usage="Azure.Cosmos.Spatial.SpatialPath.SpatialTypes" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Cosmos</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.ObjectModel.Collection&lt;Azure.Cosmos.Spatial.SpatialType&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Path's spatial type
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>