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

Record Class InfoObject

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.gateway.dataroutes.openapi.InfoObject
public record InfoObject(String title, String summary, String description, String termsOfService, ContactObject contact, LicenseObject license, String version, LogoObject logoUrl) extends Record
Record class that represents an OpenAPI Info Object

  • Constructor Details

    • InfoObject

      public InfoObject(String title, String summary, String description, String termsOfService, ContactObject contact, LicenseObject license, String version, LogoObject logoUrl)
      Creates an instance of a InfoObject record class.
      Parameters:
      title - the value for the title record component
      summary - the value for the summary record component
      description - the value for the description record component
      termsOfService - the value for the termsOfService record component
      contact - the value for the contact record component
      license - the value for the license record component
      version - the value for the version record component
      logoUrl - the value for the logoUrl 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.

    • title

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

    • summary

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

    • description

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

    • termsOfService

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

    • contact

      public ContactObject contact()
      Returns the value of the contact record component.
      Returns:
      the value of the contact record component

    • license

      public LicenseObject license()
      Returns the value of the license record component.
      Returns:
      the value of the license record component

    • version

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

    • logoUrl

      @SerializedName("x-logo") public LogoObject logoUrl()
      Returns the value of the logoUrl record component.
      Returns:
      the value of the logoUrl record component