Record Class ApiController.StopResponse

java.lang.Object
java.lang.Record
com.knezevic.edaf.v3.web.controller.ApiController.StopResponse
Enclosing class:
ApiController
public static record ApiController.StopResponse(String scope, String targetId, boolean accepted, int affectedRuns, String message) extends Record
API payload for stop request result.

  • Constructor Summary

    Constructors
    Constructor
    Description
    StopResponse(String scope, String targetId, boolean accepted, int affectedRuns, String message)
    Creates an instance of a StopResponse record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    accepted()
    Returns the value of the accepted record component.
    int
    affectedRuns()
    Returns the value of the affectedRuns record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    message()
    Returns the value of the message record component.
    String
    scope()
    Returns the value of the scope record component.
    String
    targetId()
    Returns the value of the targetId record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • StopResponse

      public StopResponse(String scope, String targetId, boolean accepted, int affectedRuns, String message)
      Creates an instance of a StopResponse record class.
      Parameters:
      scope - the value for the scope record component
      targetId - the value for the targetId record component
      accepted - the value for the accepted record component
      affectedRuns - the value for the affectedRuns record component
      message - the value for the message 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.

    • scope

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

    • targetId

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

    • accepted

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

    • affectedRuns

      public int affectedRuns()
      Returns the value of the affectedRuns record component.
      Returns:
      the value of the affectedRuns record component

    • message

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