Record Class UiApiOperation

java.lang.Object
java.lang.Record
com.kingsrook.qqq.middleware.javalin.specs.invoke.UiApiOperation
Record Components:
method - HTTP method
pathTemplate - path template, e.g. /table/{tableName}/query
summary - short summary
tag - OpenAPI tag
secured - whether a session is required
openApi - the OpenAPI operation object
specClass - the endpoint spec class name
public record UiApiOperation(HttpMethod method, String pathTemplate, String summary, String tag, boolean secured, Method openApi, String specClass) extends Record
One invocable UI API operation, as described by its endpoint spec: method, path template (relative to the version base path), whether it needs a session, and the full OpenAPI operation (parameters, request body and responses) for building tool definitions.

  • Constructor Details

    • UiApiOperation

      public UiApiOperation(HttpMethod method, String pathTemplate, String summary, String tag, boolean secured, Method openApi, String specClass)
      Creates an instance of a UiApiOperation record class.
      Parameters:
      method - the value for the method record component
      pathTemplate - the value for the pathTemplate record component
      summary - the value for the summary record component
      tag - the value for the tag record component
      secured - the value for the secured record component
      openApi - the value for the openApi record component
      specClass - the value for the specClass 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.

    • method

      public HttpMethod method()
      Returns the value of the method record component.
      Returns:
      the value of the method record component

    • pathTemplate

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

    • summary

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

    • tag

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

    • secured

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

    • openApi

      public Method openApi()
      Returns the value of the openApi record component.
      Returns:
      the value of the openApi record component

    • specClass

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