Record Class IdU1CommandLogin
java.lang.Object
java.lang.Record
com.io7m.idstore.protocol.user.cb.IdU1CommandLogin
- Record Components:
fieldUserName
- The username.fieldPassword
- The password.fieldMetadata
- Extra metadata included with the login request.
- All Implemented Interfaces:
com.io7m.cedarbridge.runtime.api.CBProtocolMessageType
,com.io7m.cedarbridge.runtime.api.CBSerializableType
,ProtocolIdUType
,ProtocolIdUv1Type
public record IdU1CommandLogin(com.io7m.cedarbridge.runtime.api.CBString fieldUserName, com.io7m.cedarbridge.runtime.api.CBString fieldPassword, com.io7m.cedarbridge.runtime.api.CBMap<com.io7m.cedarbridge.runtime.api.CBString,com.io7m.cedarbridge.runtime.api.CBString> fieldMetadata)
extends Record
implements com.io7m.cedarbridge.runtime.api.CBSerializableType, ProtocolIdUv1Type
A request to log in.
-
Constructor Summary
ConstructorDescriptionIdU1CommandLogin
(com.io7m.cedarbridge.runtime.api.CBString fieldUserName, com.io7m.cedarbridge.runtime.api.CBString fieldPassword, com.io7m.cedarbridge.runtime.api.CBMap<com.io7m.cedarbridge.runtime.api.CBString, com.io7m.cedarbridge.runtime.api.CBString> fieldMetadata) Creates an instance of aIdU1CommandLogin
record class. -
Method Summary
Modifier and TypeMethodDescriptionstatic IdU1CommandLogin
deserialize
(com.io7m.cedarbridge.runtime.api.CBSerializationContextType $context) Deserialize a value of type IdU1CommandLogin.final boolean
Indicates whether some other object is "equal to" this one.com.io7m.cedarbridge.runtime.api.CBMap
<com.io7m.cedarbridge.runtime.api.CBString, com.io7m.cedarbridge.runtime.api.CBString> Returns the value of thefieldMetadata
record component.com.io7m.cedarbridge.runtime.api.CBString
Returns the value of thefieldPassword
record component.com.io7m.cedarbridge.runtime.api.CBString
Returns the value of thefieldUserName
record component.final int
hashCode()
Returns a hash code value for this object.static void
serialize
(com.io7m.cedarbridge.runtime.api.CBSerializationContextType $context, IdU1CommandLogin $x) Serialize a value of type IdU1CommandLogin.final String
toString()
Returns a string representation of this record class.
-
Constructor Details
-
IdU1CommandLogin
public IdU1CommandLogin(com.io7m.cedarbridge.runtime.api.CBString fieldUserName, com.io7m.cedarbridge.runtime.api.CBString fieldPassword, com.io7m.cedarbridge.runtime.api.CBMap<com.io7m.cedarbridge.runtime.api.CBString, com.io7m.cedarbridge.runtime.api.CBString> fieldMetadata) Creates an instance of aIdU1CommandLogin
record class.- Parameters:
fieldUserName
- the value for thefieldUserName
record componentfieldPassword
- the value for thefieldPassword
record componentfieldMetadata
- the value for thefieldMetadata
record component
-
-
Method Details
-
serialize
public static void serialize(com.io7m.cedarbridge.runtime.api.CBSerializationContextType $context, IdU1CommandLogin $x) throws IOException Serialize a value of type IdU1CommandLogin.- Parameters:
$context
- The serialization context.$x
- The value to be serialized.- Throws:
IOException
-
deserialize
public static IdU1CommandLogin deserialize(com.io7m.cedarbridge.runtime.api.CBSerializationContextType $context) throws IOException Deserialize a value of type IdU1CommandLogin.- Parameters:
$context
- The serialization context.- Returns:
- A value of type IdU1CommandLogin.
- Throws:
IOException
-
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. -
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. -
equals
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 withObjects::equals(Object,Object)
. -
fieldUserName
public com.io7m.cedarbridge.runtime.api.CBString fieldUserName()Returns the value of thefieldUserName
record component.- Returns:
- the value of the
fieldUserName
record component
-
fieldPassword
public com.io7m.cedarbridge.runtime.api.CBString fieldPassword()Returns the value of thefieldPassword
record component.- Returns:
- the value of the
fieldPassword
record component
-
fieldMetadata
public com.io7m.cedarbridge.runtime.api.CBMap<com.io7m.cedarbridge.runtime.api.CBString,com.io7m.cedarbridge.runtime.api.CBString> fieldMetadata()Returns the value of thefieldMetadata
record component.- Returns:
- the value of the
fieldMetadata
record component
-