Package org.graylog2.indexer.messages

Interface Indexable

All Known Subinterfaces:
Event, ImmutableMessage
All Known Implementing Classes:
EventImpl, Message, SerializationMemoizingMessage
public interface Indexable

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getId()
    Deprecated.
    String
    getMessageId()
    Returns the id to address the document in Elasticsearch.
    org.joda.time.DateTime
    getReceiveTime()
     
    long
    getSize()
     
    org.joda.time.DateTime
    getTimestamp()
     
    default byte[]
    serialize(SerializationContext context)
    Serializes the object to a form that can be sent to the indexer, e.g.
    default boolean
    supportsFailureHandling()
    Guides the failure handling framework when deciding whether this particular message should be accepted for the further failure processing.
    Map<String,Object>
    toElasticSearchObject(com.fasterxml.jackson.databind.ObjectMapper objectMapper, com.codahale.metrics.Meter invalidTimestampMeter)
     

  • Method Details

    • getId

      @Deprecated String getId()
      Deprecated.
      Returns the id to address the document in Elasticsearch. Depending on the implementation this might return a UUID or ULID This method should only be used where backwards compatibility is needed. Newer code should use getMessageId() instead.

    • getMessageId

      String getMessageId()
      Returns the id to address the document in Elasticsearch. The message id is represented as a ULID

    • getSize

      long getSize()

    • getReceiveTime

      org.joda.time.DateTime getReceiveTime()

    • toElasticSearchObject

      Map<String,Object> toElasticSearchObject(com.fasterxml.jackson.databind.ObjectMapper objectMapper, @Nonnull com.codahale.metrics.Meter invalidTimestampMeter)

    • getTimestamp

      org.joda.time.DateTime getTimestamp()

    • serialize

      default byte[] serialize(SerializationContext context) throws IOException
      Serializes the object to a form that can be sent to the indexer, e.g. JSON.

      The default implementation will just call toElasticSearchObject(ObjectMapper, Meter)

      Parameters:
      context - Context required to perform the serialization
      Returns:
      an array of bytes that can be sent to the indexer
      Throws:
      IOException - if serializing the object fails

    • supportsFailureHandling

      default boolean supportsFailureHandling()
      Guides the failure handling framework when deciding whether this particular message should be accepted for the further failure processing. By default disabled for all messages.