Record Class Operation

java.lang.Object
java.lang.Record
org.infinispan.rest.framework.openapi.Operation
All Implemented Interfaces:
JsonSerialization
public record Operation(String operationId, String summary, String description, boolean deprecated, ResourceDescription group, List<Parameter> parameters, RequestBody requestBody, Collection<ResponseContent> responses) extends Record implements JsonSerialization

  • Constructor Details

    • Operation

      public Operation(String operationId, String summary, String description, boolean deprecated, ResourceDescription group, List<Parameter> parameters, RequestBody requestBody, Collection<ResponseContent> responses)
      Creates an instance of a Operation record class.
      Parameters:
      operationId - the value for the operationId record component
      summary - the value for the summary record component
      description - the value for the description record component
      deprecated - the value for the deprecated record component
      group - the value for the group 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

  • Method Details

    • toJson

      public Json toJson()
      Specified by:
      toJson in interface JsonSerialization

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

    • operationId

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

    • deprecated

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

    • group

      public ResourceDescription group()
      Returns the value of the group record component.
      Returns:
      the value of the group record component

    • parameters

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

    • requestBody

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

    • responses

      public Collection<ResponseContent> responses()
      Returns the value of the responses record component.
      Returns:
      the value of the responses record component