package io.axoniq.axonserver.grpc.event

Get desktop application:
View/edit binary Protocol Buffers messages

Service to use AxonServer as a provider of an EventScheduler

• rpc CancelScheduledEvent (CancelScheduledEventRequest, InstructionAck)

  event.proto:63

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

  message CancelScheduledEventRequest

  event.proto:214

  Request message to cancel an event

  • string token = 1

    token of scheduled event to cancel

• rpc RescheduleEvent (RescheduleEventRequest, ScheduleToken)

  event.proto:60

  Cancel a scheduled event and schedule another in its place.

  message RescheduleEventRequest

  event.proto:204

  Request message to reschedule an event

  • string token = 1

    optional token of scheduled event to cancel

  • int64 instant = 2

    timestamp when to publish the event

  • optional Event event = 3

    the event to publish

• rpc ScheduleEvent (ScheduleEventRequest, ScheduleToken)

  event.proto:57

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

  message ScheduleEventRequest

  event.proto:196

  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 operations against the EventStore functionality of Axon Server

• rpc AppendEvent (stream Event, ConfirmationWithConsistencyMarker)

  event.proto:11

  Accepts a stream of Events returning a Confirmation when completed.

  message ConfirmationWithConsistencyMarker

  event.proto:346

  A confirmation to a request from the client, including an optional consistency marker to track the position of this confirmation in the Event Stream. The consistency_marker is only set for AppendEvent requests towards a DCB context.

  • bool success = 1

    True when successful, otherwise false

  • optional ConsistencyMarker consistency_marker = 2

    The consistency marker token

• rpc AppendSnapshot (Event, Confirmation)

  event.proto:15

  Accepts a Snapshot event returning a Confirmation when completed.

• rpc GetFirstToken (GetFirstTokenRequest, TrackingToken)

  event.proto:42

  Retrieves the first token available in event store (typically 0). Returns 0 when no events in store.

  message GetFirstTokenRequest

  event.proto:226

  Request message to receive the first Token (Tail Token) of the Event Stream

  (message has no fields)

• rpc GetLastToken (GetLastTokenRequest, TrackingToken)

  event.proto:46

  Retrieves the last committed token in event store. Returns -1 when no events in store.

  message GetLastTokenRequest

  event.proto:230

  Request message to receive the last Token (Head Token) of the Event Stream

  (message has no fields)

• rpc GetTokenAt (GetTokenAtRequest, TrackingToken)

  event.proto:50

  Retrieves the token of the first token of an event from specified time in event store. Returns -1 when no events in store.

  message GetTokenAtRequest

  event.proto:234

  Request message to receive the Token that starts streaming events from the given timestamp

  • int64 instant = 1

    Timestamp expressed as milliseconds since epoch

• rpc ListAggregateEvents (GetAggregateEventsRequest, stream Event)

  event.proto:19

  Retrieves the Events for a given aggregate. Results are streamed rather than returned at once.

  message GetAggregateEventsRequest

  event.proto:361

  Request describing the desire to read events for a specific Aggregate

  • string aggregate_id = 1

    The identifier of the aggregate to read events for

  • int64 initial_sequence = 2

    The sequence number of the first event to receive

  • bool allow_snapshots = 3

    Whether a snapshot may be returned as first element in the stream

  • int64 max_sequence = 4

    The maximum sequence number (inclusive) of the events to retrieve, 0 means up to last event

  • int64 min_token = 5

    Hint for a minimum token to search events from

• rpc ListAggregateSnapshots (GetAggregateSnapshotsRequest, stream Event)

  event.proto:23

  Retrieves the Snapshots for a given aggregate. Results are streamed rather than returned at once.

  message GetAggregateSnapshotsRequest

  event.proto:380

  Request message to retrieve Snapshot Events for a specific Aggregate instance

  • string aggregate_id = 1

    The identifier to fetch the snapshots for

  • int64 initial_sequence = 2

    The minimal sequence number of the snapshots to retrieve

  • int64 max_sequence = 3

    The maximum sequence number of the snapshots to retrieve

  • int32 max_results = 4

    The maximum number of results to stream

• rpc ListEvents (stream GetEventsRequest, stream EventWithToken)

  event.proto:29

  Retrieves the Events from a given tracking token. However, if several GetEventsRequests are sent in the stream only first one will create the tracker, others are used for increasing number of permits or blacklisting. Results are streamed rather than returned at once.

  message GetEventsRequest

  event.proto:396

  Request message to open an Event Stream from the Event Store.

  • int64 tracking_token = 1

    The token to start streaming from

  • int64 number_of_permits = 2

    The number of messages the server may send before it needs to wait for more permits

  • string client_id = 3

    The unique identifier of this client instance. Used for monitoring.

  • string component_name = 4

    The component name of this client instance. Used for monitoring.

  • string processor = 5

    The name of the processor requesting this stream. Used for monitoring.

  • repeated PayloadDescription blacklist = 6

    An enumeration of payload types that need to be blacklisted. The Server will stop sending messages of these types in order to reduce I/O. Note that the Server may occasionally send a blacklisted message to prevent time-outs and stale tokens on clients.

  • bool force_read_from_leader = 7

    Indicates whether to force reading events from the leader node of an Axon Server. Forcing reads from leader reduces the staleness of the data read, but also puts extra burden on the leader, reducing overall scalability. <p> This property has no effect on connections to AxonServer SE. </p>

• rpc QueryEvents (stream QueryEventsRequest, stream QueryEventsResponse)

  event.proto:38

  Performs a query on the event store, returns a stream of results. Input is a stream to allow flow control from the client

  message QueryEventsRequest

  event.proto:258

  Message providing the parameters for executing a Query against AxonServer.

  • string query = 1

    The query to execute against the Event Stream

  • int64 number_of_permits = 2

    The number of results AxonServer may send before new permits need to be provided

  • bool live_events = 3

    Whether to keep the query running against incoming events once the Head of the Stream is reached

  • bool force_read_from_leader = 4

    Indicates whether to force querying events from the leader node of an Axon Server. Forcing reads from leader reduces the staleness of the data read, but also puts extra burden on the leader, reducing overall scalability. <p> This property has no effect on connections to AxonServer SE. </p>

  • bool query_snapshots = 5

    If true, snapshots will be queried instead of events

  • string context_name = 6

    Query from this context, not from the default context of the connection

  message QueryEventsResponse

  event.proto:285

  A message describing a response to a Query request

  • oneof data

    The actual contents of this response

    • ColumnsResponse columns = 1

      Provided when the response contains the names of the columns the response contains. This message typically arrives first.

    • RowResponse row = 2

      Provided when the response message contains results of the Query

    • Confirmation files_completed = 3

      Provided when all historic events have been included in the query results

• rpc ReadHighestSequenceNr (ReadHighestSequenceNrRequest, ReadHighestSequenceNrResponse)

  event.proto:33

  Gets the highest sequence number for a specific aggregate.

  message ReadHighestSequenceNrRequest

  event.proto:320

  Describes the combination of an Aggregate Identifier and first expected Sequence number when opening an Aggregate-specific Event Stream

  • string aggregate_id = 1

    The Identifier of the Aggregate for which to load events

  • int64 from_sequence_nr = 3

    The Sequence Number of the first event expected

  message ReadHighestSequenceNrResponse

  event.proto:329

  The highest Sequence Number found for the provided request

  • int64 to_sequence_nr = 1

    The sequence number of the latest event

Service to transform events in an event store

• rpc ApplyTransformation (ApplyTransformationRequest, stream google.protobuf.Empty)

  event.proto:87

  Applies the changes from a transformation in the event store.

  message ApplyTransformationRequest

  event.proto:146

  Request to apply a transformation

  • optional TransformationId transformation_id = 1

    The identification of the transformation

  • int64 last_sequence = 2

    The sequence of the last entry in this transformation

• rpc CancelTransformation (TransformationId, stream google.protobuf.Empty)

  event.proto:83

  Cancels a transformation before it is applied.

• rpc Compact (CompactionRequest, stream google.protobuf.Empty)

  event.proto:91

  Deletes old versions of events updated by a transformation.

  message CompactionRequest

  event.proto:96

  Request to compact event store.

  (message has no fields)

• rpc StartTransformation (StartTransformationRequest, TransformationId)

  event.proto:75

  Starts a new transformation.

  message StartTransformationRequest

  event.proto:140

  Request to start a transformation

  • string description = 1

    A description of the purpose of this transformation, for reference only

• rpc TransformEvents (stream TransformRequest, stream TransformRequestAck)

  event.proto:79

  Adds requests to transform an event to a transformation.

  message TransformRequest

  event.proto:154

  Message containing one event to transform within a transformation

  • optional TransformationId transformation_id = 1

    The identification of the transformation

  • int64 sequence = 2

    The sequence of the current transformation

  • oneof request

    • TransformedEvent replace_event = 3

      Replaces the content of an event with the new content

    • DeletedEvent delete_event = 4

      Deletes the content of an event

  message TransformRequestAck

  event.proto:188

  Acknowledgement that event with given token has been transformed successfully

  • int64 sequence = 1

    The sequence of the transformation request

• rpc Transformations (google.protobuf.Empty, stream Transformation)

  event.proto:71

  Returns the list of all transformations.

  message Transformation

  event.proto:100

  The transformation data.

  • optional TransformationId transformationId = 1

    The identifier of the transformation.

  • TransformationState state = 2

    The state of the transformation

  • int64 sequence = 3

    The sequence of the last transformation action stored. Needed for checking sequential consistency of requests.

  • string context = 4

    The bounded context in which this transformation is being executed.

  • string description = 5

    The description of the transformation.

  • int64 applied_at = 6

    The timestamp at which the transformation was applied. Set to -1 if the transformation was not applied.

  • string apply_requester = 7

    The username of user who requested the transformation to be applied. Empty if the transformation was not applied.

  • int32 version = 8

    The version of the transformation. The sequence

Message containing the names of the columns returned in a Query

Used in: QueryEventsResponse

• repeated string column = 1

  The names of the columns provided in the query

A confirmation to a request from the client

Used as response type in: EventStore.AppendSnapshot

Used as field type in: QueryEventsResponse

• bool success = 1

  True when successful, otherwise false

A marker to track the position of a Confirmation in the Event Stream, used for consistency tracking in DCB contexts

Used in: ConfirmationWithConsistencyMarker

• int64 token = 1

  The token representing the position of this marker in the Stream

Deletes the content of an event

Used in: TransformRequest

• int64 token = 1

  The global index of the event to clear

Message containing the information of an Event

Used as request type in: EventStore.AppendEvent, EventStore.AppendSnapshot

Used as response type in: EventStore.ListAggregateEvents, EventStore.ListAggregateSnapshots

Used as field type in: EventWithToken, RescheduleEventRequest, ScheduleEventRequest, TransformedEvent

• string message_identifier = 1

  The unique identifier of this event

• string aggregate_identifier = 2

  The identifier of the Aggregate instance that published this event, if any

• int64 aggregate_sequence_number = 3

  The sequence number of the Event in the Aggregate instance that published it, if any

• string aggregate_type = 4

  The Type of the Aggregate instance that published this Event, if any

• int64 timestamp = 5

  The timestamp of the Event

• optional SerializedObject payload = 6

  The Payload of the Event

• map<string, MetaDataValue> meta_data = 7

  The Meta Data of the Event

• bool snapshot = 8

  Flag indicating whether the Event is a snapshot Event

Message wrapping an Event and a Tracking Token

Used as response type in: EventStore.ListEvents

Used as field type in: streams.PersistentStreamEvent

• int64 token = 1

  The Token representing the position of this Event in the Stream

• optional Event event = 2

  The actual Event Message

Description of a Payload Type

Used in: GetEventsRequest

• string type = 1

  The type identifier of the Payload

• string revision = 2

  The revision of the Payload Type

Value used in Query Responses to represent a value in its original type

Used in: RowResponse

• oneof data

  The actual value, which can be one of string, 64 bit signed integer, boolean or 64 bits floating point

  • string text_value = 1

    The text value

  • sint64 number_value = 2

    The (64 bits) integer value

  • bool boolean_value = 3

    The boolean value

  • double double_value = 4

    The (64 bits) floating point value

Message providing Query Result data

Used in: QueryEventsResponse

• repeated QueryValue id_values = 1

  The values which, when combined, uniquely update this row. Any previously received values with the same identifiers should be replaced with this value

• repeated QueryValue sort_values = 2

  The sorting values to use when sorting this response compared to the others.

• map<string, QueryValue> values = 3

  The actual data values for each of the columns, as a column name -> value mapping

Token to manage a scheduled event

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

• string token = 1

  Field defining the token identifier

Message containing the information necessary to track the position of events in the Event Stream

Used as response type in: EventStore.GetFirstToken, EventStore.GetLastToken, EventStore.GetTokenAt

• int64 token = 1

  The value of the Token

Uniquely identifies a transformation

Used as request type in: EventTransformationService.CancelTransformation

Used as response type in: EventTransformationService.StartTransformation

Used as field type in: ApplyTransformationRequest, TransformRequest, Transformation

• string id = 1

  The value of the identifier.

The state of the transformation.

Used in: Transformation

• ACTIVE = 0

  The transformation is opened, able to receive request to transform events, or to be applied or cancelled.

• CANCELLED = 1

  The transformation has been cancelled. This a final state.

• APPLYING = 2

  The transformation is in progress of applying its actions to the event store.

• APPLIED = 3

  The transformation has been applied to the event store. This a final state.

Replaces the content of an event with the new content

Used in: TransformRequest

• int64 token = 1

  The global index of the event to replace

• optional Event event = 2

  The new content of the event