com.paypal.sdk.models

Class ListBillingPlansInput

java.lang.Object

com.paypal.sdk.models.ListBillingPlansInput

public class ListBillingPlansInput
extends Object

This is a model class for ListBillingPlansInput type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListBillingPlansInput.Builder Class to build instances of ListBillingPlansInput.

Constructor Summary

Constructors

Constructor and Description
ListBillingPlansInput() Default constructor.
ListBillingPlansInput(String prefer, String productId, Integer pageSize, Integer page, Boolean totalRequired) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
Integer	getPage() Getter for Page.
Integer	getPageSize() Getter for PageSize.
String	getPrefer() Getter for Prefer.
String	getProductId() Getter for ProductId.
Boolean	getTotalRequired() Getter for TotalRequired.
void	setPage(Integer page) Setter for Page.
void	setPageSize(Integer pageSize) Setter for PageSize.
void	setPrefer(String prefer) Setter for Prefer.
void	setProductId(String productId) Setter for ProductId.
void	setTotalRequired(Boolean totalRequired) Setter for TotalRequired.
ListBillingPlansInput.Builder	toBuilder() Builds a new ListBillingPlansInput.Builder object.
String	toString() Converts this ListBillingPlansInput into string format.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ListBillingPlansInput

public ListBillingPlansInput()

Default constructor.

ListBillingPlansInput

public ListBillingPlansInput(String prefer,
                             String productId,
                             Integer pageSize,
                             Integer page,
                             Boolean totalRequired)

Initialization constructor.

Parameters:

prefer - String value for prefer.

productId - String value for productId.

pageSize - Integer value for pageSize.

page - Integer value for page.

totalRequired - Boolean value for totalRequired.

Method Detail

getPrefer

public String getPrefer()

Getter for Prefer. The preferred server response upon successful completion of the request. Value is: return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, name, description and HATEOAS links. return=representation. The server returns a complete resource representation, including the current state of the resource.

Returns:

Returns the String

setPrefer

public void setPrefer(String prefer)

Setter for Prefer. The preferred server response upon successful completion of the request. Value is: return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, name, description and HATEOAS links. return=representation. The server returns a complete resource representation, including the current state of the resource.

Parameters:

prefer - Value for String

getProductId

public String getProductId()

Getter for ProductId. Filters the response by a Product ID.

Returns:

Returns the String

setProductId

public void setProductId(String productId)

Setter for ProductId. Filters the response by a Product ID.

Parameters:

productId - Value for String

getPageSize

public Integer getPageSize()

Getter for PageSize. The number of items to return in the response.

Returns:

Returns the Integer

setPageSize

public void setPageSize(Integer pageSize)

Setter for PageSize. The number of items to return in the response.

Parameters:

pageSize - Value for Integer

getPage

public Integer getPage()

Getter for Page. A non-zero integer which is the start index of the entire list of items to return in the response. The combination of `page=1` and `page_size=20` returns the first 20 items. The combination of `page=2` and `page_size=20` returns the next 20 items.

Returns:

Returns the Integer

setPage

public void setPage(Integer page)

Setter for Page. A non-zero integer which is the start index of the entire list of items to return in the response. The combination of `page=1` and `page_size=20` returns the first 20 items. The combination of `page=2` and `page_size=20` returns the next 20 items.

Parameters:

page - Value for Integer

getTotalRequired

public Boolean getTotalRequired()

Getter for TotalRequired. Indicates whether to show the total count in the response.

Returns:

Returns the Boolean

setTotalRequired

public void setTotalRequired(Boolean totalRequired)

Setter for TotalRequired. Indicates whether to show the total count in the response.

Parameters:

totalRequired - Value for Boolean

toString

public String toString()

Converts this ListBillingPlansInput into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public ListBillingPlansInput.Builder toBuilder()

Builds a new ListBillingPlansInput.Builder object. Creates the instance with the state of the current model.

Returns:

a new ListBillingPlansInput.Builder object