rocketmq_client_rust::base::mq_client_admin

Trait MqClientAdminInner

Source 
pub trait MqClientAdminInner: Sync {

Show 19 methods    // Required methods
    async fn query_message(
        &self,
        address: &str,
        unique_key_flag: bool,
        decompress_body: bool,
        request_header: QueryMessageRequestHeader,
        timeout_millis: u64,
    ) -> RocketMQResult<Vec<MessageExt>>;
    async fn get_topic_stats_info(
        &self,
        address: &str,
        request_header: GetTopicStatsInfoRequestHeader,
        timeout_millis: u64,
    ) -> RocketMQResult<TopicStatsTable>;
    async fn query_consume_time_span(
        &self,
        address: &str,
        request_header: QueryConsumeTimeSpanRequestHeader,
        timeout_millis: u64,
    ) -> RocketMQResult<Vec<QueueTimeSpan>>;
    async fn update_or_create_topic(
        &self,
        address: &str,
        request_header: CreateTopicRequestHeader,
        timeout_millis: u64,
    ) -> RocketMQResult<()>;
    async fn update_or_create_subscription_group(
        &self,
        address: &str,
        config: SubscriptionGroupConfig,
        timeout_millis: u64,
    ) -> RocketMQResult<()>;
    async fn delete_topic_in_broker(
        &self,
        address: &str,
        request_header: DeleteTopicRequestHeader,
        timeout_millis: u64,
    ) -> RocketMQResult<()>;
    async fn delete_topic_in_nameserver(
        &self,
        address: &str,
        request_header: DeleteTopicFromNamesrvRequestHeader,
        timeout_millis: u64,
    ) -> RocketMQResult<()>;
    async fn delete_kv_config(
        &self,
        address: &str,
        request_header: DeleteKVConfigRequestHeader,
        timeout_millis: u64,
    ) -> RocketMQResult<()>;
    async fn delete_subscription_group(
        &self,
        address: &str,
        request_header: DeleteSubscriptionGroupRequestHeader,
        timeout_millis: u64,
    ) -> RocketMQResult<()>;
    async fn invoke_broker_to_reset_offset(
        &self,
        address: &str,
        request_header: ResetOffsetRequestHeader,
        timeout_millis: u64,
    ) -> RocketMQResult<HashMap<MessageQueue, i64>>;
    async fn view_message(
        &self,
        address: &str,
        request_header: ViewMessageRequestHeader,
        timeout_millis: u64,
    ) -> RocketMQResult<MessageExt>;
    async fn get_broker_cluster_info(
        &self,
        address: &str,
        timeout_millis: u64,
    ) -> RocketMQResult<ClusterInfo>;
    async fn get_consumer_connection_list(
        &self,
        address: &str,
        request_header: GetConsumerConnectionListRequestHeader,
        timeout_millis: u64,
    ) -> RocketMQResult<ConsumerConnection>;
    async fn query_topics_by_consumer(
        &self,
        address: &str,
        request_header: QueryTopicsByConsumerRequestHeader,
        timeout_millis: u64,
    ) -> RocketMQResult<TopicList>;
    async fn query_subscription_by_consumer(
        &self,
        address: &str,
        request_header: QuerySubscriptionByConsumerRequestHeader,
        timeout_millis: u64,
    ) -> RocketMQResult<SubscriptionData>;
    async fn get_consume_stats(
        &self,
        address: &str,
        request_header: GetConsumeStatsRequestHeader,
        timeout_millis: u64,
    ) -> RocketMQResult<ConsumeStats>;
    async fn query_topic_consume_by_who(
        &self,
        address: &str,
        request_header: QueryTopicConsumeByWhoRequestHeader,
        timeout_millis: u64,
    ) -> RocketMQResult<GroupList>;
    async fn get_consumer_running_info(
        &self,
        address: &str,
        request_header: GetConsumerRunningInfoRequestHeader,
        timeout_millis: u64,
    ) -> RocketMQResult<ConsumerRunningInfo>;
    async fn consume_message_directly(
        &self,
        address: &str,
        request_header: ConsumeMessageDirectlyResultRequestHeader,
        timeout_millis: u64,
    ) -> RocketMQResult<ConsumeMessageDirectlyResult>;

}

Required Methods§

Source

async fn query_message( &self, address: &str, unique_key_flag: bool, decompress_body: bool, request_header: QueryMessageRequestHeader, timeout_millis: u64, ) -> RocketMQResult<Vec<MessageExt>>

Queries messages based on the provided request header.

§Arguments
  • address - The address of the broker.
  • unique_key_flag - Flag indicating if the unique key should be used.
  • decompress_body - Flag indicating if the message body should be decompressed.
  • request_header - The request header containing query parameters.
  • timeout_millis - The timeout in milliseconds for the operation.
§Returns

A result containing a vector of MessageExt or an error.

Source

async fn get_topic_stats_info( &self, address: &str, request_header: GetTopicStatsInfoRequestHeader, timeout_millis: u64, ) -> RocketMQResult<TopicStatsTable>

Retrieves topic statistics information.

§Arguments
  • address - The address of the broker.
  • request_header - The request header containing query parameters.
  • timeout_millis - The timeout in milliseconds for the operation.
§Returns

A result containing TopicStatsTable or an error.

Source

async fn query_consume_time_span( &self, address: &str, request_header: QueryConsumeTimeSpanRequestHeader, timeout_millis: u64, ) -> RocketMQResult<Vec<QueueTimeSpan>>

Queries the consume time span for a topic.

§Arguments
  • address - The address of the broker.
  • request_header - The request header containing query parameters.
  • timeout_millis - The timeout in milliseconds for the operation.
§Returns

A result containing a vector of QueueTimeSpan or an error.

Source

async fn update_or_create_topic( &self, address: &str, request_header: CreateTopicRequestHeader, timeout_millis: u64, ) -> RocketMQResult<()>

Updates or creates a topic.

§Arguments
  • address - The address of the broker.
  • request_header - The request header containing topic parameters.
  • timeout_millis - The timeout in milliseconds for the operation.
§Returns

A result indicating success or failure.

Source

async fn update_or_create_subscription_group( &self, address: &str, config: SubscriptionGroupConfig, timeout_millis: u64, ) -> RocketMQResult<()>

Updates or creates a subscription group.

§Arguments
  • address - The address of the broker.
  • config - The configuration for the subscription group.
  • timeout_millis - The timeout in milliseconds for the operation.
§Returns

A result indicating success or failure.

Source

async fn delete_topic_in_broker( &self, address: &str, request_header: DeleteTopicRequestHeader, timeout_millis: u64, ) -> RocketMQResult<()>

Deletes a topic in the broker.

§Arguments
  • address - The address of the broker.
  • request_header - The request header containing topic parameters.
  • timeout_millis - The timeout in milliseconds for the operation.
§Returns

A result indicating success or failure.

Source

async fn delete_topic_in_nameserver( &self, address: &str, request_header: DeleteTopicFromNamesrvRequestHeader, timeout_millis: u64, ) -> RocketMQResult<()>

Deletes a topic in the nameserver.

§Arguments
  • address - The address of the nameserver.
  • request_header - The request header containing topic parameters.
  • timeout_millis - The timeout in milliseconds for the operation.
§Returns

A result indicating success or failure.

Source

async fn delete_kv_config( &self, address: &str, request_header: DeleteKVConfigRequestHeader, timeout_millis: u64, ) -> RocketMQResult<()>

Deletes a key-value configuration.

§Arguments
  • address - The address of the nameserver.
  • request_header - The request header containing key-value parameters.
  • timeout_millis - The timeout in milliseconds for the operation.
§Returns

A result indicating success or failure.

Source

async fn delete_subscription_group( &self, address: &str, request_header: DeleteSubscriptionGroupRequestHeader, timeout_millis: u64, ) -> RocketMQResult<()>

Deletes a subscription group.

§Arguments
  • address - The address of the broker.
  • request_header - The request header containing subscription group parameters.
  • timeout_millis - The timeout in milliseconds for the operation.
§Returns

A result indicating success or failure.

Source

async fn invoke_broker_to_reset_offset( &self, address: &str, request_header: ResetOffsetRequestHeader, timeout_millis: u64, ) -> RocketMQResult<HashMap<MessageQueue, i64>>

Invokes the broker to reset the offset.

§Arguments
  • address - The address of the broker.
  • request_header - The request header containing reset offset parameters.
  • timeout_millis - The timeout in milliseconds for the operation.
§Returns

A result containing a hashmap of MessageQueue to offset or an error.

Source

async fn view_message( &self, address: &str, request_header: ViewMessageRequestHeader, timeout_millis: u64, ) -> RocketMQResult<MessageExt>

Views a message.

§Arguments
  • address - The address of the broker.
  • request_header - The request header containing view message parameters.
  • timeout_millis - The timeout in milliseconds for the operation.
§Returns

A result containing MessageExt or an error.

Source

async fn get_broker_cluster_info( &self, address: &str, timeout_millis: u64, ) -> RocketMQResult<ClusterInfo>

Retrieves broker cluster information.

§Arguments
  • address - The address of the broker.
  • timeout_millis - The timeout in milliseconds for the operation.
§Returns

A result containing ClusterInfo or an error.

Source

async fn get_consumer_connection_list( &self, address: &str, request_header: GetConsumerConnectionListRequestHeader, timeout_millis: u64, ) -> RocketMQResult<ConsumerConnection>

Retrieves the consumer connection list.

§Arguments
  • address - The address of the broker.
  • request_header - The request header containing consumer connection parameters.
  • timeout_millis - The timeout in milliseconds for the operation.
§Returns

A result containing ConsumerConnection or an error.

Source

async fn query_topics_by_consumer( &self, address: &str, request_header: QueryTopicsByConsumerRequestHeader, timeout_millis: u64, ) -> RocketMQResult<TopicList>

Queries topics by consumer.

§Arguments
  • address - The address of the broker.
  • request_header - The request header containing query parameters.
  • timeout_millis - The timeout in milliseconds for the operation.
§Returns

A result containing TopicList or an error.

Source

async fn query_subscription_by_consumer( &self, address: &str, request_header: QuerySubscriptionByConsumerRequestHeader, timeout_millis: u64, ) -> RocketMQResult<SubscriptionData>

Queries subscription by consumer.

§Arguments
  • address - The address of the broker.
  • request_header - The request header containing query parameters.
  • timeout_millis - The timeout in milliseconds for the operation.
§Returns

A result containing SubscriptionData or an error.

Source

async fn get_consume_stats( &self, address: &str, request_header: GetConsumeStatsRequestHeader, timeout_millis: u64, ) -> RocketMQResult<ConsumeStats>

Retrieves consume statistics.

§Arguments
  • address - The address of the broker.
  • request_header - The request header containing query parameters.
  • timeout_millis - The timeout in milliseconds for the operation.
§Returns

A result containing ConsumeStats or an error.

Source

async fn query_topic_consume_by_who( &self, address: &str, request_header: QueryTopicConsumeByWhoRequestHeader, timeout_millis: u64, ) -> RocketMQResult<GroupList>

Queries which group consumes a topic.

§Arguments
  • address - The address of the broker.
  • request_header - The request header containing query parameters.
  • timeout_millis - The timeout in milliseconds for the operation.
§Returns

A result containing GroupList or an error.

Source

async fn get_consumer_running_info( &self, address: &str, request_header: GetConsumerRunningInfoRequestHeader, timeout_millis: u64, ) -> RocketMQResult<ConsumerRunningInfo>

Retrieves consumer running information.

§Arguments
  • address - The address of the broker.
  • request_header - The request header containing query parameters.
  • timeout_millis - The timeout in milliseconds for the operation.
§Returns

A result containing ConsumerRunningInfo or an error.

Source

async fn consume_message_directly( &self, address: &str, request_header: ConsumeMessageDirectlyResultRequestHeader, timeout_millis: u64, ) -> RocketMQResult<ConsumeMessageDirectlyResult>

Consumes a message directly.

§Arguments
  • address - The address of the broker.
  • request_header - The request header containing consume message parameters.
  • timeout_millis - The timeout in milliseconds for the operation.
§Returns

A result containing ConsumeMessageDirectlyResult or an error.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§

Source§

impl<TraitVariantBlanketType: MqClientAdmin> MqClientAdminInner for TraitVariantBlanketType