Expand description
Experimental, runtime-neutral Rust client for Apache Kafka.
The facade exposes bounded producer, consumer, transaction, security, and administrative operations over the deterministic client engine. Version 0.0.1 is a source preview for API evaluation, not a production-readiness or broker-compatibility claim.
KAFKA is a registered trademark of The Apache Software Foundation and has been licensed for use by kafkars. kafkars has no affiliation with and is not endorsed by The Apache Software Foundation.
Structs§
- Abort
Partition Transaction - Sole terminal observer for one submitted partition-transaction abort.
- Abort
Transaction - Sole terminal observer for one accepted transaction abort.
- Abort
Transaction Builder - Inert request to abort one transaction on one Kafka partition.
- Abort
Transaction Spec - Exact producer and coordinator identity for one partition transaction abort.
- Access
Control Entry - One concrete access-control decision.
- AclBinding
- One complete ACL binding suitable for creation or exact result values.
- AclBinding
Filter - One wire-free ACL filter preserving Kafka’s nullable string selectors.
- AclOperation
- Kafka operation controlled by an ACL entry or selected by a filter.
- AclPattern
Type - Kafka resource-pattern type used by ACL bindings and filters.
- AclPermission
Type - Kafka ACL permission decision or filter selector.
- AclResource
Type - Kafka resource type used by ACL bindings and filters.
- AddRaft
Voter - Sole terminal observer for one submitted metadata-quorum voter addition.
- AddRaft
Voter Builder - Inert request to add one identified voter and its advertised endpoints.
- AddRaft
Voter Result - Successful addition of one Kafka metadata-quorum voter.
- Admin
- Cheaply cloneable, thread-safe admin handle.
- Alter
Client Quotas - Sole terminal observer for one submitted client-quota alteration.
- Alter
Client Quotas Builder - Inert caller-ordered client-quota alteration request.
- Alter
Client Quotas Result - Fully settled client-quota entity alterations in original request order.
- Alter
Consumer Group Offsets - Sole terminal observer for one submitted consumer-group offset alteration.
- Alter
Consumer Group Offsets Builder - Inert caller-ordered committed-offset alteration for one consumer group.
- Alter
Consumer Group Offsets Result - Successful deterministic consumer-group offset alteration.
- Alter
Partition Reassignments - Sole terminal observer for one submitted reassignment alteration.
- Alter
Partition Reassignments Builder - Inert caller-ordered partition-reassignment alteration.
- Alter
Partition Reassignments Result - Successful deterministic partition-reassignment alteration.
- Alter
Replica LogDirs - Sole terminal observer for one submitted replica log-directory alteration.
- Alter
Replica LogDirs Builder - Inert caller-ordered replica-to-directory assignments.
- Alter
Replica LogDirs Result - Fully settled replica log-directory assignments.
- Alter
Share Group Offsets - Sole terminal observer for one submitted
ShareGroupoffset alteration. - Alter
Share Group Offsets Builder - Inert caller-ordered partition-offset alteration for one
ShareGroup. - Alter
Share Group Offsets Result - Completed
ShareGroupoffset alteration with ordered per-partition outcomes. - Alter
Streams Group Offsets - Sole terminal observer for one submitted
StreamsGroupoffset alteration. - Alter
Streams Group Offsets Builder - Typed
StreamsGroupview of the existing caller-ordered offset alteration. - Alter
Streams Group Offsets Result - Successful
StreamsGroupoffset alteration in original caller order. - Alter
User Scram Credentials - Sole terminal observer for one submitted SCRAM credential alteration.
- Alter
User Scram Credentials Builder - Inert caller-ordered SCRAM credential alteration request.
- Alter
User Scram Credentials Result - Fully settled per-user SCRAM credential alterations.
- Assigned
Consumer - Consumer whose positions are controlled directly rather than by a group.
- Assigned
Consumer Build Error - Failure to claim one client’s directly assigned consumer.
- Assigned
Consumer Builder - Builder for a consumer with direct partition ownership.
- Assigned
Consumer Fetch Fence - Exact named identity of one failed Fetch execution.
- Assigned
Consumer Position Fence - Exact named assignment and position generation for one failure event.
- Batch
Result - Deterministically ordered per-resource outcomes for one admin operation.
- Call
Metrics - Cumulative broker-call admission, completion, and delivery totals.
- Checkpoint
- Linear next-offset checkpoint for one processed group-consumer batch.
- Checkpoint
Builder - Ordered processed-prefix checkpoint tied to one exact consumer batch.
- Checkpoint
Mark Error - Rejected partial-checkpoint advancement without progress mutation.
- Classic
Consumer Group Details - Classic selected-protocol facts.
- Classic
Consumer Group Member Details - Classic raw member metadata and assignment.
- Classic
Group Config - Session, rebalance, Heartbeat, and retry timing for classic membership.
- Classic
Group Description - Successful description of one classic group.
- Classic
Group Member - One member of a classic group.
- Client
- Cheaply cloneable cluster-scoped client handle.
- Client
Builder - Builder for one shared cluster, security, and execution context.
- Client
Quota Alteration - One client-quota entity and its caller-ordered nonempty operation set.
- Client
Quota Entity - One client-quota entity identified by canonical entity-type components.
- Client
Quota Entity Component - One entity-type component in a returned client-quota entity.
- Client
Quota Entry - One canonical client-quota entity and all its quota values.
- Client
Quota Filter Component - One bounded entity-type component of a client-quota filter.
- Client
Quota Value - One finite quota configuration value returned by Kafka.
- Close
Assigned Consumer - Sole terminal observer for one assigned-consumer close.
- Close
Consumer - Runtime-neutral terminal observer for one accepted group-consumer close.
- Close
Producer - Atomic first-success producer fence and drain barrier.
- Cluster
Broker - One broker endpoint reported by Kafka.
- Cluster
Description - One bounded broker-endpoint cluster description.
- Commit
Consumer Checkpoint - Sole terminal observer for one accepted assignment-fenced offset commit.
- Commit
Transaction - Sole terminal observer for one accepted transaction commit.
- Config
Alteration - One named configuration change.
- Config
Entry - One Kafka configuration entry.
- Config
Resource - One canonical configuration-resource identity.
- Config
Resource Alterations - One exact configuration resource and its caller-ordered changes.
- Config
Resource Query - One configuration resource and its optional ordered key selection.
- Config
Resource Type - Kafka configuration-resource type code.
- Config
Synonym - One Kafka configuration synonym.
- Consumer
- Unique classic-group consumer with hosted membership and processing liveness.
- Consumer
Acknowledge Error - Rejected processing acknowledgment retaining the exact checkpoint.
- Consumer
Assignment - One confirmed assignment fence and its ordered topic-partitions.
- Consumer
Assignment Partition - One named topic-partition in a confirmed assignment.
- Consumer
Batch - Owned group-consumer batch whose record views borrow its retained storage.
- Consumer
Build Error - Failure to reserve one bounded classic-group registration.
- Consumer
Builder - Builder for one bounded group-consumer registration.
- Consumer
Close Admission Error - Pre-admission group close rejection retaining the exact consumer.
- Consumer
Commit Admission Error - Pre-admission group commit rejection retaining the exact checkpoint.
- Consumer
Commit Error - Accepted commit failure retaining the exact checkpoint when terminal observation permits retry.
- Consumer
Control - Thread-safe control operations that do not mutate subscription state.
- Consumer
Fetch Config - Broker long-poll and byte policy shared by assigned and group consumers.
- Consumer
Group Assignment - One current or target assignment canonicalized by topic identity.
- Consumer
Group Description - Successful description of one classic or KIP-848 consumer group.
- Consumer
Group Listing - One classic or modern consumer group visible across the cluster.
- Consumer
Group Member - One member with common identity and protocol-specific facts.
- Consumer
Group Member Removal - One caller-ordered static member selected by group-instance identity.
- Consumer
Group Offset - One broker-visible committed position and its optional Kafka metadata.
- Consumer
Group Offset Alteration - One caller-ordered topic-partition committed-offset alteration.
- Consumer
Group Topic Partitions - One topic and its assigned partitions.
- Consumer
Header - One Kafka header borrowing its key and nullable value from a record batch.
- Consumer
Limits - Independent limits for Fetch execution and retained delivery batches.
- Consumer
Protocol Group Details - KIP-848 group epoch and assignor facts.
- Consumer
Protocol Member Details - Typed KIP-848 member facts.
- Consumer
Record - One Kafka record borrowing all variable-length data from its batch.
- Consumer
Records - Records borrowing their bytes from one retained
super::RecordBatch. - Consumer
Revocation - Event-owned, assignment-fenced graceful-revocation lease.
- Create
AclBroker Error - Exact Kafka rejection for one requested ACL binding.
- Create
AclOutcome - One requested ACL binding and its exact corresponding Kafka result.
- Create
Acls - Sole terminal observer for one submitted ACL creation batch.
- Create
Acls Builder - Inert caller-ordered batch of concrete ACL bindings.
- Create
Acls Result - Fully settled caller-ordered ACL creation results.
- Create
Delegation Token - Sole terminal observer for one submitted delegation-token creation.
- Create
Delegation Token Builder - Inert request for one broker-created delegation token.
- Create
Delegation Token Result - Fully settled result for one created delegation token.
- Create
Partitions - Sole terminal observer for one submitted
CreatePartitionsbatch. - Create
Partitions Builder - Inert automatic or explicit-placement partition-increase request.
- Create
Topics - Sole terminal observer for one submitted
CreateTopicsbatch. - Create
Topics Builder - Inert batched topic-creation request.
- Delegation
Token - One complete broker-created delegation token.
- Delegation
Token Hmac - Secret HMAC returned for one created delegation token.
- Delegation
Token Principal - One exact Kafka principal type and name.
- Delete
AclBroker Error - Exact broker-declared deletion failure with a nullable diagnostic.
- Delete
AclFilter Outcome - One original caller filter position and its exact corresponding result.
- Delete
AclMatch Outcome - One concrete matched binding and its exact Kafka deletion result.
- Delete
Acls - Sole terminal observer for one submitted ACL deletion batch.
- Delete
Acls Builder - Inert caller-ordered batch of ACL deletion filters.
- Delete
Acls Result - Fully settled positional filter results with nested matched bindings.
- Delete
Consumer Group Offsets - Sole terminal observer for one submitted consumer-group offset deletion.
- Delete
Consumer Group Offsets Builder - Inert caller-ordered committed-offset deletion for one consumer group.
- Delete
Consumer Group Offsets Result - Successful deterministic consumer-group offset deletion.
- Delete
Consumer Groups - Sole terminal observer for one submitted Admin
DeleteConsumerGroupsquery. - Delete
Consumer Groups Builder - Inert caller-ordered Admin
DeleteConsumerGroupsrequest. - Delete
Consumer Groups Result - Completed Admin
DeleteConsumerGroupsoperation with ordered per-group outcomes. - Delete
Records - Sole terminal observer for one submitted Admin
DeleteRecordsquery. - Delete
Records Builder - Inert caller-ordered Admin
DeleteRecordsrequest. - Delete
Records Result - Completed Admin
DeleteRecordsoperation with ordered per-target outcomes. - Delete
Records Result Info - Kafka’s successful record-deletion result.
- Delete
Records Target - One topic-partition paired with its offset-selection policy.
- Delete
Share Group Offsets - Sole terminal observer for one submitted
ShareGroupoffset deletion. - Delete
Share Group Offsets Builder - Inert caller-ordered topic offset deletion for one
ShareGroup. - Delete
Share Group Offsets Result - Completed
ShareGroupoffset deletion with ordered per-topic outcomes. - Delete
Share Groups - Sole terminal observer for one submitted share-group deletion.
- Delete
Share Groups Builder - Inert caller-ordered deletion for share groups.
- Delete
Share Groups Result - Completed share-group deletion with caller-ordered per-group outcomes.
- Delete
Streams Group Offsets - Sole terminal observer for one submitted Streams-group offset deletion.
- Delete
Streams Group Offsets Builder - Inert caller-ordered committed-offset deletion for one Streams group.
- Delete
Streams Group Offsets Result - Completed Streams-group offset deletion with original caller ordering.
- Delete
Streams Groups - Sole terminal observer for one submitted streams-group deletion.
- Delete
Streams Groups Builder - Inert caller-ordered deletion for streams groups.
- Delete
Streams Groups Result - Completed streams-group deletion with caller-ordered per-group outcomes.
- Delete
Topics - Sole terminal observer for one submitted
DeleteTopicsbatch. - Delete
Topics Builder - Inert batched topic-deletion request.
- Delete
Topics ById - Sole terminal observer for one submitted topic-ID deletion batch.
- Delete
Topics ById Builder - Inert caller-ordered topic-ID deletion request.
- Delivery
- Sole terminal observer for one record accepted by
Producer::try_send. - Describe
Acls - Sole terminal observer for one submitted ACL description.
- Describe
Acls Builder - Inert query for ACL bindings selected by one exact filter.
- Describe
Acls Result - Fully settled ACL bindings selected by one filter.
- Describe
Classic Groups - Sole terminal observer for one submitted classic-group description batch.
- Describe
Classic Groups Builder - Inert classic-group description request.
- Describe
Classic Groups Result - Successful deterministic
DescribeClassicGroupsoperation. - Describe
Client Quotas - Sole terminal observer for one submitted client-quota description.
- Describe
Client Quotas Builder - Inert client-quota query.
- Describe
Client Quotas Result - Fully settled client quotas selected by one filter.
- Describe
Cluster - Sole terminal observer for one submitted
DescribeClustercall. - Describe
Cluster Builder - Inert broker-endpoint cluster-description request.
- Describe
Config Resources - Sole terminal observer for one submitted configuration-resource batch.
- Describe
Config Resources Builder - Inert ordered configuration-resource request.
- Describe
Config Resources Result - Successful generic configuration batch in original request order.
- Describe
Configs - Sole terminal observer for one submitted topic-configuration batch.
- Describe
Configs Builder - Inert ordered topic-configuration request.
- Describe
Configs Result - Successful topic-configuration batch in original request order.
- Describe
Consumer Groups - Sole terminal observer for one submitted group-description batch.
- Describe
Consumer Groups Builder - Inert consumer-group description request.
- Describe
Consumer Groups Result - Successful deterministic
DescribeConsumerGroupsoperation. - Describe
Delegation Tokens - Sole terminal observer for one submitted delegation-token description.
- Describe
Delegation Tokens Builder - Inert query for delegation tokens visible to the authenticated principal.
- Describe
Delegation Tokens Result - Fully settled token descriptions with unique secret ownership.
- Describe
Features - Sole terminal observer for one submitted Kafka feature discovery.
- Describe
Features Builder - Inert request to discover supported and finalized Kafka features.
- Describe
Features Result - One bounded canonical Kafka feature metadata snapshot.
- Describe
LogDirs - Sole terminal observer for one submitted log-directory description.
- Describe
LogDirs Builder - Inert request for log directories on selected brokers.
- Describe
LogDirs Result - Fully settled descriptions for the selected brokers.
- Describe
Metadata Quorum - Sole terminal observer for one submitted metadata-quorum description.
- Describe
Metadata Quorum Builder - Inert request to describe Kafka’s fixed metadata quorum.
- Describe
Producers - Sole terminal observer for one submitted Admin
DescribeProducersquery. - Describe
Producers Builder - Inert caller-ordered Admin
DescribeProducersrequest. - Describe
Producers Result - Completed producer descriptions with maximum throttle observation.
- Describe
Replica LogDirs - Sole terminal observer for one selected-replica description.
- Describe
Replica LogDirs Builder - Inert request for log-directory placements of selected replicas.
- Describe
Replica LogDirs Result - Fully settled log-directory descriptions for selected replicas.
- Describe
Share Group - Sole terminal observer for one submitted
ShareGroupdescription. - Describe
Share Group Builder - Inert typed description request for one modern
ShareGroup. - Describe
Share Group Result - Completed
ShareGroupdescription plus Kafka’s throttle observation. - Describe
Share Groups - A submitted multi-group
ShareGroupdescription operation. - Describe
Share Groups Builder - Configures and submits a caller-ordered batch of
ShareGroupdescriptions. - Describe
Share Groups Result - The completed response for a caller-ordered
ShareGroupdescription batch. - Describe
Streams Group - Sole terminal observer for one submitted
StreamsGroupdescription. - Describe
Streams Group Builder - Inert typed description request for one modern
StreamsGroup. - Describe
Streams Group Result - Completed
StreamsGroupdescription plus Kafka’s throttle observation. - Describe
Streams Groups - A submitted multi-group
StreamsGroupdescription operation. - Describe
Streams Groups Builder - Configures and submits a caller-ordered batch of
StreamsGroupdescriptions. - Describe
Streams Groups Result - The completed response for a caller-ordered
StreamsGroupdescription batch. - Describe
Topic Partition - One partition description returned within an explicit response page.
- Describe
Topic Partitions - Sole terminal observer for one submitted topic-partition page.
- Describe
Topic Partitions Builder - Inert caller-ordered request for one topic-partition page.
- Describe
Topic Partitions Cursor - First topic and partition eligible for one page request.
- Describe
Topic Partitions Page - One completed page; its next cursor never starts hidden work.
- Describe
Topic Partitions Topic - One requested topic and the partition subset carried by this page.
- Describe
Topics - Sole terminal observer for one submitted
DescribeTopicsbatch. - Describe
Topics Builder - Inert batched topic-description request.
- Describe
Topics ById - Sole terminal observer for one submitted topic-ID batch.
- Describe
Topics ById Builder - Inert caller-ordered topic-ID description request.
- Describe
Transactions - Sole terminal observer for one submitted Admin
DescribeTransactionsquery. - Describe
Transactions Builder - Inert caller-ordered Admin
DescribeTransactionsrequest. - Describe
Transactions Result - Completed transaction descriptions with maximum throttle observation.
- Describe
User Scram Credentials - Sole terminal observer for one submitted SCRAM credential description.
- Describe
User Scram Credentials Builder - Inert query for users’ SCRAM credential metadata.
- Describe
User Scram Credentials Result - Fully settled per-user SCRAM credential descriptions.
- Elect
Leaders - Sole terminal observer for one submitted leader election.
- Elect
Leaders Builder - Inert selected-partition or cluster-wide leader election.
- Elect
Leaders Result - Successful deterministic leader-election alteration.
- Expire
Delegation Token - Sole terminal observer for one submitted delegation-token expiration.
- Expire
Delegation Token Builder - Inert request to expire one delegation token.
- Expire
Delegation Token Result - Kafka throttle and the expired token’s absolute expiry timestamp.
- Failure
Metrics - Cumulative classified terminal broker-call failures.
- Feature
Update - One inert finalized-feature target in caller order.
- Fence
Producers - Sole runtime-neutral observer for one submitted producer-fencing batch.
- Fence
Producers Builder - Inert caller-ordered transactional producer-fencing request.
- Fence
Producers Result - Caller-ordered fencing outcomes with the maximum observed broker throttle.
- Fenced
Producer Identity - Exact broker producer identity returned after fencing a transactional ID.
- Finalized
Feature - One cluster-wide finalized Kafka feature range.
- Flush
- Barrier over records accepted before
Producer::flushwas called. - Force
Terminate Transaction - Sole runtime-neutral observer for one force-terminated transaction.
- Force
Terminate Transaction Builder - Inert request to force-terminate one transaction by transactional ID.
- Group
Consumer Header - One Kafka header borrowing its key and nullable value from a consumer batch.
- Group
Consumer Operation Config - End-to-end operation durations inherited by one hosted group consumer.
- Group
Consumer Record - One Kafka record borrowing all variable-length data from a consumer batch.
- Group
Consumer Records - Records borrowing their bytes from one retained
super::ConsumerBatch. - Group
Listing - One Kafka group visible across the cluster.
- Group
Metadata - Stable identity of one current, confirmed group membership.
- Header
- One Kafka record header.
- Incremental
Alter Config Resources - Sole observer for one submitted configuration-resource alteration batch.
- Incremental
Alter Config Resources Builder - Inert ordered configuration-resource alteration request.
- Incremental
Alter Config Resources Result - Successful generic alteration batch in original request order.
- Incremental
Alter Configs - Sole terminal observer for one submitted topic configuration alteration batch.
- Incremental
Alter Configs Builder - Inert ordered topic configuration alteration request.
- Incremental
Alter Configs Result - Successful topic alteration batch in original request order.
- Initialize
Transactional Producer - Sole terminal observer for one submitted transactional-owner initialization.
- Kafka
Error - Extensible client error shared by producer, consumer, admin, and transactions.
- Latency
Metric - Count, saturating total, and maximum for one latency stage.
- Latency
Metrics - Cumulative monotonic duration summaries for broker-call stages.
- Leader
Election Target - One caller-ordered topic-partition selected for leader election.
- Legacy
Config Resource Replacement - One resource and its complete caller-ordered legacy configuration snapshot.
- Legacy
Replace Config Resources - Sole terminal observer for one submitted generic replacement batch.
- Legacy
Replace Config Resources Builder - Inert ordered request to replace complete configuration-resource snapshots.
- Legacy
Replace Config Resources Result - Successful generic replacement batch in original request order.
- Legacy
Replace Topic Configs - Sole terminal observer for one submitted destructive legacy replacement batch.
- Legacy
Replace Topic Configs Builder - Inert ordered request to replace complete legacy topic configuration snapshots.
- Legacy
Replace Topic Configs Result - Successful legacy replacement batch in original request order.
- Legacy
Topic Config Entry - One configuration key and its exact value in a legacy topic snapshot.
- Legacy
Topic Config Replacement - One topic and its complete caller-ordered legacy configuration snapshot.
- List
Client Metrics Resources - Sole terminal observer for one submitted client-metrics resource listing.
- List
Client Metrics Resources Builder - Inert request to list Kafka client-metrics configuration resources.
- List
Client Metrics Resources Result - Bounded client-metrics resource names returned by one Kafka broker.
- List
Config Resources - Sole terminal observer for one submitted configuration-resource listing.
- List
Config Resources Builder - Inert request to list Kafka configuration-resource identities.
- List
Config Resources Result - Bounded canonical configuration-resource identities returned by Kafka.
- List
Consumer Group Offsets - Sole terminal observer for one submitted consumer-group offset query.
- List
Consumer Group Offsets Builder - Inert query for every broker-visible committed offset in one group.
- List
Consumer Group Offsets Query - One consumer-group identity and either all or selected topic-partitions.
- List
Consumer Group Offsets Result - Successful deterministic consumer-group offset listing.
- List
Consumer Groups - Sole terminal observer for one submitted cluster-wide listing.
- List
Consumer Groups Broker Error - Exact top-level
ListGroupsrejection from one discovered broker. - List
Consumer Groups Builder - Inert cluster-wide consumer-group listing request with optional state and group-type filters.
- List
Consumer Groups Offsets - Sole terminal observer for one submitted multi-group offset query.
- List
Consumer Groups Offsets Builder - Inert caller-ordered all-partition queries for multiple consumer groups.
- List
Consumer Groups Offsets Result - Caller-ordered consumer-group offset outcomes from one accepted operation.
- List
Consumer Groups Result - Fully settled cluster-wide listing with partial broker errors preserved.
- List
Groups - Sole terminal observer for one submitted all-group listing.
- List
Groups Broker Error - Exact top-level
ListGroupsrejection from one discovered broker. - List
Groups Builder - Inert cluster-wide listing request with optional state, group-type, and protocol-type filters.
- List
Groups Result - Stable all-group listings with partial broker errors preserved.
- List
Offsets - Sole terminal observer for one submitted Admin
ListOffsetsquery. - List
Offsets Builder - Inert caller-ordered Admin
ListOffsetsrequest. - List
Offsets Query - One topic-partition paired with its offset-selection policy.
- List
Offsets Result - Successful deterministic Admin
ListOffsetsoperation. - List
Offsets Result Info - Kafka’s successful offset-selection result.
- List
Partition Reassignments - Sole terminal observer for one submitted reassignment query.
- List
Partition Reassignments Builder - Inert query for explicitly selected or all active partition reassignments.
- List
Partition Reassignments Result - Successful active reassignment listing.
- List
Share Group Offsets - Sole terminal observer for one submitted
ShareGroupoffset listing. - List
Share Group Offsets Builder - Inert all-partition or caller-selected offset query for one
ShareGroup. - List
Share Group Offsets Query - One
ShareGroupidentity and either all or selected topic-partitions. - List
Share Group Offsets Result - Completed
ShareGroupoffset listing with deterministic per-partition outcomes. - List
Share Groups Offsets - Sole terminal observer for one accepted multi-ShareGroup offset query.
- List
Share Groups Offsets Builder - Inert caller-ordered offset queries for multiple
ShareGroups. - List
Share Groups Offsets Result - Caller-ordered
ShareGroupoffset outcomes from one accepted operation. - List
Streams Group Offsets - Sole terminal observer for one submitted Streams-group offset query.
- List
Streams Group Offsets Builder - Typed inert query for every broker-visible committed offset in one Streams group.
- List
Streams Group Offsets Query - One Streams-group identity and either all or selected topic-partitions.
- List
Streams Group Offsets Result - Successful deterministic Streams-group offset listing.
- List
Streams Groups Offsets - Sole observer for one accepted multi-Streams-group offset query.
- List
Streams Groups Offsets Builder - Typed inert query for multiple Streams group identities.
- List
Streams Groups Offsets Result - Caller-ordered Streams-group offset outcomes from one accepted operation.
- List
Topics - Sole terminal observer for one submitted all-topic query.
- List
Topics Builder - Inert query for topic descriptions visible to the authenticated principal.
- List
Transactions - Sole terminal observer for one submitted cluster-wide transaction listing.
- List
Transactions Broker Error - Exact top-level
ListTransactionsrejection from one broker. - List
Transactions Builder - Inert cluster-wide transaction-listing request.
- List
Transactions Result - Fully settled cluster-wide listing with partial broker errors preserved.
- LogDir
Description - One successful log-directory description.
- LogDir
Replica - One current or future replica log without generated wire or engine values.
- Mailbox
Metrics - Current bounded driver mailbox pressure and cumulative rejection totals.
- Metadata
Quorum Description - Successful bounded description of Kafka’s fixed metadata quorum.
- Metadata
Quorum Listener - One named listener endpoint advertised by a quorum node.
- Metadata
Quorum Node - One quorum node and its canonically ordered listeners.
- Metadata
Quorum Replica - One voter or observer in the fixed metadata quorum.
- Metrics
- Sole observer for one accepted operational snapshot with staged capture points.
- Metrics
Snapshot - One bounded client snapshot with explicit owner capture points.
- NewPartitions
- One topic and its requested new total partition count.
- NewTopic
- Topic creation request.
- Next
Assigned Event - Waits for one already-retained direct-consumer failure event.
- Next
Consumer Event - Waits for one retained classic-group assignment transition.
- Partition
Reassignment - One active reassignment without generated wire or engine values.
- Partition
Reassignment Change - One caller-ordered replica replacement or explicit cancellation.
- Producer
- Cheaply cloneable, thread-safe producer handle.
- Producer
Builder - Builder for a bounded, batch-native producer.
- Producer
Config - Complete configurable policy for the client’s shared producer owner.
- Producer
Limits - Independent bounds for active records, waiting callers, and batching.
- Producer
Metrics - Producer ownership captured synchronously at
Client::metricsadmission. - Producer
Retry Config - Maximum replacement attempts and fixed delay for safe producer retries.
- Producer
State - One normalized active producer state for a Kafka partition.
- Raft
Voter Endpoint - One named network endpoint through which the quorum can contact a voter.
- Raft
Voter Identity - One Kafka metadata-quorum voter and its storage-directory identity.
- Ready
- Sole observer for one point-in-time client readiness probe.
- Record
- Owned, bytes-native record submitted to a producer.
- Record
Batch - Owned batch whose borrowed records remain valid until this value is dropped.
- Record
Metadata - Metadata for one acknowledged record.
- Recv
Assigned Batch - Waits for one already-authorized direct-consumer delivery.
- Recv
Consumer Batch - Waits for one already-authorized classic-group delivery.
- Remove
Consumer Group Members - Sole terminal observer for one submitted static-member removal.
- Remove
Consumer Group Members Builder - Inert caller-ordered selected static-member removal.
- Remove
Consumer Group Members Result - Successful deterministic consumer-group member removal.
- Remove
Raft Voter - Sole terminal observer for one submitted metadata-quorum voter removal.
- Remove
Raft Voter Builder - Inert request to remove one exactly identified metadata-quorum voter.
- Remove
Raft Voter Result - Successful removal of one Kafka metadata-quorum voter.
- Renew
Delegation Token - Sole terminal observer for one submitted delegation-token renewal.
- Renew
Delegation Token Builder - Inert request to renew one delegation token.
- Renew
Delegation Token Result - Kafka throttle and the renewed token’s absolute expiry timestamp.
- Replica
LogDir Assignment - Inert request to move one replica log to a broker-local directory path.
- Replica
LogDir Info - Kafka’s current and future log-directory placement for one replica.
- Replica
LogDir Location - One current or future broker log-directory placement.
- Resource
Pattern - One resource name interpreted using an exact Kafka pattern type.
- Sasl
- Broker credentials retained without exposing secret text in diagnostics.
- Scram
Credential Info - Non-secret facts about one SCRAM credential.
- Scram
Mechanism - Exact signed Kafka SCRAM mechanism code.
- Seek
- Waits for one assignment-fenced group position replacement.
- Send
- One producer call that waits within configured local bounds.
- Send
Batch - Runtime-neutral observer for all records accepted by one batch call.
- Send
Batch Result - Ordered terminal deliveries plus an optional exact unaccepted suffix.
- Send
Transaction Offsets - Sole terminal observer for one accepted transactional offset transfer.
- Send
Transaction Record - Sole terminal observer for one accepted transactional record send.
- Share
Group Assignment - One member’s typed
ShareGroupassignment. - Share
Group Description - Successful typed description of one modern
ShareGroup. - Share
Group Member - One current
ShareGroupmember. - Share
Group Offset - One
ShareGrouppartition’s broker-visible offset state. - Share
Group Offset Alteration - One caller-ordered
ShareGrouppartition offset alteration. - Share
Group Topic Partitions - One topic and its assigned partitions.
- Shutdown
- Graceful clone-shared client shutdown.
- Streams
Group Assignment - One member’s active, standby, and warm-up task assignment.
- Streams
Group Description - Successful typed description of one modern
StreamsGroup. - Streams
Group Endpoint - One user-defined endpoint for Kafka Streams interactive queries.
- Streams
Group KeyValue - One string key-value fact reported for a
StreamsGroup. - Streams
Group Member - One current
StreamsGroupmember. - Streams
Group Subtopology - One initialized
StreamsGroupsubtopology. - Streams
Group Task Ids - Partitions belonging to tasks in one subtopology.
- Streams
Group Task Offset - One cumulative task offset.
- Streams
Group Topic Info - One internal topic described by a
StreamsGrouptopology. - Streams
Group Topology - The topology metadata currently initialized for a
StreamsGroup. - Streams
Group Topology Description - Full topology graph returned by Kafka’s topology-description plugin.
- Streams
Group Topology Description Status - Kafka’s topology-description availability status.
- Streams
Group Topology Description Subtopology - One subtopology in the optional full topology description.
- Streams
Group Topology Global Store - One global store’s source and processor nodes.
- Streams
Group Topology Node - One processing node in a full topology description.
- Streams
Group Topology Node Type - Kafka’s Streams topology node type.
- Supported
Feature - One broker-supported Kafka feature range.
- Tls
- TLS trust policy for Kafka broker connections.
- Topic
Config Alterations - One topic and its caller-ordered incremental configuration changes.
- Topic
Config Query - One topic and its optional ordered configuration-key selection.
- Topic
Description - One bounded topic description returned by Kafka.
- Topic
Partition - One Kafka topic-partition identity with an optional direct-assignment start.
- Topic
Partition Description - One bounded partition description returned by Kafka.
- Topic
Partition Replica - One topic-partition replica hosted by an explicit broker.
- Topic
Replica Assignment - One explicit partition-to-broker assignment for a newly created topic.
- Transaction
- Opaque active transaction that exclusively borrows its producer.
- Transaction
Description - Kafka’s bounded API 65 description of one transactional ID.
- Transaction
EndAdmission Error - Rejected commit or abort that returns the active transaction unchanged.
- Transaction
Listing - One transaction visible through a broker’s transaction coordinator state.
- Transaction
Offsets Admission Error - Definitely-unsent rejection retaining the exact metadata and checkpoint.
- Transaction
Send Admission Error - Rejected transactional send retaining the caller’s record.
- Transaction
Topic - One Kafka topic and its participating transaction partitions.
- Transactional
Producer - Uniquely controlled initialized transactional producer.
- Transactional
Producer Builder - Linear builder for one uniquely controlled transactional producer.
- Transactional
Producer Identity - Kafka’s broker-issued identity for one initialized transactional owner.
- TrySend
Error - Immediate producer-admission failure that returns caller ownership.
- Unregister
Broker - Sole terminal observer for one submitted broker unregistration.
- Unregister
Broker Builder - Inert request to unregister one nonnegative broker ID from Kafka’s metadata quorum.
- Unregister
Broker Result - Successful removal of one broker from Kafka’s metadata quorum.
- Update
Features - Sole terminal observer for one submitted finalized-feature update.
- Update
Features Builder - Inert caller-ordered finalized-feature update request.
- Update
Features Result - Fully settled finalized-feature updates in original request order.
Enums§
- Assigned
Consumer Event - One application-visible failure transferred from the bounded event FIFO.
- Assigned
Consumer Fetch Failure Kind - Stable reason one exact Fetch terminated.
- Assigned
Consumer Fetch Throttle Failure Kind - Stable reason the next Fetch could not be scheduled.
- Assigned
Consumer Position Resolution Failure Kind - Stable reason one position-resolution attempt terminated.
- Cancellation
Outcome - Immediate result of asking the engine to cancel one accepted delivery.
- Checkpoint
Mark Error Kind - Stable reason one record could not advance a partial checkpoint.
- Classic
Group Assignor - Classic consumer-group partition assignor selected for one consumer.
- Client
Quota Alteration Operation - One exact client-quota key operation.
- Client
Quota Match - How one client-quota entity type is selected.
- Compression
RecordBatchcompression selected for every producer owned by one client.- Config
Alteration Operation - Exact Kafka operation applied to one named configuration.
- Consumer
Event - One application-visible classic-group assignment transition.
- Consumer
Group Description Details - Protocol-specific facts for one described group.
- Consumer
Group Member Details - Protocol-specific facts for one described member.
- Consumer
Group Protocol - Kafka consumer-group membership protocol selected for one consumer.
- Create
AclResult - Exact Kafka result for one requested ACL binding.
- Delegation
Token Hmac Error - Local validation failure for reconstructed delegation-token HMAC bytes.
- Delete
AclFilter Result - Exact result at one caller filter position.
- Delete
AclMatch Result - Exact Kafka result for one concrete binding matched by a filter.
- Delivery
Status - Certainty attached to a failed network operation.
- Error
Kind - Stable top-level category for a client failure.
- Feature
Update Intent - Explicit direction and data-loss policy for one finalized-feature update.
- Group
Membership Epoch - Broker-issued fencing epoch for one current group membership.
- Leader
Election Type - Explicit leader-election policy.
- NewTopic
Placement - Replica-placement intent for one newly created topic.
- Offset
Reset - Policy used when a group has no committed position.
- Offset
Spec - One Kafka offset-selection policy.
- Read
Isolation - Whether a consumer may observe records from unresolved transactions.
- Retry
Advice - Stable guidance for an application considering a new operation after failure.
- Sasl
Mechanism - Stable SASL mechanism selection.
- Security
- One complete transport and authentication policy for the shared client.
- Start
Position - Initial position for one directly assigned topic-partition.
- User
Scram Credential Alteration - One deletion or upsert of a user’s SCRAM credential.