Skip to main content

ApiKey

Enum ApiKey 

Source
#[non_exhaustive]
#[repr(i16)]
pub enum ApiKey {
Show 90 variants Produce = 0, Fetch = 1, ListOffsets = 2, Metadata = 3, OffsetCommit = 8, OffsetFetch = 9, FindCoordinator = 10, JoinGroup = 11, Heartbeat = 12, LeaveGroup = 13, SyncGroup = 14, DescribeGroups = 15, ListGroups = 16, SaslHandshake = 17, ApiVersions = 18, CreateTopics = 19, DeleteTopics = 20, DeleteRecords = 21, InitProducerId = 22, OffsetForLeaderEpoch = 23, AddPartitionsToTxn = 24, AddOffsetsToTxn = 25, EndTxn = 26, WriteTxnMarkers = 27, TxnOffsetCommit = 28, DescribeAcls = 29, CreateAcls = 30, DeleteAcls = 31, DescribeConfigs = 32, AlterConfigs = 33, AlterReplicaLogDirs = 34, DescribeLogDirs = 35, SaslAuthenticate = 36, CreatePartitions = 37, CreateDelegationToken = 38, RenewDelegationToken = 39, ExpireDelegationToken = 40, DescribeDelegationToken = 41, DeleteGroups = 42, ElectLeaders = 43, IncrementalAlterConfigs = 44, AlterPartitionReassignments = 45, ListPartitionReassignments = 46, OffsetDelete = 47, DescribeClientQuotas = 48, AlterClientQuotas = 49, DescribeUserScramCredentials = 50, AlterUserScramCredentials = 51, Vote = 52, BeginQuorumEpoch = 53, EndQuorumEpoch = 54, DescribeQuorum = 55, AlterPartition = 56, UpdateFeatures = 57, Envelope = 58, FetchSnapshot = 59, DescribeCluster = 60, DescribeProducers = 61, BrokerRegistration = 62, BrokerHeartbeat = 63, UnregisterBroker = 64, DescribeTransactions = 65, ListTransactions = 66, AllocateProducerIds = 67, ConsumerGroupHeartbeat = 68, ConsumerGroupDescribe = 69, ControllerRegistration = 70, GetTelemetrySubscriptions = 71, PushTelemetry = 72, AssignReplicasToDirs = 73, ListConfigResources = 74, DescribeTopicPartitions = 75, ShareGroupHeartbeat = 76, ShareGroupDescribe = 77, ShareFetch = 78, ShareAcknowledge = 79, AddRaftVoter = 80, RemoveRaftVoter = 81, UpdateRaftVoter = 82, InitializeShareGroupState = 83, ReadShareGroupState = 84, WriteShareGroupState = 85, DeleteShareGroupState = 86, ReadShareGroupStateSummary = 87, StreamsGroupHeartbeat = 88, StreamsGroupDescribe = 89, DescribeShareGroupOffsets = 90, AlterShareGroupOffsets = 91, DeleteShareGroupOffsets = 92, GetReplicaLogInfo = 93,
}
Expand description

Kafka API key registry generated from the vendored schemas.

Each variant corresponds to a request/response pair defined in the schemas. Variants with validVersions = "none" are omitted (reserved keys with no currently-valid wire version).

The enum is #[non_exhaustive] so that adding variants for new Kafka API keys in future schema updates is non-breaking.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Produce = 0

ProduceRequest (versions 3–13).

§

Fetch = 1

FetchRequest (versions 4–18).

§

ListOffsets = 2

ListOffsetsRequest (versions 1–11).

§

Metadata = 3

MetadataRequest (versions 0–13).

§

OffsetCommit = 8

OffsetCommitRequest (versions 2–10).

§

OffsetFetch = 9

OffsetFetchRequest (versions 1–10).

§

FindCoordinator = 10

FindCoordinatorRequest (versions 0–6).

§

JoinGroup = 11

JoinGroupRequest (versions 0–9).

§

Heartbeat = 12

HeartbeatRequest (versions 0–4).

§

LeaveGroup = 13

LeaveGroupRequest (versions 0–5).

§

SyncGroup = 14

SyncGroupRequest (versions 0–5).

§

DescribeGroups = 15

DescribeGroupsRequest (versions 0–6).

§

ListGroups = 16

ListGroupsRequest (versions 0–5).

§

SaslHandshake = 17

SaslHandshakeRequest (versions 0–1).

§

ApiVersions = 18

ApiVersionsRequest (versions 0–4).

§

CreateTopics = 19

CreateTopicsRequest (versions 2–7).

§

DeleteTopics = 20

DeleteTopicsRequest (versions 1–6).

§

DeleteRecords = 21

DeleteRecordsRequest (versions 0–2).

§

InitProducerId = 22

InitProducerIdRequest (versions 0–6).

§

OffsetForLeaderEpoch = 23

OffsetForLeaderEpochRequest (versions 2–4).

§

AddPartitionsToTxn = 24

AddPartitionsToTxnRequest (versions 0–5).

§

AddOffsetsToTxn = 25

AddOffsetsToTxnRequest (versions 0–4).

§

EndTxn = 26

EndTxnRequest (versions 0–5).

§

WriteTxnMarkers = 27

WriteTxnMarkersRequest (versions 1–2).

§

TxnOffsetCommit = 28

TxnOffsetCommitRequest (versions 0–5).

§

DescribeAcls = 29

DescribeAclsRequest (versions 1–3).

§

CreateAcls = 30

CreateAclsRequest (versions 1–3).

§

DeleteAcls = 31

DeleteAclsRequest (versions 1–3).

§

DescribeConfigs = 32

DescribeConfigsRequest (versions 1–4).

§

AlterConfigs = 33

AlterConfigsRequest (versions 0–2).

§

AlterReplicaLogDirs = 34

AlterReplicaLogDirsRequest (versions 1–2).

§

DescribeLogDirs = 35

DescribeLogDirsRequest (versions 1–5).

§

SaslAuthenticate = 36

SaslAuthenticateRequest (versions 0–2).

§

CreatePartitions = 37

CreatePartitionsRequest (versions 0–3).

§

CreateDelegationToken = 38

CreateDelegationTokenRequest (versions 1–3).

§

RenewDelegationToken = 39

RenewDelegationTokenRequest (versions 1–2).

§

ExpireDelegationToken = 40

ExpireDelegationTokenRequest (versions 1–2).

§

DescribeDelegationToken = 41

DescribeDelegationTokenRequest (versions 1–3).

§

DeleteGroups = 42

DeleteGroupsRequest (versions 0–2).

§

ElectLeaders = 43

ElectLeadersRequest (versions 0–2).

§

IncrementalAlterConfigs = 44

IncrementalAlterConfigsRequest (versions 0–1).

§

AlterPartitionReassignments = 45

AlterPartitionReassignmentsRequest (versions 0–1).

§

ListPartitionReassignments = 46

ListPartitionReassignmentsRequest (versions 0–0).

§

OffsetDelete = 47

OffsetDeleteRequest (versions 0–0).

§

DescribeClientQuotas = 48

DescribeClientQuotasRequest (versions 0–1).

§

AlterClientQuotas = 49

AlterClientQuotasRequest (versions 0–1).

§

DescribeUserScramCredentials = 50

DescribeUserScramCredentialsRequest (versions 0–0).

§

AlterUserScramCredentials = 51

AlterUserScramCredentialsRequest (versions 0–0).

§

Vote = 52

VoteRequest (versions 0–2).

§

BeginQuorumEpoch = 53

BeginQuorumEpochRequest (versions 0–1).

§

EndQuorumEpoch = 54

EndQuorumEpochRequest (versions 0–1).

§

DescribeQuorum = 55

DescribeQuorumRequest (versions 0–2).

§

AlterPartition = 56

AlterPartitionRequest (versions 2–3).

§

UpdateFeatures = 57

UpdateFeaturesRequest (versions 0–2).

§

Envelope = 58

EnvelopeRequest (versions 0–0).

§

FetchSnapshot = 59

FetchSnapshotRequest (versions 0–1).

§

DescribeCluster = 60

DescribeClusterRequest (versions 0–2).

§

DescribeProducers = 61

DescribeProducersRequest (versions 0–0).

§

BrokerRegistration = 62

BrokerRegistrationRequest (versions 0–4).

§

BrokerHeartbeat = 63

BrokerHeartbeatRequest (versions 0–2).

§

UnregisterBroker = 64

UnregisterBrokerRequest (versions 0–0).

§

DescribeTransactions = 65

DescribeTransactionsRequest (versions 0–0).

§

ListTransactions = 66

ListTransactionsRequest (versions 0–2).

§

AllocateProducerIds = 67

AllocateProducerIdsRequest (versions 0–0).

§

ConsumerGroupHeartbeat = 68

ConsumerGroupHeartbeatRequest (versions 0–1).

§

ConsumerGroupDescribe = 69

ConsumerGroupDescribeRequest (versions 0–1).

§

ControllerRegistration = 70

ControllerRegistrationRequest (versions 0–0).

§

GetTelemetrySubscriptions = 71

GetTelemetrySubscriptionsRequest (versions 0–0).

§

PushTelemetry = 72

PushTelemetryRequest (versions 0–0).

§

AssignReplicasToDirs = 73

AssignReplicasToDirsRequest (versions 0–0).

§

ListConfigResources = 74

ListConfigResourcesRequest (versions 0–1).

§

DescribeTopicPartitions = 75

DescribeTopicPartitionsRequest (versions 0–0).

§

ShareGroupHeartbeat = 76

ShareGroupHeartbeatRequest (versions 1–1).

§

ShareGroupDescribe = 77

ShareGroupDescribeRequest (versions 1–1).

§

ShareFetch = 78

ShareFetchRequest (versions 1–2).

§

ShareAcknowledge = 79

ShareAcknowledgeRequest (versions 1–2).

§

AddRaftVoter = 80

AddRaftVoterRequest (versions 0–1).

§

RemoveRaftVoter = 81

RemoveRaftVoterRequest (versions 0–0).

§

UpdateRaftVoter = 82

UpdateRaftVoterRequest (versions 0–0).

§

InitializeShareGroupState = 83

InitializeShareGroupStateRequest (versions 0–0).

§

ReadShareGroupState = 84

ReadShareGroupStateRequest (versions 0–0).

§

WriteShareGroupState = 85

WriteShareGroupStateRequest (versions 0–1).

§

DeleteShareGroupState = 86

DeleteShareGroupStateRequest (versions 0–0).

§

ReadShareGroupStateSummary = 87

ReadShareGroupStateSummaryRequest (versions 0–1).

§

StreamsGroupHeartbeat = 88

StreamsGroupHeartbeatRequest (versions 0–0).

§

StreamsGroupDescribe = 89

StreamsGroupDescribeRequest (versions 0–0).

§

DescribeShareGroupOffsets = 90

DescribeShareGroupOffsetsRequest (versions 0–1).

§

AlterShareGroupOffsets = 91

AlterShareGroupOffsetsRequest (versions 0–0).

§

DeleteShareGroupOffsets = 92

DeleteShareGroupOffsetsRequest (versions 0–0).

§

GetReplicaLogInfo = 93

GetReplicaLogInfoRequest (versions 0–0).

Implementations§

Source§

impl ApiKey

Source

pub const ALL: &'static [ApiKey]

All known API keys, in ascending numeric order.

Source

pub fn from_i16(k: i16) -> Option<ApiKey>

Resolve from numeric key; returns None for unknown keys.

Trait Implementations§

Source§

impl Clone for ApiKey

Source§

fn clone(&self) -> ApiKey

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ApiKey

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'_derivative_strum> From<&'_derivative_strum ApiKey> for &'static str

Source§

fn from(x: &'_derivative_strum ApiKey) -> &'static str

Converts to this type from the input type.
Source§

impl From<ApiKey> for &'static str

Source§

fn from(x: ApiKey) -> &'static str

Converts to this type from the input type.
Source§

impl Hash for ApiKey

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for ApiKey

Source§

fn eq(&self, other: &ApiKey) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for ApiKey

Source§

impl Eq for ApiKey

Source§

impl StructuralPartialEq for ApiKey

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,