com.squareup.square.models

Class ListCatalogRequest

java.lang.Object

com.squareup.square.models.ListCatalogRequest

public class ListCatalogRequest
extends Object

This is a model class for ListCatalogRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
ListCatalogRequest(String cursor, String types, Long catalogVersion) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Long	getCatalogVersion() Getter for CatalogVersion.
String	getCursor() Getter for Cursor.
String	getTypes() Getter for Types.
int	hashCode()
ListCatalogRequest.Builder	toBuilder() Builds a new ListCatalogRequest.Builder object.
String	toString() Converts this ListCatalogRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListCatalogRequest

public ListCatalogRequest(String cursor,
                          String types,
                          Long catalogVersion)

Initialization constructor.

Parameters:

cursor - String value for cursor.

types - String value for types.

catalogVersion - Long value for catalogVersion.

Method Detail

getCursor

public String getCursor()

Getter for Cursor. The pagination cursor returned in the previous response. Leave unset for an initial request. The page size is currently set to be 100. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.

Returns:

Returns the String

getTypes

public String getTypes()

Getter for Types. An optional case-insensitive, comma-separated list of object types to retrieve. The valid values are defined in the [CatalogObjectType]($m/CatalogObjectType) enum, for example, `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc. If this is unspecified, the operation returns objects of all the top level types at the version of the Square API used to make the request. Object types that are nested onto other object types are not included in the defaults. At the current API version the default object types are: ITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, DINING_OPTION, TAX_EXEMPTION, SERVICE_CHARGE, PRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT, SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS.

Returns:

Returns the String

getCatalogVersion

public Long getCatalogVersion()

Getter for CatalogVersion. The specific version of the catalog objects to be included in the response. This allows you to retrieve historical versions of objects. The specified version value is matched against the [CatalogObject]($m/CatalogObject)s' `version` attribute. If not included, results will be from the current version of the catalog.

Returns:

Returns the Long

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public ListCatalogRequest.Builder toBuilder()

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

Returns:

a new ListCatalogRequest.Builder object