com.squareup.square.models

Class UpsertCatalogObjectRequest

java.lang.Object

com.squareup.square.models.UpsertCatalogObjectRequest

public class UpsertCatalogObjectRequest
extends Object

This is a model class for UpsertCatalogObjectRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
UpsertCatalogObjectRequest(String idempotencyKey, CatalogObject object) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getIdempotencyKey() Getter for IdempotencyKey.
CatalogObject	getObject() Getter for Object.
int	hashCode()
UpsertCatalogObjectRequest.Builder	toBuilder() Builds a new UpsertCatalogObjectRequest.Builder object.
String	toString() Converts this UpsertCatalogObjectRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

UpsertCatalogObjectRequest

public UpsertCatalogObjectRequest(String idempotencyKey,
                                  CatalogObject object)

Initialization constructor.

Parameters:

idempotencyKey - String value for idempotencyKey.

object - CatalogObject value for object.

Method Detail

getIdempotencyKey

public String getIdempotencyKey()

Getter for IdempotencyKey. A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID). If you're unsure whether a particular request was successful, you can reattempt it with the same idempotency key without worrying about creating duplicate objects. See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) for more information.

Returns:

Returns the String

getObject

public CatalogObject getObject()

Getter for Object. The wrapper object for the catalog entries of a given object type. Depending on the `type` attribute value, a `CatalogObject` instance assumes a type-specific data to yield the corresponding type of catalog object. For example, if `type=ITEM`, the `CatalogObject` instance must have the ITEM-specific data set on the `item_data` attribute. The resulting `CatalogObject` instance is also a `CatalogItem` instance. In general, if `type=<OBJECT_TYPE>`, the `CatalogObject` instance must have the `<OBJECT_TYPE>`-specific data set on the `<object_type>_data` attribute. The resulting `CatalogObject` instance is also a `Catalog<ObjectType>` instance. For a more detailed discussion of the Catalog data model, please see the [Design a Catalog](https://developer.squareup.com/docs/catalog-api/design-a-catalog) guide.

Returns:

Returns the CatalogObject

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public UpsertCatalogObjectRequest.Builder toBuilder()

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

Returns:

a new UpsertCatalogObjectRequest.Builder object