Interface Summary Interface Description Checkpoint EventPointerA pointer to an event. EventRead<T>An event that was read from a stream or a checkpoint marker if one has been requested. EventStreamReader<T>A reader for a stream. EventStreamWriter<Type>A writer can write events to a stream. IdempotentEventStreamWriter<Type>A writer can write events to a stream. PositionA position in a stream. ReaderGroupA reader group is a collection of readers that collectively read all the events in the stream. ReaderGroupMetrics Serializer<T>Takes events being written and serializes them to byteBuffers so they can be sent over the wire and deserializes these same byte buffers back into objects. StreamA stream can be thought of as an unbounded sequence of events. StreamCutA set of segment/offset pairs for a single stream that represent a consistent position in the stream. Transaction<Type>Provides a mechanism for writing many events atomically. TransactionalEventStreamWriter<Type>A writer that writes Events to an Event stream transactionally.
Class Summary Class Description EventWriterConfig EventWriterConfig.EventWriterConfigBuilder ReaderConfig ReaderConfig.ReaderConfigBuilder ReaderGroupConfig ReaderGroupConfig.ReaderGroupConfigBuilder ReaderSegmentDistributionDescribes current distribution of number of segments assigned to each reader in the reader group. ReaderSegmentDistribution.ReaderSegmentDistributionBuilder RetentionPolicy RetentionPolicy.RetentionPolicyBuilder ScalingPolicyA policy that specifies how the number of segments in a stream should scale over time. ScalingPolicy.ScalingPolicyBuilder SequenceA wrapper for two numbers. StreamConfigurationThe configuration of a Stream. StreamConfiguration.StreamConfigurationBuilder TimeWindowRepresents a time window for the events which are currently being read by a reader.
Enum Summary Enum Description ReaderGroupConfig.StreamDataRetentionIf a Reader Group wants unconsumed data to be retained in a Stream, the retentionType in
ReaderGroupConfigshould be set to to 'MANUAL_RELEASE_AT_USER_STREAMCUT' or 'AUTOMATIC_RELEASE_AT_LAST_CHECKPOINT'.
RetentionPolicy.RetentionType ScalingPolicy.ScaleType Transaction.PingStatus Transaction.Status
Exception Summary Exception Description ConfigMismatchExceptionConfigMismatchException is thrown by the
ReaderGroupManager.createReaderGroup(String, ReaderGroupConfig)API when the reader group already exists with a different configuration.
DeleteScopeFailedExceptionDelete scope failed, typically because we failed to seal and delete the streams. InvalidStreamException NoSuchScopeException PingFailedExceptionTransaction heartbeat to a controller instance failed, because of one of the following reasons. ReaderGroupNotFoundExceptionReaderGroupNotFoundException is thrown by
ReaderGroupManager.getReaderGroup(String)API when the provided reader group does not exist.
ReaderNotInReaderGroupExceptionRead was invoked on a reader that the reader group does not consider a member. ReinitializationRequiredException TruncatedDataExceptionTruncatedDataException is thrown if the data to be read next has been truncated away and can no longer be read. TxnFailedExceptionA transaction has failed.