Record Class NuggetAdminQuery.Page

java.lang.Object
java.lang.Record
org.j7m.middleware.operations.api.NuggetAdminQuery.Page
Record Components:
offset - zero-based offset used by the response
limit - requested page limit
returned - number of records returned in this response
totalAvailable - total matching records when authorized and known
totalAvailableAuthorized - whether totalAvailable may be disclosed to this caller
partial - whether optional provider data is partial
truncated - whether the response was truncated by public hard bounds
collectedAt - collection timestamp
metadata - safe page metadata in schema-visible order
Enclosing class:
NuggetAdminQuery
public static record NuggetAdminQuery.Page(long offset, int limit, int returned, long totalAvailable, boolean totalAvailableAuthorized, boolean partial, boolean truncated, Instant collectedAt, Map<String,String> metadata) extends Record
Public collection page metadata.

  • Constructor Details

    • Page

      public Page(long offset, int limit, int returned, long totalAvailable, boolean totalAvailableAuthorized, boolean partial, boolean truncated, Instant collectedAt, Map<String,String> metadata)
      Creates validated page metadata.

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

    • offset

      public long offset()
      Returns the value of the offset record component.
      Returns:
      the value of the offset record component

    • limit

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

    • returned

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

    • totalAvailable

      public long totalAvailable()
      Returns the value of the totalAvailable record component.
      Returns:
      the value of the totalAvailable record component

    • totalAvailableAuthorized

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

    • partial

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

    • truncated

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

    • collectedAt

      public Instant collectedAt()
      Returns the value of the collectedAt record component.
      Returns:
      the value of the collectedAt record component

    • metadata

      public Map<String,String> metadata()
      Returns the value of the metadata record component.
      Returns:
      the value of the metadata record component