Package com.courier.api.resources.inbound.types

Class InboundTrackEvent.Builder

java.lang.Object

com.courier.api.resources.inbound.types.InboundTrackEvent.Builder

All Implemented Interfaces:

InboundTrackEvent._FinalStage, InboundTrackEvent.EventStage, InboundTrackEvent.MessageIdStage

Enclosing class:

InboundTrackEvent

public static final class InboundTrackEvent.Builder
extends java.lang.Object
implements InboundTrackEvent.EventStage, InboundTrackEvent.MessageIdStage, InboundTrackEvent._FinalStage

Method Summary

Modifier and Type	Method	Description
InboundTrackEvent	build()
InboundTrackEvent.MessageIdStage	event(java.lang.String event)	A descriptive name of the event.
InboundTrackEvent.Builder	from(InboundTrackEvent other)
InboundTrackEvent._FinalStage	messageId(java.lang.String messageId)	A required unique identifier that will be used to de-duplicate requests.
InboundTrackEvent._FinalStage	properties(java.lang.String key, java.lang.Object value)
InboundTrackEvent._FinalStage	properties(java.util.Map<java.lang.String,java.lang.Object> properties)
InboundTrackEvent._FinalStage	putAllProperties(java.util.Map<java.lang.String,java.lang.Object> properties)
InboundTrackEvent._FinalStage	userId(java.lang.String userId)	The user id assocatiated with the track
InboundTrackEvent._FinalStage	userId(java.util.Optional<java.lang.String> userId)

Methods inherited from class java.lang.Object

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

Method Detail

from

public InboundTrackEvent.Builder from(InboundTrackEvent other)

Specified by:

from in interface InboundTrackEvent.EventStage

event

public InboundTrackEvent.MessageIdStage event(java.lang.String event)

A descriptive name of the event. This name will appear as a trigger in the Courier Automation Trigger node.

Specified by:

event in interface InboundTrackEvent.EventStage

Returns:

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

messageId

public InboundTrackEvent._FinalStage messageId(java.lang.String messageId)

A required unique identifier that will be used to de-duplicate requests. If not unique, will respond with 409 Conflict status

Specified by:

messageId in interface InboundTrackEvent.MessageIdStage

Returns:

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

userId

public InboundTrackEvent._FinalStage userId(java.lang.String userId)

The user id assocatiated with the track

Specified by:

userId in interface InboundTrackEvent._FinalStage

Returns:

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

userId

public InboundTrackEvent._FinalStage userId(java.util.Optional<java.lang.String> userId)

Specified by:

userId in interface InboundTrackEvent._FinalStage

properties

public InboundTrackEvent._FinalStage properties(java.lang.String key,
                                                java.lang.Object value)

Specified by:

properties in interface InboundTrackEvent._FinalStage

putAllProperties

public InboundTrackEvent._FinalStage putAllProperties(java.util.Map<java.lang.String,java.lang.Object> properties)

Specified by:

putAllProperties in interface InboundTrackEvent._FinalStage

properties

public InboundTrackEvent._FinalStage properties(java.util.Map<java.lang.String,java.lang.Object> properties)

Specified by:

properties in interface InboundTrackEvent._FinalStage

build

public InboundTrackEvent build()

Specified by:

build in interface InboundTrackEvent._FinalStage