Package com.adyen.model.balanceplatform

Class TransactionRuleInterval

java.lang.Object

com.adyen.model.balanceplatform.TransactionRuleInterval

public class TransactionRuleInterval
extends Object

TransactionRuleInterval

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TransactionRuleInterval.DayOfWeekEnum	The day of week, used when the `duration.unit` is **weeks**.
static class	TransactionRuleInterval.TypeEnum	The [type of interval](https://docs.adyen.com/issuing/transaction-rules#time-intervals) during which the rule conditions and limits apply, and how often counters are reset.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_DAY_OF_MONTH
static String	JSON_PROPERTY_DAY_OF_WEEK
static String	JSON_PROPERTY_DURATION
static String	JSON_PROPERTY_TIME_OF_DAY
static String	JSON_PROPERTY_TIME_ZONE
static String	JSON_PROPERTY_TYPE

Constructor Summary

Constructors

Constructor	Description
TransactionRuleInterval()

Method Summary

Modifier and Type	Method	Description
TransactionRuleInterval	dayOfMonth(Integer dayOfMonth)	The day of month, used when the `duration.unit` is **months**.
TransactionRuleInterval	dayOfWeek(TransactionRuleInterval.DayOfWeekEnum dayOfWeek)	The day of week, used when the `duration.unit` is **weeks**.
TransactionRuleInterval	duration(Duration duration)	duration
boolean	equals(Object o)	Return true if this TransactionRuleInterval object is equal to o.
static TransactionRuleInterval	fromJson(String jsonString)	Create an instance of TransactionRuleInterval given an JSON string
Integer	getDayOfMonth()	The day of month, used when the `duration.unit` is **months**.
TransactionRuleInterval.DayOfWeekEnum	getDayOfWeek()	The day of week, used when the `duration.unit` is **weeks**.
Duration	getDuration()	duration
String	getTimeOfDay()	The time of day, in **hh:mm:ss** format, used when the `duration.unit` is **hours**.
String	getTimeZone()	The [time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
TransactionRuleInterval.TypeEnum	getType()	The [type of interval](https://docs.adyen.com/issuing/transaction-rules#time-intervals) during which the rule conditions and limits apply, and how often counters are reset.
int	hashCode()
void	setDayOfMonth(Integer dayOfMonth)	The day of month, used when the `duration.unit` is **months**.
void	setDayOfWeek(TransactionRuleInterval.DayOfWeekEnum dayOfWeek)	The day of week, used when the `duration.unit` is **weeks**.
void	setDuration(Duration duration)	duration
void	setTimeOfDay(String timeOfDay)	The time of day, in **hh:mm:ss** format, used when the `duration.unit` is **hours**.
void	setTimeZone(String timeZone)	The [time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
void	setType(TransactionRuleInterval.TypeEnum type)	The [type of interval](https://docs.adyen.com/issuing/transaction-rules#time-intervals) during which the rule conditions and limits apply, and how often counters are reset.
TransactionRuleInterval	timeOfDay(String timeOfDay)	The time of day, in **hh:mm:ss** format, used when the `duration.unit` is **hours**.
TransactionRuleInterval	timeZone(String timeZone)	The [time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
String	toJson()	Convert an instance of TransactionRuleInterval to an JSON string
String	toString()
TransactionRuleInterval	type(TransactionRuleInterval.TypeEnum type)	The [type of interval](https://docs.adyen.com/issuing/transaction-rules#time-intervals) during which the rule conditions and limits apply, and how often counters are reset.

Methods inherited from class java.lang.Object

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

Field Detail

JSON_PROPERTY_DAY_OF_MONTH

public static final String JSON_PROPERTY_DAY_OF_MONTH

See Also:

Constant Field Values

JSON_PROPERTY_DAY_OF_WEEK

public static final String JSON_PROPERTY_DAY_OF_WEEK

See Also:

Constant Field Values

JSON_PROPERTY_DURATION

public static final String JSON_PROPERTY_DURATION

See Also:

Constant Field Values

JSON_PROPERTY_TIME_OF_DAY

public static final String JSON_PROPERTY_TIME_OF_DAY

See Also:

Constant Field Values

JSON_PROPERTY_TIME_ZONE

public static final String JSON_PROPERTY_TIME_ZONE

See Also:

Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

Constant Field Values

Constructor Detail

TransactionRuleInterval

public TransactionRuleInterval()

Method Detail

dayOfMonth

public TransactionRuleInterval dayOfMonth(Integer dayOfMonth)

The day of month, used when the `duration.unit` is **months**. If not provided, by default, this is set to **1**, the first day of the month.

Parameters:

dayOfMonth -

Returns:

the current TransactionRuleInterval instance, allowing for method chaining

getDayOfMonth

public Integer getDayOfMonth()

The day of month, used when the `duration.unit` is **months**. If not provided, by default, this is set to **1**, the first day of the month.

Returns:

dayOfMonth

setDayOfMonth

public void setDayOfMonth(Integer dayOfMonth)

The day of month, used when the `duration.unit` is **months**. If not provided, by default, this is set to **1**, the first day of the month.

Parameters:

dayOfMonth -

dayOfWeek

public TransactionRuleInterval dayOfWeek(TransactionRuleInterval.DayOfWeekEnum dayOfWeek)

The day of week, used when the `duration.unit` is **weeks**. If not provided, by default, this is set to **monday**. Possible values: **sunday**, **monday**, **tuesday**, **wednesday**, **thursday**, **friday**.

Parameters:

dayOfWeek -

Returns:

the current TransactionRuleInterval instance, allowing for method chaining

getDayOfWeek

public TransactionRuleInterval.DayOfWeekEnum getDayOfWeek()

The day of week, used when the `duration.unit` is **weeks**. If not provided, by default, this is set to **monday**. Possible values: **sunday**, **monday**, **tuesday**, **wednesday**, **thursday**, **friday**.

Returns:

dayOfWeek

setDayOfWeek

public void setDayOfWeek(TransactionRuleInterval.DayOfWeekEnum dayOfWeek)

The day of week, used when the `duration.unit` is **weeks**. If not provided, by default, this is set to **monday**. Possible values: **sunday**, **monday**, **tuesday**, **wednesday**, **thursday**, **friday**.

Parameters:

dayOfWeek -

duration

public TransactionRuleInterval duration(Duration duration)

duration

Parameters:

duration -

Returns:

the current TransactionRuleInterval instance, allowing for method chaining

getDuration

public Duration getDuration()

duration

Returns:

duration

setDuration

public void setDuration(Duration duration)

duration

Parameters:

duration -

timeOfDay

public TransactionRuleInterval timeOfDay(String timeOfDay)

The time of day, in **hh:mm:ss** format, used when the `duration.unit` is **hours**. If not provided, by default, this is set to **00:00:00**.

Parameters:

timeOfDay -

Returns:

the current TransactionRuleInterval instance, allowing for method chaining

getTimeOfDay

public String getTimeOfDay()

The time of day, in **hh:mm:ss** format, used when the `duration.unit` is **hours**. If not provided, by default, this is set to **00:00:00**.

Returns:

timeOfDay

setTimeOfDay

public void setTimeOfDay(String timeOfDay)

The time of day, in **hh:mm:ss** format, used when the `duration.unit` is **hours**. If not provided, by default, this is set to **00:00:00**.

Parameters:

timeOfDay -

timeZone

public TransactionRuleInterval timeZone(String timeZone)

The [time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, **Europe/Amsterdam**. By default, this is set to **UTC**.

Parameters:

timeZone -

Returns:

the current TransactionRuleInterval instance, allowing for method chaining

getTimeZone

public String getTimeZone()

The [time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, **Europe/Amsterdam**. By default, this is set to **UTC**.

Returns:

timeZone

setTimeZone

public void setTimeZone(String timeZone)

The [time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, **Europe/Amsterdam**. By default, this is set to **UTC**.

Parameters:

timeZone -

type

public TransactionRuleInterval type(TransactionRuleInterval.TypeEnum type)

The [type of interval](https://docs.adyen.com/issuing/transaction-rules#time-intervals) during which the rule conditions and limits apply, and how often counters are reset. Possible values: * **perTransaction**: conditions are evaluated and the counters are reset for every transaction. * **daily**: the counters are reset daily at 00:00:00 CET. * **weekly**: the counters are reset every Monday at 00:00:00 CET. * **monthly**: the counters reset every first day of the month at 00:00:00 CET. * **lifetime**: conditions are applied to the lifetime of the payment instrument. * **rolling**: conditions are applied and the counters are reset based on a `duration`. If the reset date and time are not provided, Adyen applies the default reset time similar to fixed intervals. For example, if the duration is every two weeks, the counter resets every third Monday at 00:00:00 CET. * **sliding**: conditions are applied and the counters are reset based on the current time and a `duration` that you specify.

Parameters:

type -

Returns:

the current TransactionRuleInterval instance, allowing for method chaining

getType

public TransactionRuleInterval.TypeEnum getType()

The [type of interval](https://docs.adyen.com/issuing/transaction-rules#time-intervals) during which the rule conditions and limits apply, and how often counters are reset. Possible values: * **perTransaction**: conditions are evaluated and the counters are reset for every transaction. * **daily**: the counters are reset daily at 00:00:00 CET. * **weekly**: the counters are reset every Monday at 00:00:00 CET. * **monthly**: the counters reset every first day of the month at 00:00:00 CET. * **lifetime**: conditions are applied to the lifetime of the payment instrument. * **rolling**: conditions are applied and the counters are reset based on a `duration`. If the reset date and time are not provided, Adyen applies the default reset time similar to fixed intervals. For example, if the duration is every two weeks, the counter resets every third Monday at 00:00:00 CET. * **sliding**: conditions are applied and the counters are reset based on the current time and a `duration` that you specify.

Returns:

type

setType

public void setType(TransactionRuleInterval.TypeEnum type)

The [type of interval](https://docs.adyen.com/issuing/transaction-rules#time-intervals) during which the rule conditions and limits apply, and how often counters are reset. Possible values: * **perTransaction**: conditions are evaluated and the counters are reset for every transaction. * **daily**: the counters are reset daily at 00:00:00 CET. * **weekly**: the counters are reset every Monday at 00:00:00 CET. * **monthly**: the counters reset every first day of the month at 00:00:00 CET. * **lifetime**: conditions are applied to the lifetime of the payment instrument. * **rolling**: conditions are applied and the counters are reset based on a `duration`. If the reset date and time are not provided, Adyen applies the default reset time similar to fixed intervals. For example, if the duration is every two weeks, the counter resets every third Monday at 00:00:00 CET. * **sliding**: conditions are applied and the counters are reset based on the current time and a `duration` that you specify.

Parameters:

type -

equals

public boolean equals(Object o)

Return true if this TransactionRuleInterval object is equal to o.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

fromJson

public static TransactionRuleInterval fromJson(String jsonString)
                                        throws com.fasterxml.jackson.core.JsonProcessingException

Create an instance of TransactionRuleInterval given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of TransactionRuleInterval

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to TransactionRuleInterval

toJson

public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException

Convert an instance of TransactionRuleInterval to an JSON string

Returns:

JSON string

Throws:

com.fasterxml.jackson.core.JsonProcessingException