EventStoreDetailsResponse
API reference for EventStoreDetailsResponse
Interface: EventStoreDetailsResponse
Section titled “Interface: EventStoreDetailsResponse”Detailed event store information including usage statistics and settings. Extends the basic EventStore interface with additional details.
Extends
Section titled “Extends”Properties
Section titled “Properties”createdAt
Section titled “createdAt”createdAt:
string
ISO timestamp of when the event store was created
Inherited from
Section titled “Inherited from”databaseSizes?
Section titled “databaseSizes?”
optionaldatabaseSizes:object
Database size information for this store.
Mirrors the management API databaseSizes field.
eventBusDatabaseSize
Section titled “eventBusDatabaseSize”eventBusDatabaseSize:
number
Size of the event bus database in bytes.
eventStoreDatabaseSize
Section titled “eventStoreDatabaseSize”eventStoreDatabaseSize:
number
Size of the event store database in bytes.
totalSize
Section titled “totalSize”totalSize:
number
Combined size of all databases for this event store in bytes.
description?
Section titled “description?”
optionaldescription:string
Optional description of the event store’s purpose or contents
Inherited from
Section titled “Inherited from”id:
string
Unique identifier for the event store
Inherited from
Section titled “Inherited from”name:
string
Display name of the event store
Inherited from
Section titled “Inherited from”region?
Section titled “region?”
optionalregion:string
Optional cloud region where the event store is located
Inherited from
Section titled “Inherited from”settings?
Section titled “settings?”
optionalsettings:object
Configuration settings for the event store
maxStreamSizeBytes?
Section titled “maxStreamSizeBytes?”
optionalmaxStreamSizeBytes:number
Maximum size in bytes allowed per event stream
retentionPeriodDays?
Section titled “retentionPeriodDays?”
optionalretentionPeriodDays:number
Number of days events are retained before automatic deletion
statistics?
Section titled “statistics?”
optionalstatistics:object
Usage statistics for the event store
databaseSizeBytes
Section titled “databaseSizeBytes”databaseSizeBytes:
number
Storage size in bytes used by the event store
newestEventTimestamp?
Section titled “newestEventTimestamp?”
optionalnewestEventTimestamp:string
ISO timestamp of the newest event in the store, if available
oldestEventTimestamp?
Section titled “oldestEventTimestamp?”
optionaloldestEventTimestamp:string
ISO timestamp of the oldest event in the store, if available
totalEvents
Section titled “totalEvents”totalEvents:
number
Total number of events stored
totalStreams
Section titled “totalStreams”totalStreams:
number
Total number of event streams stored
status
Section titled “status”status:
"active"|"suspended"|"deleted"
Current status of the event store
Inherited from
Section titled “Inherited from”streams?
Section titled “streams?”
optionalstreams:object
Stream count and total event count for this store.
Mirrors the management API streams field.
count:
number
Number of streams in this event store.
totalEvents
Section titled “totalEvents”totalEvents:
number
Total number of events across all streams.
updatedAt
Section titled “updatedAt”updatedAt:
string
ISO timestamp of when the event store was last updated