com.squareup.square.models

Class BatchRetrieveCatalogObjectsRequest

java.lang.Object

com.squareup.square.models.BatchRetrieveCatalogObjectsRequest

public class BatchRetrieveCatalogObjectsRequest
extends Object

This is a model class for BatchRetrieveCatalogObjectsRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	BatchRetrieveCatalogObjectsRequest(List<String> objectIds, Boolean includeRelatedObjects, Long catalogVersion, Boolean includeDeletedObjects, Boolean includeCategoryPathToRoot) Initialization constructor.
protected	BatchRetrieveCatalogObjectsRequest(List<String> objectIds, io.apimatic.core.types.OptionalNullable<Boolean> includeRelatedObjects, io.apimatic.core.types.OptionalNullable<Long> catalogVersion, io.apimatic.core.types.OptionalNullable<Boolean> includeDeletedObjects, io.apimatic.core.types.OptionalNullable<Boolean> includeCategoryPathToRoot) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Long	getCatalogVersion() Getter for CatalogVersion.
Boolean	getIncludeCategoryPathToRoot() Getter for IncludeCategoryPathToRoot.
Boolean	getIncludeDeletedObjects() Getter for IncludeDeletedObjects.
Boolean	getIncludeRelatedObjects() Getter for IncludeRelatedObjects.
List<String>	getObjectIds() Getter for ObjectIds.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<Long>	internalGetCatalogVersion() Internal Getter for CatalogVersion.
protected io.apimatic.core.types.OptionalNullable<Boolean>	internalGetIncludeCategoryPathToRoot() Internal Getter for IncludeCategoryPathToRoot.
protected io.apimatic.core.types.OptionalNullable<Boolean>	internalGetIncludeDeletedObjects() Internal Getter for IncludeDeletedObjects.
protected io.apimatic.core.types.OptionalNullable<Boolean>	internalGetIncludeRelatedObjects() Internal Getter for IncludeRelatedObjects.
BatchRetrieveCatalogObjectsRequest.Builder	toBuilder() Builds a new BatchRetrieveCatalogObjectsRequest.Builder object.
String	toString() Converts this BatchRetrieveCatalogObjectsRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchRetrieveCatalogObjectsRequest

public BatchRetrieveCatalogObjectsRequest(List<String> objectIds,
                                          Boolean includeRelatedObjects,
                                          Long catalogVersion,
                                          Boolean includeDeletedObjects,
                                          Boolean includeCategoryPathToRoot)

Initialization constructor.

Parameters:

objectIds - List of String value for objectIds.

includeRelatedObjects - Boolean value for includeRelatedObjects.

catalogVersion - Long value for catalogVersion.

includeDeletedObjects - Boolean value for includeDeletedObjects.

includeCategoryPathToRoot - Boolean value for includeCategoryPathToRoot.

BatchRetrieveCatalogObjectsRequest

protected BatchRetrieveCatalogObjectsRequest(List<String> objectIds,
                                             io.apimatic.core.types.OptionalNullable<Boolean> includeRelatedObjects,
                                             io.apimatic.core.types.OptionalNullable<Long> catalogVersion,
                                             io.apimatic.core.types.OptionalNullable<Boolean> includeDeletedObjects,
                                             io.apimatic.core.types.OptionalNullable<Boolean> includeCategoryPathToRoot)

Initialization constructor.

Parameters:

objectIds - List of String value for objectIds.

includeRelatedObjects - Boolean value for includeRelatedObjects.

catalogVersion - Long value for catalogVersion.

includeDeletedObjects - Boolean value for includeDeletedObjects.

includeCategoryPathToRoot - Boolean value for includeCategoryPathToRoot.

Method Detail

getObjectIds

public List<String> getObjectIds()

Getter for ObjectIds. The IDs of the CatalogObjects to be retrieved.

Returns:

Returns the List of String

internalGetIncludeRelatedObjects

protected io.apimatic.core.types.OptionalNullable<Boolean> internalGetIncludeRelatedObjects()

Internal Getter for IncludeRelatedObjects. If `true`, the response will include additional objects that are related to the requested objects. Related objects are defined as any objects referenced by ID by the results in the `objects` field of the response. These objects are put in the `related_objects` field. Setting this to `true` is helpful when the objects are needed 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 Internal 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 defined as any objects referenced by ID by the results in the `objects` field of the response. These objects are put in the `related_objects` field. Setting this to `true` is helpful when the objects are needed 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

internalGetCatalogVersion

protected io.apimatic.core.types.OptionalNullable<Long> internalGetCatalogVersion()

Internal 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 Internal Long

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

internalGetIncludeDeletedObjects

protected io.apimatic.core.types.OptionalNullable<Boolean> internalGetIncludeDeletedObjects()

Internal Getter for IncludeDeletedObjects. Indicates whether to include (`true`) or not (`false`) in the response deleted objects, namely, those with the `is_deleted` attribute set to `true`.

Returns:

Returns the Internal Boolean

getIncludeDeletedObjects

public Boolean getIncludeDeletedObjects()

Getter for IncludeDeletedObjects. Indicates whether to include (`true`) or not (`false`) in the response deleted objects, namely, those with the `is_deleted` attribute set to `true`.

Returns:

Returns the Boolean

internalGetIncludeCategoryPathToRoot

protected io.apimatic.core.types.OptionalNullable<Boolean> internalGetIncludeCategoryPathToRoot()

Internal Getter for IncludeCategoryPathToRoot. Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists of `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned in the response payload.

Returns:

Returns the Internal Boolean

getIncludeCategoryPathToRoot

public Boolean getIncludeCategoryPathToRoot()

Getter for IncludeCategoryPathToRoot. Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists of `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned in the response payload.

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public BatchRetrieveCatalogObjectsRequest.Builder toBuilder()

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

Returns:

a new BatchRetrieveCatalogObjectsRequest.Builder object