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

Record Class ParameterObject

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.gateway.dataroutes.openapi.ParameterObject
public record ParameterObject(String ref, String name, ParameterObject.In in, String description, boolean required, boolean deprecated, ParameterObject.Style style, boolean explode, boolean allowReserved, com.inductiveautomation.ignition.common.gson.JsonObject schema) extends Record
Record class that represents an OpenAPI Parameter Object

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    ParameterObject.In
     
    static enum 
    ParameterObject.Style
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    ParameterObject(String ref, String name, ParameterObject.In in, String description, boolean required, boolean deprecated, ParameterObject.Style style, boolean explode, boolean allowReserved, com.inductiveautomation.ignition.common.gson.JsonObject schema)
    Creates an instance of a ParameterObject record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    allowReserved()
    Returns the value of the allowReserved record component.
    boolean
    deprecated()
    Returns the value of the deprecated record component.
    String
    description()
    Returns the value of the description record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    boolean
    explode()
    Returns the value of the explode record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    ParameterObject.In
    in()
    Returns the value of the in record component.
    String
    name()
    Returns the value of the name record component.
    static ParameterObject
    path(String name, String description, boolean required, com.inductiveautomation.ignition.common.gson.JsonObject schema)
    Create a parameter query object.
    static ParameterObject
    query(String name, String description, boolean required, boolean allowReserved, com.inductiveautomation.ignition.common.gson.JsonObject schema)
    Create a query parameter object.
    String
    ref()
    Returns the value of the ref record component.
    static ParameterObject
    ref(String ref)
    Create a parameter object that is a reference to another parameter object.
    boolean
    required()
    Returns the value of the required record component.
    com.inductiveautomation.ignition.common.gson.JsonObject
    schema()
    Returns the value of the schema record component.
    ParameterObject.Style
    style()
    Returns the value of the style record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ParameterObject

      public ParameterObject(String ref, String name, ParameterObject.In in, String description, boolean required, boolean deprecated, ParameterObject.Style style, boolean explode, boolean allowReserved, com.inductiveautomation.ignition.common.gson.JsonObject schema)
      Creates an instance of a ParameterObject record class.
      Parameters:
      ref - the value for the ref record component
      name - the value for the name record component
      in - the value for the in record component
      description - the value for the description record component
      required - the value for the required record component
      deprecated - the value for the deprecated record component
      style - the value for the style record component
      explode - the value for the explode record component
      allowReserved - the value for the allowReserved record component
      schema - the value for the schema record component

  • Method Details

    • ref

      public static ParameterObject ref(String ref)
      Create a parameter object that is a reference to another parameter object. All other fields will be null / defaults

    • query

      public static ParameterObject query(String name, String description, boolean required, boolean allowReserved, com.inductiveautomation.ignition.common.gson.JsonObject schema)
      Create a query parameter object. This will set In to "query", style to "form", and explode to true.

    • path

      public static ParameterObject path(String name, String description, boolean required, com.inductiveautomation.ignition.common.gson.JsonObject schema)
      Create a parameter query object. This will set In to "path", style to "simple", and explode to false.

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • ref

      @SerializedName("$ref") public String ref()
      Returns the value of the ref record component.
      Returns:
      the value of the ref record component

    • name

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

    • in

      public ParameterObject.In in()
      Returns the value of the in record component.
      Returns:
      the value of the in record component

    • description

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

    • required

      public boolean required()
      Returns the value of the required record component.
      Returns:
      the value of the required record component

    • deprecated

      public boolean deprecated()
      Returns the value of the deprecated record component.
      Returns:
      the value of the deprecated record component

    • style

      public ParameterObject.Style style()
      Returns the value of the style record component.
      Returns:
      the value of the style record component

    • explode

      public boolean explode()
      Returns the value of the explode record component.
      Returns:
      the value of the explode record component

    • allowReserved

      public boolean allowReserved()
      Returns the value of the allowReserved record component.
      Returns:
      the value of the allowReserved record component

    • schema

      public com.inductiveautomation.ignition.common.gson.JsonObject schema()
      Returns the value of the schema record component.
      Returns:
      the value of the schema record component