Expand description
Kafka administration API.
Structs§
- AclBinding
- One concrete Kafka ACL binding.
- AclFilter
- Filter used by Kafka ACL describe and delete operations.
- Admin
Client - Kafka administration client.
- Alter
Client Quota Entry Result - Per-entity result returned by
AdminClient::alter_client_quotas. - Alter
Client Quotas Result - Result returned by
AdminClient::alter_client_quotas. - Alter
Config Resource Result - Outcome for one resource in a classic or incremental AlterConfigs operation.
- Alter
Configs Options - Options shared by classic and incremental AlterConfigs operations.
- Alter
Configs Result - Complete response from one classic or incremental AlterConfigs operation.
- Alter
Consumer Group Offsets Partition Result - One OffsetCommit partition outcome.
- Alter
Consumer Group Offsets Result - Complete response from one administrative OffsetCommit v2 operation.
- Alter
Consumer Group Offsets Topic Result - OffsetCommit results for one topic.
- Alter
Partition Reassignment Result - Per-partition outcome returned by AlterPartitionReassignments.
- Alter
Partition Reassignment Topic Result - Per-topic outcomes returned by AlterPartitionReassignments.
- Alter
Partition Reassignments Result - Result returned by
AdminClient::alter_partition_reassignments. - Alter
Scram Credential Result - Per-user outcome returned by AlterUserScramCredentials.
- Alter
User Scram Credentials Result - Result returned by
AdminClient::alter_user_scram_credentials. - Broker
Description - Broker metadata returned by
AdminClient::describe_cluster. - Client
Quota Alteration - One compound client quota alteration.
- Client
Quota Entity - A compound Kafka client quota entity.
- Client
Quota Entity Component - One typed entity component in a client quota entity.
- Client
Quota Entry - One entity and its quota values.
- Client
Quota Filter - Filter used by
AdminClient::describe_client_quotas. - Client
Quota Filter Component - One component in a client quota describe filter.
- Client
Quota Operation - One client quota value alteration.
- Client
Quota Value - One quota key/value returned by Kafka.
- Cluster
Description - Kafka cluster metadata returned by
AdminClient::describe_cluster. - Config
Alter Operation - One operation in an incremental Kafka configuration update.
- Config
Entry - One Kafka configuration entry.
- Config
Resource Result - Configuration result for one Kafka resource.
- Config
Synonym - One synonym contributing to a Kafka configuration value.
- Consumer
Group Description - Description of one Kafka consumer group.
- Consumer
Group Member - One member in a Kafka consumer group description.
- Consumer
Group Offset - One committed consumer-group offset to set administratively.
- Consumer
Group Offset Delete - Topic partitions whose committed offsets should be deleted for a group.
- Consumer
Group Offset Partition Result - One OffsetFetch partition outcome.
- Consumer
Group Offset Query - A topic and partition filter for consumer-group offset inspection.
- Consumer
Group Offset Topic Result - OffsetFetch results for one topic.
- Create
Acls Entry Result - Per-binding result returned by
AdminClient::create_acls. - Create
Acls Result - Result returned by
AdminClient::create_acls. - Create
Partitions Options - Options for one CreatePartitions operation.
- Create
Partitions Result - Complete response from one CreatePartitions operation.
- Create
Partitions Topic Result - Outcome for one topic in a CreatePartitions response.
- Create
Topic Result - Outcome for one topic in a CreateTopics response.
- Create
Topics Options - Options for one CreateTopics operation.
- Create
Topics Result - Complete response from one CreateTopics operation.
- Delete
Acls Filter Result - Per-filter result returned by
AdminClient::delete_acls. - Delete
Acls Result - Result returned by
AdminClient::delete_acls. - Delete
Consumer Group Offsets Partition Result - Offset-deletion outcome for one topic partition.
- Delete
Consumer Group Offsets Result - Complete response from one OffsetDelete operation.
- Delete
Consumer Group Offsets Topic Result - Offset-deletion outcomes for one topic.
- Delete
Consumer Group Result - Outcome for one group in
AdminClient::delete_consumer_groups. - Delete
Records Options - Options for one DeleteRecords operation.
- Delete
Records Partition - Partition offset target for one DeleteRecords operation.
- Delete
Records Partition Result - Outcome for one partition in a DeleteRecords response.
- Delete
Records Result - Complete response from one DeleteRecords operation.
- Delete
Records Topic - Topic and partition targets for one DeleteRecords operation.
- Delete
Records Topic Result - Outcome for one topic in a DeleteRecords response.
- Delete
Topic Result - Outcome for one topic in a DeleteTopics response.
- Delete
Topics Options - Options for one DeleteTopics operation.
- Delete
Topics Result - Complete response from one DeleteTopics operation.
- Deleted
AclResult - Per-ACL deletion result nested under a delete filter result.
- Describe
Acls Result - Result returned by
AdminClient::describe_acls. - Describe
Client Quotas Result - Result returned by
AdminClient::describe_client_quotas. - Describe
Configs Options - Options for one DescribeConfigs operation.
- Describe
Configs Result - Complete response from one DescribeConfigs operation.
- Describe
Producers Active Producer - Active producer sequence state returned by Kafka.
- Describe
Producers Partition Result - Producer state for one partition in a DescribeProducers response.
- Describe
Producers Result - Complete response from one DescribeProducers operation.
- Describe
Producers Topic - Topic and partition targets for one DescribeProducers operation.
- Describe
Producers Topic Result - Outcome for one topic in a DescribeProducers response.
- Describe
Transactions Result - Complete response from one DescribeTransactions operation.
- Describe
User Scram Credentials Result - Result returned by
AdminClient::describe_user_scram_credentials. - Group
Listing - One Kafka group returned by
AdminClient::list_groups. - List
Consumer Group Offsets Result - Complete response from one OffsetFetch v2 consumer-group offset query.
- List
Partition Reassignments Result - Result returned by
AdminClient::list_partition_reassignments. - List
Transactions Options - Filters for
AdminClient::list_transactions. - List
Transactions Result - Complete response aggregated from all ListTransactions broker shards.
- Listed
Transaction - One active transaction returned by ListTransactions.
- NewPartitions
- New total partition count for an existing Kafka topic.
- NewTopic
- Definition of one Kafka topic to create.
- Ongoing
Partition Reassignment - An ongoing reassignment returned by ListPartitionReassignments.
- Ongoing
Partition Reassignment Topic - Ongoing reassignments for one topic.
- Partition
Reassignment - A topic and partition set submitted to AlterPartitionReassignments.
- Partition
Reassignment Options - Options shared by partition reassignment start and status requests.
- Partition
Reassignment Partition - One partition target in a
PartitionReassignment. - Partition
Reassignment Query - A topic and optional partition filter for ListPartitionReassignments.
- Scram
Credential Deletion - A SCRAM credential deletion request.
- Scram
Credential Info - One SCRAM mechanism and iteration count returned for a Kafka user.
- Scram
Credential Upsertion - A SCRAM credential upsertion request.
- Scram
User Credentials - Credentials and per-user outcome returned by DescribeUserScramCredentials.
- Topic
Config Alteration - Incremental configuration changes for one Kafka topic.
- Topic
Config Resource - One Kafka topic whose configuration should be described.
- Topic
Config Update - Complete dynamic topic configuration values for one topic in classic AlterConfigs.
- Topic
Config Update Entry - One configuration entry in a classic
TopicConfigUpdate. - Topic
Listing - One topic returned by
AdminClient::list_topics. - Transaction
Description - State of one transactional ID returned by Kafka.
- Transaction
Description Topic - Topic partitions currently associated with one transaction.
Enums§
- AclOperation
- Kafka ACL operation.
- AclPattern
Type - Kafka ACL resource pattern type.
- AclPermission
Type - Kafka ACL permission type.
- AclResource
Type - Kafka ACL resource type.
- Client
Quota Match Type - How a client quota filter matches an entity name.
- Config
Alter Operation Kind - Kafka IncrementalAlterConfigs operation kind.
- Config
Source - Kafka configuration source classification.
- Scram
Credential Mechanism - SCRAM mechanism identifiers accepted by Kafka’s credential administration APIs.