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

Class AutomationThrottleStep

java.lang.Object

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

All Implemented Interfaces:

IAutomationStep

public final class AutomationThrottleStep
extends java.lang.Object
implements IAutomationStep

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AutomationThrottleStep._FinalStage
static class	AutomationThrottleStep.Builder
static interface	AutomationThrottleStep.MaxAllowedStage
static interface	AutomationThrottleStep.OnThrottleStage
static interface	AutomationThrottleStep.PeriodStage
static interface	AutomationThrottleStep.ScopeStage

Method Summary

Modifier and Type	Method	Description
static AutomationThrottleStep.MaxAllowedStage	builder()
boolean	equals(java.lang.Object other)
java.lang.String	getAction()
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalProperties()
java.util.Optional<java.lang.String>	getIf()
int	getMaxAllowed()
AutomationThrottleOnThrottle	getOnThrottle()
java.lang.String	getPeriod()
java.util.Optional<java.lang.String>	getRef()
AutomationThrottleScope	getScope()
java.lang.Boolean	getShouldAlert()
java.util.Optional<java.lang.String>	getThrottleKey()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getIf

public java.util.Optional<java.lang.String> getIf()

Specified by:

getIf in interface IAutomationStep

getRef

public java.util.Optional<java.lang.String> getRef()

Specified by:

getRef in interface IAutomationStep

getAction

public java.lang.String getAction()

getMaxAllowed

public int getMaxAllowed()

Returns:

Maximum number of allowed notifications in that timeframe

getPeriod

public java.lang.String getPeriod()

Returns:

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

getScope

public AutomationThrottleScope getScope()

getThrottleKey

public java.util.Optional<java.lang.String> getThrottleKey()

Returns:

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

getShouldAlert

public java.lang.Boolean getShouldAlert()

Returns:

Value must be true

getOnThrottle

public AutomationThrottleOnThrottle getOnThrottle()

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

getAdditionalProperties

public java.util.Map<java.lang.String,java.lang.Object> getAdditionalProperties()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static AutomationThrottleStep.MaxAllowedStage builder()