com.squareup.square.models

Class ListCustomersRequest

java.lang.Object

com.squareup.square.models.ListCustomersRequest

public class ListCustomersRequest
extends Object

This is a model class for ListCustomersRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ListCustomersRequest(io.apimatic.core.types.OptionalNullable<String> cursor, io.apimatic.core.types.OptionalNullable<Integer> limit, String sortField, String sortOrder, io.apimatic.core.types.OptionalNullable<Boolean> count) Initialization constructor.
	ListCustomersRequest(String cursor, Integer limit, String sortField, String sortOrder, Boolean count) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Boolean	getCount() Getter for Count.
String	getCursor() Getter for Cursor.
Integer	getLimit() Getter for Limit.
String	getSortField() Getter for SortField.
String	getSortOrder() Getter for SortOrder.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<Boolean>	internalGetCount() Internal Getter for Count.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetCursor() Internal Getter for Cursor.
protected io.apimatic.core.types.OptionalNullable<Integer>	internalGetLimit() Internal Getter for Limit.
ListCustomersRequest.Builder	toBuilder() Builds a new ListCustomersRequest.Builder object.
String	toString() Converts this ListCustomersRequest into string format.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListCustomersRequest

public ListCustomersRequest(String cursor,
                            Integer limit,
                            String sortField,
                            String sortOrder,
                            Boolean count)

Initialization constructor.

Parameters:

cursor - String value for cursor.

limit - Integer value for limit.

sortField - String value for sortField.

sortOrder - String value for sortOrder.

count - Boolean value for count.

ListCustomersRequest

protected ListCustomersRequest(io.apimatic.core.types.OptionalNullable<String> cursor,
                               io.apimatic.core.types.OptionalNullable<Integer> limit,
                               String sortField,
                               String sortOrder,
                               io.apimatic.core.types.OptionalNullable<Boolean> count)

Initialization constructor.

Parameters:

cursor - String value for cursor.

limit - Integer value for limit.

sortField - String value for sortField.

sortOrder - String value for sortOrder.

count - Boolean value for count.

Method Detail

internalGetCursor

protected io.apimatic.core.types.OptionalNullable<String> internalGetCursor()

Internal Getter for Cursor. A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for your original query. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

Returns:

Returns the Internal String

getCursor

public String getCursor()

Getter for Cursor. A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for your original query. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

Returns:

Returns the String

internalGetLimit

protected io.apimatic.core.types.OptionalNullable<Integer> internalGetLimit()

Internal Getter for Limit. The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. If the specified limit is less than 1 or greater than 100, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 100. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

Returns:

Returns the Internal Integer

getLimit

public Integer getLimit()

Getter for Limit. The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. If the specified limit is less than 1 or greater than 100, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 100. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

Returns:

Returns the Integer

getSortField

public String getSortField()

Getter for SortField. Specifies customer attributes as the sort key to customer profiles returned from a search.

Returns:

Returns the String

getSortOrder

public String getSortOrder()

Getter for SortOrder. The order (e.g., chronological or alphabetical) in which results from a request are returned.

Returns:

Returns the String

internalGetCount

protected io.apimatic.core.types.OptionalNullable<Boolean> internalGetCount()

Internal Getter for Count. Indicates whether to return the total count of customers in the `count` field of the response. The default value is `false`.

Returns:

Returns the Internal Boolean

getCount

public Boolean getCount()

Getter for Count. Indicates whether to return the total count of customers in the `count` field of the response. The default value is `false`.

Returns:

Returns the Boolean

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Converts this ListCustomersRequest into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public ListCustomersRequest.Builder toBuilder()

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

Returns:

a new ListCustomersRequest.Builder object