/azure-docs-sdk-dotnet

Permalink
Switch branches/tags
Nothing to show
Find file
azure-docs-sdk-dotnet/xml/Microsoft.Azure.Graphs.Elements/Vertex.xml
Fetching contributors…
Cannot retrieve contributors at this time
Raw Blame History
231 lines (231 sloc) 10.8 KB
<Type Name="Vertex" FullName="Microsoft.Azure.Graphs.Elements.Vertex">
<TypeSignature Language="C#" Value="public sealed class Vertex" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit Vertex extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Graphs.Elements.Vertex" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Graphs</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName>Newtonsoft.Json.JsonConverter(typeof(Microsoft.Azure.Graphs.Elements.VertexConverter))</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Storage container for vertex data.
Supports deserialization from GraphSON format.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="GetInEdges">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable&lt;Microsoft.Azure.Graphs.Elements.VertexEdge&gt; GetInEdges ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Collections.Generic.IEnumerable`1&lt;class Microsoft.Azure.Graphs.Elements.VertexEdge&gt; GetInEdges() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Graphs.Elements.Vertex.GetInEdges" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Graphs</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable&lt;Microsoft.Azure.Graphs.Elements.VertexEdge&gt;</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Gets all the incoming edges to the vertex.
</summary>
<returns>Enumerable containing in-edges.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetInEdges">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable&lt;Microsoft.Azure.Graphs.Elements.VertexEdge&gt; GetInEdges (string label);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Collections.Generic.IEnumerable`1&lt;class Microsoft.Azure.Graphs.Elements.VertexEdge&gt; GetInEdges(string label) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Graphs.Elements.Vertex.GetInEdges(System.String)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Graphs</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable&lt;Microsoft.Azure.Graphs.Elements.VertexEdge&gt;</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="label" Type="System.String" />
</Parameters>
<Docs>
<param name="label">Edge label to match on.</param>
<summary>
Gets all the incoming edges to the vertex with label <paramref name="label" />.
</summary>
<returns>Enumerable containing incoming edges.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetOutEdges">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable&lt;Microsoft.Azure.Graphs.Elements.VertexEdge&gt; GetOutEdges ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Collections.Generic.IEnumerable`1&lt;class Microsoft.Azure.Graphs.Elements.VertexEdge&gt; GetOutEdges() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Graphs.Elements.Vertex.GetOutEdges" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Graphs</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable&lt;Microsoft.Azure.Graphs.Elements.VertexEdge&gt;</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Gets all the outgoing edges from the vertex.
</summary>
<returns>Enumerable containing outgoing edges.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetOutEdges">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable&lt;Microsoft.Azure.Graphs.Elements.VertexEdge&gt; GetOutEdges (string label);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Collections.Generic.IEnumerable`1&lt;class Microsoft.Azure.Graphs.Elements.VertexEdge&gt; GetOutEdges(string label) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Graphs.Elements.Vertex.GetOutEdges(System.String)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Graphs</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable&lt;Microsoft.Azure.Graphs.Elements.VertexEdge&gt;</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="label" Type="System.String" />
</Parameters>
<Docs>
<param name="label">Edge label to match on.</param>
<summary>
Gets all the outgoing edges from the vertex with label <paramref name="label" />.
</summary>
<returns>Enumerable containing outgoing edges.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetVertexProperties">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable&lt;Microsoft.Azure.Graphs.Elements.VertexProperty&gt; GetVertexProperties ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Collections.Generic.IEnumerable`1&lt;class Microsoft.Azure.Graphs.Elements.VertexProperty&gt; GetVertexProperties() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Graphs.Elements.Vertex.GetVertexProperties" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Graphs</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable&lt;Microsoft.Azure.Graphs.Elements.VertexProperty&gt;</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Gets all the vertex properties on the vertex.
</summary>
<returns>Enumerable containing all vertex properties.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetVertexProperties">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable&lt;Microsoft.Azure.Graphs.Elements.VertexProperty&gt; GetVertexProperties (string key);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Collections.Generic.IEnumerable`1&lt;class Microsoft.Azure.Graphs.Elements.VertexProperty&gt; GetVertexProperties(string key) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Graphs.Elements.Vertex.GetVertexProperties(System.String)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Graphs</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable&lt;Microsoft.Azure.Graphs.Elements.VertexProperty&gt;</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="key" Type="System.String" />
</Parameters>
<Docs>
<param name="key">The property key to query.</param>
<summary>
Gets the vertex properties that correspond to a given property key.
</summary>
<returns>Enumerable containing vertex properties matching the <paramref name="key" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Id">
<MemberSignature Language="C#" Value="public object Id { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance object Id" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Graphs.Elements.Vertex.Id" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Graphs</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the identifier.
</summary>
<value>
The identifier.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Label">
<MemberSignature Language="C#" Value="public string Label { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Label" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Graphs.Elements.Vertex.Label" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Graphs</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the label.
</summary>
<value>
The label.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Validate">
<MemberSignature Language="C#" Value="public void Validate ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Validate() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Graphs.Elements.Vertex.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">
Vertex must have a valid Id.
or
Vertex must have a valid Label.
</exception>
</Docs>
</Member>
</Members>
</Type>