com.squareup.square.models

Class TerminalAction

java.lang.Object

com.squareup.square.models.TerminalAction

public class TerminalAction
extends Object

This is a model class for TerminalAction type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
TerminalAction(String id, String deviceId, String deadlineDuration, String status, String cancelReason, String createdAt, String updatedAt, String appId, String type, SaveCardOptions saveCardOptions) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAppId() Getter for AppId.
String	getCancelReason() Getter for CancelReason.
String	getCreatedAt() Getter for CreatedAt.
String	getDeadlineDuration() Getter for DeadlineDuration.
String	getDeviceId() Getter for DeviceId.
String	getId() Getter for Id.
SaveCardOptions	getSaveCardOptions() Getter for SaveCardOptions.
String	getStatus() Getter for Status.
String	getType() Getter for Type.
String	getUpdatedAt() Getter for UpdatedAt.
int	hashCode()
TerminalAction.Builder	toBuilder() Builds a new TerminalAction.Builder object.
String	toString() Converts this TerminalAction into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

TerminalAction

public TerminalAction(String id,
                      String deviceId,
                      String deadlineDuration,
                      String status,
                      String cancelReason,
                      String createdAt,
                      String updatedAt,
                      String appId,
                      String type,
                      SaveCardOptions saveCardOptions)

Initialization constructor.

Parameters:

id - String value for id.

deviceId - String value for deviceId.

deadlineDuration - String value for deadlineDuration.

status - String value for status.

cancelReason - String value for cancelReason.

createdAt - String value for createdAt.

updatedAt - String value for updatedAt.

appId - String value for appId.

type - String value for type.

saveCardOptions - SaveCardOptions value for saveCardOptions.

Method Detail

getId

public String getId()

Getter for Id. A unique ID for this `TerminalAction`.

Returns:

Returns the String

getDeviceId

public String getDeviceId()

Getter for DeviceId. The unique Id of the device intended for this `TerminalAction`. The Id can be retrieved from /v2/devices api.

Returns:

Returns the String

getDeadlineDuration

public String getDeadlineDuration()

Getter for DeadlineDuration. The duration as an RFC 3339 duration, after which the action will be automatically canceled. TerminalActions that are `PENDING` will be automatically `CANCELED` and have a cancellation reason of `TIMED_OUT` Default: 5 minutes from creation Maximum: 5 minutes

Returns:

Returns the String

getStatus

public String getStatus()

Getter for Status. The status of the `TerminalAction`. Options: `PENDING`, `IN_PROGRESS`, `CANCELED`, `COMPLETED`

Returns:

Returns the String

getCancelReason

public String getCancelReason()

Getter for CancelReason.

Returns:

Returns the String

getCreatedAt

public String getCreatedAt()

Getter for CreatedAt. The time when the `TerminalAction` was created as an RFC 3339 timestamp.

Returns:

Returns the String

getUpdatedAt

public String getUpdatedAt()

Getter for UpdatedAt. The time when the `TerminalAction` was last updated as an RFC 3339 timestamp.

Returns:

Returns the String

getAppId

public String getAppId()

Getter for AppId. The ID of the application that created the action.

Returns:

Returns the String

getType

public String getType()

Getter for Type. Describes the type of this unit and indicates which field contains the unit information. This is an ‘open’ enum.

Returns:

Returns the String

getSaveCardOptions

public SaveCardOptions getSaveCardOptions()

Getter for SaveCardOptions. Describes save-card action fields.

Returns:

Returns the SaveCardOptions

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public TerminalAction.Builder toBuilder()

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

Returns:

a new TerminalAction.Builder object