Package com.arc_e_tect.gradle.apionly.transcriberj.model

Record Class AsyncOperation

java.lang.Object
java.lang.Record
com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncOperation
Record Components:
operationId - its key under operations, which AsyncAPI 3 makes the operation's id
action - action: send or receive
channelKey - the key of the channel it acts on, or null when the document does not point at one this model understands
messageKeys - the keys of the channel's messages it names, in order; empty when it names none, which means every message of the channel
summary - summary, or null
description - description, or null
location - the JSON pointer of the operation in its document
public record AsyncOperation(String operationId, String action, String channelKey, List<String> messageKeys, String summary, String description, String location) extends Record
An operation of an AsyncAPI contract: an application sending or receiving on a channel.

  • Constructor Details

    • AsyncOperation

      public AsyncOperation(String operationId, String action, String channelKey, List<String> messageKeys, String summary, String description, String location)
      Creates an instance of a AsyncOperation record class.
      Parameters:
      operationId - the value for the operationId record component
      action - the value for the action record component
      channelKey - the value for the channelKey record component
      messageKeys - the value for the messageKeys record component
      summary - the value for the summary record component
      description - the value for the description record component
      location - the value for the location 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. 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

    • action

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

    • channelKey

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

    • messageKeys

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

    • location

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