Link.cs

namespace net.openstack.Core.Domain
{
    using System.Diagnostics;
    using Newtonsoft.Json;

    /// <summary>
    /// Represents a link associated with a resource.
    /// </summary>
    /// <seealso href="http://docs.openstack.org/api/openstack-compute/2/content/LinksReferences.html">Links and References (OpenStack Compute API v2 and Extensions Reference)</seealso>
    /// <threadsafety static="true" instance="false"/>
    [JsonObject(MemberSerialization.OptIn)]
    [DebuggerDisplay("{Rel,nq}: {Href,nq}")]
    public class Link : ExtensibleJsonObject
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="Link"/> class.
        /// </summary>
        /// <param name="rel">The link type.</param>
        /// <param name="href">The link.</param>
        [JsonConstructor]
        public Link(string rel, string href)
        {
            Rel = rel;
            Href = href;
        }

        /// <summary>
        /// Gets the link target.
        /// </summary>
        /// <seealso href="http://docs.openstack.org/api/openstack-compute/2/content/LinksReferences.html">Links and References (OpenStack Compute API v2 and Extensions Reference)</seealso>
        [JsonProperty("href")]
        public string Href { get; private set; }

        /// <summary>
        /// Gets the link relation.
        /// </summary>
        /// <remarks>
        /// <list type="bullet">
        /// <item>A <c>self</c> link contains a versioned link to the resource. Use these links when the link will be followed immediately.</item>
        /// <item>A <c>bookmark</c> link provides a permanent link to a resource that is appropriate for long-term storage.</item>
        /// <item>An <c>alternate</c> link can contain an alternative representation of the resource. For example, an OpenStack Compute image might have an alternate representation in the OpenStack Image service.</item>
        /// </list>
        /// </remarks>
        /// <seealso href="http://docs.openstack.org/api/openstack-compute/2/content/LinksReferences.html">Links and References (OpenStack Compute API v2 and Extensions Reference)</seealso>
        [JsonProperty("rel")]
        public string Rel { get; private set; }
    }
}