Record Class CatalogSearchPagination

java.lang.Object
java.lang.Record
com.github.copilot.generated.rpc.CatalogSearchPagination

@Generated("copilot-sdk-codegen") public record CatalogSearchPagination(String token, Long currentPage, Long pageSize, Long totalCount, CatalogSearchTotalCountRelation totalCountRelation, Long pageCount, Long maxPage, Boolean hasNextPage) extends Record
Authority-reported navigation metadata, returned only to callers requiring catalog-search-pagination and only when a supported token is present. Tokenless first-page and continuation responses omit this object; no counts are inferred from candidates. The opaque token may be retained for previous or numbered navigation even when hasNextPage is false.
Since:
1.0.0
  • Constructor Details

    • CatalogSearchPagination

      public CatalogSearchPagination(String token, Long currentPage, Long pageSize, Long totalCount, CatalogSearchTotalCountRelation totalCountRelation, Long pageCount, Long maxPage, Boolean hasNextPage)
      Creates an instance of a CatalogSearchPagination record class.
      Parameters:
      token - the value for the token record component
      currentPage - the value for the currentPage record component
      pageSize - the value for the pageSize record component
      totalCount - the value for the totalCount record component
      totalCountRelation - the value for the totalCountRelation record component
      pageCount - the value for the pageCount record component
      maxPage - the value for the maxPage record component
      hasNextPage - the value for the hasNextPage 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. 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.
    • token

      public String token()
      Returns the value of the token record component.
      Returns:
      the value of the token record component
    • currentPage

      public Long currentPage()
      Returns the value of the currentPage record component.
      Returns:
      the value of the currentPage record component
    • pageSize

      public Long pageSize()
      Returns the value of the pageSize record component.
      Returns:
      the value of the pageSize record component
    • totalCount

      public Long totalCount()
      Returns the value of the totalCount record component.
      Returns:
      the value of the totalCount record component
    • totalCountRelation

      public CatalogSearchTotalCountRelation totalCountRelation()
      Returns the value of the totalCountRelation record component.
      Returns:
      the value of the totalCountRelation record component
    • pageCount

      public Long pageCount()
      Returns the value of the pageCount record component.
      Returns:
      the value of the pageCount record component
    • maxPage

      public Long maxPage()
      Returns the value of the maxPage record component.
      Returns:
      the value of the maxPage record component
    • hasNextPage

      public Boolean hasNextPage()
      Returns the value of the hasNextPage record component.
      Returns:
      the value of the hasNextPage record component