SweepSchedule class abstract

SweepSchedule

Properties:

  • cronExpression - A 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 for more examples. Required when type is cron.
  • type - The schedule type. Possible values: * cron: push out funds based on a cronExpression. * 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: execute the sweep instantly if the triggerAmount is reached.
Annotations
  • @BuiltValue.new()

Constructors

SweepSchedule([void updates(SweepScheduleBuilder b)])
factory

Properties

cronExpression → String?
A 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 for more examples. Required when type is cron.
no setter
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
type → SweepScheduleTypeEnum
The schedule type. Possible values: * cron: push out funds based on a cronExpression. * 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: execute the sweep instantly if the triggerAmount is reached.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(SweepScheduleBuilder)) → SweepSchedule
Rebuilds the instance.
inherited
toBuilder() → SweepScheduleBuilder
Converts the instance to a builder B.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

serializer → Serializer<SweepSchedule>
no setter