com.snowplowanalytics.snowplow.event

Class ConsentDocument

java.lang.Object

com.snowplowanalytics.snowplow.event.AbstractEvent

com.snowplowanalytics.snowplow.event.AbstractSelfDescribing

com.snowplowanalytics.snowplow.event.ConsentDocument

All Implemented Interfaces:

Event

public class ConsentDocument
extends AbstractSelfDescribing

A consent document event.

Field Summary

Fields

Modifier and Type	Field and Description
String	documentDescription Description of the document.
String	documentId Identifier of the document.
String	documentName Name of the document.
String	documentVersion Version of the document.

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

customContexts, trueTimestamp

Constructor Summary

Constructors

Constructor and Description
ConsentDocument(String documentId, String documentVersion) Create a consent document event.

Method Summary

Modifier and Type	Method and Description
ConsentDocument	documentDescription(String documentDescription) Description of the document.
ConsentDocument	documentName(String documentName) Name of the document.
Map<String,Object>	getDataPayload()
String	getSchema()

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

documentId

@NonNull
public final String documentId

Identifier of the document.

documentVersion

@NonNull
public final String documentVersion

Version of the document.

documentName

@Nullable
public String documentName

Name of the document.

documentDescription

@Nullable
public String documentDescription

Description of the document.

Constructor Detail

ConsentDocument

public ConsentDocument(@NonNull
                       String documentId,
                       @NonNull
                       String documentVersion)

Create a consent document event.

Parameters:

documentId - identifier of the document.

documentVersion - version of the document.

Method Detail

documentName

@NonNull
public ConsentDocument documentName(@Nullable
                                             String documentName)

Name of the document.

documentDescription

@NonNull
public ConsentDocument documentDescription(@Nullable
                                                    String documentDescription)

Description of the document.

getDataPayload

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

Returns:

the event data payload

getSchema

@NonNull
public String getSchema()

Specified by:

getSchema in class AbstractSelfDescribing

Returns:

The schema of the event.