Module admin 

Kafka admin client.

Corresponds to the org.apache.kafka.clients.admin package (the clients segment is dropped per the project naming conventions). See .claude/rules/admin-client.md for the design decisions that govern this module.

Re-exports

pub use alter_config_op::AlterConfigOp;

pub use alter_config_op::OpType;

pub use config_entry::ConfigEntry;

pub use config_entry::ConfigEntryOptions;

pub use config_entry::ConfigEntryOptionsBuilder;

pub use create_topics_result::CreateTopicsResult;

pub use create_topics_result::TopicMetadataAndConfig;

pub use delete_acls_result::DeleteAclsResult;

pub use delete_acls_result::FilterResult;

pub use delete_acls_result::FilterResults;

pub use describe_producers_result::DescribeProducersResult;

pub use describe_producers_result::PartitionProducerState;

pub use describe_replica_log_dirs_result::DescribeReplicaLogDirsResult;

pub use describe_replica_log_dirs_result::ReplicaLogDirInfo;

pub use feature_update::FeatureUpdate;

pub use feature_update::UpgradeType;

pub use list_offsets_result::ListOffsetsResult;

pub use list_offsets_result::ListOffsetsResultInfo;

pub use options::AbortTransactionOptions;

pub use options::AlterClientQuotasOptions;

pub use options::AlterConfigsOptions;

pub use options::AlterConsumerGroupOffsetsOptions;

pub use options::AlterPartitionReassignmentsOptions;

pub use options::AlterReplicaLogDirsOptions;

pub use options::AlterUserScramCredentialsOptions;

pub use options::CreateAclsOptions;

pub use options::CreateDelegationTokenOptions;

pub use options::CreatePartitionsOptions;

pub use options::CreateTopicsOptions;

pub use options::DeleteAclsOptions;

pub use options::DeleteConsumerGroupOffsetsOptions;

pub use options::DeleteConsumerGroupsOptions;

pub use options::DeleteRecordsOptions;

pub use options::DeleteTopicsOptions;

pub use options::DescribeAclsOptions;

pub use options::DescribeClassicGroupsOptions;

pub use options::DescribeClientQuotasOptions;

pub use options::DescribeClusterOptions;

pub use options::DescribeConfigsOptions;

pub use options::DescribeConsumerGroupsOptions;

pub use options::DescribeDelegationTokenOptions;

pub use options::DescribeFeaturesOptions;

pub use options::DescribeLogDirsOptions;

pub use options::DescribeProducersOptions;

pub use options::DescribeReplicaLogDirsOptions;

pub use options::DescribeTopicsOptions;

pub use options::DescribeTransactionsOptions;

pub use options::DescribeUserScramCredentialsOptions;

pub use options::ElectLeadersOptions;

pub use options::ExpireDelegationTokenOptions;

pub use options::FenceProducersOptions;

pub use options::ListConfigResourcesOptions;

pub use options::ListConsumerGroupOffsetsOptions;

pub use options::ListGroupsOptions;

pub use options::ListOffsetsOptions;

pub use options::ListPartitionReassignmentsOptions;

pub use options::ListTopicsOptions;

pub use options::ListTransactionsOptions;

pub use options::RemoveMembersFromConsumerGroupOptions;

pub use options::RenewDelegationTokenOptions;

pub use options::TerminateTransactionOptions;

pub use options::UpdateFeaturesOptions;

Modules

alter_config_op

An alter configuration operation.

config_entry

A configuration entry containing name, value and additional metadata.

create_topics_result

The result of Admin::create_topics.

delete_acls_result

The result of Admin::delete_acls.

describe_producers_result

The result of Admin::describe_producers.

describe_replica_log_dirs_result

The result of Admin::describe_replica_log_dirs.

feature_update

Details about an update to a finalized feature.

list_offsets_result

The result of Admin::list_offsets.

options

Options classes for admin operations.

Structs

AbortTransactionResult

The result of Admin::abort_transaction.

AbortTransactionSpec

The identifiers required to abort a hanging transaction on a partition.

AdminClientConfig

Configuration for the admin client.

AlterClientQuotasResult

The result of the Admin::alter_client_quotas call.

AlterConfigsResult

The result of the Admin::incremental_alter_configs call.

AlterConsumerGroupOffsetsResult

The result of Admin::alter_consumer_group_offsets.

AlterPartitionReassignmentsResult

The result of Admin::alter_partition_reassignments.

AlterReplicaLogDirsResult

The result of the Admin::alter_replica_log_dirs call.

AlterUserScramCredentialsResult

The result of the Admin::alter_user_scram_credentials call.

ClassicGroupDescription

A detailed description of a single classic group in the cluster.

Config

A configuration object containing the configuration entries for a resource.

ConsumerGroupDescription

A detailed description of a single consumer group in the cluster.

CreateAclsResult

The result of the Admin::create_acls call.

CreateDelegationTokenResult

The result of the Admin::create_delegation_token call.

CreatePartitionsResult

The result of Admin::create_partitions.

DeleteConsumerGroupOffsetsResult

The result of Admin::delete_consumer_group_offsets.

DeleteConsumerGroupsResult

The result of the Admin::delete_consumer_groups call for a Collection<String> (group id) input.

DeleteRecordsResult

The result of Admin::delete_records.

DeletedRecords

Represents information about deleted records.

DescribeAclsResult

The result of the Admin::describe_acls call.

DescribeClassicGroupsResult

The result of Admin::describe_classic_groups.

DescribeClientQuotasResult

The result of the Admin::describe_client_quotas call.

DescribeClusterResult

The result of the Admin::describe_cluster call.

DescribeConfigsResult

The result of the Admin::describe_configs call.

DescribeConsumerGroupsResult

The result of Admin::describe_consumer_groups.

DescribeDelegationTokenResult

The result of the Admin::describe_delegation_token call.

DescribeFeaturesResult

The result of the describe_features_with_options call.

DescribeLogDirsResult

The result of the Admin::describe_log_dirs call.

DescribeTransactionsResult

The result of Admin::describe_transactions.

DescribeUserScramCredentialsResult

The result of the Admin::describe_user_scram_credentials call.

ElectLeadersResult

The result of Admin::elect_leaders.

ExpireDelegationTokenResult

The result of the Admin::expire_delegation_token call.

FeatureMetadata

Encapsulates details about finalized as well as supported features.

FenceProducersResult

The result of Admin::fence_producers.

FinalizedVersionRange

Represents a range of version levels supported by every broker in a cluster for some feature.

GroupListing

A listing of a group in the cluster.

KafkaAdminClient

The administrative client for Kafka.

ListConfigResourcesResult

The result of the Admin::list_config_resources call.

ListConsumerGroupOffsetsResult

The result of Admin::list_consumer_group_offsets_with_group_specs.

ListConsumerGroupOffsetsSpec

Specification of consumer group offsets to list using Admin::list_consumer_group_offsets_with_group_specs.

ListGroupsResult

The result of Admin::list_groups.

ListPartitionReassignmentsResult

The result of Admin::list_partition_reassignments.

ListTopicsResult

The result of Admin::list_topics.

ListTransactionsResult

The result of Admin::list_transactions.

LogDirDescription

A description of a log directory on a particular broker.

MemberAssignment

A description of the assignments of a specific group member.

MemberDescription

A detailed description of a single group member in the cluster.

MemberToRemove

A struct containing information about the member to be removed.

MockAdminClient

An in-memory Admin implementation for tests.

NewPartitionReassignment

A new partition reassignment, which can be applied via Admin::alter_partition_reassignments.

NewPartitions

Describes new partitions for a particular topic in a call to Admin::create_partitions.

NewTopic

A new topic to be created via Admin::create_topics.

PartitionReassignment

A partition reassignment, which has been listed via Admin::list_partition_reassignments.

ProducerState

The state of an active producer for a partition.

RecordsToDelete

Describe records to delete in a call to Admin::delete_records.

RemoveMembersFromConsumerGroupResult

The result of Admin::remove_members_from_consumer_group.

RenewDelegationTokenResult

The result of the Admin::renew_delegation_token call.

ReplicaInfo

A description of a replica on a particular broker.

ScramCredentialInfo

Mechanism and iterations for a SASL/SCRAM credential associated with a user.

SupportedVersionRange

Represents a range of versions that a particular broker supports for some feature.

TerminateTransactionResult

The result of Admin::force_terminate_transaction.

TopicDescription

A detailed description of a single topic in the cluster.

TopicListing

A listing of a topic in the cluster.

TransactionDescription

The description of a transaction.

TransactionListing

A transaction listing.

UpdateFeaturesResult

The result of the update_features_with_options call.

UserScramCredentialDeletion

A request to delete a SASL/SCRAM credential for a user.

UserScramCredentialUpsertion

A request to update/insert a SASL/SCRAM credential for a user.

UserScramCredentialsDescription

Representation of all SASL/SCRAM credentials associated with a user that can be retrieved.

Enums

AdminClient

The base class for in-built admin clients.

DeleteTopicsResult

The result of Admin::delete_topics.

DescribeTopicsResult

The result of Admin::describe_topics_with_topics.

OffsetSpec

Specifies the desired offsets when using Admin::list_offsets.

ScramMechanism

Representation of a SASL/SCRAM Mechanism.

TransactionState

The state of a transaction.

UserScramCredentialAlteration

A request to alter a user’s SASL/SCRAM credentials.

Traits

Admin

The administrative client for Kafka, which supports managing and inspecting topics, brokers, configurations and records.

Type Aliases

GroupOffsets

A map of topic partitions to their committed offset and metadata. A None value indicates the group has no committed offset for that partition (Java’s null value in the map).