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

Record Class OperationObject

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.gateway.dataroutes.openapi.OperationObject
public record OperationObject(List<String> tags, String summary, String description, ExternalDocumentationObject externalDocs, List<ParameterObject> parameters, RequestBodyObject requestBody, ResponsesObject responses, boolean deprecated) extends Record
A record object that represents an OpenAPI Operation Object.

An Operation Object describes a single API operation on a path. These are typically created by route authors using the OpenApiOperationBuilder created using RouteGroup.RouteMounter.openApi(Consumer)

  • Constructor Details

    • OperationObject

      public OperationObject(List<String> tags, String summary, String description, ExternalDocumentationObject externalDocs, List<ParameterObject> parameters, RequestBodyObject requestBody, ResponsesObject responses, boolean deprecated)
      Creates an instance of a OperationObject record class.
      Parameters:
      tags - the value for the tags record component
      summary - the value for the summary record component
      description - the value for the description record component
      externalDocs - the value for the externalDocs record component
      parameters - the value for the parameters record component
      requestBody - the value for the requestBody record component
      responses - the value for the responses record component
      deprecated - the value for the deprecated 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 '=='.
      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.

    • tags

      public List<String> tags()
      Returns the value of the tags record component.
      Returns:
      the value of the tags 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

    • externalDocs

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

    • parameters

      public List<ParameterObject> parameters()
      Returns the value of the parameters record component.
      Returns:
      the value of the parameters record component

    • requestBody

      public RequestBodyObject requestBody()
      Returns the value of the requestBody record component.
      Returns:
      the value of the requestBody record component

    • responses

      public ResponsesObject responses()
      Returns the value of the responses record component.
      Returns:
      the value of the responses record component

    • deprecated

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