com.snowplowanalytics.snowplow.event

Class Structured

java.lang.Object

com.snowplowanalytics.snowplow.event.AbstractEvent

com.snowplowanalytics.snowplow.event.AbstractPrimitive

com.snowplowanalytics.snowplow.event.Structured

All Implemented Interfaces:

Event

public class Structured
extends AbstractPrimitive

A Structured event.

Field Summary

Fields

Modifier and Type	Field and Description
String	action
String	category
String	label
String	property
Double	value

Fields inherited from class com.snowplowanalytics.snowplow.event.AbstractEvent

customContexts, trueTimestamp

Constructor Summary

Constructors

Constructor and Description
Structured(String category, String action)

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getDataPayload()
String	getName()
Structured	label(String label)
Structured	property(String property)
Structured	value(Double value)

Methods inherited from class com.snowplowanalytics.snowplow.event.AbstractEvent

beginProcessing, contexts, endProcessing, getContexts, getTrueTimestamp, trueTimestamp

Methods inherited from class java.lang.Object

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

Field Detail

category

@NonNull
public final String category

action

@NonNull
public final String action

label

@Nullable
public String label

property

@Nullable
public String property

value

@Nullable
public Double value

Constructor Detail

Structured

public Structured(@NonNull
                  String category,
                  @NonNull
                  String action)

Method Detail

label

@NonNull
public Structured label(@Nullable
                                 String label)

property

@NonNull
public Structured property(@Nullable
                                    String property)

value

@NonNull
public Structured value(@Nullable
                                 Double value)

getDataPayload

@NonNull
public Map<String,Object> getDataPayload()

Returns:

the event data payload

getName

@NonNull
public String getName()

Specified by:

getName in class AbstractPrimitive

Returns:

The name of the event.