com.mparticle.sdk.model.eventprocessing.EventProcessingRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-sdk Show documentation
mParticle Java SDK used to integrate with mParticle's Firehose API
There is a newer version: 3.2.0
package com.mparticle.sdk.model.eventprocessing;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.mparticle.sdk.model.Message;
import com.mparticle.sdk.model.eventprocessing.consent.ConsentState;
import com.mparticle.sdk.model.eventprocessing.notification.SystemNotification;
import com.mparticle.sdk.model.registration.Account;
import com.mparticle.sdk.model.registration.Setting;

import java.util.List;
import java.util.Map;

/**
 * This message contains application events logged by the mobile SDKs.
 */
public final class EventProcessingRequest extends Message {

    public EventProcessingRequest() {
        super(Type.EVENT_PROCESSING_REQUEST);
    }

    @JsonProperty("source_id")
    private String sourceId;

    @JsonProperty(value="account", required=true)
    private Account account;

    @JsonProperty("user_identities")
    private List userIdentities;

    @JsonProperty("user_attributes")
    private Map userAttributes;

    @JsonProperty("user_attribute_lists")
    private Map> userAttributeLists;

    @JsonProperty("runtime_environment")
    private RuntimeEnvironment runtimeEnvironment;

    @JsonProperty("integration_attributes")
    private  Map integrationAttributes;

    @JsonProperty("events")
    private List events;

    @JsonProperty("event_connection_settings")
    private List connectionSettings;

    @JsonProperty("source_channel")
    private String sourceChannel;

    @JsonProperty("device_application_stamp")
    private String deviceApplicationStamp;

    @JsonProperty("consent_state")
    private ConsentState consentState;

    @JsonProperty("system_notifications")
    private List systemNotifications;

    public String getSourceId() {
        return sourceId;
    }

    public void setSourceId(String sourceId) {
        this.sourceId = sourceId;
    }

    /**
     *
     * @return module subscription account
     */
    public Account getAccount() {
        return account;
    }

    /**
     *
     * @param account module subscription account
     */
    public void setAccount(Account account) {
        this.account = account;
    }

    /**
     *
     * @return user identities
     */
    public List getUserIdentities() {
        return userIdentities;
    }

    /**
     *
     * @param userIdentities user identities
     */
    public void setUserIdentities(List userIdentities) {
        this.userIdentities = userIdentities;
    }

    /**
     *
     * @return user attributes
     */
    public Map getUserAttributes() {
        return userAttributes;
    }

    /**
     *
     * @param userAttributes user attributes
     */
    public void setUserAttributes(Map userAttributes) {
        this.userAttributes = userAttributes;
    }

    /**
     *
     * @return application execution environment
     */
    public RuntimeEnvironment getRuntimeEnvironment() {
        return runtimeEnvironment;
    }

    /**
     *
     * @param runtimeEnvironment application execution environment
     */
    public void setRuntimeEnvironment(RuntimeEnvironment runtimeEnvironment) {
        this.runtimeEnvironment = runtimeEnvironment;
    }

    /**
     *
     * @return list of events
     */
    public List getEvents() {
        return events;
    }

    /**
     *
     * @param events list of events
     */
    public void setEvents(List events) {
        this.events = events;
    }

    /**
     *
     * @return a map of user attribute lists
     */
    public Map> getUserAttributeLists() {
        return userAttributeLists;
    }

    /**
     *
     * @param userAttributeLists
     */
    public void setUserAttributeLists(Map> userAttributeLists) {
        this.userAttributeLists = userAttributeLists;
    }

    /**
     * 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.
     *
     * @return
     */
    public Map getIntegrationAttributes() {
        return 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.
     *
     * @param integrationAttributes
     */
    public void setIntegrationAttributes(Map integrationAttributes) {
        this.integrationAttributes = integrationAttributes;
    }

    /**
     * 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.
     *
     * @see #getAccount() to get the account-level settings registered for this integration
     * @return connection settings registered by the integration
     */
    public List getConnectionSettings() {
        return connectionSettings;
    }

    public void setConnectionSettings(List connectionSettings) {
        this.connectionSettings = connectionSettings;
    }

    /**
     * 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.
     *
     * @see com.mparticle.sdk.model.Consts.ChannelSourceType
     * @return returns the string constant representing the source
     */
    public String getSourceChannel() {
        return sourceChannel;
    }

    public void setSourceChannel(String sourceChannel) {
        this.sourceChannel = sourceChannel;
    }

    public String getDeviceApplicationStamp() {
        return deviceApplicationStamp;
    }

    public void setDeviceApplicationStamp(String deviceApplicationStamp) {
        this.deviceApplicationStamp = deviceApplicationStamp;
    }

    /**
     * Get the Consent State of the user profile to which this request applies.
     *
     * @return
     */
    public ConsentState getConsentState() {
        return consentState;
    }

    public void setConsentState(ConsentState consentState) {
        this.consentState = consentState;
    }

    public List getSystemNotifications() {
        return systemNotifications;
    }

    public void setSystemNotifications(List systemNotifications) {
        this.systemNotifications = systemNotifications;
    }
}