com.squareup.square.models

Class SearchCatalogObjectsRequest

java.lang.Object

com.squareup.square.models.SearchCatalogObjectsRequest

public class SearchCatalogObjectsRequest
extends Object

This is a model class for SearchCatalogObjectsRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
SearchCatalogObjectsRequest(String cursor, List<String> objectTypes, Boolean includeDeletedObjects, Boolean includeRelatedObjects, String beginTime, CatalogQuery query, Integer limit) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getBeginTime() Getter for BeginTime.
String	getCursor() Getter for Cursor.
Boolean	getIncludeDeletedObjects() Getter for IncludeDeletedObjects.
Boolean	getIncludeRelatedObjects() Getter for IncludeRelatedObjects.
Integer	getLimit() Getter for Limit.
List<String>	getObjectTypes() Getter for ObjectTypes.
CatalogQuery	getQuery() Getter for Query.
int	hashCode()
SearchCatalogObjectsRequest.Builder	toBuilder() Builds a new SearchCatalogObjectsRequest.Builder object.
String	toString() Converts this SearchCatalogObjectsRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchCatalogObjectsRequest

public SearchCatalogObjectsRequest(String cursor,
                                   List<String> objectTypes,
                                   Boolean includeDeletedObjects,
                                   Boolean includeRelatedObjects,
                                   String beginTime,
                                   CatalogQuery query,
                                   Integer limit)

Initialization constructor.

Parameters:

cursor - String value for cursor.

objectTypes - List of String value for objectTypes.

includeDeletedObjects - Boolean value for includeDeletedObjects.

includeRelatedObjects - Boolean value for includeRelatedObjects.

beginTime - String value for beginTime.

query - CatalogQuery value for query.

limit - Integer value for limit.

Method Detail

getCursor

public String getCursor()

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

Returns:

Returns the String

getObjectTypes

public List<String> getObjectTypes()

Getter for ObjectTypes. The desired set of object types to appear in the search results. 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 List of String

getIncludeDeletedObjects

public Boolean getIncludeDeletedObjects()

Getter for IncludeDeletedObjects. If `true`, deleted objects will be included in the results. Deleted objects will have their `is_deleted` field set to `true`.

Returns:

Returns the Boolean

getIncludeRelatedObjects

public Boolean getIncludeRelatedObjects()

Getter for IncludeRelatedObjects. If `true`, the response will include additional objects that are related to the requested objects. Related objects are objects that are referenced by object ID by the objects in the response. This is helpful if the objects are being fetched for immediate display to a user. This process only goes one level deep. Objects referenced by the related objects will not be included. For example: If the `objects` field of the response contains a CatalogItem, its associated CatalogCategory objects, CatalogTax objects, CatalogImage objects and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `objects` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. Default value: `false`

Returns:

Returns the Boolean

getBeginTime

public String getBeginTime()

Getter for BeginTime. Return objects modified after this [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates), in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`. The timestamp is exclusive - objects with a timestamp equal to `begin_time` will not be included in the response.

Returns:

Returns the String

getQuery

public CatalogQuery getQuery()

Getter for Query. A query composed of one or more different types of filters to narrow the scope of targeted objects when calling the `SearchCatalogObjects` endpoint. Although a query can have multiple filters, only certain query types can be combined per call to [SearchCatalogObjects]($e/Catalog/SearchCatalogObjects). Any combination of the following types may be used together: - [exact_query]($m/CatalogQueryExact) - [prefix_query]($m/CatalogQueryPrefix) - [range_query]($m/CatalogQueryRange) - [sorted_attribute_query]($m/CatalogQuerySortedAttribute) - [text_query]($m/CatalogQueryText) All other query types cannot be combined with any others. When a query filter is based on an attribute, the attribute must be searchable. Searchable attributes are listed as follows, along their parent types that can be searched for with applicable query filters. * Searchable attribute and objects queryable by searchable attributes ** - `name`: `CatalogItem`, `CatalogItemVariation`, `CatalogCategory`, `CatalogTax`, `CatalogDiscount`, `CatalogModifier`, 'CatalogModifierList`, `CatalogItemOption`, `CatalogItemOptionValue` - `description`: `CatalogItem`, `CatalogItemOptionValue` - `abbreviation`: `CatalogItem` - `upc`: `CatalogItemVariation` - `sku`: `CatalogItemVariation` - `caption`: `CatalogImage` - `display_name`: `CatalogItemOption` For example, to search for [CatalogItem]($m/CatalogItem) objects by searchable attributes, you can use the `"name"`, `"description"`, or `"abbreviation"` attribute in an applicable query filter.

Returns:

Returns the CatalogQuery

getLimit

public Integer getLimit()

Getter for Limit. A limit on the number of results to be returned in a single page. The limit is advisory - the implementation may return more or fewer results. If the supplied limit is negative, zero, or is higher than the maximum limit of 1,000, it will be ignored.

Returns:

Returns the Integer

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public SearchCatalogObjectsRequest.Builder toBuilder()

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

Returns:

a new SearchCatalogObjectsRequest.Builder object