Package com.yahoo.elide.swagger.property

Class Datum

  • All Implemented Interfaces:
    io.swagger.models.properties.Property, Cloneable
    public class Datum
extends io.swagger.models.properties.ObjectProperty
    Represents a JSON-API single resource or resource identifier. It is used when a schema is required for swagger.

    • Field Summary

      • Fields inherited from class io.swagger.models.properties.ObjectProperty

        TYPE

      • Fields inherited from class io.swagger.models.properties.AbstractProperty

        access, allowEmptyValue, description, example, format, name, position, readOnly, required, title, type, vendorExtensions, xml

    • Constructor Summary

      Constructors 
      Constructor Description
      Datum​(Relationship relationship)
      Constructs a singular resource identifier.
      Datum​(String definitionName)
      Constructs a singular resource (referenced by type).
      Datum​(String definitionName, boolean included)
      Constructs a singular resource (referenced by type).

    • Method Summary

      • Methods inherited from class io.swagger.models.properties.ObjectProperty

        _default, access, description, equals, example, getProperties, getRequiredProperties, hashCode, isType, isType, name, properties, property, readOnly, readOnly, required, setProperties, setRequiredProperties, title, vendorExtension, xml

      • Methods inherited from class io.swagger.models.properties.AbstractProperty

        allowEmptyValue, getAccess, getAllowEmptyValue, getDescription, getExample, getFormat, getName, getPosition, getReadOnly, getRequired, getTitle, getType, getVendorExtensions, getXml, rename, setAccess, setAllowEmptyValue, setDefault, setDescription, setExample, setExample, setFormat, setName, setPosition, setReadOnly, setRequired, setTitle, setType, setVendorExtension, setVendorExtensionMap, setVendorExtensions, setXml

      • Methods inherited from interface io.swagger.models.properties.Property

        getAccess, getAllowEmptyValue, getDescription, getExample, getFormat, getName, getPosition, getReadOnly, getRequired, getTitle, getType, getVendorExtensions, getXml, rename, setAccess, setAllowEmptyValue, setDefault, setDescription, setExample, setExample, setName, setPosition, setReadOnly, setRequired, setTitle, setXml

    • Constructor Detail

      • Datum

        public Datum​(String definitionName)
        Constructs a singular resource (referenced by type).
        Parameters:
        definitionName - The swagger model to reference in 'data'.

      • Datum

        public Datum​(String definitionName,
             boolean included)
        Constructs a singular resource (referenced by type).
        Parameters:
        definitionName - The swagger model to reference in 'data'.
        included - Whether or not to add the 'included' property to the schema.

      • Datum

        public Datum​(Relationship relationship)
        Constructs a singular resource identifier.
        Parameters:
        relationship - Added to the property 'data'.