Record Class MailpitSetReadStatusRequest

java.lang.Object
java.lang.Record
io.micronaut.email.mailpit.client.model.MailpitSetReadStatusRequest
Record Components:
ids - Optional message IDs.
read - Read status.
search - Optional search query.
public record MailpitSetReadStatusRequest(@Nullable List<String> ids, boolean read, @Nullable String search) extends Record
Request to set read status for messages.
Since:
3.1.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    MailpitSetReadStatusRequest(@Nullable List<String> ids, boolean read, @Nullable String search)
    Creates an instance of a MailpitSetReadStatusRequest record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    @Nullable List<String>
    ids()
    Returns the value of the ids record component.
    boolean
    read()
    Returns the value of the read record component.
    @Nullable String
    search()
    Returns the value of the search record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • MailpitSetReadStatusRequest

      public MailpitSetReadStatusRequest(@Nullable List<String> ids, boolean read, @Nullable String search)
      Creates an instance of a MailpitSetReadStatusRequest record class.
      Parameters:
      ids - the value for the ids record component
      read - the value for the read record component
      search - the value for the search 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.

    • ids

      public @Nullable List<String> ids()
      Returns the value of the ids record component.
      Returns:
      the value of the ids record component

    • read

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

    • search

      public @Nullable String search()
      Returns the value of the search record component.
      Returns:
      the value of the search record component