com.mparticle.sdk.model.eventprocessing

Class EventProcessingRequest

java.lang.Object

com.mparticle.sdk.model.Message

com.mparticle.sdk.model.eventprocessing.EventProcessingRequest

public final class EventProcessingRequest
extends Message

This message contains application events logged by the mobile SDKs.

Nested Class Summary

Nested classes/interfaces inherited from class com.mparticle.sdk.model.Message

Message.Type

Constructor Summary

Constructors

Constructor and Description
EventProcessingRequest()

Method Summary

Modifier and Type	Method and Description
Account	getAccount()
java.util.List<Setting>	getConnectionSettings() Gets the connection-level settings registered by this integration.
ConsentState	getConsentState() Get the Consent State of the user profile to which this request applies.
java.lang.String	getDeviceApplicationStamp()
java.util.List<Event>	getEvents()
java.util.Map<java.lang.String,java.lang.String>	getIntegrationAttributes() Integration attributes provide a way to set user/request-level attributes specific to an integration.
RuntimeEnvironment	getRuntimeEnvironment()
java.lang.String	getSourceChannel() Gets the source channel of this request.
java.lang.String	getSourceId()
java.util.List<SystemNotification>	getSystemNotifications()
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getUserAttributeLists()
java.util.Map<java.lang.String,java.lang.String>	getUserAttributes()
java.util.List<UserIdentity>	getUserIdentities()
void	setAccount(Account account)
void	setConnectionSettings(java.util.List<Setting> connectionSettings)
void	setConsentState(ConsentState consentState)
void	setDeviceApplicationStamp(java.lang.String deviceApplicationStamp)
void	setEvents(java.util.List<Event> events)
void	setIntegrationAttributes(java.util.Map<java.lang.String,java.lang.String> integrationAttributes) Integration attributes provide a way to set user/request-level attributes specific to an integration.
void	setRuntimeEnvironment(RuntimeEnvironment runtimeEnvironment)
void	setSourceChannel(java.lang.String sourceChannel)
void	setSourceId(java.lang.String sourceId)
void	setSystemNotifications(java.util.List<SystemNotification> systemNotifications)
void	setUserAttributeLists(java.util.Map<java.lang.String,java.util.List<java.lang.String>> userAttributeLists)
void	setUserAttributes(java.util.Map<java.lang.String,java.lang.String> userAttributes)
void	setUserIdentities(java.util.List<UserIdentity> userIdentities)

Methods inherited from class com.mparticle.sdk.model.Message

getId, getTimestamp, getType, setTimestamp

Methods inherited from class java.lang.Object

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

Constructor Detail

EventProcessingRequest

public EventProcessingRequest()

Method Detail

getSourceId

public java.lang.String getSourceId()

setSourceId

public void setSourceId(java.lang.String sourceId)

getAccount

public Account getAccount()

Returns:

module subscription account

setAccount

public void setAccount(Account account)

Parameters:

account - module subscription account

getUserIdentities

public java.util.List<UserIdentity> getUserIdentities()

Returns:

user identities

setUserIdentities

public void setUserIdentities(java.util.List<UserIdentity> userIdentities)

Parameters:

userIdentities - user identities

getUserAttributes

public java.util.Map<java.lang.String,java.lang.String> getUserAttributes()

Returns:

user attributes

setUserAttributes

public void setUserAttributes(java.util.Map<java.lang.String,java.lang.String> userAttributes)

Parameters:

userAttributes - user attributes

getRuntimeEnvironment

public RuntimeEnvironment getRuntimeEnvironment()

Returns:

application execution environment

setRuntimeEnvironment

public void setRuntimeEnvironment(RuntimeEnvironment runtimeEnvironment)

Parameters:

runtimeEnvironment - application execution environment

getEvents

public java.util.List<Event> getEvents()

Returns:

list of events

setEvents

public void setEvents(java.util.List<Event> events)

Parameters:

events - list of events

getUserAttributeLists

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getUserAttributeLists()

Returns:

a map of user attribute lists

setUserAttributeLists

public void setUserAttributeLists(java.util.Map<java.lang.String,java.util.List<java.lang.String>> userAttributeLists)

Parameters:

userAttributeLists -

getIntegrationAttributes

public java.util.Map<java.lang.String,java.lang.String> getIntegrationAttributes()

Integration attributes provide a way to set user/request-level attributes specific to an integration. For example, a Kit in the mobile SDK can set an ID for use by its respective server-side integration.

Returns:

setIntegrationAttributes

public void setIntegrationAttributes(java.util.Map<java.lang.String,java.lang.String> integrationAttributes)

Integration attributes provide a way to set user/request-level attributes specific to an integration. For example, a Kit in the mobile SDK can set an ID for use by its respective server-side integration.

Parameters:

integrationAttributes -

getConnectionSettings

public java.util.List<Setting> getConnectionSettings()

Gets the connection-level settings registered by this integration. mParticle integrations may be configured with two different sets of settings: - Account-level settings, meant to be reused across platforms and/or apps - Connection-level settings, meant to change specific behaviors for each instance of an output/integration As a Firehose integration developer, it's up to *you* to define which settings should be account-level, and which should be configured on a per-integration-instance basis.

Returns:

connection settings registered by the integration

See Also:

to get the account-level settings registered for this integration

setConnectionSettings

public void setConnectionSettings(java.util.List<Setting> connectionSettings)

getSourceChannel

public java.lang.String getSourceChannel()

Gets the source channel of this request. This is the originating source of the data, such as one of mParticle's native SDKs, or server APIs.

Returns:

returns the string constant representing the source

See Also:

Consts.ChannelSourceType

setSourceChannel

public void setSourceChannel(java.lang.String sourceChannel)

getDeviceApplicationStamp

public java.lang.String getDeviceApplicationStamp()

setDeviceApplicationStamp

public void setDeviceApplicationStamp(java.lang.String deviceApplicationStamp)

getConsentState

public ConsentState getConsentState()

Get the Consent State of the user profile to which this request applies.

Returns:

setConsentState

public void setConsentState(ConsentState consentState)

getSystemNotifications

public java.util.List<SystemNotification> getSystemNotifications()

setSystemNotifications

public void setSystemNotifications(java.util.List<SystemNotification> systemNotifications)