Package com.io7m.idstore.protocol.admin.cb

# Record Class IdA1ResponseUserSearchBegin

java.lang.Object
java.lang.Record
com.io7m.idstore.protocol.admin.cb.IdA1ResponseUserSearchBegin

Record Components:
  `fieldRequestId` - The ID of the request that yielded this response.
  `fieldPage` - The first page of results.

All Implemented Interfaces:
  `com.io7m.cedarbridge.runtime.api.CBProtocolMessageType`, `com.io7m.cedarbridge.runtime.api.CBSerializableType`, `ProtocolIdA1Type`, `ProtocolIdA1v1Type`

public record IdA1ResponseUserSearchBegin(com.io7m.cedarbridge.runtime.api.CBUUID fieldRequestId, IdA1Page<IdA1UserSummary> fieldPage) extends Record implements com.io7m.cedarbridge.runtime.api.CBSerializableType, ProtocolIdA1v1Type
A response to IdA1CommandUserSearchBegin.

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `IdA1ResponseUserSearchBegin(com.io7m.cedarbridge.runtime.api.CBUUID fieldRequestId, IdA1Page<IdA1UserSummary> fieldPage)`
  Creates an instance of a `IdA1ResponseUserSearchBegin` record class.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `static IdA1ResponseUserSearchBegin`
  `deserialize(com.io7m.cedarbridge.runtime.api.CBSerializationContextType $context)`
  Deserialize a value of type IdA1ResponseUserSearchBegin.
  `final boolean`
  `equals(Object o)`
  Indicates whether some other object is "equal to" this one.
  `IdA1Page<IdA1UserSummary>`
  `fieldPage()`
  Returns the value of the `fieldPage` record component.
  `com.io7m.cedarbridge.runtime.api.CBUUID`
  `fieldRequestId()`
  Returns the value of the `fieldRequestId` record component.
  `final int`
  `hashCode()`
  Returns a hash code value for this object.
  `static void`
  `serialize(com.io7m.cedarbridge.runtime.api.CBSerializationContextType $context, IdA1ResponseUserSearchBegin $x)`
  Serialize a value of type IdA1ResponseUserSearchBegin.
  `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

  - ### IdA1ResponseUserSearchBegin

    public IdA1ResponseUserSearchBegin(com.io7m.cedarbridge.runtime.api.CBUUID fieldRequestId, IdA1Page<IdA1UserSummary> fieldPage)
    Creates an instance of a `IdA1ResponseUserSearchBegin` record class.
    Parameters:
      `fieldRequestId` - the value for the `fieldRequestId` record component
      `fieldPage` - the value for the `fieldPage` record component

- ## Method Details

  - ### serialize

    public static void serialize(com.io7m.cedarbridge.runtime.api.CBSerializationContextType $context, IdA1ResponseUserSearchBegin $x) throws IOException
    Serialize a value of type IdA1ResponseUserSearchBegin.
    Parameters:
      `$context` - The serialization context.
      `$x` - The value to be serialized.
    Throws:
      `IOException`

  - ### deserialize

    public static IdA1ResponseUserSearchBegin deserialize(com.io7m.cedarbridge.runtime.api.CBSerializationContextType $context) throws IOException
    Deserialize a value of type IdA1ResponseUserSearchBegin.
    Parameters:
      `$context` - The serialization context.
    Returns:
      A value of type IdA1ResponseUserSearchBegin.
    Throws:
      `IOException`

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

  - ### fieldRequestId

    public com.io7m.cedarbridge.runtime.api.CBUUID fieldRequestId()
    Returns the value of the `fieldRequestId` record component.
    Returns:
      the value of the `fieldRequestId` record component

  - ### fieldPage

    public IdA1Page<IdA1UserSummary> fieldPage()
    Returns the value of the `fieldPage` record component.
    Returns:
      the value of the `fieldPage` record component