Class Pagination

  • All Implemented Interfaces:

    @JsonClass(generateAdapter = true) 
    public final class Pagination
    
                        
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      final Long getCount() The number of objects in the entries array.
      final Unit setCount(@Json(name = "count") Long count) The number of objects in the entries array.
      final Boolean getHasMoreItems() A boolean value which is true if there are more entities in the collection beyond those in this response.
      final Unit setHasMoreItems(@Json(name = "hasMoreItems") Boolean hasMoreItems) A boolean value which is true if there are more entities in the collection beyond those in this response.
      final Long getSkipCount() An integer describing how many entities exist in the collection before those included in this list.
      final Unit setSkipCount(@Json(name = "skipCount") Long skipCount) An integer describing how many entities exist in the collection before those included in this list.
      final Long getMaxItems() The value of the maxItems parameter used to generate this list.
      final Unit setMaxItems(@Json(name = "maxItems") Long maxItems) The value of the maxItems parameter used to generate this list.
      final Long getTotalItems() An integer describing the total number of entities in the collection.
      final Unit setTotalItems(@Json(name = "totalItems") Long totalItems) An integer describing the total number of entities in the collection.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • getCount

         final Long getCount()

        The number of objects in the entries array.

      • setCount

         final Unit setCount(@Json(name = "count") Long count)

        The number of objects in the entries array.

      • getHasMoreItems

         final Boolean getHasMoreItems()

        A boolean value which is true if there are more entities in the collection beyond those in this response. A true value means a request with a larger value for the skipCount or the maxItems parameter will return more entities.

      • setHasMoreItems

         final Unit setHasMoreItems(@Json(name = "hasMoreItems") Boolean hasMoreItems)

        A boolean value which is true if there are more entities in the collection beyond those in this response. A true value means a request with a larger value for the skipCount or the maxItems parameter will return more entities.

      • getSkipCount

         final Long getSkipCount()

        An integer describing how many entities exist in the collection before those included in this list. If there was no skipCount parameter then the default value is 0.

      • setSkipCount

         final Unit setSkipCount(@Json(name = "skipCount") Long skipCount)

        An integer describing how many entities exist in the collection before those included in this list. If there was no skipCount parameter then the default value is 0.

      • getMaxItems

         final Long getMaxItems()

        The value of the maxItems parameter used to generate this list. If there was no maxItems parameter then the default value is 100.

      • setMaxItems

         final Unit setMaxItems(@Json(name = "maxItems") Long maxItems)

        The value of the maxItems parameter used to generate this list. If there was no maxItems parameter then the default value is 100.

      • getTotalItems

         final Long getTotalItems()

        An integer describing the total number of entities in the collection. The API might not be able to determine this value, in which case this property will not be present.

      • setTotalItems

         final Unit setTotalItems(@Json(name = "totalItems") Long totalItems)

        An integer describing the total number of entities in the collection. The API might not be able to determine this value, in which case this property will not be present.