Interface Event.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Event.Builder,Event>, SdkBuilder<Event.Builder,Event>, SdkPojo
Enclosing class:
Event

@Mutable @NotThreadSafe public static interface Event.Builder extends SdkPojo, CopyableBuilder<Event.Builder,Event>
  • Method Details

    • eventId

      Event.Builder eventId(String eventId)

      The event's ID.

      Parameters:
      eventId - The event's ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • spaceId

      Event.Builder spaceId(String spaceId)

      The ID of the space.

      Parameters:
      spaceId - The ID of the space.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • actorId

      Event.Builder actorId(String actorId)

      The ID of the actor the event belongs to.

      Parameters:
      actorId - The ID of the actor the event belongs to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • sessionId

      Event.Builder sessionId(String sessionId)

      The ID of the session the event belongs to.

      Parameters:
      sessionId - The ID of the session the event belongs to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • payload

      Event.Builder payload(EventPayload payload)

      The event's content, as submitted to CreateEvent.

      Parameters:
      payload - The event's content, as submitted to CreateEvent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • payload

      default Event.Builder payload(Consumer<EventPayload.Builder> payload)

      The event's content, as submitted to CreateEvent.

      This is a convenience method that creates an instance of the EventPayload.Builder avoiding the need to create one manually via EventPayload.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to payload(EventPayload).

      Parameters:
      payload - a consumer that will call methods on EventPayload.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • metadata

      Event.Builder metadata(Map<String,String> metadata)

      The event's metadata tags, as supplied to CreateEvent. May be empty.

      Parameters:
      metadata - The event's metadata tags, as supplied to CreateEvent. May be empty.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • eventTimestamp

      Event.Builder eventTimestamp(Instant eventTimestamp)

      The time the event occurred.

      Parameters:
      eventTimestamp - The time the event occurred.
      Returns:
      Returns a reference to this object so that method calls can be chained together.