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

Record Class PathItem

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.gateway.dataroutes.openapi.PathItem
public record PathItem(String summary, String description, OperationObject get, OperationObject put, OperationObject post, OperationObject delete, OperationObject options, OperationObject head, OperationObject patch, OperationObject trace) extends Record
Record class that represents an OpenAPI Path Item Object

  • Constructor Details

    • PathItem

      public PathItem(String summary, String description, OperationObject get, OperationObject put, OperationObject post, OperationObject delete, OperationObject options, OperationObject head, OperationObject patch, OperationObject trace)
      Creates an instance of a PathItem record class.
      Parameters:
      summary - the value for the summary record component
      description - the value for the description record component
      get - the value for the get record component
      put - the value for the put record component
      post - the value for the post record component
      delete - the value for the delete record component
      options - the value for the options record component
      head - the value for the head record component
      patch - the value for the patch record component
      trace - the value for the trace record component

  • Method Details

    • forHttpMethod

      public static PathItem forHttpMethod(HttpMethod method, String summary, String description, OperationObject operation)

    • 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.

    • 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

    • get

      public OperationObject get()
      Returns the value of the get record component.
      Returns:
      the value of the get record component

    • put

      public OperationObject put()
      Returns the value of the put record component.
      Returns:
      the value of the put record component

    • post

      public OperationObject post()
      Returns the value of the post record component.
      Returns:
      the value of the post record component

    • delete

      public OperationObject delete()
      Returns the value of the delete record component.
      Returns:
      the value of the delete record component

    • options

      public OperationObject options()
      Returns the value of the options record component.
      Returns:
      the value of the options record component

    • head

      public OperationObject head()
      Returns the value of the head record component.
      Returns:
      the value of the head record component

    • patch

      public OperationObject patch()
      Returns the value of the patch record component.
      Returns:
      the value of the patch record component

    • trace

      public OperationObject trace()
      Returns the value of the trace record component.
      Returns:
      the value of the trace record component