ConflictResolutionDefinition.xml

<Type Name="ConflictResolutionDefinition" FullName="Azure.Cosmos.Fluent.ConflictResolutionDefinition">
  <TypeSignature Language="C#" Value="public class ConflictResolutionDefinition" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ConflictResolutionDefinition extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Azure.Cosmos.Fluent.ConflictResolutionDefinition" />
  <TypeSignature Language="VB.NET" Value="Public Class ConflictResolutionDefinition" />
  <TypeSignature Language="F#" Value="type ConflictResolutionDefinition = class" />
  <AssemblyInfo>
    <AssemblyName>Azure.Cosmos</AssemblyName>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
      <see cref="T:Azure.Cosmos.ConflictResolutionPolicy" /> fluent definition.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName="Attach">
      <MemberSignature Language="C#" Value="public Azure.Cosmos.Fluent.ContainerBuilder Attach ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Azure.Cosmos.Fluent.ContainerBuilder Attach() cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Cosmos.Fluent.ConflictResolutionDefinition.Attach" />
      <MemberSignature Language="VB.NET" Value="Public Function Attach () As ContainerBuilder" />
      <MemberSignature Language="F#" Value="member this.Attach : unit -&gt; Azure.Cosmos.Fluent.ContainerBuilder" Usage="conflictResolutionDefinition.Attach " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Cosmos</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.Cosmos.Fluent.ContainerBuilder</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Applies the current definition to the parent.
            </summary>
        <returns>An instance of the parent.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="WithCustomStoredProcedureResolution">
      <MemberSignature Language="C#" Value="public Azure.Cosmos.Fluent.ConflictResolutionDefinition WithCustomStoredProcedureResolution (string conflictResolutionProcedure);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Azure.Cosmos.Fluent.ConflictResolutionDefinition WithCustomStoredProcedureResolution(string conflictResolutionProcedure) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Cosmos.Fluent.ConflictResolutionDefinition.WithCustomStoredProcedureResolution(System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Function WithCustomStoredProcedureResolution (conflictResolutionProcedure As String) As ConflictResolutionDefinition" />
      <MemberSignature Language="F#" Value="member this.WithCustomStoredProcedureResolution : string -&gt; Azure.Cosmos.Fluent.ConflictResolutionDefinition" Usage="conflictResolutionDefinition.WithCustomStoredProcedureResolution conflictResolutionProcedure" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Cosmos</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.Cosmos.Fluent.ConflictResolutionDefinition</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="conflictResolutionProcedure" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="conflictResolutionProcedure"> Sets the stored procedure's name to be used for conflict-resolution.</param>
        <summary>
            Defines the stored procedure to be used as custom conflict resolution mode <see cref="T:Azure.Cosmos.ConflictResolutionPolicy" />.
            </summary>
        <returns>An instance of the current <see cref="T:Azure.Cosmos.Fluent.UniqueKeyDefinition" />.</returns>
        <remarks>The stored procedure can be created later on, but needs to honor the name specified here.</remarks>
        <example>
            This example below creates a <see cref="T:Azure.Cosmos.CosmosContainer" /> with a Conflict Resolution policy that uses a stored procedure to resolve conflicts:
            <code language="c#"><![CDATA[
            await databaseForConflicts.DefineContainer("myContainer", "/id")
                .WithConflictResolution()
                    .WithCustomStoredProcedureResolution("myStoredProcedure")
                    .Attach()
                .CreateAsync();
            </example>
            ]]></code></example>
      </Docs>
    </Member>
    <Member MemberName="WithLastWriterWinsResolution">
      <MemberSignature Language="C#" Value="public Azure.Cosmos.Fluent.ConflictResolutionDefinition WithLastWriterWinsResolution (string conflictResolutionPath);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Azure.Cosmos.Fluent.ConflictResolutionDefinition WithLastWriterWinsResolution(string conflictResolutionPath) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Cosmos.Fluent.ConflictResolutionDefinition.WithLastWriterWinsResolution(System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Function WithLastWriterWinsResolution (conflictResolutionPath As String) As ConflictResolutionDefinition" />
      <MemberSignature Language="F#" Value="member this.WithLastWriterWinsResolution : string -&gt; Azure.Cosmos.Fluent.ConflictResolutionDefinition" Usage="conflictResolutionDefinition.WithLastWriterWinsResolution conflictResolutionPath" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Cosmos</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.Cosmos.Fluent.ConflictResolutionDefinition</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="conflictResolutionPath" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="conflictResolutionPath"> sets the path which is present in each item in the Azure Cosmos DB service for last writer wins conflict-resolution. <see cref="P:Azure.Cosmos.ConflictResolutionPolicy.ResolutionPath" />.</param>
        <summary>
            Defines the path used to resolve LastWrtierWins resolution mode <see cref="T:Azure.Cosmos.ConflictResolutionPolicy" />.
            </summary>
        <returns>An instance of the current <see cref="T:Azure.Cosmos.Fluent.UniqueKeyDefinition" />.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>