Class JourneyNode.JourneyBatchNode
-
- All Implemented Interfaces:
public final class JourneyNode.JourneyBatchNodeCollect events arriving at the node into a single batch and fire one downstream step with the aggregated payload. The first event into a batch owns the run; later contributing events terminate at the batch step. The batch releases when any of
max_itemsis reached, a quiet window ofwait_periodelapses, or themax_wait_periodceiling hits.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classJourneyNode.JourneyBatchNode.BuilderA builder for JourneyBatchNode.
public final classJourneyNode.JourneyBatchNode.RetainHow to select which collected events to retain in the aggregated payload when the batch releases.
public final classJourneyNode.JourneyBatchNode.Scopepublic final classJourneyNode.JourneyBatchNode.Type
-
Method Summary
Modifier and Type Method Description final StringmaxWaitPeriod()ISO 8601 duration. final JourneyNode.JourneyBatchNode.Retainretain()How to select which collected events to retain in the aggregated payload when the batch releases. final JourneyNode.JourneyBatchNode.Scopescope()final JourneyNode.JourneyBatchNode.Typetype()final StringwaitPeriod()ISO 8601 duration. final Optional<String>id()final Optional<String>categoryKey()Optional partition key. final Optional<JourneyConditionsField>conditions()Condition spec for a journey node. final Optional<Long>maxItems()Releases the batch once this many events have been collected. final JsonField<String>_maxWaitPeriod()Returns the raw JSON value of maxWaitPeriod. final JsonField<JourneyNode.JourneyBatchNode.Retain>_retain()Returns the raw JSON value of retain. final JsonField<JourneyNode.JourneyBatchNode.Scope>_scope()Returns the raw JSON value of scope. final JsonField<JourneyNode.JourneyBatchNode.Type>_type()Returns the raw JSON value of type. final JsonField<String>_waitPeriod()Returns the raw JSON value of waitPeriod. final JsonField<String>_id()Returns the raw JSON value of id. final JsonField<String>_categoryKey()Returns the raw JSON value of categoryKey. final JsonField<JourneyConditionsField>_conditions()Returns the raw JSON value of conditions. final JsonField<Long>_maxItems()Returns the raw JSON value of maxItems. final Map<String, JsonValue>_additionalProperties()final JourneyNode.JourneyBatchNode.BuildertoBuilder()final JourneyNode.JourneyBatchNodevalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static JourneyNode.JourneyBatchNode.Builderbuilder()Returns a mutable builder for constructing an instance of JourneyBatchNode. -
-
Method Detail
-
maxWaitPeriod
final String maxWaitPeriod()
ISO 8601 duration. Hard ceiling from the first event into the batch; releases the batch unconditionally when it elapses.
-
retain
final JourneyNode.JourneyBatchNode.Retain retain()
How to select which collected events to retain in the aggregated payload when the batch releases.
-
scope
final JourneyNode.JourneyBatchNode.Scope scope()
-
type
final JourneyNode.JourneyBatchNode.Type type()
-
waitPeriod
final String waitPeriod()
ISO 8601 duration. Quiet window that releases the batch when it elapses with no new contributing events. Must be less than
max_wait_period.
-
categoryKey
final Optional<String> categoryKey()
Optional partition key. Events with the same
category_keyare batched together; events with different values are batched separately.
-
conditions
final Optional<JourneyConditionsField> conditions()
Condition spec for a journey node. Accepts a single condition atom, an AND/OR group, or an AND/OR nested group. Omit the
conditionsproperty entirely to express "no conditions".
-
maxItems
final Optional<Long> maxItems()
Releases the batch once this many events have been collected.
-
_maxWaitPeriod
final JsonField<String> _maxWaitPeriod()
Returns the raw JSON value of maxWaitPeriod.
Unlike maxWaitPeriod, this method doesn't throw if the JSON field has an unexpected type.
-
_retain
final JsonField<JourneyNode.JourneyBatchNode.Retain> _retain()
Returns the raw JSON value of retain.
Unlike retain, this method doesn't throw if the JSON field has an unexpected type.
-
_scope
final JsonField<JourneyNode.JourneyBatchNode.Scope> _scope()
Returns the raw JSON value of scope.
Unlike scope, this method doesn't throw if the JSON field has an unexpected type.
-
_type
final JsonField<JourneyNode.JourneyBatchNode.Type> _type()
Returns the raw JSON value of type.
Unlike type, this method doesn't throw if the JSON field has an unexpected type.
-
_waitPeriod
final JsonField<String> _waitPeriod()
Returns the raw JSON value of waitPeriod.
Unlike waitPeriod, this method doesn't throw if the JSON field has an unexpected type.
-
_id
final JsonField<String> _id()
Returns the raw JSON value of id.
Unlike id, this method doesn't throw if the JSON field has an unexpected type.
-
_categoryKey
final JsonField<String> _categoryKey()
Returns the raw JSON value of categoryKey.
Unlike categoryKey, this method doesn't throw if the JSON field has an unexpected type.
-
_conditions
final JsonField<JourneyConditionsField> _conditions()
Returns the raw JSON value of conditions.
Unlike conditions, this method doesn't throw if the JSON field has an unexpected type.
-
_maxItems
final JsonField<Long> _maxItems()
Returns the raw JSON value of maxItems.
Unlike maxItems, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final JourneyNode.JourneyBatchNode.Builder toBuilder()
-
validate
final JourneyNode.JourneyBatchNode validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static JourneyNode.JourneyBatchNode.Builder builder()
Returns a mutable builder for constructing an instance of JourneyBatchNode.
The following fields are required:
.maxWaitPeriod() .retain() .scope() .type() .waitPeriod()
-
-
-
-