Interface IngestedEventOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
IngestedEvent, IngestedEvent.Builder

public interface IngestedEventOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Summary

    Modifier and Type
    Method
    Description
    Specifies the collection to which this event belongs.
    com.google.protobuf.ByteString
    Specifies the collection to which this event belongs.
    Specifies the payload of the event being delivered.
    com.google.protobuf.ByteString
    Specifies the payload of the event being delivered.
    boolean
    Whether this event is a standalone event (`true`), or part of a series (`false`).
    int
    Index of this event within the ordinal context of all events sent for a given event stream or session.
    long
    Specifies the timestamp indicating when this event was ingested.
    long
    Specifies the timestamp indicating when this event occurred.
    Scope or operational context ID for this event.
    com.google.protobuf.ByteString
    Scope or operational context ID for this event.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • getCollection

      String getCollection()
       Specifies the collection to which this event belongs. Named event collections are used for certain types of events
       which are grouped together for reporting purposes.
       
      string collection = 1 [json_name = "collection"];
      Returns:
      The collection.
    • getCollectionBytes

      com.google.protobuf.ByteString getCollectionBytes()
       Specifies the collection to which this event belongs. Named event collections are used for certain types of events
       which are grouped together for reporting purposes.
       
      string collection = 1 [json_name = "collection"];
      Returns:
      The bytes for collection.
    • getFin

      boolean getFin()
       Whether this event is a standalone event (`true`), or part of a series (`false`). Only applicable when sending
       streams of events.
       
      bool fin = 2 [json_name = "fin"];
      Returns:
      The fin.
    • getIndex

      int getIndex()
       Index of this event within the ordinal context of all events sent for a given event stream or session. Only
       applicable in circumstances where events have a natural order.
       
      uint32 index = 3 [json_name = "index"];
      Returns:
      The index.
    • getScope

      String getScope()
       Scope or operational context ID for this event. This value may be mixed into the event's ID and other data. This
       value is optional. For example, it may be filled in with a build ID in CI systems.
       
      string scope = 4 [json_name = "scope"];
      Returns:
      The scope.
    • getScopeBytes

      com.google.protobuf.ByteString getScopeBytes()
       Scope or operational context ID for this event. This value may be mixed into the event's ID and other data. This
       value is optional. For example, it may be filled in with a build ID in CI systems.
       
      string scope = 4 [json_name = "scope"];
      Returns:
      The bytes for scope.
    • getEvent

      String getEvent()
       Specifies the payload of the event being delivered. This field is required and constitutes the actual content of
       the event which should be validated, enriched, and persisted.
       
      string event = 5 [json_name = "event"];
      Returns:
      The event.
    • getEventBytes

      com.google.protobuf.ByteString getEventBytes()
       Specifies the payload of the event being delivered. This field is required and constitutes the actual content of
       the event which should be validated, enriched, and persisted.
       
      string event = 5 [json_name = "event"];
      Returns:
      The bytes for event.
    • getOccurred

      long getOccurred()
       Specifies the timestamp indicating when this event occurred.
       
      uint64 occurred = 6 [json_name = "occurred"];
      Returns:
      The occurred.
    • getIngested

      long getIngested()
       Specifies the timestamp indicating when this event was ingested.
       
      uint64 ingested = 7 [json_name = "ingested"];
      Returns:
      The ingested.