VertexEdge.xml

<Type Name="VertexEdge" FullName="Microsoft.Azure.Graphs.Elements.VertexEdge">
  <TypeSignature Language="C#" Value="public sealed class VertexEdge : Microsoft.Azure.Graphs.Elements.Edge" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit VertexEdge extends Microsoft.Azure.Graphs.Elements.Edge" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Azure.Graphs.Elements.VertexEdge" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Azure.Graphs</AssemblyName>
    <AssemblyVersion>1.14.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>Microsoft.Azure.Graphs.Elements.Edge</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute>
      <AttributeName>Newtonsoft.Json.JsonConverter(typeof(Microsoft.Azure.Graphs.Elements.VertexEdgeConverter))</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>
            Storage container for edge data contained within a vertex.
            Supports deserialization from GraphSON format.
            </summary>
    <remarks>
            Vertex edge data is more sparse than edge data in that it doesn't populate the vertex in\out labels.
            Vertex edge data also contains direction information relative to its parent vertex.
            It is used to represent the edge information that is stored within a vertex rather than the full, independent, edge object.
            </remarks>
  </Docs>
  <Members>
    <Member MemberName="Direction">
      <MemberSignature Language="C#" Value="public Microsoft.Azure.Graphs.Elements.Direction Direction { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.Graphs.Elements.Direction Direction" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Graphs.Elements.VertexEdge.Direction" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Graphs</AssemblyName>
        <AssemblyVersion>1.14.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Azure.Graphs.Elements.Direction</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the vertex edge direction.
            </summary>
        <value>
            The vertex edge direction.
            </value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Validate">
      <MemberSignature Language="C#" Value="public override void Validate ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Validate() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Graphs.Elements.VertexEdge.Validate" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Graphs</AssemblyName>
        <AssemblyVersion>1.14.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Validates this instance.
            </summary>
        <remarks>To be added.</remarks>
        <exception cref="T:System.ArgumentNullException">
            VertexEdge must have a valid Id.
            or
            VertexEdge must have a valid Label.
            </exception>
        <exception cref="T:System.ArgumentException">VertexEdge must specify at least one InVertexId or OutVertexId.</exception>
      </Docs>
    </Member>
  </Members>
</Type>