Class CronSweepSchedule


  • public class CronSweepSchedule
    extends Object
    CronSweepSchedule
    • Constructor Detail

      • CronSweepSchedule

        public CronSweepSchedule()
    • Method Detail

      • getCronExpression

        public String getCronExpression()
        A [cron expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) that is used to set the sweep schedule. The schedule uses the time zone of the balance account. For example, **30 17 * * MON** schedules a sweep every Monday at 17:30. The expression must have five values separated by a single space in the following order: * Minute: **0-59** * Hour: **0-23** * Day of the month: **1-31** * Month: **1-12** or **JAN-DEC** * Day of the week: **0-7** (0 and 7 are Sunday) or **MON-SUN**. The following non-standard characters are supported: *****, **L**, **#**, **W** and **_/_**. See [crontab guru](https://crontab.guru/) for more examples.
        Returns:
        cronExpression
      • setCronExpression

        public void setCronExpression​(String cronExpression)
      • getType

        public CronSweepSchedule.TypeEnum getType()
        The schedule type. Possible values: * **cron**: push out funds based on a cron expression. * **daily**: push out funds daily at 07:00 AM CET. * **weekly**: push out funds every Monday at 07:00 AM CET. * **monthly**: push out funds every first of the month at 07:00 AM CET. * **balance**: pull in funds instantly if the balance is less than or equal to the `triggerAmount`. You can only use this for sweeps of `type` **pull** and when the source is a `merchantAccount` or `transferInstrument`.
        Returns:
        type
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • validateJsonObject

        public static void validateJsonObject​(com.google.gson.JsonObject jsonObj)
                                       throws IOException
        Validates the JSON Object and throws an exception if issues found
        Parameters:
        jsonObj - JSON Object
        Throws:
        IOException - if the JSON Object is invalid with respect to CronSweepSchedule
      • fromJson

        public static CronSweepSchedule fromJson​(String jsonString)
                                          throws IOException
        Create an instance of CronSweepSchedule given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of CronSweepSchedule
        Throws:
        IOException - if the JSON string is invalid with respect to CronSweepSchedule
      • toJson

        public String toJson()
        Convert an instance of CronSweepSchedule to an JSON string
        Returns:
        JSON string