package io.axoniq.axonserver.grpc.event.dcb

Get desktop application:
View/edit binary Protocol Buffers messages

Service to use AxonServer as a provider of an EventScheduler

• rpc CancelScheduledEvent (CancelScheduledEventRequest, InstructionAck)

  dcb.proto:77

  Cancel the publication of a scheduled event. If the events has already been published, this method does nothing.

  message CancelScheduledEventRequest

  dcb.proto:100

  Request message to cancel an event

  • string token = 1

    token of scheduled event to cancel

• rpc RescheduleEvent (RescheduleEventRequest, ScheduleToken)

  dcb.proto:74

  Reschedule a scheduled event and optionally replace it by a new event.

  message RescheduleEventRequest

  dcb.proto:90

  Request message to reschedule an event

  • string token = 1

    schedule token of the event to reschedule

  • int64 instant = 2

    timestamp when to publish the event

  • optional Event event = 3

    optionally provide a new event to publish

• rpc ScheduleEvent (ScheduleEventRequest, ScheduleToken)

  dcb.proto:71

  Schedule the given event for publication at the given time}. The returned ScheduleToken can be used to reschedule or cancel the planned publication.

  message ScheduleEventRequest

  dcb.proto:82

  Request message to schedule an event

  • int64 instant = 1

    timestamp when to publish the event

  • optional Event event = 2

    the event to publish

Service providing Event Store RPCs supporting DCB.

• rpc AddTags (AddTagsRequest, AddTagsResponse)

  dcb.proto:33

  Assigns tags to the event identified by its sequence.

  message AddTagsRequest

  dcb.proto:354

  The request to add tags to the event.

  • int64 sequence = 1

    The sequence of the event whose tags list will be expanded with the tags from the request.

  • repeated Tag tag = 2

    The tags to be added to the event. If the event already contains a tag from the same list (with the same key and the value) the new one will be ignored.

  message AddTagsResponse

  dcb.proto:365

  The response indicating a successful addition of tags to the event.

  (message has no fields)

• rpc Append (stream AppendEventsRequest, AppendEventsResponse)

  dcb.proto:10

  Appends new events to the store.

  message AppendEventsRequest

  dcb.proto:165

  The message representing the request to append events to the event store.

  • optional ConsistencyCondition condition = 1

    The condition used to check the validity of this request. If omitted, events will be appended unconditionally.

  • repeated TaggedEvent event = 2

    A list of tagged events to be appended to the event store if the condition is met. These events are considered as a transaction - they are either all appended or none of them are appended. The event store will index the events based on provided tags for future faster retrieval.

  message AppendEventsResponse

  dcb.proto:178

  The response of a successful append events request. If there was an issue with the append events request, the stream will complete with an error.

  • int64 sequence_of_the_first_event = 1

    The sequence of the first event stored in the event store. Corresponding to the list of events (a transaction) passed in the AppendEventsRequest.

  • int32 transaction_size = 2

    The number of events appended. Matches the number of events passed in the AppendEventsRequest.

  • int64 consistency_marker = 3

    The consistency marker which may be used for a subsequent append events requests. Do note that during the time this consistency marker may get far behind the head of the event store which will increase the time needed for the append events request to be validated. If you don't plan to do subsequent append events requests in a "short" period of time, use the Source RPC to refresh the consistency marker.

• rpc GetHead (GetHeadRequest, GetHeadResponse)

  dcb.proto:19

  Gets the current _head_ of the Event Store. The _head_ points to the sequence of the first event to be appended.

  message GetHeadRequest

  dcb.proto:311

  The request to retrieve the current HEAD of the event store.

  (message has no fields)

  message GetHeadResponse

  dcb.proto:316

  The current HEAD of the event store.

  • int64 sequence = 1

    The sequence of the current head. Points to the position of the first event to be appended. The HEAD of an empty event store is 0.

• rpc GetSequenceAt (GetSequenceAtRequest, GetSequenceAtResponse)

  dcb.proto:30

  Returns the lowest sequence of an event with a timestamp equal to or higher than the given timestamp. The HEAD is returned if no events exist with a timestamp equal to or higher than the given timestamp. N.B. Axon Server does not assign timestamps to events. The timestamps used for fulfilling this RPC are timestamps provided by the client. It could happen that there are events after the returned sequence that have an earlier timestamp. Axon Server does not reject appends if timestamps of events are not monotonically increasing.

  message GetSequenceAtRequest

  dcb.proto:340

  The request to get the sequence of the event whose timestamp is the same as the timestamp provided in the request. If there are no events with the exact timestamp, then the sequence of the first one after the provided timestamp is returned. If the provided timestamp is greater that the sequence of the last event in the event store, the HEAD is returned.

  • int64 timestamp = 1

    The timestamp.

  message GetSequenceAtResponse

  dcb.proto:347

  The sequence of the event approximately close to the provided timestamp.

  • int64 sequence = 1

    The sequence of the event.

• rpc GetTags (GetTagsRequest, GetTagsResponse)

  dcb.proto:39

  Gets tags for the event identified by its sequence.

  message GetTagsRequest

  dcb.proto:385

  The request to retrieve tags of the event.

  • int64 sequence = 1

    The sequence of the event whose tags should be retrieved.

  message GetTagsResponse

  dcb.proto:392

  The response containing tags of an event.

  • repeated Tag tag = 1

    The tags associated to the event.

• rpc GetTail (GetTailRequest, GetTailResponse)

  dcb.proto:22

  Gets the current _tail_ of the Event Store. The _tail_ points to the sequence of the first event stored.

  message GetTailRequest

  dcb.proto:324

  The request to retrieve the current TAIL of the event store.

  (message has no fields)

  message GetTailResponse

  dcb.proto:329

  The current TAIL of the event store.

  • int64 sequence = 1

    The sequence of the first event in the event store. 0 for an empty event store. 0 for a non-truncated event store. Non-zero for a truncated event store.

• rpc RemoveTags (RemoveTagsRequest, RemoveTagsResponse)

  dcb.proto:36

  Removes tags from the event identified by its sequence.

  message RemoveTagsRequest

  dcb.proto:370

  The request to remove tags from the event.

  • int64 sequence = 1

    The sequence of the event whose tags should be removed.

  • repeated Tag tag = 2

    Tags to be removed. If the event is not tagged with listed tags, they are skipped.

  message RemoveTagsResponse

  dcb.proto:380

  The response indicating a successful removal of tags for the event.

  (message has no fields)

• rpc Source (SourceEventsRequest, stream SourceEventsResponse)

  dcb.proto:13

  Provides a finite stream of events based on the passed SourceEventsRequest.

  message SourceEventsRequest

  dcb.proto:197

  The request to source events from the event store. It results in a finite stream of events completed by the event store. It may also be cancelled by the client. Only events matching the given criteria (a provided list of criterions) will be present in the stream. The stream is capped by the HEAD of the event store.

  • int64 from_sequence = 1

    An inclusive sequence of the first event to be included in the resulting stream.

  • repeated Criterion criterion = 2

    The criteria consisting of the list of criterions. If at least one of these criterions is met, the criteria is met.

  message SourceEventsResponse

  dcb.proto:229

  The response to the SourceEventsRequest. It consists either of an event (with its corresponding sequence) or a consistency marker. The consistency marker should be used in a following AppendEventsRequest related to the criteria used in the SourceEventsRequest this response originates from.

  • oneof result

    • SequencedEvent event = 1

      The event matching the criteria with its corresponding sequence.

    • int64 consistency_marker = 2

      The consistency marker to be used for the following append related to the same criteria.

• rpc Stream (StreamEventsRequest, stream StreamEventsResponse)

  dcb.proto:16

  Provides an infinite stream of events based on the passed StreamEventsRequest.

  message StreamEventsRequest

  dcb.proto:293

  The request to provide an infinite stream of events from the event store. The client may cancel the stream at any time.

  • int64 from_sequence = 1

    The inclusive sequence to start streaming from.

  • repeated Criterion criterion = 2

    The criteria used to filter out events. Represented by a list of criterions. If at least one is met, the whole criteria is met.

  message StreamEventsResponse

  dcb.proto:304

  The response to the StreamEventsRequest.

  • optional SequencedEvent event = 1

    The event with its corresponding sequence.

Service providing Snapshot Store RPCs.

• rpc Add (AddSnapshotRequest, AddSnapshotResponse)

  dcb.proto:46

  Adds a snapshot to the snapshot store.

  message AddSnapshotRequest

  dcb.proto:418

  The request to add the snapshot to the snapshot store.

  • bytes key = 1

    The key this snapshot is added to.

  • int64 sequence = 2

    The sequence of the snapshot. Usually linked to the sequence of the event in the event store up to which the snapshot is taken.

  • bool prune = 3

    If set to true, older snapshots for the same key are pruned.

  • optional Snapshot snapshot = 4

    The snapshot.

  message AddSnapshotResponse

  dcb.proto:435

  The response indicating the successful addition of the snapshot.

  (message has no fields)

• rpc Delete (DeleteSnapshotsRequest, DeleteSnapshotsResponse)

  dcb.proto:49

  Deletes a snapshot from the snapshot store.

  message DeleteSnapshotsRequest

  dcb.proto:443

  The request to delete the snapshot from the snapshot store. Deletes from a sequence of `0` to the specified `to_sequence`

  • bytes key = 1

    The key the snapshot is identified by.

  • int64 to_sequence = 3

    The exclusive upper bound sequence of the snapshot to end the deletion.

  message DeleteSnapshotsResponse

  dcb.proto:454

  The response indicating the successful deletion of the snapshot.

  (message has no fields)

• rpc GetLast (GetLastSnapshotRequest, GetLastSnapshotResponse)

  dcb.proto:55

  Gets the latest snapshot based on the request from the snapshot store.

  message GetLastSnapshotRequest

  dcb.proto:485

  The request to retrieve the snapshot with the highest sequence from the snapshot store.

  • bytes key = 1

    The key of the snapshot.

  message GetLastSnapshotResponse

  dcb.proto:492

  The response to GetLatestSnapshotRequest.

  • bytes key = 1

    The key of the snapshot.

  • int64 sequence = 2

    The sequence of the snapshot.

  • optional Snapshot snapshot = 3

    The snapshot.

• rpc List (ListSnapshotsRequest, stream ListSnapshotsResponse)

  dcb.proto:52

  Retrieves snapshots from the snapshot store.

  message ListSnapshotsRequest

  dcb.proto:459

  The request to retrieve all snapshots from the snapshot store based on the key and sequence bounds.

  • bytes key = 1

    The key of the snapshot.

  • int64 from_sequence = 2

    The inclusive bottom bound sequence used to filter out snapshots.

  • int64 to_sequence = 3

    The exclusive upper bound sequence used to filter out snapshots.

  message ListSnapshotsResponse

  dcb.proto:472

  The response to the ListSnapshotRequest.

  • bytes key = 1

    The key of the snapshot.

  • int64 sequence = 2

    The sequence of the snapshot.

  • optional Snapshot snapshot = 3

    The snapshot.

Service providing Event Store RPCs supporting DCB combined with snapshots.

• rpc Source (SnapshottedSourceRequest, stream SnapshottedSourceEventsResponse)

  dcb.proto:65

  Provides a finite stream of events based on the passed SnapshottedSourceRequest, optionally preceded by the latest snapshot stored under the given snapshot key. When a snapshot is present, the stream starts with that snapshot followed by the events with a sequence greater than the snapshot's sequence; otherwise, it behaves like a regular Source RPC starting from the beginning.

  message SnapshottedSourceRequest

  dcb.proto:211

  The request to source events from the event store, prefixed by the latest matching snapshot if available. It results in a finite stream completed by the event store. It may also be cancelled by the client. Only events matching the given criteria (a provided list of criterions) will be present in the stream. The stream is capped by the HEAD of the event store.

  • bytes snapshot_key = 1

    The key used to look up the latest snapshot in the snapshot store. If a snapshot exists for this key, it is emitted as the first response and events are sourced starting from the sequence following that snapshot. If no snapshot exists, events are sourced from the beginning. The server does not validate any relationship between the snapshot key and the provided criteria. It is the caller's responsibility to ensure the snapshot key and criteria refer to the same entity, so that the snapshot represents a state that can be correctly evolved by applying the sourced events.

  • repeated Criterion criterion = 2

    The criteria consisting of the list of criterions. If at least one of these criterions is met, the criteria is met.

  message SnapshottedSourceEventsResponse

  dcb.proto:244

  The response to the SnapshottedSourceRequest. It consists either of a snapshot (emitted at most once at the beginning of the stream), an event (with its corresponding sequence), or a consistency marker. The consistency marker should be used in a following AppendEventsRequest related to the criteria used in the SnapshottedSourceRequest this response originates from.

  • oneof result

    • Snapshot snapshot = 1

      The latest snapshot stored under the snapshot key from the request. When present, it is emitted as the first message of the stream and is followed by events with a sequence greater than the snapshot's sequence.

    • SequencedEvent event = 2

      The event matching the criteria with its corresponding sequence.

    • int64 consistency_marker = 3

      The consistency marker to be used for the following append related to the same criteria.

The condition for an AppendEventsRequest. Consists of the consistency marker and the criteria (a list of criterions).

Used in: AppendEventsRequest

• int64 consistency_marker = 1

  The sequence used to start checking for the consistency of an append. If there are events with a sequence greater or equal than the consistency marker and those are matching the given criteria, the condition is not met and the transaction is rejected. Otherwise, it is accepted.

• repeated Criterion criterion = 2

  The criteria. Consists of a list of criterions. If a single criterion is met, the whole criteria is met.

The integral part of the criteria.

Used in: ConsistencyCondition, SnapshottedSourceRequest, SourceEventsRequest, StreamEventsRequest

• optional TagsAndNamesCriterion tags_and_names = 1

  The criterion based on event tags and event names.

The event message.

Used in: RescheduleEventRequest, ScheduleEventRequest, SequencedEvent, TaggedEvent

• string identifier = 1

  The unique identifier of the event.

• int64 timestamp = 2

  The timestamp of the event.

• string name = 3

  The name of the event.

• string version = 4

  The version of the event.

• bytes payload = 5

  The payload of the event.

• map<string, string> metadata = 6

  The metadata of the event.

Token to manage a scheduled event

Used as response type in: DcbEventScheduler.RescheduleEvent, DcbEventScheduler.ScheduleEvent

• string token = 1

  Field defining the token identifier

The event retrieved from the event store with its corresponding sequence.

Used in: SnapshottedSourceEventsResponse, SourceEventsResponse, StreamEventsResponse

• int64 sequence = 1

  The sequence of the event.

• optional Event event = 2

  The event.

The snapshot.

Used in: AddSnapshotRequest, GetLastSnapshotResponse, ListSnapshotsResponse, SnapshottedSourceEventsResponse

• string name = 1

  The name of the snapshot.

• string version = 2

  The version of the snapshot.

• bytes payload = 3

  The payload of the snapshot.

• int64 timestamp = 4

  The timestamp of the snapshot.

• map<string, string> metadata = 5

  The metadata of the snapshot.

The tag. Describes an event with more details. Usually using concepts from the Domain.

Used in: AddTagsRequest, GetTagsResponse, RemoveTagsRequest, TaggedEvent, TagsAndNamesCriterion

• bytes key = 1

  The key of the tag.

• bytes value = 2

  The value of the tag.

The event described in more details by a list of tags.

Used in: AppendEventsRequest

• optional Event event = 1

  The event.

• repeated Tag tag = 2

  List of tags describing the given event in more details.

The criterion based on event tags and event names. The event meets this criterion if ALL tags from this criterion are present in the tags of the event AND if the event name is present in one of the names of the this criterion.

Used in: Criterion

• repeated string name = 1

  A list of event names. The event meets this criterion if its name is in one of the names in this list.

• repeated Tag tag = 2

  A list of event tags. The event meets this criterion if it contains all the tags from this list. It meets the criterion if it contains more than provided list here, but it MUST contain all from the list.