com.squareup.square.models

Class CatalogQuickAmount

java.lang.Object

com.squareup.square.models.CatalogQuickAmount

public class CatalogQuickAmount
extends Object

This is a model class for CatalogQuickAmount type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
CatalogQuickAmount(String type, Money amount, Long score, Long ordinal) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Money	getAmount() Getter for Amount.
Long	getOrdinal() Getter for Ordinal.
Long	getScore() Getter for Score.
String	getType() Getter for Type.
int	hashCode()
CatalogQuickAmount.Builder	toBuilder() Builds a new CatalogQuickAmount.Builder object.
String	toString() Converts this CatalogQuickAmount into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

CatalogQuickAmount

public CatalogQuickAmount(String type,
                          Money amount,
                          Long score,
                          Long ordinal)

Initialization constructor.

Parameters:

type - String value for type.

amount - Money value for amount.

score - Long value for score.

ordinal - Long value for ordinal.

Method Detail

getType

public String getType()

Getter for Type. Determines the type of a specific Quick Amount.

Returns:

Returns the String

getAmount

public Money getAmount()

Getter for Amount. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.

Returns:

Returns the Money

getScore

public Long getScore()

Getter for Score. Describes the ranking of the Quick Amount provided by machine learning model, in the range [0, 100]. MANUAL type amount will always have score = 100.

Returns:

Returns the Long

getOrdinal

public Long getOrdinal()

Getter for Ordinal. The order in which this Quick Amount should be displayed.

Returns:

Returns the Long

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CatalogQuickAmount.Builder toBuilder()

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

Returns:

a new CatalogQuickAmount.Builder object