TransferRecurringSchedule (com.plaid:plaid-java 18.0.0 API)

java.lang.Object
- com.plaid.client.model.TransferRecurringSchedule

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-17T22:44:09.100608Z[Etc/UTC]")
public class TransferRecurringSchedule
extends Object

The schedule that the recurring transfer will be executed on.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_END_DATE`
`static String`	`SERIALIZED_NAME_INTERVAL_COUNT`
`static String`	`SERIALIZED_NAME_INTERVAL_EXECUTION_DAY`
`static String`	`SERIALIZED_NAME_INTERVAL_UNIT`
`static String`	`SERIALIZED_NAME_START_DATE`

Constructor Summary

Constructors
Constructor and Description

TransferRecurringSchedule()

Constructors
Constructor and Description
`TransferRecurringSchedule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TransferRecurringSchedule`	`endDate(LocalDate endDate)`
`boolean`	`equals(Object o)`
`LocalDate`	`getEndDate()` A date in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
`Integer`	`getIntervalCount()` The number of recurring `interval_units` between originations.
`Integer`	`getIntervalExecutionDay()` The day of the interval on which to schedule the transfer.
`TransferScheduleIntervalUnit`	`getIntervalUnit()` Get intervalUnit
`LocalDate`	`getStartDate()` A date in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
`int`	`hashCode()`
`TransferRecurringSchedule`	`intervalCount(Integer intervalCount)`
`TransferRecurringSchedule`	`intervalExecutionDay(Integer intervalExecutionDay)`
`TransferRecurringSchedule`	`intervalUnit(TransferScheduleIntervalUnit intervalUnit)`
`void`	`setEndDate(LocalDate endDate)`
`void`	`setIntervalCount(Integer intervalCount)`
`void`	`setIntervalExecutionDay(Integer intervalExecutionDay)`
`void`	`setIntervalUnit(TransferScheduleIntervalUnit intervalUnit)`
`void`	`setStartDate(LocalDate startDate)`
`TransferRecurringSchedule`	`startDate(LocalDate startDate)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZED_NAME_INTERVAL_UNIT
```
public static final String SERIALIZED_NAME_INTERVAL_UNIT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_INTERVAL_COUNT
```
public static final String SERIALIZED_NAME_INTERVAL_COUNT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_INTERVAL_EXECUTION_DAY
```
public static final String SERIALIZED_NAME_INTERVAL_EXECUTION_DAY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_START_DATE
```
public static final String SERIALIZED_NAME_START_DATE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_END_DATE
```
public static final String SERIALIZED_NAME_END_DATE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TransferRecurringSchedule
```
public TransferRecurringSchedule()
```
- Method Detail
  - intervalUnit
```
public TransferRecurringSchedule intervalUnit(TransferScheduleIntervalUnit intervalUnit)
```
  - getIntervalUnit
```
public TransferScheduleIntervalUnit getIntervalUnit()
```
    Get intervalUnit
    
    Returns:
    
    intervalUnit
  - setIntervalUnit
```
public void setIntervalUnit(TransferScheduleIntervalUnit intervalUnit)
```
  - intervalCount
```
public TransferRecurringSchedule intervalCount(Integer intervalCount)
```
  - getIntervalCount
```
public Integer getIntervalCount()
```
    The number of recurring `interval_units` between originations. The recurring interval (before holiday adjustment) is calculated by multiplying `interval_unit` and `interval_count`. For example, to schedule a recurring transfer which originates once every two weeks, set `interval_unit` = `week` and `interval_count` = 2.
    
    Returns:
    
    intervalCount
  - setIntervalCount
```
public void setIntervalCount(Integer intervalCount)
```
  - intervalExecutionDay
```
public TransferRecurringSchedule intervalExecutionDay(Integer intervalExecutionDay)
```
  - getIntervalExecutionDay
```
public Integer getIntervalExecutionDay()
```
    The day of the interval on which to schedule the transfer. If the `interval_unit` is `week`, `interval_execution_day` should be an integer from 1 (Monday) to 5 (Friday). If the `interval_unit` is `month`, `interval_execution_day` should be an integer indicating which day of the month to make the transfer on. Integers from 1 to 28 can be used to make a transfer on that day of the month. Negative integers from -1 to -5 can be used to make a transfer relative to the end of the month. To make a transfer on the last day of the month, use -1; to make the transfer on the second-to-last day, use -2, and so on. The transfer will be originated on the next available banking day if the designated day is a non banking day.
    
    Returns:
    
    intervalExecutionDay
  - setIntervalExecutionDay
```
public void setIntervalExecutionDay(Integer intervalExecutionDay)
```
  - startDate
```
public TransferRecurringSchedule startDate(LocalDate startDate)
```
  - getStartDate
```
public LocalDate getStartDate()
```
    A date in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD). The recurring transfer will begin on the first `interval_execution_day` on or after the `start_date`. If the first `interval_execution_day` on or after the start date is also the same day that `/transfer/recurring/create` was called, the bank *may* make the first payment on that day, but it is not guaranteed to do so.
    
    Returns:
    
    startDate
  - setStartDate
```
public void setStartDate(LocalDate startDate)
```
  - endDate
```
public TransferRecurringSchedule endDate(LocalDate endDate)
```
  - getEndDate
```
@Nullable
public LocalDate getEndDate()
```
    A date in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD). The recurring transfer will end on the last `interval_execution_day` on or before the `end_date`. If the `interval_execution_day` between the start date and the end date (inclusive) is also the same day that `/transfer/recurring/create` was called, the bank *may* make a payment on that day, but it is not guaranteed to do so.
    
    Returns:
    
    endDate
  - setEndDate
```
public void setEndDate(LocalDate endDate)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class TransferRecurringSchedule

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_INTERVAL_UNIT

SERIALIZED_NAME_INTERVAL_COUNT

SERIALIZED_NAME_INTERVAL_EXECUTION_DAY

SERIALIZED_NAME_START_DATE

SERIALIZED_NAME_END_DATE

Constructor Detail

TransferRecurringSchedule

Method Detail

intervalUnit

getIntervalUnit

setIntervalUnit

intervalCount

getIntervalCount

setIntervalCount

intervalExecutionDay

getIntervalExecutionDay

setIntervalExecutionDay

startDate

getStartDate

setStartDate

endDate

getEndDate

setEndDate

equals

hashCode

toString