com.heroiclabs.satori.api

Interface EventOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Event, Event.Builder

public interface EventOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsMetadata(java.lang.String key) Event metadata, if any.
java.lang.String	getId() Optional event ID assigned by the client, used to de-duplicate in retransmission scenarios.
com.google.protobuf.ByteString	getIdBytes() Optional event ID assigned by the client, used to de-duplicate in retransmission scenarios.
java.util.Map<java.lang.String,java.lang.String>	getMetadata() Deprecated.
int	getMetadataCount() Event metadata, if any.
java.util.Map<java.lang.String,java.lang.String>	getMetadataMap() Event metadata, if any.
java.lang.String	getMetadataOrDefault(java.lang.String key, java.lang.String defaultValue) Event metadata, if any.
java.lang.String	getMetadataOrThrow(java.lang.String key) Event metadata, if any.
java.lang.String	getName() Event name.
com.google.protobuf.ByteString	getNameBytes() Event name.
com.google.protobuf.Timestamp	getTimestamp() The time when the event was triggered on the producer side.
com.google.protobuf.TimestampOrBuilder	getTimestampOrBuilder() The time when the event was triggered on the producer side.
java.lang.String	getValue() Optional value.
com.google.protobuf.ByteString	getValueBytes() Optional value.
boolean	hasTimestamp() The time when the event was triggered on the producer side.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

java.lang.String getName()

 Event name.
 

string name = 1 [json_name = "name"];

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Event name.
 

string name = 1 [json_name = "name"];

Returns:

The bytes for name.

getId

java.lang.String getId()

 Optional event ID assigned by the client, used to de-duplicate in retransmission scenarios.
 If not supplied the server will assign a randomly generated unique event identifier.
 

string id = 2 [json_name = "id"];

Returns:

The id.

getIdBytes

com.google.protobuf.ByteString getIdBytes()

 Optional event ID assigned by the client, used to de-duplicate in retransmission scenarios.
 If not supplied the server will assign a randomly generated unique event identifier.
 

string id = 2 [json_name = "id"];

Returns:

The bytes for id.

getMetadataCount

int getMetadataCount()

 Event metadata, if any.
 

map<string, string> metadata = 3 [json_name = "metadata"];

containsMetadata

boolean containsMetadata(java.lang.String key)

 Event metadata, if any.
 

map<string, string> metadata = 3 [json_name = "metadata"];

getMetadata

@Deprecated
java.util.Map<java.lang.String,java.lang.String> getMetadata()

Deprecated.

Use getMetadataMap() instead.

getMetadataMap

java.util.Map<java.lang.String,java.lang.String> getMetadataMap()

 Event metadata, if any.
 

map<string, string> metadata = 3 [json_name = "metadata"];

getMetadataOrDefault

java.lang.String getMetadataOrDefault(java.lang.String key,
                                      java.lang.String defaultValue)

 Event metadata, if any.
 

map<string, string> metadata = 3 [json_name = "metadata"];

getMetadataOrThrow

java.lang.String getMetadataOrThrow(java.lang.String key)

 Event metadata, if any.
 

map<string, string> metadata = 3 [json_name = "metadata"];

getValue

java.lang.String getValue()

 Optional value.
 

string value = 4 [json_name = "value"];

Returns:

The value.

getValueBytes

com.google.protobuf.ByteString getValueBytes()

 Optional value.
 

string value = 4 [json_name = "value"];

Returns:

The bytes for value.

hasTimestamp

boolean hasTimestamp()

 The time when the event was triggered on the producer side.
 

.google.protobuf.Timestamp timestamp = 5 [json_name = "timestamp"];

Returns:

Whether the timestamp field is set.

getTimestamp

com.google.protobuf.Timestamp getTimestamp()

 The time when the event was triggered on the producer side.
 

.google.protobuf.Timestamp timestamp = 5 [json_name = "timestamp"];

Returns:

The timestamp.

getTimestampOrBuilder

com.google.protobuf.TimestampOrBuilder getTimestampOrBuilder()

 The time when the event was triggered on the producer side.
 

.google.protobuf.Timestamp timestamp = 5 [json_name = "timestamp"];