/azure-docs-sdk-dotnet

Permalink
Switch branches/tags
Nothing to show
Find file
azure-docs-sdk-dotnet/xml/Microsoft.Azure.Documents/PartitionKey.xml
Fetching contributors…
Cannot retrieve contributors at this time
Raw Blame History
182 lines (182 sloc) 8.55 KB
<Type Name="PartitionKey" FullName="Microsoft.Azure.Documents.PartitionKey">
<TypeSignature Language="C#" Value="public sealed class PartitionKey" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit PartitionKey extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Documents.PartitionKey" />
<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>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Represents a partition key value that identifies the target partition of a collection in the Azure DocumentDB database service.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public PartitionKey (object keyValue);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(object keyValue) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.PartitionKey.#ctor(System.Object)" />
<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="keyValue" Type="System.Object" />
</Parameters>
<Docs>
<param name="keyValue">
The value of the document property that is specified as the partition key when a collection is created.
</param>
<summary>
Instantiate a new instance of the <see cref="T:Microsoft.Azure.Documents.PartitionKey" /> object.
</summary>
<remarks>
This class represents a partition key value that identifies the target partition of a collection in the Azure DocumentDB database service.
</remarks>
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public override bool Equals (object other);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object other) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.PartitionKey.Equals(System.Object)" />
<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.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="other" Type="System.Object" />
</Parameters>
<Docs>
<param name="other">The object to compare with.</param>
<summary>
Overrides the Equal operator for object comparisons between two instances of <see cref="T:Microsoft.Azure.Documents.PartitionKey" />.
</summary>
<returns>True if two object instance are considered equal.</returns>
<remarks>
This class represents a partition key value that identifies the target partition of a collection in the Azure DocumentDB database service.
</remarks>
</Docs>
</Member>
<Member MemberName="FromJsonString">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Documents.PartitionKey FromJsonString (string keyValue);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Documents.PartitionKey FromJsonString(string keyValue) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.PartitionKey.FromJsonString(System.String)" />
<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.PartitionKey</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="keyValue" Type="System.String" />
</Parameters>
<Docs>
<param name="keyValue">
The value of the document property that is specified as the partition key
when a collection is created, in serialized JSON form.
</param>
<summary>
Instantiate a new instance of the <see cref="T:Microsoft.Azure.Documents.PartitionKey" /> object.
</summary>
<returns>To be added.</returns>
<remarks>
This class represents a partition key value that identifies the target partition of a collection in the Azure DocumentDB database service.
</remarks>
</Docs>
</Member>
<Member MemberName="GetHashCode">
<MemberSignature Language="C#" Value="public override int GetHashCode ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.PartitionKey.GetHashCode" />
<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.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Hash function to return the hash code for the object.
</summary>
<returns>The hash code for this <see cref="T:Microsoft.Azure.Documents.PartitionKey" /> instance</returns>
<remarks>
This class represents a partition key value that identifies the target partition of a collection in the Azure DocumentDB database service.
</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.PartitionKey.ToString" />
<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.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Override the base ToString method to output the value of each key component, separated by a space.
</summary>
<returns>The string representation of all the key component values.</returns>
<remarks>
This class represents a partition key value that identifies the target partition of a collection in the Azure DocumentDB database service.
</remarks>
</Docs>
</Member>
</Members>
</Type>