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

Class AutomationAddToBatchStep.Builder

java.lang.Object

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

All Implemented Interfaces:

AutomationAddToBatchStep._FinalStage, AutomationAddToBatchStep.MaxWaitPeriodStage, AutomationAddToBatchStep.RetainStage, AutomationAddToBatchStep.WaitPeriodStage

Enclosing class:

AutomationAddToBatchStep

public static final class AutomationAddToBatchStep.Builder
extends java.lang.Object
implements AutomationAddToBatchStep.WaitPeriodStage, AutomationAddToBatchStep.MaxWaitPeriodStage, AutomationAddToBatchStep.RetainStage, AutomationAddToBatchStep._FinalStage

Method Summary

Modifier and Type	Method	Description
AutomationAddToBatchStep._FinalStage	batchId(java.lang.String batchId)
AutomationAddToBatchStep._FinalStage	batchId(java.util.Optional<java.lang.String> batchId)
AutomationAddToBatchStep._FinalStage	batchKey(java.lang.String batchKey)	If using scope=dynamic, provide the key or a reference (e.g., refs.data.batch_key)
AutomationAddToBatchStep._FinalStage	batchKey(java.util.Optional<java.lang.String> batchKey)
AutomationAddToBatchStep	build()
AutomationAddToBatchStep._FinalStage	categoryKey(java.lang.String categoryKey)	Defines the field of the data object the batch is set to when complete.
AutomationAddToBatchStep._FinalStage	categoryKey(java.util.Optional<java.lang.String> categoryKey)
AutomationAddToBatchStep.Builder	from(AutomationAddToBatchStep other)
AutomationAddToBatchStep._FinalStage	if_(java.lang.String if_)
AutomationAddToBatchStep._FinalStage	if_(java.util.Optional<java.lang.String> if_)
AutomationAddToBatchStep._FinalStage	maxItems(AutomationAddToBatchMaxItemsType maxItems)	If specified, the batch will release as soon as this number is reached
AutomationAddToBatchStep._FinalStage	maxItems(java.util.Optional<AutomationAddToBatchMaxItemsType> maxItems)
AutomationAddToBatchStep.RetainStage	maxWaitPeriod(java.lang.String maxWaitPeriod)	Defines the maximum wait time before the batch should be released.
AutomationAddToBatchStep._FinalStage	ref(java.lang.String ref)
AutomationAddToBatchStep._FinalStage	ref(java.util.Optional<java.lang.String> ref)
AutomationAddToBatchStep._FinalStage	retain(AutomationAddToBatchRetain retain)
AutomationAddToBatchStep._FinalStage	scope(AutomationAddToBatchScope scope)	Determine the scope of the batching.
AutomationAddToBatchStep._FinalStage	scope(java.util.Optional<AutomationAddToBatchScope> scope)
AutomationAddToBatchStep.MaxWaitPeriodStage	waitPeriod(java.lang.String waitPeriod)	Defines the period of inactivity before the batch is released.

Methods inherited from class java.lang.Object

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

Method Detail

from

public AutomationAddToBatchStep.Builder from(AutomationAddToBatchStep other)

Specified by:

from in interface AutomationAddToBatchStep.WaitPeriodStage

waitPeriod

public AutomationAddToBatchStep.MaxWaitPeriodStage waitPeriod(java.lang.String waitPeriod)

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

Specified by:

waitPeriod in interface AutomationAddToBatchStep.WaitPeriodStage

Returns:

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

maxWaitPeriod

public AutomationAddToBatchStep.RetainStage maxWaitPeriod(java.lang.String maxWaitPeriod)

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

Specified by:

maxWaitPeriod in interface AutomationAddToBatchStep.MaxWaitPeriodStage

Returns:

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

retain

public AutomationAddToBatchStep._FinalStage retain(AutomationAddToBatchRetain retain)

Specified by:

retain in interface AutomationAddToBatchStep.RetainStage

categoryKey

public AutomationAddToBatchStep._FinalStage categoryKey(java.lang.String categoryKey)

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

Specified by:

categoryKey in interface AutomationAddToBatchStep._FinalStage

Returns:

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

categoryKey

public AutomationAddToBatchStep._FinalStage categoryKey(java.util.Optional<java.lang.String> categoryKey)

Specified by:

categoryKey in interface AutomationAddToBatchStep._FinalStage

batchId

public AutomationAddToBatchStep._FinalStage batchId(java.lang.String batchId)

Specified by:

batchId in interface AutomationAddToBatchStep._FinalStage

batchId

public AutomationAddToBatchStep._FinalStage batchId(java.util.Optional<java.lang.String> batchId)

Specified by:

batchId in interface AutomationAddToBatchStep._FinalStage

batchKey

public AutomationAddToBatchStep._FinalStage batchKey(java.lang.String batchKey)

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

Specified by:

batchKey in interface AutomationAddToBatchStep._FinalStage

Returns:

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

batchKey

public AutomationAddToBatchStep._FinalStage batchKey(java.util.Optional<java.lang.String> batchKey)

Specified by:

batchKey in interface AutomationAddToBatchStep._FinalStage

scope

public AutomationAddToBatchStep._FinalStage scope(AutomationAddToBatchScope scope)

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

Specified by:

scope in interface AutomationAddToBatchStep._FinalStage

Returns:

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

scope

public AutomationAddToBatchStep._FinalStage scope(java.util.Optional<AutomationAddToBatchScope> scope)

Specified by:

scope in interface AutomationAddToBatchStep._FinalStage

maxItems

public AutomationAddToBatchStep._FinalStage maxItems(AutomationAddToBatchMaxItemsType maxItems)

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

Specified by:

maxItems in interface AutomationAddToBatchStep._FinalStage

Returns:

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

maxItems

public AutomationAddToBatchStep._FinalStage maxItems(java.util.Optional<AutomationAddToBatchMaxItemsType> maxItems)

Specified by:

maxItems in interface AutomationAddToBatchStep._FinalStage

ref

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

Specified by:

ref in interface AutomationAddToBatchStep._FinalStage

ref

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

Specified by:

ref in interface AutomationAddToBatchStep._FinalStage

if_

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

Specified by:

if_ in interface AutomationAddToBatchStep._FinalStage

if_

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

Specified by:

if_ in interface AutomationAddToBatchStep._FinalStage

build

public AutomationAddToBatchStep build()

Specified by:

build in interface AutomationAddToBatchStep._FinalStage