Struct ydb_unofficial::generated::ydb::topic::DescribeTopicResult

pub struct DescribeTopicResult {
    pub self_: Option<Entry>,
    pub partitioning_settings: Option<PartitioningSettings>,
    pub partitions: Vec<PartitionInfo, Global>,
    pub retention_period: Option<Duration>,
    pub retention_storage_mb: i64,
    pub supported_codecs: Option<SupportedCodecs>,
    pub partition_write_speed_bytes_per_second: i64,
    pub partition_write_burst_bytes: i64,
    pub attributes: HashMap<String, String, RandomState>,
    pub consumers: Vec<Consumer, Global>,
    pub metering_mode: i32,
    pub topic_stats: Option<TopicStats>,
}

Describe topic result message that will be inside DescribeTopicResponse.operation.

Fields

self_: Option<Entry>

Description of scheme object.

partitioning_settings: Option<PartitioningSettings>

Settings for partitioning

partitions: Vec<PartitionInfo, Global>

Partitions description.

retention_period: Option<Duration>

Retention settings. Currently, only one limit may be set, so other should not be set.

How long data in partition should be stored.

retention_storage_mb: i64

How much data in partition should be stored. Zero value means infinite limit.

supported_codecs: Option<SupportedCodecs>

List of allowed codecs for writers. Writes with codec not from this list are forbidden.

partition_write_speed_bytes_per_second: i64

Partition write speed in bytes per second. Zero value means default limit: 1 MB per second.

partition_write_burst_bytes: i64

Burst size for write in partition, in bytes. Zero value means default limit: 1 MB.

attributes: HashMap<String, String, RandomState>

User and server attributes of topic. Server attributes starts from “_” and will be validated by server.

consumers: Vec<Consumer, Global>

List of consumers for this topic.

metering_mode: i32

Metering settings.

topic_stats: Option<TopicStats>

Statistics of topic.

Implementations

impl DescribeTopicResult

pub fn metering_mode(&self) -> MeteringMode

Returns the enum value of metering_mode, or the default if the field is set to an invalid enum value.

pub fn set_metering_mode(&mut self, value: MeteringMode)

Sets metering_mode to the provided enum value.

Trait Implementations

impl Clone for DescribeTopicResult

fn clone(&self) -> DescribeTopicResult

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeTopicResult

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for DescribeTopicResult

fn default() -> DescribeTopicResult

Returns the “default value” for a type.

impl Message for DescribeTopicResult

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8, Global>where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8, Global>where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<DescribeTopicResult> for DescribeTopicResult

fn eq(&self, other: &DescribeTopicResult) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DescribeTopicResult