com.squareup.square.models

Class ListCustomerCustomAttributesRequest

java.lang.Object

com.squareup.square.models.ListCustomerCustomAttributesRequest

public class ListCustomerCustomAttributesRequest
extends Object

This is a model class for ListCustomerCustomAttributesRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
ListCustomerCustomAttributesRequest(Integer limit, String cursor, Boolean withDefinitions) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCursor() Getter for Cursor.
Integer	getLimit() Getter for Limit.
Boolean	getWithDefinitions() Getter for WithDefinitions.
int	hashCode()
ListCustomerCustomAttributesRequest.Builder	toBuilder() Builds a new ListCustomerCustomAttributesRequest.Builder object.
String	toString() Converts this ListCustomerCustomAttributesRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListCustomerCustomAttributesRequest

public ListCustomerCustomAttributesRequest(Integer limit,
                                           String cursor,
                                           Boolean withDefinitions)

Initialization constructor.

Parameters:

limit - Integer value for limit.

cursor - String value for cursor.

withDefinitions - Boolean value for withDefinitions.

Method Detail

getLimit

public Integer getLimit()

Getter for Limit. The maximum number of results to return in a single paged response. This limit is advisory. The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

Returns:

Returns the Integer

getCursor

public String getCursor()

Getter for Cursor. The cursor returned in the paged response from the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

Returns:

Returns the String

getWithDefinitions

public Boolean getWithDefinitions()

Getter for WithDefinitions. Indicates whether to return the [custom attribute definition]($m/CustomAttributeDefinition) in the `definition` field of each custom attribute. Set this parameter to `true` to get the name and description of each custom attribute, information about the data type, or other definition details. 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 ListCustomerCustomAttributesRequest into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public ListCustomerCustomAttributesRequest.Builder toBuilder()

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

Returns:

a new ListCustomerCustomAttributesRequest.Builder object