Package com.inductiveautomation.ignition.gateway.dataroutes.openapi

Record Class OasObject

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.gateway.dataroutes.openapi.OasObject
public record OasObject(String openapi, InfoObject info, ExternalDocumentationObject externalDocs, Map<String,PathItem> paths, ComponentsObject components, List<GroupObject> groups) extends Record
This record class is the root of an OpenAPI specification. This class and other record types in this package are designed to naturally Gson-serialize into a valid OpenAPI specification document in JSON. Please see the OpenAPI reference documentation

  • Constructor Details

    • OasObject

      public OasObject(String openapi, InfoObject info, ExternalDocumentationObject externalDocs, Map<String,PathItem> paths, ComponentsObject components, List<GroupObject> groups)
      Creates an instance of a OasObject record class.
      Parameters:
      openapi - the value for the openapi record component
      info - the value for the info record component
      externalDocs - the value for the externalDocs record component
      paths - the value for the paths record component
      components - the value for the components record component
      groups - the value for the groups record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • openapi

      public String openapi()
      Returns the value of the openapi record component.
      Returns:
      the value of the openapi record component

    • info

      public InfoObject info()
      Returns the value of the info record component.
      Returns:
      the value of the info record component

    • externalDocs

      public ExternalDocumentationObject externalDocs()
      Returns the value of the externalDocs record component.
      Returns:
      the value of the externalDocs record component

    • paths

      public Map<String,PathItem> paths()
      Returns the value of the paths record component.
      Returns:
      the value of the paths record component

    • components

      public ComponentsObject components()
      Returns the value of the components record component.
      Returns:
      the value of the components record component

    • groups

      @SerializedName("x-tagGroups") public List<GroupObject> groups()
      Returns the value of the groups record component.
      Returns:
      the value of the groups record component