com.squareup.square.models

Class CreateCatalogImageRequest

java.lang.Object

com.squareup.square.models.CreateCatalogImageRequest

public class CreateCatalogImageRequest
extends Object

This is a model class for CreateCatalogImageRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
CreateCatalogImageRequest(String idempotencyKey, CatalogObject image, String objectId, Boolean isPrimary) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getIdempotencyKey() Getter for IdempotencyKey.
CatalogObject	getImage() Getter for Image.
Boolean	getIsPrimary() Getter for IsPrimary.
String	getObjectId() Getter for ObjectId.
int	hashCode()
CreateCatalogImageRequest.Builder	toBuilder() Builds a new CreateCatalogImageRequest.Builder object.
String	toString() Converts this CreateCatalogImageRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateCatalogImageRequest

public CreateCatalogImageRequest(String idempotencyKey,
                                 CatalogObject image,
                                 String objectId,
                                 Boolean isPrimary)

Initialization constructor.

Parameters:

idempotencyKey - String value for idempotencyKey.

image - CatalogObject value for image.

objectId - String value for objectId.

isPrimary - Boolean value for isPrimary.

Method Detail

getIdempotencyKey

public String getIdempotencyKey()

Getter for IdempotencyKey. A unique string that identifies this CreateCatalogImage request. Keys can be any valid string but must be unique for every CreateCatalogImage request. See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information.

Returns:

Returns the String

getObjectId

public String getObjectId()

Getter for ObjectId. Unique ID of the `CatalogObject` to attach this `CatalogImage` object to. Leave this field empty to create unattached images, for example if you are building an integration where an image can be attached to catalog items at a later time.

Returns:

Returns the String

getImage

public CatalogObject getImage()

Getter for Image. 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

getIsPrimary

public Boolean getIsPrimary()

Getter for IsPrimary. If this is set to `true`, the image created will be the primary, or first image of the object referenced by `object_id`. If the `CatalogObject` already has a primary `CatalogImage`, setting this field to `true` will replace the primary image. If this is set to `false` and you use the Square API version 2021-12-15 or later, the image id will be appended to the list of `image_ids` on the object. With Square API version 2021-12-15 or later, the default value is `false`. Otherwise, the effective default value is `true`.

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CreateCatalogImageRequest.Builder toBuilder()

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

Returns:

a new CreateCatalogImageRequest.Builder object