com.mailgun.model.PagingWithPivot Maven / Gradle / Ivy

Go to download
package com.mailgun.model;

import com.mailgun.enums.Page;
import feign.Param;
import lombok.Builder;
import lombok.Value;
import lombok.extern.jackson.Jacksonized;

/**
 * 
 * Template page request.
 * 
 *
 * @see Templates
 */
@Value
@Jacksonized
@Builder
public class PagingWithPivot {

    /**
     * 
     * Number of records to retrieve.
     * Default value is 10.
     * 
     */
    Integer limit;

    /**
     * 
     * Name of a page to retrieve.
     * FIRST, LAST, NEXT or PREV.
     * 
     */
    String page;

    /**
     * 
     * Pivot is used to retrieve records in chronological order.
     * 
     */
    @Param("p")
    String pivot;

    public static class PagingWithPivotBuilder {

        /**
         * 
         * Name of a page to retrieve.
         * FIRST, LAST, NEXT or PREV.
         * 
         *
         * @param page {@link Page}
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        public PagingWithPivot.PagingWithPivotBuilder page(Page page) {
            this.page = page.getValue();
            return this;
        }
    }

}