Interface PaginatedResponse

All Known Subinterfaces:
DiffResponse, EntriesResponse, LogResponse, ReferencesResponse, RefLogResponse

public interface PaginatedResponse
  • Method Summary

    Modifier and Type
    Method
    Description
    @Size @Size(min=1) String
    Pass this value to the next invocation of the API function to get the next page of results.
    default boolean
    Whether there are more result-items than returned by this response object.
  • Method Details

    • isHasMore

      @Default default boolean isHasMore()
      Whether there are more result-items than returned by this response object.

      If there are more result-items, the value returned by getToken() can be used in the next invocation to get the next "page" of results.

      Returns:
      true, if there are more result items.
    • getToken

      @Nullable @Nullable @Size @Size(min=1) @Size @Size(min=1) String getToken()
      Pass this value to the next invocation of the API function to get the next page of results.

      Paging tokens are opaque and the structure may change without prior notice even in patch releases.

      Returns:
      paging continuation token for the next invocation of an API function supporting pagination, if isHasMore() is true. Undefined, if isHasMore() is false.