Package com.courier.api.resources.automations.types

Class AutomationThrottleStep.Builder

java.lang.Object

com.courier.api.resources.automations.types.AutomationThrottleStep.Builder

All Implemented Interfaces:

AutomationThrottleStep._FinalStage, AutomationThrottleStep.MaxAllowedStage, AutomationThrottleStep.OnThrottleStage, AutomationThrottleStep.PeriodStage, AutomationThrottleStep.ScopeStage

Enclosing class:

AutomationThrottleStep

public static final class AutomationThrottleStep.Builder
extends java.lang.Object
implements AutomationThrottleStep.MaxAllowedStage, AutomationThrottleStep.PeriodStage, AutomationThrottleStep.ScopeStage, AutomationThrottleStep.OnThrottleStage, AutomationThrottleStep._FinalStage

Method Summary

Modifier and Type	Method	Description
AutomationThrottleStep	build()
AutomationThrottleStep.Builder	from(AutomationThrottleStep other)
AutomationThrottleStep._FinalStage	if_(java.lang.String if_)
AutomationThrottleStep._FinalStage	if_(java.util.Optional<java.lang.String> if_)
AutomationThrottleStep.PeriodStage	maxAllowed(int maxAllowed)	Maximum number of allowed notifications in that timeframe
AutomationThrottleStep._FinalStage	onThrottle(AutomationThrottleOnThrottle onThrottle)
AutomationThrottleStep.ScopeStage	period(java.lang.String period)	Defines the throttle period which corresponds to the max_allowed.
AutomationThrottleStep._FinalStage	ref(java.lang.String ref)
AutomationThrottleStep._FinalStage	ref(java.util.Optional<java.lang.String> ref)
AutomationThrottleStep.OnThrottleStage	scope(AutomationThrottleScope scope)
AutomationThrottleStep._FinalStage	throttleKey(java.lang.String throttleKey)	If using scope=dynamic, provide the reference (e.g., refs.data.throttle_key) to the how the throttle should be identified
AutomationThrottleStep._FinalStage	throttleKey(java.util.Optional<java.lang.String> throttleKey)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

from

public AutomationThrottleStep.Builder from(AutomationThrottleStep other)

Specified by:

from in interface AutomationThrottleStep.MaxAllowedStage

maxAllowed

public AutomationThrottleStep.PeriodStage maxAllowed(int maxAllowed)

Maximum number of allowed notifications in that timeframe

Specified by:

maxAllowed in interface AutomationThrottleStep.MaxAllowedStage

Returns:

Reference to this so that method calls can be chained together.

period

public AutomationThrottleStep.ScopeStage period(java.lang.String period)

Defines the throttle period which corresponds to the max_allowed. Specified as an ISO 8601 duration, https://en.wikipedia.org/wiki/ISO_8601#Durations

Specified by:

period in interface AutomationThrottleStep.PeriodStage

Returns:

Reference to this so that method calls can be chained together.

scope

public AutomationThrottleStep.OnThrottleStage scope(AutomationThrottleScope scope)

Specified by:

scope in interface AutomationThrottleStep.ScopeStage

onThrottle

public AutomationThrottleStep._FinalStage onThrottle(AutomationThrottleOnThrottle onThrottle)

Specified by:

onThrottle in interface AutomationThrottleStep.OnThrottleStage

throttleKey

public AutomationThrottleStep._FinalStage throttleKey(java.lang.String throttleKey)

If using scope=dynamic, provide the reference (e.g., refs.data.throttle_key) to the how the throttle should be identified

Specified by:

throttleKey in interface AutomationThrottleStep._FinalStage

Returns:

Reference to this so that method calls can be chained together.

throttleKey

public AutomationThrottleStep._FinalStage throttleKey(java.util.Optional<java.lang.String> throttleKey)

Specified by:

throttleKey in interface AutomationThrottleStep._FinalStage

ref

public AutomationThrottleStep._FinalStage ref(java.lang.String ref)

Specified by:

ref in interface AutomationThrottleStep._FinalStage

ref

public AutomationThrottleStep._FinalStage ref(java.util.Optional<java.lang.String> ref)

Specified by:

ref in interface AutomationThrottleStep._FinalStage

if_

public AutomationThrottleStep._FinalStage if_(java.lang.String if_)

Specified by:

if_ in interface AutomationThrottleStep._FinalStage

if_

public AutomationThrottleStep._FinalStage if_(java.util.Optional<java.lang.String> if_)

Specified by:

if_ in interface AutomationThrottleStep._FinalStage

build

public AutomationThrottleStep build()

Specified by:

build in interface AutomationThrottleStep._FinalStage