Skip to main content

JourneyNode

Struct JourneyNode 

Source
pub struct JourneyNode {
Show 17 fields pub id: Option<String>, pub kind: KindType, pub client_node_id: Option<String>, pub annotation: Option<String>, pub duration_seconds: Option<i32>, pub relative_to: Option<RelativeToType>, pub windows: Option<Vec<JourneyTimeWindow>>, pub time_zone: Option<String>, pub use_user_time_zone: Option<bool>, pub template_id: Option<String>, pub iam_id: Option<String>, pub user_ttl_seconds: Option<i32>, pub webhook_id: Option<String>, pub assignments: Option<HashMap<String, String>>, pub randomize_on_entry: Option<bool>, pub branches: Option<Vec<JourneyBranch>>, pub expiration: Option<Box<JourneyWaitUntilExpiration>>,
}
Expand description

JourneyNode : A journey node. The kind field selects which other fields apply. Branching nodes (split_range, yes_no, wait_until) nest their sub-graphs inline via branches[].nodes.

Fields§

§id: Option<String>

Server-assigned node UUID. Returned on reads. Required on update to keep an existing node. Rejected on create with a 400 validation error.

§kind: KindType

Node kind. Selects which other fields apply.

§client_node_id: Option<String>

Optional client-assigned identifier, unique within the journey. Use it to reference this node from elsewhere in the same request. Persisted and returned on reads.

§annotation: Option<String>

Optional free-text label, up to 255 characters. Stored and returned as-is with no effect on journey behavior.

§duration_seconds: Option<i32>

wait nodes: seconds to hold the user. Minimum 60, maximum 31556952 (1 year).

§relative_to: Option<RelativeToType>

time_window nodes: schedule_in_timezone uses the configured windows; last_active_time holds relative to the user’s last active time.

§windows: Option<Vec<JourneyTimeWindow>>

time_window nodes: one or more time windows. A window with no day_of_week applies to every day. Required when relative_to is schedule_in_timezone; omit when it is last_active_time.

§time_zone: Option<String>

time_window nodes: IANA timezone identifier used when the user’s timezone is unavailable.

§use_user_time_zone: Option<bool>

time_window nodes: when true, uses the user’s timezone if available.

§template_id: Option<String>

send_push, send_email, and send_sms nodes: UUID of the template to send.

§iam_id: Option<String>

send_iam nodes: UUID of the in-app message to send.

§user_ttl_seconds: Option<i32>

send_iam nodes: optional time-to-live for the in-app message, in seconds.

§webhook_id: Option<String>

send_webhook nodes: UUID of the webhook to send.

§assignments: Option<HashMap<String, String>>

tag nodes: tag key-value pairs to assign. An empty string value removes the tag. Keys are limited to 255 characters and values to 1024.

§randomize_on_entry: Option<bool>

split_range nodes: when true, assigns each user to a branch at random on entry. Defaults to false.

§branches: Option<Vec<JourneyBranch>>

Branching nodes: nested branches. split_range requires 2-20 weighted branches that sum to 100. yes_no requires exactly 2 branches. wait_until requires 1-10 condition branches.

§expiration: Option<Box<JourneyWaitUntilExpiration>>

Implementations§

Source§

impl JourneyNode

Source

pub fn new(kind: KindType) -> JourneyNode

A journey node. The kind field selects which other fields apply. Branching nodes (split_range, yes_no, wait_until) nest their sub-graphs inline via branches[].nodes.

Trait Implementations§

Source§

impl Clone for JourneyNode

Source§

fn clone(&self) -> JourneyNode

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for JourneyNode

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for JourneyNode

Source§

fn default() -> JourneyNode

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for JourneyNode

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for JourneyNode

Source§

fn eq(&self, other: &JourneyNode) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for JourneyNode

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for JourneyNode

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more