xml/Azure.ResourceManager.DurableTask.Models/DurableTaskPurgeableOrchestrationState.xml

<Type Name="DurableTaskPurgeableOrchestrationState" FullName="Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState">
  <TypeSignature Language="C#" Value="public readonly struct DurableTaskPurgeableOrchestrationState : IEquatable&lt;Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState&gt;" />
  <TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit DurableTaskPurgeableOrchestrationState extends System.ValueType implements class System.IEquatable`1&lt;valuetype Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState&gt;" />
  <TypeSignature Language="DocId" Value="T:Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState" />
  <TypeSignature Language="VB.NET" Value="Public Structure DurableTaskPurgeableOrchestrationState&#xA;Implements IEquatable(Of DurableTaskPurgeableOrchestrationState)" />
  <TypeSignature Language="F#" Value="type DurableTaskPurgeableOrchestrationState = struct" />
  <AssemblyInfo>
    <AssemblyName>Azure.ResourceManager.DurableTask</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.ValueType</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>System.IEquatable&lt;Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState&gt;</InterfaceName>
    </Interface>
  </Interfaces>
  <Docs>
    <summary> Purgeable orchestration state to be used in retention policies. </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public DurableTaskPurgeableOrchestrationState (string value);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string value) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState.#ctor(System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (value As String)" />
      <MemberSignature Language="F#" Value="new Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState : string -&gt; Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState" Usage="new Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState value" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.DurableTask</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="value" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="value">To be added.</param>
        <summary> Initializes a new instance of <see cref="T:Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState" />. </summary>
        <remarks>To be added.</remarks>
        <exception cref="T:System.ArgumentNullException">
          <paramref name="value" /> is null. </exception>
      </Docs>
    </Member>
    <Member MemberName="Canceled">
      <MemberSignature Language="C#" Value="public static Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState Canceled { get; }" />
      <MemberSignature Language="ILAsm" Value=".property valuetype Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState Canceled" />
      <MemberSignature Language="DocId" Value="P:Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState.Canceled" />
      <MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property Canceled As DurableTaskPurgeableOrchestrationState" />
      <MemberSignature Language="F#" Value="static member Canceled : Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState" Usage="Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState.Canceled" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.DurableTask</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> The orchestration is canceled. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Completed">
      <MemberSignature Language="C#" Value="public static Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState Completed { get; }" />
      <MemberSignature Language="ILAsm" Value=".property valuetype Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState Completed" />
      <MemberSignature Language="DocId" Value="P:Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState.Completed" />
      <MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property Completed As DurableTaskPurgeableOrchestrationState" />
      <MemberSignature Language="F#" Value="static member Completed : Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState" Usage="Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState.Completed" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.DurableTask</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> The orchestration is completed. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Equals">
      <MemberSignature Language="C#" Value="public bool Equals (Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState other);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Equals(valuetype Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState other) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState.Equals(Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState)" />
      <MemberSignature Language="VB.NET" Value="Public Function Equals (other As DurableTaskPurgeableOrchestrationState) As Boolean" />
      <MemberSignature Language="F#" Value="override this.Equals : Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState -&gt; bool" Usage="durableTaskPurgeableOrchestrationState.Equals other" />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:System.IEquatable`1.Equals(`0)</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.DurableTask</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="other" Type="Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState" />
      </Parameters>
      <Docs>
        <param name="other">An object to compare with this object.</param>
        <summary>Indicates whether the current object is equal to another object of the same type.</summary>
        <returns>
          <see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Equals">
      <MemberSignature Language="C#" Value="public override bool Equals (object obj);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState.Equals(System.Object)" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function Equals (obj As Object) As Boolean" />
      <MemberSignature Language="F#" Value="override this.Equals : obj -&gt; bool" Usage="durableTaskPurgeableOrchestrationState.Equals obj" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.DurableTask</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="obj" Type="System.Object" />
      </Parameters>
      <Docs>
        <param name="obj">The object to compare with the current instance.</param>
        <summary>Indicates whether this instance and a specified object are equal.</summary>
        <returns>
          <see langword="true" /> if <paramref name="obj" /> and this instance are the same type and represent the same value; otherwise, <see langword="false" />.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Failed">
      <MemberSignature Language="C#" Value="public static Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState Failed { get; }" />
      <MemberSignature Language="ILAsm" Value=".property valuetype Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState Failed" />
      <MemberSignature Language="DocId" Value="P:Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState.Failed" />
      <MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property Failed As DurableTaskPurgeableOrchestrationState" />
      <MemberSignature Language="F#" Value="static member Failed : Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState" Usage="Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState.Failed" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.DurableTask</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> The orchestration is failed. </summary>
        <value>To be added.</value>
        <remarks>To be added.</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:Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState.GetHashCode" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function GetHashCode () As Integer" />
      <MemberSignature Language="F#" Value="override this.GetHashCode : unit -&gt; int" Usage="durableTaskPurgeableOrchestrationState.GetHashCode " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.DurableTask</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Returns the hash code for this instance.</summary>
        <returns>A 32-bit signed integer that is the hash code for this instance.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="op_Equality">
      <MemberSignature Language="C#" Value="public static bool operator == (Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState left, Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState right);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Equality(valuetype Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState left, valuetype Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState right) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState.op_Equality(Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState,Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState)" />
      <MemberSignature Language="VB.NET" Value="Public Shared Operator == (left As DurableTaskPurgeableOrchestrationState, right As DurableTaskPurgeableOrchestrationState) As Boolean" />
      <MemberSignature Language="F#" Value="static member ( = ) : Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState * Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState -&gt; bool" Usage="left = right" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.DurableTask</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="left" Type="Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState" />
        <Parameter Name="right" Type="Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState" />
      </Parameters>
      <Docs>
        <param name="left">To be added.</param>
        <param name="right">To be added.</param>
        <summary> Determines if two <see cref="T:Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState" /> values are the same. </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="op_Implicit">
      <MemberSignature Language="C#" Value="public static implicit operator Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState (string value);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname valuetype Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState op_Implicit(string value) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState.op_Implicit(System.String)~Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState" />
      <MemberSignature Language="VB.NET" Value="Public Shared Widening Operator CType (value As String) As DurableTaskPurgeableOrchestrationState" />
      <MemberSignature Language="F#" Value="static member op_Implicit : string -&gt; Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState" Usage="Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState.op_Implicit value" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.DurableTask</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="value" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="value">To be added.</param>
        <summary> Converts a <see cref="T:System.String" /> to a <see cref="T:Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState" />. </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="op_Inequality">
      <MemberSignature Language="C#" Value="public static bool operator != (Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState left, Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState right);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Inequality(valuetype Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState left, valuetype Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState right) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState.op_Inequality(Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState,Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState)" />
      <MemberSignature Language="VB.NET" Value="Public Shared Operator != (left As DurableTaskPurgeableOrchestrationState, right As DurableTaskPurgeableOrchestrationState) As Boolean" />
      <MemberSignature Language="F#" Value="static member op_Inequality : Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState * Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState -&gt; bool" Usage="Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState.op_Inequality (left, right)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.DurableTask</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="left" Type="Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState" />
        <Parameter Name="right" Type="Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState" />
      </Parameters>
      <Docs>
        <param name="left">To be added.</param>
        <param name="right">To be added.</param>
        <summary> Determines if two <see cref="T:Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState" /> values are not the same. </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Terminated">
      <MemberSignature Language="C#" Value="public static Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState Terminated { get; }" />
      <MemberSignature Language="ILAsm" Value=".property valuetype Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState Terminated" />
      <MemberSignature Language="DocId" Value="P:Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState.Terminated" />
      <MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property Terminated As DurableTaskPurgeableOrchestrationState" />
      <MemberSignature Language="F#" Value="static member Terminated : Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState" Usage="Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState.Terminated" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.DurableTask</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> The orchestration is terminated. </summary>
        <value>To be added.</value>
        <remarks>To be added.</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:Azure.ResourceManager.DurableTask.Models.DurableTaskPurgeableOrchestrationState.ToString" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
      <MemberSignature Language="F#" Value="override this.ToString : unit -&gt; string" Usage="durableTaskPurgeableOrchestrationState.ToString " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.DurableTask</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Returns the fully qualified type name of this instance.</summary>
        <returns>The fully qualified type name.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>