Struct DefaultMQAdminExt 

pub struct DefaultMQAdminExt { /* private fields */ }

Java-style Admin facade that owns a self-wired DefaultMQAdminExtImpl.

DefaultMQAdminExtImpl remains the concrete implementation behind the scoped administration capabilities. This facade requires an application-owned ClientRuntime and dereferences to the implementation for advanced admin operations.

Implementations

impl DefaultMQAdminExt

pub fn new(client_runtime: Arc<ClientRuntime>) -> Self

pub fn client_runtime(&self) -> Arc<ClientRuntime>

Returns the application-owned runtime borrowed by this Admin facade.

pub fn with_timeout( client_runtime: Arc<ClientRuntime>, timeout_millis: Duration, ) -> Self

pub fn with_rpc_hook( client_runtime: Arc<ClientRuntime>, rpc_hook: Arc<dyn RPCHook>, ) -> Self

pub fn with_rpc_hook_and_timeout( client_runtime: Arc<ClientRuntime>, rpc_hook: Arc<dyn RPCHook>, timeout_millis: Duration, ) -> Self

pub fn with_admin_ext_group( client_runtime: Arc<ClientRuntime>, admin_ext_group: impl Into<CheetahString>, ) -> Self

pub fn with_admin_ext_group_and_timeout( client_runtime: Arc<ClientRuntime>, admin_ext_group: impl Into<CheetahString>, timeout_millis: Duration, ) -> Self

pub fn with_admin_ext_group_and_rpc_hook( client_runtime: Arc<ClientRuntime>, admin_ext_group: impl Into<CheetahString>, rpc_hook: Arc<dyn RPCHook>, ) -> Self

pub fn with_admin_ext_group_rpc_hook_and_timeout( client_runtime: Arc<ClientRuntime>, admin_ext_group: impl Into<CheetahString>, rpc_hook: Arc<dyn RPCHook>, timeout_millis: Duration, ) -> Self

pub fn set_namesrv_addr(&mut self, name_serv_addr: impl Into<CheetahString>)

pub fn is_use_tls(&self) -> bool

pub fn set_use_tls(&mut self, use_tls: bool)

pub fn client_config(&self) -> &ClientConfig

pub fn client_config_mut(&mut self) -> &mut ClientConfig

pub fn inner(&self) -> &DefaultMQAdminExtImpl

pub fn inner_mut(&mut self) -> &mut DefaultMQAdminExtImpl

pub fn has_inner(&self) -> bool

pub async fn start(&mut self) -> ClientResult<()>

pub async fn shutdown(&mut self)

Methods from Deref<Target = DefaultMQAdminExtImpl>

pub async fn check_controller_rollout( &self, controller_address: CheetahString, target_node_id: u64, ) -> ClientResult<RolloutQuorumStatus>

Uses this admin session’s credentials and transport for a fresh rollout check.

Errors

Fails if the session is stopped or the current leader cannot confirm the remaining quorum.

pub fn has_inner(&self) -> bool

Returns whether the facade has a usable concrete implementation.

The implementation is now owned directly, so this compatibility query is always true.

pub fn client_config(&self) -> &ClientConfig

pub fn client_config_mut(&mut self) -> &mut ClientConfig

pub fn is_use_tls(&self) -> bool

pub fn set_use_tls(&mut self, use_tls: bool)

pub async fn create_acl_with_acl_info( &self, broker_addr: CheetahString, acl_info: AclInfo, ) -> ClientResult<()>

pub async fn update_acl_with_acl_info( &self, broker_addr: CheetahString, acl_info: AclInfo, ) -> ClientResult<()>

pub async fn create_user_with_user_info( &self, broker_addr: CheetahString, user_info: UserInfo, ) -> ClientResult<()>

pub async fn update_user_with_user_info( &self, broker_addr: CheetahString, user_info: UserInfo, ) -> ClientResult<()>

pub async fn pull_message_from_queue( &self, broker_addr: &str, mq: &MessageQueue, sub_expression: &str, offset: i64, max_nums: i32, timeout_millis: u64, ) -> ClientResult<PullResult>

pub async fn query_message_by_key( &self, cluster_name: Option<CheetahString>, topic: CheetahString, key: CheetahString, max_num: i32, begin_timestamp: i64, end_timestamp: i64, key_type: CheetahString, last_key: Option<CheetahString>, ) -> ClientResult<QueryResult>

pub async fn query_message_by_unique_key( &self, cluster_name: Option<CheetahString>, topic: CheetahString, unique_key: CheetahString, max_num: i32, begin_timestamp: i64, end_timestamp: i64, ) -> ClientResult<QueryResult>

Trait Implementations

impl AsMut<DefaultMQAdminExtImpl> for DefaultMQAdminExt

fn as_mut(&mut self) -> &mut DefaultMQAdminExtImpl

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<DefaultMQAdminExtImpl> for DefaultMQAdminExt

fn as_ref(&self) -> &DefaultMQAdminExtImpl

Converts this type into a shared reference of the (usually inferred) input type.

impl AuthAdmin for DefaultMQAdminExt

async fn create_and_update_plain_access_config( &self, addr: CheetahString, config: PlainAccessConfig, ) -> ClientResult<()>

async fn delete_plain_access_config( &self, addr: CheetahString, access_key: CheetahString, ) -> ClientResult<()>

async fn update_global_white_addr_config( &self, addr: CheetahString, global_white_addrs: CheetahString, acl_file_full_path: Option<CheetahString>, ) -> ClientResult<()>

async fn examine_broker_cluster_acl_version_info( &self, addr: CheetahString, ) -> ClientResult<CheetahString>

async fn get_user_subscription_group( &self, broker_addr: CheetahString, timeout_millis: u64, ) -> ClientResult<SubscriptionGroupWrapper>

async fn get_user_topic_config( &self, broker_addr: CheetahString, special_topic: bool, timeout_millis: u64, ) -> ClientResult<TopicConfigSerializeWrapper>

async fn create_user( &self, broker_addr: CheetahString, username: CheetahString, password: CheetahString, user_type: CheetahString, ) -> ClientResult<()>

async fn create_user_with_info( &self, broker_addr: CheetahString, username: CheetahString, password: CheetahString, ) -> ClientResult<()>

async fn update_user( &self, broker_addr: CheetahString, username: CheetahString, password: CheetahString, user_type: CheetahString, user_status: CheetahString, ) -> ClientResult<()>

async fn update_user_with_info( &self, broker_addr: CheetahString, username: CheetahString, password: CheetahString, ) -> ClientResult<()>

async fn delete_user( &self, broker_addr: CheetahString, username: CheetahString, ) -> ClientResult<()>

async fn get_user( &self, broker_addr: CheetahString, username: CheetahString, ) -> ClientResult<Option<UserInfo>>

async fn list_users( &self, broker_addr: CheetahString, filter: CheetahString, ) -> ClientResult<Vec<UserInfo>>

async fn create_acl( &self, broker_addr: CheetahString, subject: CheetahString, resources: Vec<CheetahString>, actions: Vec<CheetahString>, source_ips: Vec<CheetahString>, decision: CheetahString, ) -> ClientResult<()>

async fn create_acl_with_info( &self, broker_addr: CheetahString, subject: CheetahString, ) -> ClientResult<()>

async fn update_acl( &self, broker_addr: CheetahString, subject: CheetahString, resources: Vec<CheetahString>, actions: Vec<CheetahString>, source_ips: Vec<CheetahString>, decision: CheetahString, ) -> ClientResult<()>

async fn update_acl_with_info( &self, broker_addr: CheetahString, subject: CheetahString, ) -> ClientResult<()>

async fn delete_acl( &self, broker_addr: CheetahString, subject: CheetahString, resource: CheetahString, ) -> ClientResult<()>

async fn delete_acl_entry( &self, broker_addr: CheetahString, subject: CheetahString, policy_type: CheetahString, resource: CheetahString, ) -> ClientResult<()>

Deletes one resource from an explicitly selected ACL policy type.

async fn get_acl( &self, broker_addr: CheetahString, subject: CheetahString, ) -> ClientResult<AclInfo>

async fn list_acl( &self, broker_addr: CheetahString, subject_filter: CheetahString, resource_filter: CheetahString, ) -> ClientResult<Vec<AclInfo>>

async fn list_user( &self, broker_addr: CheetahString, filter: CheetahString, ) -> ClientResult<Vec<UserInfo>>

impl BrokerAdmin for DefaultMQAdminExt

async fn start(&mut self) -> ClientResult<()>

async fn shutdown(&mut self)

async fn add_broker_to_container( &self, broker_container_addr: CheetahString, broker_config: CheetahString, ) -> ClientResult<()>

async fn remove_broker_from_container( &self, broker_container_addr: CheetahString, cluster_name: CheetahString, broker_name: CheetahString, broker_id: u64, ) -> ClientResult<()>

async fn update_broker_config( &self, broker_addr: CheetahString, properties: HashMap<CheetahString, CheetahString>, ) -> ClientResult<()>

async fn get_broker_config( &self, broker_addr: CheetahString, ) -> ClientResult<HashMap<CheetahString, CheetahString>>

async fn fetch_broker_runtime_stats( &self, broker_addr: CheetahString, ) -> ClientResult<KVTable>

async fn check_rocksdb_cq_write_progress( &self, broker_addr: CheetahString, topic: CheetahString, check_store_time: i64, ) -> ClientResult<CheckRocksdbCqWriteResult>

async fn wipe_write_perm_of_broker( &self, namesrv_addr: CheetahString, broker_name: CheetahString, ) -> ClientResult<i32>

async fn add_write_perm_of_broker( &self, namesrv_addr: CheetahString, broker_name: CheetahString, ) -> ClientResult<i32>

async fn view_broker_stats_data( &self, broker_addr: CheetahString, stats_name: CheetahString, stats_key: CheetahString, ) -> ClientResult<BrokerStatsData>

async fn resume_check_half_message( &self, topic: CheetahString, msg_id: CheetahString, ) -> ClientResult<bool>

async fn get_broker_ha_status( &self, broker_addr: CheetahString, ) -> ClientResult<HARuntimeInfo>

async fn get_in_sync_state_data( &self, controller_address: CheetahString, brokers: Vec<CheetahString>, ) -> ClientResult<BrokerReplicasInfo>

async fn get_broker_epoch_cache( &self, broker_addr: CheetahString, ) -> ClientResult<EpochEntryCache>

async fn get_controller_meta_data( &self, controller_addr: CheetahString, ) -> ClientResult<GetMetaDataResponseHeader>

async fn get_controller_config( &self, controller_servers: Vec<CheetahString>, ) -> ClientResult<HashMap<CheetahString, HashMap<CheetahString, CheetahString>>>

async fn update_controller_config( &self, properties: HashMap<CheetahString, CheetahString>, controllers: Vec<CheetahString>, ) -> ClientResult<()>

async fn elect_master( &self, controller_addr: CheetahString, cluster_name: CheetahString, broker_name: CheetahString, broker_id: Option<u64>, ) -> ClientResult<(ElectMasterResponseHeader, BrokerMemberGroup)>

async fn clean_controller_broker_data( &self, controller_addr: CheetahString, cluster_name: CheetahString, broker_name: CheetahString, broker_controller_ids_to_clean: Option<CheetahString>, is_clean_living_broker: bool, ) -> ClientResult<()>

async fn get_cold_data_flow_ctr_info( &self, broker_addr: CheetahString, ) -> ClientResult<CheetahString>

async fn notify_min_broker_id_changed( &self, cluster_name: CheetahString, broker_name: CheetahString, min_broker_id: u64, min_broker_addr: CheetahString, offline_broker_addr: Option<CheetahString>, ha_broker_addr: Option<CheetahString>, ) -> ClientResult<()>

async fn export_pop_records( &self, broker_addr: CheetahString, timeout: u64, ) -> ClientResult<()>

async fn switch_timer_engine( &self, broker_addr: CheetahString, des_timer_engine: CheetahString, ) -> ClientResult<()>

async fn get_broker_lite_info( &self, broker_addr: CheetahString, ) -> ClientResult<GetBrokerLiteInfoResponseBody>

async fn get_lite_client_info( &self, broker_addr: CheetahString, parent_topic: CheetahString, group: CheetahString, client_id: CheetahString, ) -> ClientResult<GetLiteClientInfoResponseBody>

async fn trigger_lite_dispatch( &self, broker_addr: CheetahString, group: CheetahString, client_id: CheetahString, ) -> ClientResult<()>

async fn export_rocksdb_config_to_json( &self, broker_addr: CheetahString, config_types: Vec<CheetahString>, ) -> ClientResult<()>

impl ClientSessionProvider for DefaultMQAdminExt

fn client_session(&self) -> Option<&ClientSession>

impl ConsumerAdmin for DefaultMQAdminExt

async fn create_and_update_subscription_group_config( &self, addr: CheetahString, config: SubscriptionGroupConfig, ) -> ClientResult<()>

async fn create_and_update_subscription_group_config_list( &self, broker_addr: CheetahString, configs: Vec<SubscriptionGroupConfig>, ) -> ClientResult<()>

async fn examine_subscription_group_config( &self, addr: CheetahString, group: CheetahString, ) -> ClientResult<SubscriptionGroupConfig>

async fn examine_consume_stats( &self, consumer_group: CheetahString, topic: Option<CheetahString>, cluster_name: Option<CheetahString>, broker_addr: Option<CheetahString>, timeout_millis: Option<u64>, ) -> ClientResult<ConsumeStats>

async fn examine_consumer_connection_info( &self, consumer_group: CheetahString, broker_addr: Option<CheetahString>, ) -> ClientResult<ConsumerConnection>

async fn examine_producer_connection_info( &self, producer_group: CheetahString, topic: CheetahString, ) -> ClientResult<ProducerConnection>

async fn get_all_producer_info( &self, broker_addr: CheetahString, ) -> ClientResult<ProducerTableInfo>

async fn delete_subscription_group( &self, addr: CheetahString, group_name: CheetahString, remove_offset: Option<bool>, ) -> ClientResult<()>

async fn delete_subscription_group_list( &self, addr: CheetahString, group_names: Vec<CheetahString>, clean_offset: bool, ) -> ClientResult<()>

async fn get_consume_status( &self, topic: CheetahString, group: CheetahString, client_addr: CheetahString, ) -> ClientResult<HashMap<CheetahString, HashMap<MessageQueue, u64>>>

async fn query_subscription( &self, group: CheetahString, topic: CheetahString, ) -> ClientResult<SubscriptionData>

async fn clean_expired_consumer_queue( &self, cluster: Option<CheetahString>, addr: Option<CheetahString>, ) -> ClientResult<bool>

async fn clean_expired_consumer_queue_by_addr( &self, addr: CheetahString, ) -> ClientResult<bool>

async fn get_consumer_running_info( &self, consumer_group: CheetahString, client_id: CheetahString, jstack: bool, metrics: Option<bool>, ) -> ClientResult<ConsumerRunningInfo>

async fn consume_message_directly( &self, consumer_group: CheetahString, client_id: CheetahString, topic: CheetahString, msg_id: CheetahString, ) -> ClientResult<ConsumeMessageDirectlyResult>

async fn consume_message_directly_ext( &self, cluster_name: CheetahString, consumer_group: CheetahString, client_id: CheetahString, topic: CheetahString, msg_id: CheetahString, ) -> ClientResult<ConsumeMessageDirectlyResult>

async fn message_track_detail( &self, msg: MessageExt, ) -> ClientResult<Vec<MessageTrack>>

async fn message_track_detail_concurrent( &self, msg: MessageExt, ) -> AdminToolResult<Vec<MessageTrack>>

async fn fetch_consume_stats_in_broker( &self, broker_addr: CheetahString, is_order: bool, timeout_millis: u64, ) -> ClientResult<ConsumeStatsList>

async fn get_all_subscription_group( &self, broker_addr: CheetahString, timeout_millis: u64, ) -> ClientResult<SubscriptionGroupWrapper>

async fn query_consume_queue( &self, broker_addr: CheetahString, topic: CheetahString, queue_id: i32, index: u64, count: i32, consumer_group: CheetahString, ) -> ClientResult<QueryConsumeQueueResponseBody>

async fn update_and_get_group_read_forbidden( &self, broker_addr: CheetahString, group_name: CheetahString, topic_name: CheetahString, readable: Option<bool>, ) -> ClientResult<GroupForbidden>

async fn query_message( &self, cluster_name: CheetahString, topic: CheetahString, msg_id: CheetahString, ) -> ClientResult<MessageExt>

async fn update_cold_data_flow_ctr_group_config( &self, broker_addr: CheetahString, properties: HashMap<CheetahString, CheetahString>, ) -> ClientResult<()>

async fn remove_cold_data_flow_ctr_group_config( &self, broker_addr: CheetahString, consumer_group: CheetahString, ) -> ClientResult<()>

async fn query_lite_pull_subscription_list( &self, addr: CheetahString, topic: CheetahString, ) -> ClientResult<GroupList>

async fn examine_consume_stats_with_queue( &self, consumer_group: CheetahString, topic: Option<CheetahString>, queue_id: Option<i32>, ) -> ClientResult<ConsumeStats>

async fn examine_consume_stats_concurrent( &self, consumer_group: CheetahString, topic: Option<CheetahString>, ) -> AdminToolResult<ConsumeStats>

async fn examine_consume_stats_concurrent_with_cluster( &self, consumer_group: CheetahString, topic: Option<CheetahString>, cluster_name: Option<CheetahString>, ) -> AdminToolResult<ConsumeStats>

async fn sync_broker_member_group( &self, controller_addr: CheetahString, cluster_name: CheetahString, broker_name: CheetahString, ) -> ClientResult<()>

async fn get_lite_group_info( &self, broker_addr: CheetahString, group: CheetahString, lite_topic: CheetahString, top_k: i32, ) -> ClientResult<GetLiteGroupInfoResponseBody>

impl Deref for DefaultMQAdminExt

type Target = DefaultMQAdminExtImpl

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for DefaultMQAdminExt

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl MQAdminConsumerObservationReadExt for DefaultMQAdminExt

async fn consumer_group_config_at( &self, broker_addr: CheetahString, consumer_group: CheetahString, ) -> ClientResult<ConsumerGroupConfigRead>

async fn consumer_connection_at( &self, broker_addr: CheetahString, consumer_group: CheetahString, ) -> ClientResult<ConsumerConnectionRead>

async fn consumer_progress_at( &self, broker_addr: CheetahString, consumer_group: CheetahString, ) -> ClientResult<ConsumerProgressRead>

impl MQAdminInfrastructureObservationReadExt for DefaultMQAdminExt

async fn broker_ha_runtime_at( &self, broker_endpoint: CheetahString, ) -> Result<HARuntimeInfo, InfrastructureObservationReadError>

async fn controller_sync_state_at( &self, controller_endpoint: CheetahString, broker_names: Vec<CheetahString>, ) -> Result<BrokerReplicasInfo, InfrastructureObservationReadError>

async fn controller_metadata_at( &self, controller_endpoint: CheetahString, ) -> Result<GetMetaDataResponseHeader, InfrastructureObservationReadError>

async fn nameserver_config_at( &self, nameserver_endpoint: CheetahString, ) -> Result<HashMap<CheetahString, CheetahString>, InfrastructureObservationReadError>

impl MQAdminMessageReadExt for DefaultMQAdminExt

async fn query_message_metadata( &self, topic: CheetahString, message_id: CheetahString, ) -> ClientResult<MessageMetadataRead>

Looks up one message while returning only a fixed body-free metadata projection.

async fn query_message_metadata_by_id( &self, message_id: CheetahString, ) -> ClientResult<MessageMetadataRead>

Looks up one offset message identifier and derives the authoritative Topic from the returned message.

impl MQAdminMutationExt for DefaultMQAdminExt

async fn begin_proxy_drain( &self, proxy_addr: CheetahString, operation_id: CheetahString, ) -> ClientResult<ProxyDrainStateResponseBody>

Begins one authenticated, reversible drain operation for a Proxy.

async fn cancel_proxy_drain( &self, proxy_addr: CheetahString, operation_id: CheetahString, ) -> ClientResult<ProxyDrainStateResponseBody>

Cancels a timed-out drain and restores Proxy admission/readiness.

async fn broker_config_generation( &self, broker_addr: CheetahString, ) -> ClientResult<u64>

Reads the broker configuration generation used by supervised prechecks.

async fn patch_broker_config_if_generation( &self, broker_addr: CheetahString, expected_generation: u64, properties: HashMap<CheetahString, CheetahString>, ) -> ClientResult<BrokerConfigPatchOutcome>

Applies a broker configuration patch only when expected_generation still matches the broker’s current generation.

async fn preview_consumer_offset_reset_on_broker( &self, broker_addr: CheetahString, broker_name: CheetahString, read_queue_nums: u32, consumer_group: CheetahString, topic: CheetahString, timestamp: i64, ) -> ClientResult<Vec<MutationConsumerOffsetPreview>>

Computes exact queue offsets for one already-selected Broker master without mutation.

async fn mutation_consumer_offset( &self, broker_addr: CheetahString, consumer_group: CheetahString, topic: CheetahString, queue_id: i32, ) -> ClientResult<i64>

Re-reads one exact queue offset for postcondition verification.

async fn patch_topic_config_if_version( &self, broker_addr: CheetahString, topic: CheetahString, expected_version: u64, patch: TopicConfigPatch, ) -> ClientResult<TopicConfigPatchOutcome>

Changes only the three fields in TopicConfigPatch when the Broker’s current Topic metadata version still matches expected_version.

async fn mutation_topic_config_with_version( &self, broker_addr: CheetahString, topic: CheetahString, ) -> ClientResult<MutationTopicConfigVersioned>

Reads only the Topic fields and version needed to prepare a supervised queue-count compare-and-set mutation.

async fn mutation_topic_config_state( &self, broker_addr: CheetahString, topic: CheetahString, ) -> ClientResult<MutationTopicConfigState>

Reads a presence-aware, allowlisted Topic state from one exact Broker.

async fn replace_topic_config_if_state( &self, broker_addr: CheetahString, topic: CheetahString, expected_state: MutationExpectedState, replacement: MutationTopicConfig, ) -> ClientResult<MutationStateCasOutcome>

Creates or fully replaces the allowlisted Topic state only when its presence/version precondition still matches.

async fn patch_subscription_group_config_if_version( &self, broker_addr: CheetahString, group: CheetahString, expected_version: u64, patch: SubscriptionGroupConfigPatch, ) -> ClientResult<SubscriptionGroupConfigPatchOutcome>

Changes only the three fields in SubscriptionGroupConfigPatch when the Broker’s current Subscription Group metadata version still matches expected_version.

async fn mutation_subscription_group_config_state( &self, broker_addr: CheetahString, group: CheetahString, ) -> ClientResult<MutationSubscriptionGroupConfigState>

Reads presence-aware, allowlisted Subscription Group state from one exact Broker.

async fn replace_subscription_group_config_if_state( &self, broker_addr: CheetahString, group: CheetahString, expected_state: MutationExpectedState, replacement: MutationSubscriptionGroupConfig, ) -> ClientResult<MutationStateCasOutcome>

Creates or fully replaces the allowlisted Subscription Group state under one state CAS.

async fn broker_mutation_config_state( &self, broker_addr: CheetahString, ) -> ClientResult<BrokerMutationConfigState>

Reads only the six Broker settings accepted by supervised control preflight.

async fn reset_consumer_offset_if_current( &self, broker_addr: CheetahString, consumer_group: CheetahString, topic: CheetahString, queue_id: i32, expected_offset: i64, new_offset: i64, ) -> ClientResult<ConditionalConsumerOffsetOutcome>

Applies one exact queue offset transition without route re-resolution or retry.

async fn mutation_message_request_mode( &self, broker_addr: CheetahString, topic: CheetahString, consumer_group: CheetahString, ) -> ClientResult<Option<MutationMessageRequestMode>>

Reads one exact Topic/group request-mode entry from a selected Broker master.

async fn replace_message_request_mode_if_current( &self, broker_addr: CheetahString, topic: CheetahString, consumer_group: CheetahString, expected: MutationExpectedMessageRequestMode, replacement: MutationMessageRequestMode, ) -> ClientResult<MutationMessageRequestModeOutcome>

Conditionally replaces one exact Topic/group request-mode entry.

async fn replace_message_request_mode_if_current_with_timeout( &self, broker_addr: CheetahString, topic: CheetahString, consumer_group: CheetahString, expected: MutationExpectedMessageRequestMode, replacement: MutationMessageRequestMode, timeout_millis: u64, ) -> ClientResult<MutationMessageRequestModeOutcome>

Conditionally replaces one exact Topic/group request-mode entry using the caller’s bounded request timeout.

async fn set_broker_log_filter_ttl( &self, broker_addr: CheetahString, logger: CheetahString, level: CheetahString, ttl_seconds: u32, operation_id: CheetahString, ) -> ClientResult<()>

Applies one bounded Broker logger override with an automatic TTL.

async fn restore_broker_log_filter( &self, broker_addr: CheetahString, operation_id: CheetahString, ) -> ClientResult<()>

Restores the Broker logger baseline for one bounded operation.

async fn upsert_topic_config( &self, broker_addr: CheetahString, config: TopicConfig, ) -> ClientResult<()>

async fn remove_topic( &self, topic_name: CheetahString, cluster_name: CheetahString, ) -> ClientResult<()>

async fn reset_consumer_offset( &self, cluster_name: Option<CheetahString>, topic: CheetahString, consumer_group: CheetahString, timestamp: u64, force: bool, ) -> ClientResult<HashMap<MessageQueue, u64>>

async fn reset_consumer_offset_detailed( &self, cluster_name: CheetahString, topic: CheetahString, consumer_group: CheetahString, timestamp: u64, force: bool, ) -> ClientResult<TopicOffsetMutationOutcome>

Resets each exact broker/queue target independently and retains partial outcomes.

async fn skip_accumulated_message( &self, cluster_name: Option<CheetahString>, topic: CheetahString, consumer_group: CheetahString, force: bool, ) -> ClientResult<usize>

Advances one exact consumer group and Topic to the latest available offsets. This is deliberately separate from timestamp reset because the RocketMQ protocol represents latest with the signed -1 sentinel.

async fn skip_accumulated_message_detailed( &self, cluster_name: CheetahString, topic: CheetahString, consumer_group: CheetahString, force: bool, ) -> ClientResult<TopicOffsetMutationOutcome>

Advances each exact broker/queue target to latest while retaining partial outcomes.

async fn upsert_subscription_group( &self, broker_addr: CheetahString, config: SubscriptionGroupConfig, ) -> ClientResult<()>

async fn remove_subscription_group( &self, broker_addr: CheetahString, group_name: CheetahString, remove_offset: Option<bool>, ) -> ClientResult<()>

async fn remove_subscription_groups( &self, broker_addr: CheetahString, group_names: Vec<CheetahString>, clean_offset: bool, ) -> ClientResult<()>

Removes multiple subscription groups from one broker in a single request.

async fn configure_message_request_mode( &self, broker_addr: CheetahString, topic: CheetahString, consumer_group: CheetahString, mode: MessageRequestMode, pop_work_group_size: i32, timeout_millis: u64, ) -> ClientResult<()>

async fn consume_directly( &self, consumer_group: CheetahString, client_id: CheetahString, topic: CheetahString, message_id: CheetahString, ) -> ClientResult<ConsumeMessageDirectlyResult>

async fn clone_consumer_group_offset( &self, source_group: CheetahString, destination_group: CheetahString, topic: CheetahString, offline: bool, ) -> ClientResult<()>

async fn mutation_cluster_info(&self) -> ClientResult<ClusterInfo>

Returns the cluster topology needed to resolve mutation targets.

async fn mutation_topic_route( &self, topic: CheetahString, ) -> ClientResult<Option<TopicRouteData>>

Returns route data used to scope a mutation to the topic’s brokers.

async fn mutation_topic_config( &self, broker_addr: CheetahString, topic: CheetahString, ) -> ClientResult<TopicConfig>

Reads a broker’s current topic configuration before a bounded test send.

async fn remove_topic_from_brokers( &self, broker_addrs: HashSet<CheetahString>, topic: CheetahString, ) -> ClientResult<()>

Removes a topic from an explicitly resolved broker set.

async fn remove_topics_from_broker( &self, broker_addr: CheetahString, topics: Vec<CheetahString>, ) -> ClientResult<()>

Removes multiple topics from one broker in a single request.

async fn remove_topic_from_name_servers( &self, namesrv_addrs: HashSet<CheetahString>, cluster_name: Option<CheetahString>, topic: CheetahString, ) -> ClientResult<()>

Removes a topic from an explicitly resolved NameServer set.

async fn mutation_name_server_addresses( &self, ) -> ClientResult<Vec<CheetahString>>

Returns the NameServer targets owned by this started admin session.

async fn upsert_order_topic_config( &self, topic: CheetahString, value: CheetahString, cluster_wide: bool, ) -> ClientResult<()>

Updates the order-topic configuration associated with a topic mutation.

async fn mutation_order_topic_config( &self, topic: CheetahString, ) -> ClientResult<Option<CheetahString>>

Reads the exact NameServer-wide order-topic value used by a supervised mutation guard.

async fn delete_order_topic_config( &self, topic: CheetahString, ) -> ClientResult<()>

Deletes the global order-topic entry after an unordered update or a complete Topic deletion.

async fn reset_consumer_offset_legacy( &self, cluster_name: Option<CheetahString>, consumer_group: CheetahString, topic: CheetahString, timestamp: u64, force: bool, ) -> ClientResult<Vec<RollbackStats>>

Performs the broker-by-broker offset reset fallback used for offline consumers.

async fn view_message_for_mutation( &self, topic: CheetahString, message_id: CheetahString, ) -> ClientResult<MessageExt>

Views the message metadata required to validate a DLQ resend.

impl MQAdminReadExt for DefaultMQAdminExt

async fn start(&mut self) -> ClientResult<()>

async fn shutdown(&mut self)

async fn fetch_all_topic_list(&self) -> ClientResult<TopicList>

async fn fetch_broker_runtime_stats( &self, broker_addr: CheetahString, ) -> ClientResult<KVTable>

async fn get_broker_config_allowlisted( &self, broker_addr: CheetahString, ) -> ClientResult<BrokerConfigAllowlisted>

Reads only the fixed non-sensitive Broker fields evaluated by the SRE generation-CAS action.

async fn proxy_drain_state( &self, proxy_addr: CheetahString, ) -> ClientResult<ProxyDrainStateResponseBody>

Returns the authenticated, bounded drain state for one Proxy endpoint.

async fn examine_consume_stats( &self, consumer_group: CheetahString, topic: Option<CheetahString>, _cluster_name: Option<CheetahString>, broker_addr: Option<CheetahString>, timeout_millis: Option<u64>, ) -> ClientResult<ConsumeStats>

async fn examine_consume_stats_with_evidence( &self, consumer_group: CheetahString, topic: Option<CheetahString>, broker_addr: Option<CheetahString>, timeout_millis: Option<u64>, ) -> ClientResult<ConsumeStatsReadResult>

Reads consumer statistics without discarding an individual Broker failure. Broker addresses and backend error strings never enter the returned evidence.

async fn examine_broker_cluster_info(&self) -> ClientResult<ClusterInfo>

async fn examine_topic_route_info( &self, topic: CheetahString, ) -> ClientResult<Option<TopicRouteData>>

async fn topic_config_with_version( &self, broker_addr: CheetahString, topic: CheetahString, ) -> ClientResult<TopicConfigVersioned>

Reads one Broker’s Topic configuration and metadata version atomically.

async fn subscription_group_config_with_version( &self, broker_addr: CheetahString, group: CheetahString, ) -> ClientResult<SubscriptionGroupConfigVersioned>

Reads one Broker’s Subscription Group configuration and metadata version atomically.

async fn examine_consumer_connection_info( &self, consumer_group: CheetahString, broker_addr: Option<CheetahString>, ) -> ClientResult<ConsumerConnection>

async fn observe_consumer_connection_at( &self, consumer_group: CheetahString, broker_addr: CheetahString, ) -> ClientResult<ConsumerConnection>

Reads one exact target without converting an authoritative empty connection set into a synthetic error or offline inference.

async fn examine_producer_connection_info( &self, producer_group: CheetahString, topic: CheetahString, ) -> ClientResult<ProducerConnection>

async fn observe_producer_connection_info( &self, producer_group: CheetahString, topic: CheetahString, ) -> ClientResult<ProducerConnection>

Reads producer connections without converting an authoritative empty set into a fabricated status or an unavailable observation.

async fn observe_producer_connection_at( &self, producer_group: CheetahString, broker_addr: CheetahString, ) -> ClientResult<ProducerConnection>

Reads producer connections from one exact broker address. An empty connection set is authoritative and is returned unchanged.

async fn get_all_producer_info( &self, broker_addr: CheetahString, ) -> ClientResult<ProducerTableInfo>

async fn query_topic_consume_by_who( &self, topic: CheetahString, ) -> ClientResult<GroupList>

impl MQAdminTopicInventoryReadExt for DefaultMQAdminExt

async fn fetch_topic_inventory( &self, cluster: Option<CheetahString>, ) -> ClientResult<TopicList>

Fetches one cluster inventory when cluster is present, or the global NameServer inventory otherwise.

impl MQAdminTopicStatsReadExt for DefaultMQAdminExt

async fn topic_stats_at( &self, broker_addr: CheetahString, topic: CheetahString, ) -> ClientResult<TopicStatsTable>

Reads the Topic statistics exposed by one exact Broker.

impl OffsetAdmin for DefaultMQAdminExt

async fn reset_offset_by_timestamp_old( &self, cluster_name: Option<CheetahString>, consumer_group: CheetahString, topic: CheetahString, timestamp: u64, force: bool, ) -> ClientResult<Vec<RollbackStats>>

async fn reset_offset_by_timestamp( &self, cluster_name: Option<CheetahString>, topic: CheetahString, group: CheetahString, timestamp: u64, is_force: bool, ) -> ClientResult<HashMap<MessageQueue, u64>>

async fn reset_offset_new( &self, consumer_group: CheetahString, topic: CheetahString, timestamp: u64, ) -> ClientResult<()>

async fn reset_offset_new_concurrent( &self, group: CheetahString, topic: CheetahString, timestamp: u64, ) -> AdminToolResult<BrokerOperatorResult>

async fn query_consume_time_span( &self, topic: CheetahString, group: CheetahString, ) -> ClientResult<Vec<QueueTimeSpan>>

async fn query_consume_time_span_concurrent( &self, topic: CheetahString, group: CheetahString, ) -> AdminToolResult<Vec<QueueTimeSpan>>

async fn delete_expired_commit_log( &self, cluster: Option<CheetahString>, addr: Option<CheetahString>, ) -> ClientResult<bool>

async fn delete_expired_commit_log_by_addr( &self, addr: CheetahString, ) -> ClientResult<bool>

async fn clone_group_offset( &self, src_group: CheetahString, dest_group: CheetahString, topic: CheetahString, is_offline: bool, ) -> ClientResult<()>

async fn update_consume_offset( &self, broker_addr: CheetahString, consume_group: CheetahString, mq: MessageQueue, offset: u64, ) -> ClientResult<()>

async fn reset_offset_by_queue_id( &self, broker_addr: CheetahString, consumer_group: CheetahString, topic_name: CheetahString, queue_id: i32, reset_offset: u64, ) -> ClientResult<()>

async fn reset_master_flush_offset( &self, broker_addr: CheetahString, master_flush_offset: u64, ) -> ClientResult<()>

async fn set_commit_log_read_ahead_mode( &self, broker_addr: CheetahString, mode: CheetahString, ) -> ClientResult<CheetahString>

async fn update_lite_pull_consumer_offset( &self, addr: CheetahString, topic: CheetahString, group: CheetahString, queue_id: i32, offset: u64, ) -> ClientResult<()>

async fn export_rocksdb_consumer_offset_to_json( &self, broker_addr: CheetahString, file_path: CheetahString, ) -> ClientResult<()>

async fn export_rocksdb_consumer_offset_from_memory( &self, broker_addr: CheetahString, ) -> ClientResult<CheetahString>

async fn search_offset( &self, broker_addr: CheetahString, topic_name: CheetahString, queue_id: i32, timestamp: u64, timeout_millis: u64, ) -> ClientResult<u64>

async fn min_offset( &self, broker_addr: CheetahString, message_queue: MessageQueue, timeout_millis: u64, ) -> ClientResult<i64>

async fn max_offset( &self, broker_addr: CheetahString, message_queue: MessageQueue, timeout_millis: u64, ) -> ClientResult<i64>

impl RouteAdmin for DefaultMQAdminExt

async fn examine_broker_cluster_info(&self) -> ClientResult<ClusterInfo>

async fn get_name_server_address_list(&self) -> Vec<CheetahString>

async fn put_kv_config( &self, namespace: CheetahString, key: CheetahString, value: CheetahString, )

async fn get_kv_config( &self, namespace: CheetahString, key: CheetahString, ) -> ClientResult<CheetahString>

async fn get_kv_list_by_namespace( &self, namespace: CheetahString, ) -> ClientResult<KVTable>

async fn create_and_update_kv_config( &self, namespace: CheetahString, key: CheetahString, value: CheetahString, ) -> ClientResult<()>

async fn delete_kv_config( &self, namespace: CheetahString, key: CheetahString, ) -> ClientResult<()>

async fn get_cluster_list( &self, topic: String, ) -> ClientResult<HashSet<CheetahString>>

async fn update_name_server_config( &self, properties: HashMap<CheetahString, CheetahString>, name_servers: Option<Vec<CheetahString>>, ) -> ClientResult<()>

async fn get_name_server_config( &self, name_servers: Vec<CheetahString>, ) -> ClientResult<HashMap<CheetahString, HashMap<CheetahString, CheetahString>>>

async fn probe_name_server( &self, name_server: CheetahString, ) -> ClientResult<()>

impl TopicAdmin for DefaultMQAdminExt

async fn create_and_update_topic_config( &self, addr: CheetahString, config: TopicConfig, ) -> ClientResult<()>

async fn create_and_update_topic_config_list( &self, addr: CheetahString, topic_config_list: Vec<TopicConfig>, ) -> ClientResult<()>

async fn examine_topic_stats( &self, topic: CheetahString, broker_addr: Option<CheetahString>, ) -> ClientResult<TopicStatsTable>

async fn examine_topic_stats_concurrent( &self, topic: CheetahString, ) -> AdminToolResult<TopicStatsTable>

async fn fetch_all_topic_list(&self) -> ClientResult<TopicList>

async fn fetch_topics_by_cluster( &self, cluster_name: CheetahString, ) -> ClientResult<TopicList>

async fn examine_topic_route_info( &self, topic: CheetahString, ) -> ClientResult<Option<TopicRouteData>>

async fn delete_topic( &self, topic_name: CheetahString, cluster_name: CheetahString, ) -> ClientResult<()>

async fn delete_topic_in_broker( &self, addrs: HashSet<CheetahString>, topic: CheetahString, ) -> ClientResult<()>

async fn delete_topic_in_broker_list( &self, addrs: HashSet<CheetahString>, topics: Vec<CheetahString>, ) -> ClientResult<()>

async fn delete_topic_in_broker_concurrent( &self, addrs: HashSet<CheetahString>, topic: CheetahString, ) -> AdminToolResult<BrokerOperatorResult>

async fn delete_topic_in_name_server( &self, addrs: HashSet<CheetahString>, cluster_name: Option<CheetahString>, topic: CheetahString, ) -> ClientResult<()>

async fn create_or_update_order_conf( &self, key: CheetahString, value: CheetahString, is_cluster: bool, ) -> ClientResult<()>

async fn query_topic_consume_by_who( &self, topic: CheetahString, ) -> ClientResult<GroupList>

async fn query_topics_by_consumer( &self, group: CheetahString, ) -> ClientResult<TopicList>

async fn query_topics_by_consumer_concurrent( &self, group: CheetahString, ) -> AdminToolResult<TopicList>

async fn clean_unused_topic( &self, cluster: Option<CheetahString>, addr: Option<CheetahString>, ) -> ClientResult<bool>

async fn clean_unused_topic_by_addr( &self, addr: CheetahString, ) -> ClientResult<bool>

async fn get_topic_cluster_list( &self, topic: String, ) -> ClientResult<HashSet<CheetahString>>

async fn get_all_topic_config( &self, broker_addr: CheetahString, timeout_millis: u64, ) -> ClientResult<TopicConfigSerializeWrapper>

async fn set_message_request_mode( &self, broker_addr: CheetahString, topic: CheetahString, consumer_group: CheetahString, mode: MessageRequestMode, pop_work_group_size: i32, timeout_millis: u64, ) -> ClientResult<()>

async fn examine_topic_config( &self, addr: CheetahString, topic: CheetahString, ) -> ClientResult<TopicConfig>

async fn create_static_topic( &self, addr: CheetahString, default_topic: CheetahString, topic_config: TopicConfig, mapping_detail: TopicQueueMappingDetail, force: bool, ) -> ClientResult<()>

async fn create_lite_pull_topic( &self, addr: CheetahString, topic: CheetahString, queue_num: i32, topic_sys_flag: i32, read_queue_nums: i32, write_queue_nums: i32, ) -> ClientResult<()>

async fn update_lite_pull_topic( &self, addr: CheetahString, topic: CheetahString, read_queue_nums: i32, write_queue_nums: i32, ) -> ClientResult<()>

async fn get_lite_pull_topic( &self, addr: CheetahString, topic: CheetahString, ) -> ClientResult<TopicConfig>

async fn delete_lite_pull_topic( &self, addr: CheetahString, cluster_name: CheetahString, topic: CheetahString, ) -> ClientResult<()>

async fn query_lite_pull_topic_list( &self, addr: CheetahString, ) -> ClientResult<TopicList>

async fn query_lite_pull_topic_by_cluster( &self, cluster_name: CheetahString, ) -> ClientResult<TopicList>

async fn get_topic_config_by_topic_name( &self, broker_addr: CheetahString, topic_name: CheetahString, ) -> ClientResult<TopicConfig>

async fn get_topic_stats_info( &self, broker_addr: CheetahString, topic: CheetahString, ) -> ClientResult<TopicStatsTable>

async fn query_broker_has_topic( &self, broker_addr: CheetahString, topic: CheetahString, ) -> ClientResult<bool>

async fn get_system_topic_list_from_broker( &self, broker_addr: CheetahString, ) -> ClientResult<TopicList>

async fn examine_topic_route_info_with_timeout( &self, topic: CheetahString, timeout_millis: u64, ) -> ClientResult<Option<TopicRouteData>>

async fn get_parent_topic_info( &self, broker_addr: CheetahString, topic: CheetahString, ) -> ClientResult<GetParentTopicInfoResponseBody>

async fn get_lite_topic_info( &self, broker_addr: CheetahString, parent_topic: CheetahString, lite_topic: CheetahString, ) -> ClientResult<GetLiteTopicInfoResponseBody>