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

Class AutomationAddToBatchStep

java.lang.Object

com.courier.api.resources.automations.types.AutomationAddToBatchStep

All Implemented Interfaces:

IAutomationStep

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AutomationAddToBatchStep._FinalStage
static class	AutomationAddToBatchStep.Builder
static interface	AutomationAddToBatchStep.MaxWaitPeriodStage
static interface	AutomationAddToBatchStep.RetainStage
static interface	AutomationAddToBatchStep.WaitPeriodStage

Method Summary

Modifier and Type	Method	Description
static AutomationAddToBatchStep.WaitPeriodStage	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>	getBatchId()
java.util.Optional<java.lang.String>	getBatchKey()
java.util.Optional<java.lang.String>	getCategoryKey()
java.util.Optional<java.lang.String>	getIf()
java.util.Optional<AutomationAddToBatchMaxItemsType>	getMaxItems()
java.lang.String	getMaxWaitPeriod()
java.util.Optional<java.lang.String>	getRef()
AutomationAddToBatchRetain	getRetain()
java.util.Optional<AutomationAddToBatchScope>	getScope()
java.lang.String	getWaitPeriod()
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()

getWaitPeriod

public java.lang.String getWaitPeriod()

Returns:

Defines the period of inactivity before the batch is released. Specified as an ISO 8601 duration

getMaxWaitPeriod

public java.lang.String getMaxWaitPeriod()

Returns:

Defines the maximum wait time before the batch should be released. Must be less than wait period. Maximum of 60 days. Specified as an ISO 8601 duration

getMaxItems

public java.util.Optional<AutomationAddToBatchMaxItemsType> getMaxItems()

Returns:

If specified, the batch will release as soon as this number is reached

getRetain

public AutomationAddToBatchRetain getRetain()

getScope

public java.util.Optional<AutomationAddToBatchScope> getScope()

Returns:

Determine the scope of the batching. If user, chosen in this order: recipient, profile.user_id, data.user_id, data.userId. If dynamic, then specify where the batch_key or a reference to the batch_key

getBatchKey

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

Returns:

If using scope=dynamic, provide the key or a reference (e.g., refs.data.batch_key)

getBatchId

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

getCategoryKey

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

Returns:

Defines the field of the data object the batch is set to when complete. Defaults to batch

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 AutomationAddToBatchStep.WaitPeriodStage builder()