NodeTransitionDescription.xml

<Type Name="NodeTransitionDescription" FullName="System.Fabric.Description.NodeTransitionDescription">
  <TypeSignature Language="C#" Value="public abstract class NodeTransitionDescription" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit NodeTransitionDescription extends System.Object" />
  <TypeSignature Language="DocId" Value="T:System.Fabric.Description.NodeTransitionDescription" />
  <TypeSignature Language="VB.NET" Value="Public MustInherit Class NodeTransitionDescription" />
  <TypeSignature Language="F#" Value="type NodeTransitionDescription = class" />
  <AssemblyInfo>
    <AssemblyName>System.Fabric</AssemblyName>
    <AssemblyVersion>8.0.0.0</AssemblyVersion>
    <AssemblyVersion>9.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Describes information about how a node should be transitioned, and is used with StartNodeTransitionAsync().  
            This object should not be used directly, the derived classes should be used.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected NodeTransitionDescription (System.Fabric.NodeTransitionType nodeTransitionType, Guid operationId, string nodeName, System.Numerics.BigInteger nodeInstanceId);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(valuetype System.Fabric.NodeTransitionType nodeTransitionType, valuetype System.Guid operationId, string nodeName, valuetype System.Numerics.BigInteger nodeInstanceId) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Fabric.Description.NodeTransitionDescription.#ctor(System.Fabric.NodeTransitionType,System.Guid,System.String,System.Numerics.BigInteger)" />
      <MemberSignature Language="VB.NET" Value="Protected Sub New (nodeTransitionType As NodeTransitionType, operationId As Guid, nodeName As String, nodeInstanceId As BigInteger)" />
      <MemberSignature Language="F#" Value="new System.Fabric.Description.NodeTransitionDescription : System.Fabric.NodeTransitionType * Guid * string * System.Numerics.BigInteger -&gt; System.Fabric.Description.NodeTransitionDescription" Usage="new System.Fabric.Description.NodeTransitionDescription (nodeTransitionType, operationId, nodeName, nodeInstanceId)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Fabric</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="nodeTransitionType" Type="System.Fabric.NodeTransitionType" />
        <Parameter Name="operationId" Type="System.Guid" />
        <Parameter Name="nodeName" Type="System.String" />
        <Parameter Name="nodeInstanceId" Type="System.Numerics.BigInteger" />
      </Parameters>
      <Docs>
        <param name="nodeTransitionType">Indicates the type of transition to perform.  NodeTransitionType.Start will start a stopped node.  NodeTransitionType.Stop will stop a node that is up.</param>
        <param name="operationId">A Guid to identify this operation.  This should be unique, and should not be used with other operations.</param>
        <param name="nodeName">The name of the node to start or stop.  The name can be determined through GetNodeListAsync().</param>
        <param name="nodeInstanceId">The node instance id of the target node.  This can be determined through GetNodeListAsync().</param>
        <summary>
            Constructs a NodeTransitionDescription
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="NodeInstanceId">
      <MemberSignature Language="C#" Value="public System.Numerics.BigInteger NodeInstanceId { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Numerics.BigInteger NodeInstanceId" />
      <MemberSignature Language="DocId" Value="P:System.Fabric.Description.NodeTransitionDescription.NodeInstanceId" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property NodeInstanceId As BigInteger" />
      <MemberSignature Language="F#" Value="member this.NodeInstanceId : System.Numerics.BigInteger" Usage="System.Fabric.Description.NodeTransitionDescription.NodeInstanceId" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Fabric</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Numerics.BigInteger</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The node instance id of the target node.  This can be determined through GetNodeListAsync().
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="NodeName">
      <MemberSignature Language="C#" Value="public string NodeName { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string NodeName" />
      <MemberSignature Language="DocId" Value="P:System.Fabric.Description.NodeTransitionDescription.NodeName" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property NodeName As String" />
      <MemberSignature Language="F#" Value="member this.NodeName : string" Usage="System.Fabric.Description.NodeTransitionDescription.NodeName" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Fabric</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The name of the node to start or stop.  The name can be determined through GetNodeListAsync().
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="NodeTransitionType">
      <MemberSignature Language="C#" Value="public System.Fabric.NodeTransitionType NodeTransitionType { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Fabric.NodeTransitionType NodeTransitionType" />
      <MemberSignature Language="DocId" Value="P:System.Fabric.Description.NodeTransitionDescription.NodeTransitionType" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property NodeTransitionType As NodeTransitionType" />
      <MemberSignature Language="F#" Value="member this.NodeTransitionType : System.Fabric.NodeTransitionType" Usage="System.Fabric.Description.NodeTransitionDescription.NodeTransitionType" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Fabric</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Fabric.NodeTransitionType</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            NodeTransitionType determines what type of transition to perform.  Start will start a stopped node.  Stop will stop an up node.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="OperationId">
      <MemberSignature Language="C#" Value="public Guid OperationId { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Guid OperationId" />
      <MemberSignature Language="DocId" Value="P:System.Fabric.Description.NodeTransitionDescription.OperationId" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property OperationId As Guid" />
      <MemberSignature Language="F#" Value="member this.OperationId : Guid" Usage="System.Fabric.Description.NodeTransitionDescription.OperationId" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Fabric</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Guid</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            A Guid to identify this operation.  This should be unique, and should not be used with other operations.
            </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:System.Fabric.Description.NodeTransitionDescription.ToString" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
      <MemberSignature Language="F#" Value="override this.ToString : unit -&gt; string" Usage="nodeTransitionDescription.ToString " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Fabric</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Prints a string representation of this object.
            </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>