Package com.heroiclabs.satori.api

Class Event

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
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, Serializable
public final class Event extends com.google.protobuf.GeneratedMessageV3 implements EventOrBuilder
 A single event. Usually, but not necessarily, part of a batch.
Protobuf type satori.api.Event
See Also:

  • Nested Class Summary

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

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

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

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

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    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
    Description
    boolean
    containsMetadata(String key)
    Event metadata, if any.
    boolean
    equals(Object obj)
     
    static Event
    getDefaultInstance()
     
    Event
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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.
    Map<String,String>
    getMetadata()
    Deprecated.
    int
    getMetadataCount()
    Event metadata, if any.
    Map<String,String>
    getMetadataMap()
    Event metadata, if any.
    String
    getMetadataOrDefault(String key, String defaultValue)
    Event metadata, if any.
    String
    getMetadataOrThrow(String key)
    Event metadata, if any.
    String
    getName()
    Event name.
    com.google.protobuf.ByteString
    getNameBytes()
    Event name.
    com.google.protobuf.Parser<Event>
    getParserForType()
     
    int
    getSerializedSize()
     
    Timestamp
    getTimestamp()
    The time when the event was triggered on the producer side.
    TimestampOrBuilder
    getTimestampOrBuilder()
    The time when the event was triggered on the producer side.
    final com.google.protobuf.UnknownFieldSet
    getUnknownFields()
     
    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.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    protected com.google.protobuf.MapField
    internalGetMapField(int number)
     
    final boolean
    isInitialized()
     
    static Event.Builder
    newBuilder()
     
    static Event.Builder
    newBuilder(Event prototype)
     
    Event.Builder
    newBuilderForType()
     
    protected Event.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Event
    parseDelimitedFrom(InputStream input)
     
    static Event
    parseDelimitedFrom(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(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(InputStream input)
     
    static Event
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Event
    parseFrom(ByteBuffer data)
     
    static Event
    parseFrom(ByteBuffer data, 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.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, 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.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getUnknownFields

      public final com.google.protobuf.UnknownFieldSet getUnknownFields()
      Specified by:
      getUnknownFields in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getUnknownFields in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

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

    • internalGetMapField

      protected com.google.protobuf.MapField internalGetMapField(int number)
      Overrides:
      internalGetMapField in class com.google.protobuf.GeneratedMessageV3

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getName

      public String getName()
       Event name.
      string name = 1;
      Specified by:
      getName in interface EventOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Event name.
      string name = 1;
      Specified by:
      getNameBytes in interface EventOrBuilder
      Returns:
      The bytes for name.

    • getId

      public 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;
      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;
      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;
      Specified by:
      getMetadataCount in interface EventOrBuilder

    • containsMetadata

      public boolean containsMetadata(String key)
       Event metadata, if any.
      map<string, string> metadata = 3;
      Specified by:
      containsMetadata in interface EventOrBuilder

    • getMetadata

      @Deprecated public Map<String,String> getMetadata()
      Deprecated.
      Use getMetadataMap() instead.
      Specified by:
      getMetadata in interface EventOrBuilder

    • getMetadataMap

      public Map<String,String> getMetadataMap()
       Event metadata, if any.
      map<string, string> metadata = 3;
      Specified by:
      getMetadataMap in interface EventOrBuilder

    • getMetadataOrDefault

      public String getMetadataOrDefault(String key, String defaultValue)
       Event metadata, if any.
      map<string, string> metadata = 3;
      Specified by:
      getMetadataOrDefault in interface EventOrBuilder

    • getMetadataOrThrow

      public String getMetadataOrThrow(String key)
       Event metadata, if any.
      map<string, string> metadata = 3;
      Specified by:
      getMetadataOrThrow in interface EventOrBuilder

    • getValue

      public String getValue()
       Optional value.
      string value = 4;
      Specified by:
      getValue in interface EventOrBuilder
      Returns:
      The value.

    • getValueBytes

      public com.google.protobuf.ByteString getValueBytes()
       Optional value.
      string value = 4;
      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;
      Specified by:
      hasTimestamp in interface EventOrBuilder
      Returns:
      Whether the timestamp field is set.

    • getTimestamp

      public Timestamp getTimestamp()
       The time when the event was triggered on the producer side.
      .google.protobuf.Timestamp timestamp = 5;
      Specified by:
      getTimestamp in interface EventOrBuilder
      Returns:
      The timestamp.

    • getTimestampOrBuilder

      public TimestampOrBuilder getTimestampOrBuilder()
       The time when the event was triggered on the producer side.
      .google.protobuf.Timestamp timestamp = 5;
      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.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(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(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Event parseFrom(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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static Event parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static Event parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Event parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      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.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • 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.GeneratedMessageV3

    • getDefaultInstanceForType

      public Event getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder