com.squareup.square.models

Class BatchRetrieveInventoryCountsRequest

java.lang.Object

com.squareup.square.models.BatchRetrieveInventoryCountsRequest

public class BatchRetrieveInventoryCountsRequest
extends Object

This is a model class for BatchRetrieveInventoryCountsRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	BatchRetrieveInventoryCountsRequest(List<String> catalogObjectIds, List<String> locationIds, String updatedAfter, String cursor, List<String> states, Integer limit) Initialization constructor.
protected	BatchRetrieveInventoryCountsRequest(io.apimatic.core.types.OptionalNullable<List<String>> catalogObjectIds, io.apimatic.core.types.OptionalNullable<List<String>> locationIds, io.apimatic.core.types.OptionalNullable<String> updatedAfter, io.apimatic.core.types.OptionalNullable<String> cursor, io.apimatic.core.types.OptionalNullable<List<String>> states, io.apimatic.core.types.OptionalNullable<Integer> limit) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<String>	getCatalogObjectIds() Getter for CatalogObjectIds.
String	getCursor() Getter for Cursor.
Integer	getLimit() Getter for Limit.
List<String>	getLocationIds() Getter for LocationIds.
List<String>	getStates() Getter for States.
String	getUpdatedAfter() Getter for UpdatedAfter.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<List<String>>	internalGetCatalogObjectIds() Internal Getter for CatalogObjectIds.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetCursor() Internal Getter for Cursor.
protected io.apimatic.core.types.OptionalNullable<Integer>	internalGetLimit() Internal Getter for Limit.
protected io.apimatic.core.types.OptionalNullable<List<String>>	internalGetLocationIds() Internal Getter for LocationIds.
protected io.apimatic.core.types.OptionalNullable<List<String>>	internalGetStates() Internal Getter for States.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetUpdatedAfter() Internal Getter for UpdatedAfter.
BatchRetrieveInventoryCountsRequest.Builder	toBuilder() Builds a new BatchRetrieveInventoryCountsRequest.Builder object.
String	toString() Converts this BatchRetrieveInventoryCountsRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchRetrieveInventoryCountsRequest

public BatchRetrieveInventoryCountsRequest(List<String> catalogObjectIds,
                                           List<String> locationIds,
                                           String updatedAfter,
                                           String cursor,
                                           List<String> states,
                                           Integer limit)

Initialization constructor.

Parameters:

catalogObjectIds - List of String value for catalogObjectIds.

locationIds - List of String value for locationIds.

updatedAfter - String value for updatedAfter.

cursor - String value for cursor.

states - List of String value for states.

limit - Integer value for limit.

BatchRetrieveInventoryCountsRequest

protected BatchRetrieveInventoryCountsRequest(io.apimatic.core.types.OptionalNullable<List<String>> catalogObjectIds,
                                              io.apimatic.core.types.OptionalNullable<List<String>> locationIds,
                                              io.apimatic.core.types.OptionalNullable<String> updatedAfter,
                                              io.apimatic.core.types.OptionalNullable<String> cursor,
                                              io.apimatic.core.types.OptionalNullable<List<String>> states,
                                              io.apimatic.core.types.OptionalNullable<Integer> limit)

Initialization constructor.

Parameters:

catalogObjectIds - List of String value for catalogObjectIds.

locationIds - List of String value for locationIds.

updatedAfter - String value for updatedAfter.

cursor - String value for cursor.

states - List of String value for states.

limit - Integer value for limit.

Method Detail

internalGetCatalogObjectIds

protected io.apimatic.core.types.OptionalNullable<List<String>> internalGetCatalogObjectIds()

Internal Getter for CatalogObjectIds. The filter to return results by `CatalogObject` ID. The filter is applicable only when set. The default is null.

Returns:

Returns the Internal List of String

getCatalogObjectIds

public List<String> getCatalogObjectIds()

Getter for CatalogObjectIds. The filter to return results by `CatalogObject` ID. The filter is applicable only when set. The default is null.

Returns:

Returns the List of String

internalGetLocationIds

protected io.apimatic.core.types.OptionalNullable<List<String>> internalGetLocationIds()

Internal Getter for LocationIds. The filter to return results by `Location` ID. This filter is applicable only when set. The default is null.

Returns:

Returns the Internal List of String

getLocationIds

public List<String> getLocationIds()

Getter for LocationIds. The filter to return results by `Location` ID. This filter is applicable only when set. The default is null.

Returns:

Returns the List of String

internalGetUpdatedAfter

protected io.apimatic.core.types.OptionalNullable<String> internalGetUpdatedAfter()

Internal Getter for UpdatedAfter. The filter to return results with their `calculated_at` value after the given time as specified in an RFC 3339 timestamp. The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`).

Returns:

Returns the Internal String

getUpdatedAfter

public String getUpdatedAfter()

Getter for UpdatedAfter. The filter to return results with their `calculated_at` value after the given time as specified in an RFC 3339 timestamp. The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`).

Returns:

Returns the String

internalGetCursor

protected io.apimatic.core.types.OptionalNullable<String> internalGetCursor()

Internal Getter for Cursor. A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.

Returns:

Returns the Internal String

getCursor

public String getCursor()

Getter for Cursor. A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.

Returns:

Returns the String

internalGetStates

protected io.apimatic.core.types.OptionalNullable<List<String>> internalGetStates()

Internal Getter for States. The filter to return results by `InventoryState`. The filter is only applicable when set. Ignored are untracked states of `NONE`, `SOLD`, and `UNLINKED_RETURN`. The default is null.

Returns:

Returns the Internal List of String

getStates

public List<String> getStates()

Getter for States. The filter to return results by `InventoryState`. The filter is only applicable when set. Ignored are untracked states of `NONE`, `SOLD`, and `UNLINKED_RETURN`. The default is null.

Returns:

Returns the List of String

internalGetLimit

protected io.apimatic.core.types.OptionalNullable<Integer> internalGetLimit()

Internal Getter for Limit. The number of [records](entity:InventoryCount) to return.

Returns:

Returns the Internal Integer

getLimit

public Integer getLimit()

Getter for Limit. The number of [records](entity:InventoryCount) to return.

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public BatchRetrieveInventoryCountsRequest.Builder toBuilder()

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

Returns:

a new BatchRetrieveInventoryCountsRequest.Builder object