com.snowplowanalytics.snowplow.payload

Interface Payload

All Known Implementing Classes:

TrackerPayload

public interface Payload

Payload interface The Payload is used to store all the parameters and configurations that are used to send data via the HTTP GET/POST request.

Method Summary

Modifier and Type	Method and Description
void	add(String key, Object value) Add a basic parameter.
void	add(String key, String value) Add a basic parameter.
void	addMap(Map<String,Object> map) Add all the mappings from the specified map.
void	addMap(Map map, Boolean base64_encoded, String type_encoded, String type_no_encoded) Add a map to the Payload with a key dependent on the base 64 encoding option you choose using the two keys provided.
long	getByteSize() Returns the byte size of a payload.
Map	getMap() Returns the Payload as a HashMap.
String	toString() Returns the Payload as a string.

Method Detail

add

void add(@NonNull
         String key,
         @Nullable
         String value)

Add a basic parameter.

Parameters:

key - The parameter key

value - The parameter value as a String

add

void add(@NonNull
         String key,
         @Nullable
         Object value)

Add a basic parameter.

Parameters:

key - The parameter key

value - The parameter value

addMap

void addMap(@NonNull
            Map<String,Object> map)

Add all the mappings from the specified map. The effect is the equivalent to that of calling add(String key, Object value) for each mapping for each key.

Parameters:

map - Mappings to be stored in this map

addMap

void addMap(@NonNull
            Map map,
            @NonNull
            Boolean base64_encoded,
            @Nullable
            String type_encoded,
            @Nullable
            String type_no_encoded)

Add a map to the Payload with a key dependent on the base 64 encoding option you choose using the two keys provided.

Parameters:

map - Mapping to be stored

base64_encoded - The option you choose to encode the data

type_encoded - The key that would be set if the encoding option was set to true

type_no_encoded - They key that would be set if the encoding option was set to false

getMap

@NonNull
Map getMap()

Returns the Payload as a HashMap.

Returns:

A HashMap

toString

@NonNull
String toString()

Returns the Payload as a string. This is essentially the toString from the ObjectNode used to store the Payload.

Overrides:

toString in class Object

Returns:

A string value of the Payload.

getByteSize

long getByteSize()

Returns the byte size of a payload.

Returns:

A long representing the byte size of the payload.