Record Class IdA1AdminSearchParameters
java.lang.Object
java.lang.Record
com.io7m.idstore.protocol.admin.cb.IdA1AdminSearchParameters
- Record Components:
fieldTimeCreatedRange
- The range of creation times for returned admins.fieldTimeUpdatedRange
- The range of update times for returned admins.fieldSearch
- The search query text.fieldOrdering
- The result ordering.fieldLimit
- The limit on the number of results.
- All Implemented Interfaces:
com.io7m.cedarbridge.runtime.api.CBSerializableType
public record IdA1AdminSearchParameters(IdA1TimeRange fieldTimeCreatedRange, IdA1TimeRange fieldTimeUpdatedRange, com.io7m.cedarbridge.runtime.api.CBOptionType<com.io7m.cedarbridge.runtime.api.CBString> fieldSearch, IdA1AdminColumnOrdering fieldOrdering, com.io7m.cedarbridge.runtime.api.CBIntegerUnsigned16 fieldLimit)
extends Record
implements com.io7m.cedarbridge.runtime.api.CBSerializableType
Search parameters for admins.
-
Constructor Summary
ConstructorDescriptionIdA1AdminSearchParameters
(IdA1TimeRange fieldTimeCreatedRange, IdA1TimeRange fieldTimeUpdatedRange, com.io7m.cedarbridge.runtime.api.CBOptionType<com.io7m.cedarbridge.runtime.api.CBString> fieldSearch, IdA1AdminColumnOrdering fieldOrdering, com.io7m.cedarbridge.runtime.api.CBIntegerUnsigned16 fieldLimit) Creates an instance of aIdA1AdminSearchParameters
record class. -
Method Summary
Modifier and TypeMethodDescriptionstatic IdA1AdminSearchParameters
deserialize
(com.io7m.cedarbridge.runtime.api.CBSerializationContextType $context) Deserialize a value of type IdA1AdminSearchParameters.final boolean
Indicates whether some other object is "equal to" this one.com.io7m.cedarbridge.runtime.api.CBIntegerUnsigned16
Returns the value of thefieldLimit
record component.Returns the value of thefieldOrdering
record component.com.io7m.cedarbridge.runtime.api.CBOptionType
<com.io7m.cedarbridge.runtime.api.CBString> Returns the value of thefieldSearch
record component.Returns the value of thefieldTimeCreatedRange
record component.Returns the value of thefieldTimeUpdatedRange
record component.final int
hashCode()
Returns a hash code value for this object.static void
serialize
(com.io7m.cedarbridge.runtime.api.CBSerializationContextType $context, IdA1AdminSearchParameters $x) Serialize a value of type IdA1AdminSearchParameters.final String
toString()
Returns a string representation of this record class.
-
Constructor Details
-
IdA1AdminSearchParameters
public IdA1AdminSearchParameters(IdA1TimeRange fieldTimeCreatedRange, IdA1TimeRange fieldTimeUpdatedRange, com.io7m.cedarbridge.runtime.api.CBOptionType<com.io7m.cedarbridge.runtime.api.CBString> fieldSearch, IdA1AdminColumnOrdering fieldOrdering, com.io7m.cedarbridge.runtime.api.CBIntegerUnsigned16 fieldLimit) Creates an instance of aIdA1AdminSearchParameters
record class.- Parameters:
fieldTimeCreatedRange
- the value for thefieldTimeCreatedRange
record componentfieldTimeUpdatedRange
- the value for thefieldTimeUpdatedRange
record componentfieldSearch
- the value for thefieldSearch
record componentfieldOrdering
- the value for thefieldOrdering
record componentfieldLimit
- the value for thefieldLimit
record component
-
-
Method Details
-
serialize
public static void serialize(com.io7m.cedarbridge.runtime.api.CBSerializationContextType $context, IdA1AdminSearchParameters $x) throws IOException Serialize a value of type IdA1AdminSearchParameters.- Parameters:
$context
- The serialization context.$x
- The value to be serialized.- Throws:
IOException
-
deserialize
public static IdA1AdminSearchParameters deserialize(com.io7m.cedarbridge.runtime.api.CBSerializationContextType $context) throws IOException Deserialize a value of type IdA1AdminSearchParameters.- Parameters:
$context
- The serialization context.- Returns:
- A value of type IdA1AdminSearchParameters.
- 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)
. -
fieldTimeCreatedRange
Returns the value of thefieldTimeCreatedRange
record component.- Returns:
- the value of the
fieldTimeCreatedRange
record component
-
fieldTimeUpdatedRange
Returns the value of thefieldTimeUpdatedRange
record component.- Returns:
- the value of the
fieldTimeUpdatedRange
record component
-
fieldSearch
public com.io7m.cedarbridge.runtime.api.CBOptionType<com.io7m.cedarbridge.runtime.api.CBString> fieldSearch()Returns the value of thefieldSearch
record component.- Returns:
- the value of the
fieldSearch
record component
-
fieldOrdering
Returns the value of thefieldOrdering
record component.- Returns:
- the value of the
fieldOrdering
record component
-
fieldLimit
public com.io7m.cedarbridge.runtime.api.CBIntegerUnsigned16 fieldLimit()Returns the value of thefieldLimit
record component.- Returns:
- the value of the
fieldLimit
record component
-