Package com.adyen.model.management
Class ScheduleTerminalActionsRequest
- java.lang.Object
-
- com.adyen.model.management.ScheduleTerminalActionsRequest
-
public class ScheduleTerminalActionsRequest extends Object
ScheduleTerminalActionsRequest
-
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_ACTION_DETAILSstatic StringJSON_PROPERTY_SCHEDULED_ATstatic StringJSON_PROPERTY_STORE_IDstatic StringJSON_PROPERTY_TERMINAL_IDS
-
Constructor Summary
Constructors Constructor Description ScheduleTerminalActionsRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ScheduleTerminalActionsRequestactionDetails(ScheduleTerminalActionsRequestActionDetails actionDetails)actionDetailsScheduleTerminalActionsRequestaddTerminalIdsItem(String terminalIdsItem)booleanequals(Object o)Return true if this ScheduleTerminalActionsRequest object is equal to o.static ScheduleTerminalActionsRequestfromJson(String jsonString)Create an instance of ScheduleTerminalActionsRequest given an JSON stringScheduleTerminalActionsRequestActionDetailsgetActionDetails()actionDetailsStringgetScheduledAt()The date and time when the action should happen.StringgetStoreId()The unique ID of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/stores).List<String>getTerminalIds()A list of unique IDs of the terminals to apply the action to.inthashCode()ScheduleTerminalActionsRequestscheduledAt(String scheduledAt)The date and time when the action should happen.voidsetActionDetails(ScheduleTerminalActionsRequestActionDetails actionDetails)actionDetailsvoidsetScheduledAt(String scheduledAt)The date and time when the action should happen.voidsetStoreId(String storeId)The unique ID of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/stores).voidsetTerminalIds(List<String> terminalIds)A list of unique IDs of the terminals to apply the action to.ScheduleTerminalActionsRequeststoreId(String storeId)The unique ID of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/stores).ScheduleTerminalActionsRequestterminalIds(List<String> terminalIds)A list of unique IDs of the terminals to apply the action to.StringtoJson()Convert an instance of ScheduleTerminalActionsRequest to an JSON stringStringtoString()
-
-
-
Field Detail
-
JSON_PROPERTY_ACTION_DETAILS
public static final String JSON_PROPERTY_ACTION_DETAILS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SCHEDULED_AT
public static final String JSON_PROPERTY_SCHEDULED_AT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_STORE_ID
public static final String JSON_PROPERTY_STORE_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TERMINAL_IDS
public static final String JSON_PROPERTY_TERMINAL_IDS
- See Also:
- Constant Field Values
-
-
Method Detail
-
actionDetails
public ScheduleTerminalActionsRequest actionDetails(ScheduleTerminalActionsRequestActionDetails actionDetails)
actionDetails- Parameters:
actionDetails-- Returns:
- the current
ScheduleTerminalActionsRequestinstance, allowing for method chaining
-
getActionDetails
public ScheduleTerminalActionsRequestActionDetails getActionDetails()
actionDetails- Returns:
- actionDetails
-
setActionDetails
public void setActionDetails(ScheduleTerminalActionsRequestActionDetails actionDetails)
actionDetails- Parameters:
actionDetails-
-
scheduledAt
public ScheduleTerminalActionsRequest scheduledAt(String scheduledAt)
The date and time when the action should happen. Format: [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339), but without the **Z** before the time offset. For example, **2021-11-15T12:16:21+0100** The action is sent with the first [maintenance call](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api#when-actions-take-effect) after the specified date and time in the time zone of the terminal. An empty value causes the action to be sent as soon as possible: at the next maintenance call.- Parameters:
scheduledAt-- Returns:
- the current
ScheduleTerminalActionsRequestinstance, allowing for method chaining
-
getScheduledAt
public String getScheduledAt()
The date and time when the action should happen. Format: [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339), but without the **Z** before the time offset. For example, **2021-11-15T12:16:21+0100** The action is sent with the first [maintenance call](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api#when-actions-take-effect) after the specified date and time in the time zone of the terminal. An empty value causes the action to be sent as soon as possible: at the next maintenance call.- Returns:
- scheduledAt
-
setScheduledAt
public void setScheduledAt(String scheduledAt)
The date and time when the action should happen. Format: [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339), but without the **Z** before the time offset. For example, **2021-11-15T12:16:21+0100** The action is sent with the first [maintenance call](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api#when-actions-take-effect) after the specified date and time in the time zone of the terminal. An empty value causes the action to be sent as soon as possible: at the next maintenance call.- Parameters:
scheduledAt-
-
storeId
public ScheduleTerminalActionsRequest storeId(String storeId)
The unique ID of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/stores). If present, all terminals in the `terminalIds` list must be assigned to this store.- Parameters:
storeId-- Returns:
- the current
ScheduleTerminalActionsRequestinstance, allowing for method chaining
-
getStoreId
public String getStoreId()
The unique ID of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/stores). If present, all terminals in the `terminalIds` list must be assigned to this store.- Returns:
- storeId
-
setStoreId
public void setStoreId(String storeId)
The unique ID of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/stores). If present, all terminals in the `terminalIds` list must be assigned to this store.- Parameters:
storeId-
-
terminalIds
public ScheduleTerminalActionsRequest terminalIds(List<String> terminalIds)
A list of unique IDs of the terminals to apply the action to. You can extract the IDs from the [GET `/terminals`](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/terminals) response. Maximum length: 100 IDs.- Parameters:
terminalIds-- Returns:
- the current
ScheduleTerminalActionsRequestinstance, allowing for method chaining
-
addTerminalIdsItem
public ScheduleTerminalActionsRequest addTerminalIdsItem(String terminalIdsItem)
-
getTerminalIds
public List<String> getTerminalIds()
A list of unique IDs of the terminals to apply the action to. You can extract the IDs from the [GET `/terminals`](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/terminals) response. Maximum length: 100 IDs.- Returns:
- terminalIds
-
setTerminalIds
public void setTerminalIds(List<String> terminalIds)
A list of unique IDs of the terminals to apply the action to. You can extract the IDs from the [GET `/terminals`](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/terminals) response. Maximum length: 100 IDs.- Parameters:
terminalIds-
-
equals
public boolean equals(Object o)
Return true if this ScheduleTerminalActionsRequest object is equal to o.
-
fromJson
public static ScheduleTerminalActionsRequest fromJson(String jsonString) throws com.fasterxml.jackson.core.JsonProcessingException
Create an instance of ScheduleTerminalActionsRequest given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of ScheduleTerminalActionsRequest
- Throws:
com.fasterxml.jackson.core.JsonProcessingException- if the JSON string is invalid with respect to ScheduleTerminalActionsRequest
-
toJson
public String toJson() throws com.fasterxml.jackson.core.JsonProcessingException
Convert an instance of ScheduleTerminalActionsRequest to an JSON string- Returns:
- JSON string
- Throws:
com.fasterxml.jackson.core.JsonProcessingException
-
-