package io.axoniq.axonserver.grpc.streams

Get desktop application:
View/edit binary Protocol Buffers messages

Service providing operations for persistent event streams, event streams where Axon Server keeps track of the progress. All operations require a header (AxonIQ-Context) to be passed with each request to define the context.

• rpc CreateStream (CreateStreamRequest, CreateStreamResponse)

  persistent-streams.proto:13

  Creates a persistent stream if it does not exist.

  message CreateStreamRequest

  persistent-streams.proto:76

  Request to create a persistent stream

  • string stream_id = 1

    the unique identification of the stream

  • optional InitializationProperties initialization_properties = 2

    properties to create the stream if it does not exist

  message CreateStreamResponse

  persistent-streams.proto:82

  Response for a create stream request

  • CreateResult result = 1

    the result (created or already existing)

• rpc DeleteStream (DeleteStreamRequest, stream google.protobuf.Empty)

  persistent-streams.proto:22

  Deletes a persistent event stream. All existing connections to the stream are closed.

  message DeleteStreamRequest

  persistent-streams.proto:94

  Request to delete a persistent stream

  • string stream_id = 1

    the unique identification of the stream

• rpc ListStreams (ListStreamsRequest, stream StreamStatus)

  persistent-streams.proto:33

  Returns a list of all persistent event streams defined (for the context). For each event stream it returns the progress per segment.

  message ListStreamsRequest

  persistent-streams.proto:44

  request to list the persistent streams for a context

  (message has no fields)

  message StreamStatus

  persistent-streams.proto:48

  Contains the current status of a persistent stream

  • string stream_id = 1

    the unique identification of the persistent stream

  • string stream_name = 2

    a name for the persistent stream

  • optional SequencingPolicy sequencing_policy = 3

    the policy used to distribute events across segments.

  • string filter = 4

    an expression to filter events, same syntax as used for ad-hoc queries on the event store

  • repeated SegmentPosition segments = 5

    the last confirmed position per segment

• rpc OpenStream (stream StreamRequest, stream StreamSignal)

  persistent-streams.proto:17

  Open a persistent event stream connection from a client. Creates the stream if it does not exist.

  message StreamRequest

  persistent-streams.proto:66

  Request to set up a connection to a stream. Clients should first submit an OpenRequest on this connection to connect to a stream and can then submit Acknowledgement messages to report progress.

  • oneof request

    • Open open = 1

      the initial message to connect to a stream

    • ProgressAcknowledgement acknowledgeProgress = 2

      sends progress in processing events to Axon Server

    • Requests requests = 3

      request a number of messages for a segment

    • SegmentError error = 4

      notifies an error

  message StreamSignal

  persistent-streams.proto:145

  Message sent by Axon Server to the client stream connection

  • int32 segment = 1

    the segment number

  • oneof type

    • PersistentStreamEvent event = 2

      an event to process in the client

    • bool closed = 3

      indicates that the segment is closed by Axon Server

    • OpenSegment open = 4

      segment assigned to the client

• rpc ResetStream (ResetStreamRequest, stream google.protobuf.Empty)

  persistent-streams.proto:38

  Resets the position of a persistent stream.

  message ResetStreamRequest

  persistent-streams.proto:98

  • string stream_id = 1

    the unique identification of the stream

  • optional ResetStreamConfiguration options = 2

• rpc UpdateStream (UpdateStreamRequest, stream google.protobuf.Empty)

  persistent-streams.proto:27

  Change properties of a persistent event stream.

  message UpdateStreamRequest

  persistent-streams.proto:104

  Request to update the properties of a persistent stream

  • string stream_id = 1

    the unique identification of the stream

  • int32 segments = 2

    Request to change the number of segments

  • string stream_name = 3

    Request to change the name of the stream

result of create stream

Used in: CreateStreamResponse

• created = 0

• already_exists = 1

Properties to create the stream if it does not exist

Used in: CreateStreamRequest, Open

• int32 segments = 1

  the initial number of segments

• int64 initial_position = 2

  the position in the event store to start reading from

• optional SequencingPolicy sequencing_policy = 3

  the sequencing policy

• string filter = 4

  an expression to filter events, same syntax as used for ad-hoc queries on the event store

• string stream_name = 5

  a name for the persistent stream

Request to open a connection to a persistent stream

Used in: StreamRequest

• string stream_id = 1

  the unique identification of the stream

• string client_id = 2

  the unique identification of the client

• optional InitializationProperties initialization_properties = 3

  properties to create the stream if it does not exist

Message to prepare client for events on a specific segment

Used in: StreamSignal

(message has no fields)

Event sent on a persistent stream segment

Used in: StreamSignal

• optional event.EventWithToken event = 1

  an event to process in the client

• bool replay = 2

  indicates that the event is sent again after a reset stream

Message to report progress of event processing for a specific segment in a stream

Used in: StreamRequest

• int32 segment = 1

  the segment number

• int64 position = 2

  the position of the last processed event

Used in: StreamRequest

• int32 segment = 1

  the segment number

• int32 requests = 2

  the number of messages to request

Message to provide parameters for resetting a persistent stream

Used in: ResetStreamRequest

• oneof type

  • google.protobuf.Empty head = 1

    indicates reset to head

  • google.protobuf.Empty tail = 2

    indicates reset to tail

  • int64 datetime = 3

    timestamp in epoch milliseconds

  • int64 position = 4

    global index (inclusive)

Request to notify Axon Server of an error on a persistent stream segment

Used in: StreamRequest

• int32 segment = 1

  the segment number

• string error = 2

  the error that occurred while processing the events for this segment

Contains the position per segment

Used in: StreamStatus

• int32 segment = 1

  the segment number

• int64 position = 2

  the last confirmed position

• string client_id = 3

  the connected client, empty if there is no client connected to this segment

• string error = 4

  optional error reported by the client for this segment

Defines the policy used to distribute events across segments. The policy name must be known on the server.

Used in: InitializationProperties, StreamStatus

• string policy_name = 1

  the name of the sequencing policy

• repeated string parameter = 2

  optional list of parameters used by the sequencing policy