com.squareup.square.models

Class SearchCustomersRequest

java.lang.Object

com.squareup.square.models.SearchCustomersRequest

public class SearchCustomersRequest
extends Object

This is a model class for SearchCustomersRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
SearchCustomersRequest(String cursor, Long limit, CustomerQuery query, 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.
Long	getLimit() Getter for Limit.
CustomerQuery	getQuery() Getter for Query.
int	hashCode()
SearchCustomersRequest.Builder	toBuilder() Builds a new SearchCustomersRequest.Builder object.
String	toString() Converts this SearchCustomersRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchCustomersRequest

public SearchCustomersRequest(String cursor,
                              Long limit,
                              CustomerQuery query,
                              Boolean count)

Initialization constructor.

Parameters:

cursor - String value for cursor.

limit - Long value for limit.

query - CustomerQuery value for query.

count - Boolean value for count.

Method Detail

getCursor

public String getCursor()

Getter for Cursor. Include the pagination cursor in subsequent calls to this endpoint to retrieve the next set of results associated with the original query. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

Returns:

Returns the String

getLimit

public Long 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 invalid, 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 Long

getQuery

public CustomerQuery getQuery()

Getter for Query. Represents filtering and sorting criteria for a [SearchCustomers]($e/Customers/SearchCustomers) request.

Returns:

Returns the CustomerQuery

getCount

public Boolean getCount()

Getter for Count. Indicates whether to return the total count of matching 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 SearchCustomersRequest into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public SearchCustomersRequest.Builder toBuilder()

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

Returns:

a new SearchCustomersRequest.Builder object