com.heroiclabs.satori.api

Class Event

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.heroiclabs.satori.api.Event

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, EventOrBuilder, java.io.Serializable

public final class Event
extends com.google.protobuf.GeneratedMessage
implements EventOrBuilder

 A single event. Usually, but not necessarily, part of a batch.
 

Protobuf type satori.api.Event

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Event.Builder A single event.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ID_FIELD_NUMBER
static int	METADATA_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	TIMESTAMP_FIELD_NUMBER
static int	VALUE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	containsMetadata(java.lang.String key) Event metadata, if any.
boolean	equals(java.lang.Object obj)
static Event	getDefaultInstance()
Event	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.Parser<Event>	getParserForType()
int	getSerializedSize()
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.
int	hashCode()
boolean	hasTimestamp() The time when the event was triggered on the producer side.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapFieldReflectionAccessor	internalGetMapFieldReflection(int number)
boolean	isInitialized()
static Event.Builder	newBuilder()
static Event.Builder	newBuilder(Event prototype)
Event.Builder	newBuilderForType()
protected Event.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static Event	parseDelimitedFrom(java.io.InputStream input)
static Event	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Event	parseFrom(byte[] data)
static Event	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Event	parseFrom(java.nio.ByteBuffer data)
static Event	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Event	parseFrom(com.google.protobuf.ByteString data)
static Event	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Event	parseFrom(com.google.protobuf.CodedInputStream input)
static Event	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Event	parseFrom(java.io.InputStream input)
static Event	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Event>	parser()
Event.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER

See Also:

Constant Field Values

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER

See Also:

Constant Field Values

VALUE_FIELD_NUMBER

public static final int VALUE_FIELD_NUMBER

See Also:

Constant Field Values

TIMESTAMP_FIELD_NUMBER

public static final int TIMESTAMP_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapFieldReflection

protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getName

public java.lang.String getName()

 Event name.
 

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

Specified by:

getName in interface EventOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Event name.
 

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

Specified by:

getNameBytes in interface EventOrBuilder

Returns:

The bytes for name.

getId

public 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"];

Specified by:

getId in interface EventOrBuilder

Returns:

The id.

getIdBytes

public 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"];

Specified by:

getIdBytes in interface EventOrBuilder

Returns:

The bytes for id.

getMetadataCount

public int getMetadataCount()

Description copied from interface: EventOrBuilder

 Event metadata, if any.
 

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

Specified by:

getMetadataCount in interface EventOrBuilder

containsMetadata

public boolean containsMetadata(java.lang.String key)

 Event metadata, if any.
 

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

Specified by:

containsMetadata in interface EventOrBuilder

getMetadata

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

Deprecated.

Use getMetadataMap() instead.

Specified by:

getMetadata in interface EventOrBuilder

getMetadataMap

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

 Event metadata, if any.
 

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

Specified by:

getMetadataMap in interface EventOrBuilder

getMetadataOrDefault

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

 Event metadata, if any.
 

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

Specified by:

getMetadataOrDefault in interface EventOrBuilder

getMetadataOrThrow

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

 Event metadata, if any.
 

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

Specified by:

getMetadataOrThrow in interface EventOrBuilder

getValue

public java.lang.String getValue()

 Optional value.
 

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

Specified by:

getValue in interface EventOrBuilder

Returns:

The value.

getValueBytes

public com.google.protobuf.ByteString getValueBytes()

 Optional value.
 

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

Specified by:

getValueBytes in interface EventOrBuilder

Returns:

The bytes for value.

hasTimestamp

public boolean hasTimestamp()

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

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

Specified by:

hasTimestamp in interface EventOrBuilder

Returns:

Whether the timestamp field is set.

getTimestamp

public com.google.protobuf.Timestamp getTimestamp()

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

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

Specified by:

getTimestamp in interface EventOrBuilder

Returns:

The timestamp.

getTimestampOrBuilder

public com.google.protobuf.TimestampOrBuilder getTimestampOrBuilder()

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

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

Specified by:

getTimestampOrBuilder in interface EventOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Event parseFrom(java.nio.ByteBuffer data)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Event parseFrom(java.nio.ByteBuffer data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Event parseFrom(com.google.protobuf.ByteString data)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Event parseFrom(com.google.protobuf.ByteString data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Event parseFrom(byte[] data)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Event parseFrom(byte[] data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Event parseFrom(java.io.InputStream input)
                       throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Event parseFrom(java.io.InputStream input,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Event parseDelimitedFrom(java.io.InputStream input)
                                throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Event parseDelimitedFrom(java.io.InputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Event parseFrom(com.google.protobuf.CodedInputStream input)
                       throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Event parseFrom(com.google.protobuf.CodedInputStream input,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public Event.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Event.Builder newBuilder()

newBuilder

public static Event.Builder newBuilder(Event prototype)

toBuilder

public Event.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Event.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static Event getDefaultInstance()

parser

public static com.google.protobuf.Parser<Event> parser()

getParserForType

public com.google.protobuf.Parser<Event> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public Event getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder