Package com.intercom.api.resources.dataevents.types

Class DataEvent.Builder

java.lang.Object

com.intercom.api.resources.dataevents.types.DataEvent.Builder

All Implemented Interfaces:

DataEvent._FinalStage, DataEvent.CreatedAtStage, DataEvent.EventNameStage

Enclosing class:

DataEvent

public static final class DataEvent.Builder
extends java.lang.Object
implements DataEvent.EventNameStage, DataEvent.CreatedAtStage, DataEvent._FinalStage

Method Summary

Modifier and Type	Method	Description
DataEvent	build()
DataEvent._FinalStage	createdAt(int createdAt)	The time the event occurred as a UTC Unix timestamp
DataEvent._FinalStage	email(java.lang.String email)	An email address for your user.
DataEvent._FinalStage	email(java.util.Optional<java.lang.String> email)	An email address for your user.
DataEvent.CreatedAtStage	eventName(java.lang.String eventName)	The name of the event that occurred.
DataEvent.Builder	from(DataEvent other)
DataEvent._FinalStage	id(java.lang.String id)	Your identifier for a lead or a user.
DataEvent._FinalStage	id(java.util.Optional<java.lang.String> id)	Your identifier for a lead or a user.
DataEvent._FinalStage	intercomUserId(java.lang.String intercomUserId)	The Intercom identifier for the user.
DataEvent._FinalStage	intercomUserId(java.util.Optional<java.lang.String> intercomUserId)	The Intercom identifier for the user.
DataEvent._FinalStage	metadata(java.util.Map<java.lang.String,java.lang.String> metadata)	Optional metadata about the event.
DataEvent._FinalStage	metadata(java.util.Optional<java.util.Map<java.lang.String,java.lang.String>> metadata)	Optional metadata about the event.
DataEvent._FinalStage	type(java.lang.String type)	The type of the object
DataEvent._FinalStage	type(java.util.Optional<java.lang.String> type)	The type of the object
DataEvent._FinalStage	userId(java.lang.String userId)	Your identifier for the user.
DataEvent._FinalStage	userId(java.util.Optional<java.lang.String> userId)	Your identifier for the user.

Methods inherited from class java.lang.Object

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

Method Detail

from

public DataEvent.Builder from(DataEvent other)

Specified by:

from in interface DataEvent.EventNameStage

eventName

public DataEvent.CreatedAtStage eventName(@NotNull
                                          java.lang.String eventName)

The name of the event that occurred. This is presented to your App's admins when filtering and creating segments - a good event name is typically a past tense 'verb-noun' combination, to improve readability, for example updated-plan.

The name of the event that occurred. This is presented to your App's admins when filtering and creating segments - a good event name is typically a past tense 'verb-noun' combination, to improve readability, for example updated-plan.

Specified by:

eventName in interface DataEvent.EventNameStage

Returns:

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

createdAt

public DataEvent._FinalStage createdAt(int createdAt)

The time the event occurred as a UTC Unix timestamp

The time the event occurred as a UTC Unix timestamp

Specified by:

createdAt in interface DataEvent.CreatedAtStage

Returns:

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

metadata

public DataEvent._FinalStage metadata(java.util.Map<java.lang.String,java.lang.String> metadata)

Optional metadata about the event.

Specified by:

metadata in interface DataEvent._FinalStage

Returns:

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

metadata

public DataEvent._FinalStage metadata(java.util.Optional<java.util.Map<java.lang.String,java.lang.String>> metadata)

Optional metadata about the event.

Specified by:

metadata in interface DataEvent._FinalStage

email

public DataEvent._FinalStage email(java.lang.String email)

An email address for your user. An email should only be used where your application uses email to uniquely identify users.

Specified by:

email in interface DataEvent._FinalStage

Returns:

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

email

public DataEvent._FinalStage email(java.util.Optional<java.lang.String> email)

An email address for your user. An email should only be used where your application uses email to uniquely identify users.

Specified by:

email in interface DataEvent._FinalStage

intercomUserId

public DataEvent._FinalStage intercomUserId(java.lang.String intercomUserId)

The Intercom identifier for the user.

Specified by:

intercomUserId in interface DataEvent._FinalStage

Returns:

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

intercomUserId

public DataEvent._FinalStage intercomUserId(java.util.Optional<java.lang.String> intercomUserId)

The Intercom identifier for the user.

Specified by:

intercomUserId in interface DataEvent._FinalStage

id

public DataEvent._FinalStage id(java.lang.String id)

Your identifier for a lead or a user.

Specified by:

id in interface DataEvent._FinalStage

Returns:

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

id

public DataEvent._FinalStage id(java.util.Optional<java.lang.String> id)

Your identifier for a lead or a user.

Specified by:

id in interface DataEvent._FinalStage

userId

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

Your identifier for the user.

Specified by:

userId in interface DataEvent._FinalStage

Returns:

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

userId

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

Your identifier for the user.

Specified by:

userId in interface DataEvent._FinalStage

type

public DataEvent._FinalStage type(java.lang.String type)

The type of the object

Specified by:

type in interface DataEvent._FinalStage

Returns:

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

type

public DataEvent._FinalStage type(java.util.Optional<java.lang.String> type)

The type of the object

Specified by:

type in interface DataEvent._FinalStage

build

public DataEvent build()

Specified by:

build in interface DataEvent._FinalStage