Package dev.rafex.ether.http.openapi.model

Record Class OpenApiOperation

java.lang.Object
java.lang.Record
dev.rafex.ether.http.openapi.model.OpenApiOperation
public record OpenApiOperation(String operationId, String summary, String description, List<String> tags, List<OpenApiParameter> parameters, Map<String,OpenApiResponse> responses, OpenApiRequestBody requestBody) extends Record

  • Constructor Details

    • OpenApiOperation

      public OpenApiOperation(String operationId, String summary, String description, List<String> tags, List<OpenApiParameter> parameters, Map<String,OpenApiResponse> responses, OpenApiRequestBody requestBody)
      Creates an instance of a OpenApiOperation 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
      tags - the value for the tags record component
      parameters - the value for the parameters record component
      responses - the value for the responses record component
      requestBody - the value for the requestBody record component

  • Method Details

    • of

      public static OpenApiOperation of(String operationId, String summary)

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

    • 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

    • tags

      public List<String> tags()
      Returns the value of the tags record component.
      Returns:
      the value of the tags record component

    • parameters

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

    • responses

      public Map<String,OpenApiResponse> responses()
      Returns the value of the responses record component.
      Returns:
      the value of the responses record component

    • requestBody

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