Skip to main content

EventService

Source and message fields. Error family: operations.

ListEvents​

Every event declared by the latest manifest of a service, with the stream's counts and every subscriber (reactors of services, rules and other consumers on the stream) with its consumer state.

  • Path: /backplane.console.v1.EventService/ListEvents.
  • Input: ListEventsRequest; output: ListEventsResponse; mode: unary.
  • Errors: operations + common.
  • Read/validation: safe to retry after a transient failure.
// client: EventServiceClient; request: ListEventsRequest; signal: AbortSignal
const response = await client.listEvents(request, { signal });

GetStream​

One service's event stream and dead-letter stream, every consumer on the event stream and the dead letters per reactor of the service.

  • Path: /backplane.console.v1.EventService/GetStream.
  • Input: GetStreamRequest; output: GetStreamResponse; mode: unary.
  • Errors: operations + common.
  • Read/validation: safe to retry after a transient failure.
// client: EventServiceClient; request: GetStreamRequest; signal: AbortSignal
const response = await client.getStream(request, { signal });

PeekMessages​

Messages of a service's event stream: a page forward from a sequence or a time, or the newest ones.

  • Path: /backplane.console.v1.EventService/PeekMessages.
  • Input: PeekMessagesRequest; output: PeekMessagesResponse; mode: unary.
  • Errors: operations + common.
  • Read/validation: safe to retry after a transient failure.
// client: EventServiceClient; request: PeekMessagesRequest; signal: AbortSignal
const response = await client.peekMessages(request, { signal });

PublishTestEvent​

Publishes a declared event by hand, marked as a test (ce-bptest).

  • Path: /backplane.console.v1.EventService/PublishTestEvent.
  • Input: PublishTestEventRequest; output: PublishTestEventResponse; mode: unary.
  • Errors: operations + common.
  • External command: durable intent/result; never automatically replay. Additional audit statuses: Unavailable before dispatch, Aborted if result persistence fails.
// client: EventServiceClient; request: PublishTestEventRequest; signal: AbortSignal
const response = await client.publishTestEvent(request, { signal });

ListDeadLetters​

Dead letters of a subscriber's reactors, oldest first.

  • Path: /backplane.console.v1.EventService/ListDeadLetters.
  • Input: ListDeadLettersRequest; output: ListDeadLettersResponse; mode: unary.
  • Errors: operations + common.
  • Read/validation: safe to retry after a transient failure.
// client: EventServiceClient; request: ListDeadLettersRequest; signal: AbortSignal
const response = await client.listDeadLetters(request, { signal });

RedriveDeadLetters​

Publishes dead letters back to their reactor alone (its redrive subject) and removes them from the dead-letter stream.

  • Path: /backplane.console.v1.EventService/RedriveDeadLetters.
  • Input: RedriveDeadLettersRequest; output: RedriveDeadLettersResponse; mode: unary.
  • Errors: operations + common.
  • External command: durable intent/result; never automatically replay. Additional audit statuses: Unavailable before dispatch, Aborted if result persistence fails.
// client: EventServiceClient; request: RedriveDeadLettersRequest; signal: AbortSignal
const response = await client.redriveDeadLetters(request, { signal });

PurgeDeadLetters​

Removes dead letters without handling them.

  • Path: /backplane.console.v1.EventService/PurgeDeadLetters.
  • Input: PurgeDeadLettersRequest; output: PurgeDeadLettersResponse; mode: unary.
  • Errors: operations + common.
  • External command: durable intent/result; never automatically replay. Additional audit statuses: Unavailable before dispatch, Aborted if result persistence fails.
// client: EventServiceClient; request: PurgeDeadLettersRequest; signal: AbortSignal
const response = await client.purgeDeadLetters(request, { signal });