com.squareup.square.models

Class CatalogImage

java.lang.Object

com.squareup.square.models.CatalogImage

public class CatalogImage
extends Object

This is a model class for CatalogImage type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
CatalogImage(String name, String url, String caption, String photoStudioOrderId) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCaption() Getter for Caption.
String	getName() Getter for Name.
String	getPhotoStudioOrderId() Getter for PhotoStudioOrderId.
String	getUrl() Getter for Url.
int	hashCode()
CatalogImage.Builder	toBuilder() Builds a new CatalogImage.Builder object.
String	toString() Converts this CatalogImage into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

CatalogImage

public CatalogImage(String name,
                    String url,
                    String caption,
                    String photoStudioOrderId)

Initialization constructor.

Parameters:

name - String value for name.

url - String value for url.

caption - String value for caption.

photoStudioOrderId - String value for photoStudioOrderId.

Method Detail

getName

public String getName()

Getter for Name. The internal name to identify this image in calls to the Square API. This is a searchable attribute for use in applicable query filters using the [SearchCatalogObjects]($e/Catalog/SearchCatalogObjects). It is not unique and should not be shown in a buyer facing context.

Returns:

Returns the String

getUrl

public String getUrl()

Getter for Url. The URL of this image, generated by Square after an image is uploaded using the [CreateCatalogImage]($e/Catalog/CreateCatalogImage) endpoint. To modify the image, use the UpdateCatalogImage endpoint. Do not change the URL field.

Returns:

Returns the String

getCaption

public String getCaption()

Getter for Caption. A caption that describes what is shown in the image. Displayed in the Square Online Store. This is a searchable attribute for use in applicable query filters using the [SearchCatalogObjects]($e/Catalog/SearchCatalogObjects).

Returns:

Returns the String

getPhotoStudioOrderId

public String getPhotoStudioOrderId()

Getter for PhotoStudioOrderId. The immutable order ID for this image object created by the Photo Studio service in Square Online Store.

Returns:

Returns the String

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CatalogImage.Builder toBuilder()

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

Returns:

a new CatalogImage.Builder object