com.squareup.square.models

Class SearchCatalogItemsRequest

java.lang.Object

com.squareup.square.models.SearchCatalogItemsRequest

public class SearchCatalogItemsRequest
extends Object

This is a model class for SearchCatalogItemsRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
SearchCatalogItemsRequest(String textFilter, List<String> categoryIds, List<String> stockLevels, List<String> enabledLocationIds, String cursor, Integer limit, String sortOrder, List<String> productTypes, List<CustomAttributeFilter> customAttributeFilters) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<String>	getCategoryIds() Getter for CategoryIds.
String	getCursor() Getter for Cursor.
List<CustomAttributeFilter>	getCustomAttributeFilters() Getter for CustomAttributeFilters.
List<String>	getEnabledLocationIds() Getter for EnabledLocationIds.
Integer	getLimit() Getter for Limit.
List<String>	getProductTypes() Getter for ProductTypes.
String	getSortOrder() Getter for SortOrder.
List<String>	getStockLevels() Getter for StockLevels.
String	getTextFilter() Getter for TextFilter.
int	hashCode()
SearchCatalogItemsRequest.Builder	toBuilder() Builds a new SearchCatalogItemsRequest.Builder object.
String	toString() Converts this SearchCatalogItemsRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchCatalogItemsRequest

public SearchCatalogItemsRequest(String textFilter,
                                 List<String> categoryIds,
                                 List<String> stockLevels,
                                 List<String> enabledLocationIds,
                                 String cursor,
                                 Integer limit,
                                 String sortOrder,
                                 List<String> productTypes,
                                 List<CustomAttributeFilter> customAttributeFilters)

Initialization constructor.

Parameters:

textFilter - String value for textFilter.

categoryIds - List of String value for categoryIds.

stockLevels - List of String value for stockLevels.

enabledLocationIds - List of String value for enabledLocationIds.

cursor - String value for cursor.

limit - Integer value for limit.

sortOrder - String value for sortOrder.

productTypes - List of String value for productTypes.

customAttributeFilters - List of CustomAttributeFilter value for customAttributeFilters.

Method Detail

getTextFilter

public String getTextFilter()

Getter for TextFilter. The text filter expression to return items or item variations containing specified text in the `name`, `description`, or `abbreviation` attribute value of an item, or in the `name`, `sku`, or `upc` attribute value of an item variation.

Returns:

Returns the String

getCategoryIds

public List<String> getCategoryIds()

Getter for CategoryIds. The category id query expression to return items containing the specified category IDs.

Returns:

Returns the List of String

getStockLevels

public List<String> getStockLevels()

Getter for StockLevels. The stock-level query expression to return item variations with the specified stock levels. See [SearchCatalogItemsRequestStockLevel](#type-searchcatalogitemsrequeststocklevel) for possible values

Returns:

Returns the List of String

getEnabledLocationIds

public List<String> getEnabledLocationIds()

Getter for EnabledLocationIds. The enabled-location query expression to return items and item variations having specified enabled locations.

Returns:

Returns the List of String

getCursor

public String getCursor()

Getter for Cursor. The pagination token, returned in the previous response, used to fetch the next batch of pending results.

Returns:

Returns the String

getLimit

public Integer getLimit()

Getter for Limit. The maximum number of results to return per page. The default value is 100.

Returns:

Returns the Integer

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

getProductTypes

public List<String> getProductTypes()

Getter for ProductTypes. The product types query expression to return items or item variations having the specified product types.

Returns:

Returns the List of String

getCustomAttributeFilters

public List<CustomAttributeFilter> getCustomAttributeFilters()

Getter for CustomAttributeFilters. The customer-attribute filter to return items or item variations matching the specified custom attribute expressions. A maximum number of 10 custom attribute expressions are supported in a single call to the [SearchCatalogItems]($e/Catalog/SearchCatalogItems) endpoint.

Returns:

Returns the List of CustomAttributeFilter

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public SearchCatalogItemsRequest.Builder toBuilder()

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

Returns:

a new SearchCatalogItemsRequest.Builder object