Package com.yahoo.elide.swagger.property

Class Data

  • All Implemented Interfaces:
    io.swagger.models.properties.Property, Cloneable
    public class Data
extends io.swagger.models.properties.ObjectProperty
    Represents a JSON-API collection of resources or resource identifiers. It is used when a property 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
      Data​(Relationship relationship)
      Used to construct a collection of resource identifiers.
      Data​(String definitionName)
      Used to construct a collection of resources (referenced by the resource type).
      Data​(String definitionName, boolean included)
      Used to construct a collection of resources (referenced by the resource 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

      • Data

        public Data​(String definitionName)
        Used to construct a collection of resources (referenced by the resource type).
        Parameters:
        definitionName - The swagger model to reference in 'data'

      • Data

        public Data​(String definitionName,
            boolean included)
        Used to construct a collection of resources (referenced by the resource type).
        Parameters:
        definitionName - The swagger model to reference in 'data'
        included - Whether or not to add the 'included' property to the schema.

      • Data

        public Data​(Relationship relationship)
        Used to construct a collection of resource identifiers.
        Parameters:
        relationship - Added to the property 'data'