com.squareup.square.models

Class BatchUpsertCatalogObjectsRequest

java.lang.Object

com.squareup.square.models.BatchUpsertCatalogObjectsRequest

public class BatchUpsertCatalogObjectsRequest
extends Object

This is a model class for BatchUpsertCatalogObjectsRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
BatchUpsertCatalogObjectsRequest(String idempotencyKey, List<CatalogObjectBatch> batches) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<CatalogObjectBatch>	getBatches() Getter for Batches.
String	getIdempotencyKey() Getter for IdempotencyKey.
int	hashCode()
BatchUpsertCatalogObjectsRequest.Builder	toBuilder() Builds a new BatchUpsertCatalogObjectsRequest.Builder object.
String	toString() Converts this BatchUpsertCatalogObjectsRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchUpsertCatalogObjectsRequest

public BatchUpsertCatalogObjectsRequest(String idempotencyKey,
                                        List<CatalogObjectBatch> batches)

Initialization constructor.

Parameters:

idempotencyKey - String value for idempotencyKey.

batches - List of CatalogObjectBatch value for batches.

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

getBatches

public List<CatalogObjectBatch> getBatches()

Getter for Batches. A batch of CatalogObjects to be inserted/updated atomically. The objects within a batch will be inserted in an all-or-nothing fashion, i.e., if an error occurs attempting to insert or update an object within a batch, the entire batch will be rejected. However, an error in one batch will not affect other batches within the same request. For each object, its `updated_at` field is ignored and replaced with a current [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates), and its `is_deleted` field must not be set to `true`. To modify an existing object, supply its ID. To create a new object, use an ID starting with `#`. These IDs may be used to create relationships between an object and attributes of other objects that reference it. For example, you can create a CatalogItem with ID `#ABC` and a CatalogItemVariation with its `item_id` attribute set to `#ABC` in order to associate the CatalogItemVariation with its parent CatalogItem. Any `#`-prefixed IDs are valid only within a single atomic batch, and will be replaced by server-generated IDs. Each batch may contain up to 1,000 objects. The total number of objects across all batches for a single request may not exceed 10,000. If either of these limits is violated, an error will be returned and no objects will be inserted or updated.

Returns:

Returns the List of CatalogObjectBatch

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public BatchUpsertCatalogObjectsRequest.Builder toBuilder()

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

Returns:

a new BatchUpsertCatalogObjectsRequest.Builder object