Constructor Detail

Method Detail

• apiInvokeTrigger

   final Optional<JourneyApiInvokeTriggerNode> apiInvokeTrigger()

  Trigger fired when the journey is invoked via the API. The optional schema field is a JSON Schema that validates the invocation payload.

• segmentTrigger

   final Optional<JourneySegmentTriggerNode> segmentTrigger()

  Trigger fired by a segment event (identify, group, or track).

• send

   final Optional<JourneySendNode> send()

  Send a notification template to the recipient. Optionally override the recipient address, delay the send, or attach data.

• delayDuration

   final Optional<JourneyDelayDurationNode> delayDuration()

  Pause the journey run for a fixed duration.

• delayUntil

   final Optional<JourneyDelayUntilNode> delayUntil()

  Pause the journey run until a specific time.

• fetchGetDelete

   final Optional<JourneyFetchGetDeleteNode> fetchGetDelete()

  Issue an HTTP GET or DELETE request and merge the response into the journey state per merge_strategy.

• fetchPostPut

   final Optional<JourneyFetchPostPutNode> fetchPostPut()

  Issue an HTTP POST or PUT request with a body and merge the response into the journey state per merge_strategy.

• ai

   final Optional<JourneyAiNode> ai()

  Invoke an AI step with user_prompt and optional web_search. Returns a structured response conforming to output_schema.

• throttleStatic

   final Optional<JourneyThrottleStaticNode> throttleStatic()

  Throttle the journey by a static scope (user or global), allowing at most max_allowed invocations per period.

• throttleDynamic

   final Optional<JourneyThrottleDynamicNode> throttleDynamic()

  Throttle the journey by a dynamic throttle_key, allowing at most max_allowed invocations per period.

• batch

   final Optional<JourneyNode.JourneyBatchNode> batch()

  Collect 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_items is reached, a quiet window of wait_period elapses, or the max_wait_period ceiling hits.

• exit

   final Optional<JourneyExitNode> exit()

  Terminate the journey run.

• branch

   final Optional<JourneyNode.JourneyBranchNode> branch()

  Branch node. Routes to the first entry in paths[] whose conditions match, else falls through to default.nodes.

• isApiInvokeTrigger

   final Boolean isApiInvokeTrigger()

• isSegmentTrigger

   final Boolean isSegmentTrigger()

• isSend

   final Boolean isSend()

• isDelayDuration

   final Boolean isDelayDuration()

• isDelayUntil

   final Boolean isDelayUntil()

• isFetchGetDelete

   final Boolean isFetchGetDelete()

• isFetchPostPut

   final Boolean isFetchPostPut()

• isAi

   final Boolean isAi()

• isThrottleStatic

   final Boolean isThrottleStatic()

• isThrottleDynamic

   final Boolean isThrottleDynamic()

• isBatch

   final Boolean isBatch()

• isExit

   final Boolean isExit()

• isBranch

   final Boolean isBranch()

• asApiInvokeTrigger

   final JourneyApiInvokeTriggerNode asApiInvokeTrigger()

  Trigger fired when the journey is invoked via the API. The optional schema field is a JSON Schema that validates the invocation payload.

• asSegmentTrigger

   final JourneySegmentTriggerNode asSegmentTrigger()

  Trigger fired by a segment event (identify, group, or track).

• asSend

   final JourneySendNode asSend()

  Send a notification template to the recipient. Optionally override the recipient address, delay the send, or attach data.

• asDelayDuration

   final JourneyDelayDurationNode asDelayDuration()

  Pause the journey run for a fixed duration.

• asDelayUntil

   final JourneyDelayUntilNode asDelayUntil()

  Pause the journey run until a specific time.

• asFetchGetDelete

   final JourneyFetchGetDeleteNode asFetchGetDelete()

  Issue an HTTP GET or DELETE request and merge the response into the journey state per merge_strategy.

• asFetchPostPut

   final JourneyFetchPostPutNode asFetchPostPut()

  Issue an HTTP POST or PUT request with a body and merge the response into the journey state per merge_strategy.

• asAi

   final JourneyAiNode asAi()

  Invoke an AI step with user_prompt and optional web_search. Returns a structured response conforming to output_schema.

• asThrottleStatic

   final JourneyThrottleStaticNode asThrottleStatic()

  Throttle the journey by a static scope (user or global), allowing at most max_allowed invocations per period.

• asThrottleDynamic

   final JourneyThrottleDynamicNode asThrottleDynamic()

  Throttle the journey by a dynamic throttle_key, allowing at most max_allowed invocations per period.

• asBatch

   final JourneyNode.JourneyBatchNode asBatch()

  Collect 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_items is reached, a quiet window of wait_period elapses, or the max_wait_period ceiling hits.

• asExit

   final JourneyExitNode asExit()

  Terminate the journey run.

• asBranch

   final JourneyNode.JourneyBranchNode asBranch()

  Branch node. Routes to the first entry in paths[] whose conditions match, else falls through to default.nodes.

• _json

   final Optional<JsonValue> _json()

• accept

   final <T extends Any> T accept(JourneyNode.Visitor<T> visitor)

  Maps this instance's current variant to a value of type T using the given visitor.

  Note that this method is not forwards compatible with new variants from the API, unless visitor overrides Visitor.unknown. To handle variants not known to this version of the SDK gracefully, consider overriding Visitor.unknown:

  import com.courier.core.JsonValue;
  import java.util.Optional;
  
  Optional<String> result = journeyNode.accept(new JourneyNode.Visitor<Optional<String>>() {
      @Override
      public Optional<String> visitApiInvokeTrigger(JourneyApiInvokeTriggerNode apiInvokeTrigger) {
          return Optional.of(apiInvokeTrigger.toString());
      }
  
      // ...
  
      @Override
      public Optional<String> unknown(JsonValue json) {
          // Or inspect the `json`.
          return Optional.empty();
      }
  });

• validate

   final JourneyNode 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.

• isValid

   final Boolean isValid()

• equals

   Boolean equals(Object other)

• hashCode

   Integer hashCode()

• toString

   String toString()

• ofApiInvokeTrigger

   final static JourneyNode ofApiInvokeTrigger(JourneyApiInvokeTriggerNode apiInvokeTrigger)

  Trigger fired when the journey is invoked via the API. The optional schema field is a JSON Schema that validates the invocation payload.

• ofSegmentTrigger

   final static JourneyNode ofSegmentTrigger(JourneySegmentTriggerNode segmentTrigger)

  Trigger fired by a segment event (identify, group, or track).

• ofSend

   final static JourneyNode ofSend(JourneySendNode send)

  Send a notification template to the recipient. Optionally override the recipient address, delay the send, or attach data.

• ofDelayDuration

   final static JourneyNode ofDelayDuration(JourneyDelayDurationNode delayDuration)

  Pause the journey run for a fixed duration.

• ofDelayUntil

   final static JourneyNode ofDelayUntil(JourneyDelayUntilNode delayUntil)

  Pause the journey run until a specific time.

• ofFetchGetDelete

   final static JourneyNode ofFetchGetDelete(JourneyFetchGetDeleteNode fetchGetDelete)

  Issue an HTTP GET or DELETE request and merge the response into the journey state per merge_strategy.

• ofFetchPostPut

   final static JourneyNode ofFetchPostPut(JourneyFetchPostPutNode fetchPostPut)

  Issue an HTTP POST or PUT request with a body and merge the response into the journey state per merge_strategy.

• ofAi

   final static JourneyNode ofAi(JourneyAiNode ai)

  Invoke an AI step with user_prompt and optional web_search. Returns a structured response conforming to output_schema.

• ofThrottleStatic

   final static JourneyNode ofThrottleStatic(JourneyThrottleStaticNode throttleStatic)

  Throttle the journey by a static scope (user or global), allowing at most max_allowed invocations per period.

• ofThrottleDynamic

   final static JourneyNode ofThrottleDynamic(JourneyThrottleDynamicNode throttleDynamic)

  Throttle the journey by a dynamic throttle_key, allowing at most max_allowed invocations per period.

• ofBatch

   final static JourneyNode ofBatch(JourneyNode.JourneyBatchNode batch)

  Collect 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_items is reached, a quiet window of wait_period elapses, or the max_wait_period ceiling hits.

• ofExit

   final static JourneyNode ofExit(JourneyExitNode exit)

  Terminate the journey run.

• ofBranch

   final static JourneyNode ofBranch(JourneyNode.JourneyBranchNode branch)

  Branch node. Routes to the first entry in paths[] whose conditions match, else falls through to default.nodes.