MongoDBShardKeySetting.xml

<Type Name="MongoDBShardKeySetting" FullName="Azure.ResourceManager.DataMigration.Models.MongoDBShardKeySetting">
  <TypeSignature Language="C#" Value="public class MongoDBShardKeySetting" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit MongoDBShardKeySetting extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Azure.ResourceManager.DataMigration.Models.MongoDBShardKeySetting" />
  <TypeSignature Language="VB.NET" Value="Public Class MongoDBShardKeySetting" />
  <TypeSignature Language="F#" Value="type MongoDBShardKeySetting = class" />
  <AssemblyInfo>
    <AssemblyName>Azure.ResourceManager.DataMigration</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary> Describes a MongoDB shard key. </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public MongoDBShardKeySetting (System.Collections.Generic.IEnumerable&lt;Azure.ResourceManager.DataMigration.Models.MongoDBShardKeyField&gt; fields);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Collections.Generic.IEnumerable`1&lt;class Azure.ResourceManager.DataMigration.Models.MongoDBShardKeyField&gt; fields) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.ResourceManager.DataMigration.Models.MongoDBShardKeySetting.#ctor(System.Collections.Generic.IEnumerable{Azure.ResourceManager.DataMigration.Models.MongoDBShardKeyField})" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (fields As IEnumerable(Of MongoDBShardKeyField))" />
      <MemberSignature Language="F#" Value="new Azure.ResourceManager.DataMigration.Models.MongoDBShardKeySetting : seq&lt;Azure.ResourceManager.DataMigration.Models.MongoDBShardKeyField&gt; -&gt; Azure.ResourceManager.DataMigration.Models.MongoDBShardKeySetting" Usage="new Azure.ResourceManager.DataMigration.Models.MongoDBShardKeySetting fields" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.DataMigration</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="fields" Type="System.Collections.Generic.IEnumerable&lt;Azure.ResourceManager.DataMigration.Models.MongoDBShardKeyField&gt;" />
      </Parameters>
      <Docs>
        <param name="fields"> The fields within the shard key. </param>
        <summary> Initializes a new instance of MongoDBShardKeySetting. </summary>
        <remarks>To be added.</remarks>
        <exception cref="T:System.ArgumentNullException">
          <paramref name="fields" /> is null. </exception>
      </Docs>
    </Member>
    <Member MemberName="Fields">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IList&lt;Azure.ResourceManager.DataMigration.Models.MongoDBShardKeyField&gt; Fields { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1&lt;class Azure.ResourceManager.DataMigration.Models.MongoDBShardKeyField&gt; Fields" />
      <MemberSignature Language="DocId" Value="P:Azure.ResourceManager.DataMigration.Models.MongoDBShardKeySetting.Fields" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Fields As IList(Of MongoDBShardKeyField)" />
      <MemberSignature Language="F#" Value="member this.Fields : System.Collections.Generic.IList&lt;Azure.ResourceManager.DataMigration.Models.MongoDBShardKeyField&gt;" Usage="Azure.ResourceManager.DataMigration.Models.MongoDBShardKeySetting.Fields" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.DataMigration</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IList&lt;Azure.ResourceManager.DataMigration.Models.MongoDBShardKeyField&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> The fields within the shard key. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="IsUnique">
      <MemberSignature Language="C#" Value="public bool? IsUnique { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;bool&gt; IsUnique" />
      <MemberSignature Language="DocId" Value="P:Azure.ResourceManager.DataMigration.Models.MongoDBShardKeySetting.IsUnique" />
      <MemberSignature Language="VB.NET" Value="Public Property IsUnique As Nullable(Of Boolean)" />
      <MemberSignature Language="F#" Value="member this.IsUnique : Nullable&lt;bool&gt; with get, set" Usage="Azure.ResourceManager.DataMigration.Models.MongoDBShardKeySetting.IsUnique" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.DataMigration</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.Boolean&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> Whether the shard key is unique. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>