com.ringcentral.definitions.MessagingPagingInfo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ringcentral Show documentation

RingCentral Java SDK

There is a newer version: 3.2.1

package com.ringcentral.definitions;


/**
 * Information on paging
 */
public class MessagingPagingInfo {
    /**
     * Current page number. 1-indexed, so the first page is 1
     * by default. May be omitted if result is empty (because non-existent page
     * was specified or perPage=0 was requested)
     * Format: int32
     */
    public Long page;
    /**
     * Current page size, describes how many items are in each page.
     * Default value is 100. Maximum value is 1000. If perPage value in the request
     * is greater than 1000, the maximum value (1000) is applied
     * Format: int32
     */
    public Long perPage;
    /**
     * Zero-based number of the first element on the current page.
     * Omitted if the page is omitted or result is empty
     * Format: int32
     */
    public Long pageStart;
    /**
     * Zero-based index of the last element on the current page.
     * Omitted if the page is omitted or result is empty
     * Format: int32
     */
    public Long pageEnd;
    /**
     * Total number of pages in a dataset. May be omitted for
     * some resources due to performance reasons
     * Format: int32
     */
    public Long totalPages;
    /**
     * Total number of elements in a dataset. May be omitted for
     * some resource due to performance reasons
     * Format: int32
     */
    public Long totalElements;

    public MessagingPagingInfo page(Long page) {
        this.page = page;
        return this;
    }

    public MessagingPagingInfo perPage(Long perPage) {
        this.perPage = perPage;
        return this;
    }

    public MessagingPagingInfo pageStart(Long pageStart) {
        this.pageStart = pageStart;
        return this;
    }

    public MessagingPagingInfo pageEnd(Long pageEnd) {
        this.pageEnd = pageEnd;
        return this;
    }

    public MessagingPagingInfo totalPages(Long totalPages) {
        this.totalPages = totalPages;
        return this;
    }

    public MessagingPagingInfo totalElements(Long totalElements) {
        this.totalElements = totalElements;
        return this;
    }
}