sdk/src/models/topic.rs

use crate::compression::compression_algorithm::CompressionAlgorithm;
use crate::{models::partition::Partition, utils::byte_size::IggyByteSize};
use serde::{Deserialize, Serialize};

/// `Topic` represents the medium level of logical separation of data as it's a part of the stream.
/// It consists of the following fields:
/// - `id`: the unique identifier (numeric) of the topic.
/// - `created_at`: the timestamp when the topic was created.
/// - `name`: the unique name of the topic.
/// - `size`: the total size of the topic in bytes.
/// - `message_expiry`: the optional expiry of the messages in the topic in seconds.
/// - `max_topic_size`: the optional maximum size of the topic in bytes.
/// - `replication_factor`: replication factor for the topic.
/// - `messages_count`: the total number of messages in the topic.
/// - `partitions_count`: the total number of partitions in the topic.
#[derive(Debug, Serialize, Deserialize)]
pub struct Topic {
    /// The unique identifier (numeric) of the topic.
    pub id: u32,
    /// The timestamp when the topic was created.
    pub created_at: u64,
    /// The unique name of the topic.
    pub name: String,
    /// The total size of the topic in bytes.
    pub size: IggyByteSize,
    /// The optional expiry of the messages in the topic in seconds.
    pub message_expiry: Option<u32>,
    /// Compression algorithm for the topic.
    pub compression_algorithm: CompressionAlgorithm,
    /// The optional maximum size of the topic.
    /// Can't be lower than segment size in the config.
    pub max_topic_size: Option<IggyByteSize>,
    /// Replication factor for the topic.
    pub replication_factor: u8,
    /// The total number of messages in the topic.
    pub messages_count: u64,
    /// The total number of partitions in the topic.
    pub partitions_count: u32,
}

/// `TopicDetails` represents the detailed information about the topic.
/// It consists of the following fields:
/// - `id`: the unique identifier (numeric) of the topic.
/// - `created_at`: the timestamp when the topic was created.
/// - `name`: the unique name of the topic.
/// - `size`: the total size of the topic.
/// - `message_expiry`: the optional expiry of the messages in the topic in seconds.
/// - `max_topic_size`: the optional maximum size of the topic.
/// - `replication_factor`: replication factor for the topic.
/// - `messages_count`: the total number of messages in the topic.
/// - `partitions_count`: the total number of partitions in the topic.
/// - `partitions`: the collection of partitions in the topic.
#[derive(Debug, Serialize, Deserialize)]
pub struct TopicDetails {
    /// The unique identifier (numeric) of the topic.
    pub id: u32,
    /// The timestamp when the topic was created.
    pub created_at: u64,
    /// The unique name of the topic.
    pub name: String,
    /// The total size of the topic.
    pub size: IggyByteSize,
    /// The optional expiry of the messages in the topic.
    pub message_expiry: Option<u32>,
    /// Compression algorithm for the topic.
    pub compression_algorithm: CompressionAlgorithm,
    /// The optional maximum size of the topic.
    /// Can't be lower than segment size in the config.
    pub max_topic_size: Option<IggyByteSize>,
    /// Replication factor for the topic.
    pub replication_factor: u8,
    /// The total number of messages in the topic.
    pub messages_count: u64,
    /// The total number of partitions in the topic.
    pub partitions_count: u32,
    /// The collection of partitions in the topic.
    pub partitions: Vec<Partition>,
}