com.squareup.square.models

Class SearchCustomersResponse

java.lang.Object

com.squareup.square.models.SearchCustomersResponse

public class SearchCustomersResponse
extends Object

This is a model class for SearchCustomersResponse type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
SearchCustomersResponse(List<Error> errors, List<Customer> customers, String cursor) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
HttpContext	getContext()
String	getCursor() Getter for Cursor.
List<Customer>	getCustomers() Getter for Customers.
List<Error>	getErrors() Getter for Errors.
int	hashCode()
SearchCustomersResponse.Builder	toBuilder() Builds a new SearchCustomersResponse.Builder object.
String	toString() Converts this SearchCustomersResponse into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchCustomersResponse

public SearchCustomersResponse(List<Error> errors,
                               List<Customer> customers,
                               String cursor)

Initialization constructor.

Parameters:

errors - List of Error value for errors.

customers - List of Customer value for customers.

cursor - String value for cursor.

Method Detail

getContext

public HttpContext getContext()

getErrors

public List<Error> getErrors()

Getter for Errors. Any errors that occurred during the request.

Returns:

Returns the List of Error

getCustomers

public List<Customer> getCustomers()

Getter for Customers. An array of `Customer` objects that match a query.

Returns:

Returns the List of Customer

getCursor

public String getCursor()

Getter for Cursor. A pagination cursor that can be used during subsequent calls to `SearchCustomers` to retrieve the next set of results associated with the original query. Pagination cursors are only present when a request succeeds and additional results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

Returns:

Returns the String

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 SearchCustomersResponse into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public SearchCustomersResponse.Builder toBuilder()

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

Returns:

a new SearchCustomersResponse.Builder object