Table of Contents

Class KafkaAdminClientExtensions

Namespace
MASES.KNet.Extensions
Assembly
MASES.KNet.dll

Extension for KafkaAdminClient

public static class KafkaAdminClientExtensions
Inheritance
KafkaAdminClientExtensions
Inherited Members

Methods

AbortTransactionAsync(IAdmin, AbortTransactionSpec)

public static Task<AbortTransactionResult> AbortTransactionAsync(this IAdmin admin, AbortTransactionSpec spec)

Parameters

admin IAdmin
spec AbortTransactionSpec

Returns

Task<AbortTransactionResult>

AbortTransactionAsync(IAdmin, AbortTransactionSpec, AbortTransactionOptions)

public static Task<AbortTransactionResult> AbortTransactionAsync(this IAdmin admin, AbortTransactionSpec spec, AbortTransactionOptions options)

Parameters

admin IAdmin
spec AbortTransactionSpec
options AbortTransactionOptions

Returns

Task<AbortTransactionResult>

AlterClientQuotasAsync(IAdmin, Collection<ClientQuotaAlteration>)

public static Task<AlterClientQuotasResult> AlterClientQuotasAsync(this IAdmin admin, Collection<ClientQuotaAlteration> entries)

Parameters

admin IAdmin
entries Collection<ClientQuotaAlteration>

Returns

Task<AlterClientQuotasResult>

AlterClientQuotasAsync(IAdmin, Collection<ClientQuotaAlteration>, AlterClientQuotasOptions)

public static Task<AlterClientQuotasResult> AlterClientQuotasAsync(this IAdmin admin, Collection<ClientQuotaAlteration> entries, AlterClientQuotasOptions options)

Parameters

admin IAdmin
entries Collection<ClientQuotaAlteration>
options AlterClientQuotasOptions

Returns

Task<AlterClientQuotasResult>

AlterConsumerGroupOffsetsAsync(IAdmin, string, Map<TopicPartition, OffsetAndMetadata>)

public static Task<AlterConsumerGroupOffsetsResult> AlterConsumerGroupOffsetsAsync(this IAdmin admin, string groupId, Map<TopicPartition, OffsetAndMetadata> offsets)

Parameters

admin IAdmin
groupId string
offsets Map<TopicPartition, OffsetAndMetadata>

Returns

Task<AlterConsumerGroupOffsetsResult>

AlterConsumerGroupOffsetsAsync(IAdmin, string, Map<TopicPartition, OffsetAndMetadata>, AlterConsumerGroupOffsetsOptions)

public static Task<AlterConsumerGroupOffsetsResult> AlterConsumerGroupOffsetsAsync(this IAdmin admin, string groupId, Map<TopicPartition, OffsetAndMetadata> offsets, AlterConsumerGroupOffsetsOptions options)

Parameters

admin IAdmin
groupId string
offsets Map<TopicPartition, OffsetAndMetadata>
options AlterConsumerGroupOffsetsOptions

Returns

Task<AlterConsumerGroupOffsetsResult>

AlterPartitionReassignmentsAsync(IAdmin, Map<TopicPartition, Optional<NewPartitionReassignment>>)

public static Task<AlterPartitionReassignmentsResult> AlterPartitionReassignmentsAsync(this IAdmin admin, Map<TopicPartition, Optional<NewPartitionReassignment>> reassignments)

Parameters

admin IAdmin
reassignments Map<TopicPartition, Optional<NewPartitionReassignment>>

Returns

Task<AlterPartitionReassignmentsResult>

AlterPartitionReassignmentsAsync(IAdmin, Map<TopicPartition, Optional<NewPartitionReassignment>>, AlterPartitionReassignmentsOptions)

public static Task<AlterPartitionReassignmentsResult> AlterPartitionReassignmentsAsync(this IAdmin admin, Map<TopicPartition, Optional<NewPartitionReassignment>> reassignments, AlterPartitionReassignmentsOptions options)

Parameters

admin IAdmin
reassignments Map<TopicPartition, Optional<NewPartitionReassignment>>
options AlterPartitionReassignmentsOptions

Returns

Task<AlterPartitionReassignmentsResult>

AlterReplicaLogDirsAsync(IAdmin, Map<TopicPartitionReplica, String>)

public static Task<AlterReplicaLogDirsResult> AlterReplicaLogDirsAsync(this IAdmin admin, Map<TopicPartitionReplica, String> replicaAssignment)

Parameters

admin IAdmin
replicaAssignment Map<TopicPartitionReplica, String>

Returns

Task<AlterReplicaLogDirsResult>

AlterReplicaLogDirsAsync(IAdmin, Map<TopicPartitionReplica, String>, AlterReplicaLogDirsOptions)

public static Task<AlterReplicaLogDirsResult> AlterReplicaLogDirsAsync(this IAdmin admin, Map<TopicPartitionReplica, String> replicaAssignment, AlterReplicaLogDirsOptions options)

Parameters

admin IAdmin
replicaAssignment Map<TopicPartitionReplica, String>
options AlterReplicaLogDirsOptions

Returns

Task<AlterReplicaLogDirsResult>

AlterUserScramCredentialsAsync(IAdmin, List<UserScramCredentialAlteration>)

public static Task<AlterUserScramCredentialsResult> AlterUserScramCredentialsAsync(this IAdmin admin, List<UserScramCredentialAlteration> alterations)

Parameters

admin IAdmin
alterations List<UserScramCredentialAlteration>

Returns

Task<AlterUserScramCredentialsResult>

AlterUserScramCredentialsAsync(IAdmin, List<UserScramCredentialAlteration>, AlterUserScramCredentialsOptions)

public static Task<AlterUserScramCredentialsResult> AlterUserScramCredentialsAsync(this IAdmin admin, List<UserScramCredentialAlteration> alterations, AlterUserScramCredentialsOptions options)

Parameters

admin IAdmin
alterations List<UserScramCredentialAlteration>
options AlterUserScramCredentialsOptions

Returns

Task<AlterUserScramCredentialsResult>

CreateAclsAsync(IAdmin, Collection<AclBinding>)

public static Task<CreateAclsResult> CreateAclsAsync(this IAdmin admin, Collection<AclBinding> acls)

Parameters

admin IAdmin
acls Collection<AclBinding>

Returns

Task<CreateAclsResult>

CreateAclsAsync(IAdmin, Collection<AclBinding>, CreateAclsOptions)

public static Task<CreateAclsResult> CreateAclsAsync(this IAdmin admin, Collection<AclBinding> acls, CreateAclsOptions options)

Parameters

admin IAdmin
acls Collection<AclBinding>
options CreateAclsOptions

Returns

Task<CreateAclsResult>

CreateDelegationTokenAsync(IAdmin)

Async version of CreateDelegationToken()

public static Task<CreateDelegationTokenResult> CreateDelegationTokenAsync(this IAdmin admin)

Parameters

admin IAdmin

Returns

Task<CreateDelegationTokenResult>

CreateDelegationTokenAsync(IAdmin, CreateDelegationTokenOptions)

public static Task<CreateDelegationTokenResult> CreateDelegationTokenAsync(this IAdmin admin, CreateDelegationTokenOptions options)

Parameters

admin IAdmin
options CreateDelegationTokenOptions

Returns

Task<CreateDelegationTokenResult>

CreatePartitionsAsync(IAdmin, Map<String, NewPartitions>)

public static Task<CreatePartitionsResult> CreatePartitionsAsync(this IAdmin admin, Map<String, NewPartitions> newPartitions)

Parameters

admin IAdmin
newPartitions Map<String, NewPartitions>

Returns

Task<CreatePartitionsResult>

CreatePartitionsAsync(IAdmin, Map<String, NewPartitions>, CreatePartitionsOptions)

public static Task<CreatePartitionsResult> CreatePartitionsAsync(this IAdmin admin, Map<String, NewPartitions> newPartitions, CreatePartitionsOptions options)

Parameters

admin IAdmin
newPartitions Map<String, NewPartitions>
options CreatePartitionsOptions

Returns

Task<CreatePartitionsResult>

CreateTopic(IAdmin, NewTopic)

public static void CreateTopic(this IAdmin admin, NewTopic topic)

Parameters

admin IAdmin
topic NewTopic

CreateTopic(IAdmin, string, int, short)

public static void CreateTopic(this IAdmin admin, string topicName, int numPartitions = 1, short replicationFactor = 1)

Parameters

admin IAdmin
topicName string
numPartitions int
replicationFactor short

CreateTopicAsync(IAdmin, string, int, short)

public static Task<CreateTopicsResult> CreateTopicAsync(this IAdmin admin, string topicName, int numPartitions = 1, short replicationFactor = 1)

Parameters

admin IAdmin
topicName string
numPartitions int
replicationFactor short

Returns

Task<CreateTopicsResult>

CreateTopicsAsync(IAdmin, Collection<NewTopic>)

public static Task<CreateTopicsResult> CreateTopicsAsync(this IAdmin admin, Collection<NewTopic> newTopics)

Parameters

admin IAdmin
newTopics Collection<NewTopic>

Returns

Task<CreateTopicsResult>

CreateTopicsAsync(IAdmin, Collection<NewTopic>, CreateTopicsOptions)

public static Task<CreateTopicsResult> CreateTopicsAsync(this IAdmin admin, Collection<NewTopic> newTopics, CreateTopicsOptions options)

Parameters

admin IAdmin
newTopics Collection<NewTopic>
options CreateTopicsOptions

Returns

Task<CreateTopicsResult>

DeleteAclsAsync(IAdmin, Collection<AclBindingFilter>)

public static Task<DeleteAclsResult> DeleteAclsAsync(this IAdmin admin, Collection<AclBindingFilter> filters)

Parameters

admin IAdmin
filters Collection<AclBindingFilter>

Returns

Task<DeleteAclsResult>

DeleteAclsAsync(IAdmin, Collection<AclBindingFilter>, DeleteAclsOptions)

public static Task<DeleteAclsResult> DeleteAclsAsync(this IAdmin admin, Collection<AclBindingFilter> filters, DeleteAclsOptions options)

Parameters

admin IAdmin
filters Collection<AclBindingFilter>
options DeleteAclsOptions

Returns

Task<DeleteAclsResult>

DeleteConsumerGroupOffsetsAsync(IAdmin, string, Set<TopicPartition>)

public static Task<DeleteConsumerGroupOffsetsResult> DeleteConsumerGroupOffsetsAsync(this IAdmin admin, string groupId, Set<TopicPartition> partitions)

Parameters

admin IAdmin
groupId string
partitions Set<TopicPartition>

Returns

Task<DeleteConsumerGroupOffsetsResult>

DeleteConsumerGroupOffsetsAsync(IAdmin, string, Set<TopicPartition>, DeleteConsumerGroupOffsetsOptions)

public static Task<DeleteConsumerGroupOffsetsResult> DeleteConsumerGroupOffsetsAsync(this IAdmin admin, string groupId, Set<TopicPartition> partitions, DeleteConsumerGroupOffsetsOptions options)

Parameters

admin IAdmin
groupId string
partitions Set<TopicPartition>
options DeleteConsumerGroupOffsetsOptions

Returns

Task<DeleteConsumerGroupOffsetsResult>

DeleteConsumerGroupsAsync(IAdmin, IEnumerable<string>)

public static Task<DeleteConsumerGroupsResult> DeleteConsumerGroupsAsync(this IAdmin admin, IEnumerable<string> groupIds)

Parameters

admin IAdmin
groupIds IEnumerable<string>

Returns

Task<DeleteConsumerGroupsResult>

DeleteConsumerGroupsAsync(IAdmin, IEnumerable<string>, DeleteConsumerGroupsOptions)

public static Task<DeleteConsumerGroupsResult> DeleteConsumerGroupsAsync(this IAdmin admin, IEnumerable<string> groupIds, DeleteConsumerGroupsOptions options)

Parameters

admin IAdmin
groupIds IEnumerable<string>
options DeleteConsumerGroupsOptions

Returns

Task<DeleteConsumerGroupsResult>

DeleteRecordsAsync(IAdmin, Map<TopicPartition, RecordsToDelete>)

public static Task<DeleteRecordsResult> DeleteRecordsAsync(this IAdmin admin, Map<TopicPartition, RecordsToDelete> recordsToDelete)

Parameters

admin IAdmin
recordsToDelete Map<TopicPartition, RecordsToDelete>

Returns

Task<DeleteRecordsResult>

DeleteRecordsAsync(IAdmin, Map<TopicPartition, RecordsToDelete>, DeleteRecordsOptions)

public static Task<DeleteRecordsResult> DeleteRecordsAsync(this IAdmin admin, Map<TopicPartition, RecordsToDelete> recordsToDelete, DeleteRecordsOptions options)

Parameters

admin IAdmin
recordsToDelete Map<TopicPartition, RecordsToDelete>
options DeleteRecordsOptions

Returns

Task<DeleteRecordsResult>

DeleteTopic(IAdmin, string)

public static void DeleteTopic(this IAdmin admin, string topicName)

Parameters

admin IAdmin
topicName string

DeleteTopicAsync(IAdmin, string)

public static Task<DeleteTopicsResult> DeleteTopicAsync(this IAdmin admin, string topicName)

Parameters

admin IAdmin
topicName string

Returns

Task<DeleteTopicsResult>

DeleteTopicsAsync(IAdmin, TopicCollection)

public static Task<DeleteTopicsResult> DeleteTopicsAsync(this IAdmin admin, TopicCollection topics)

Parameters

admin IAdmin
topics TopicCollection

Returns

Task<DeleteTopicsResult>

DeleteTopicsAsync(IAdmin, TopicCollection, DeleteTopicsOptions)

public static Task<DeleteTopicsResult> DeleteTopicsAsync(this IAdmin admin, TopicCollection topics, DeleteTopicsOptions options)

Parameters

admin IAdmin
topics TopicCollection
options DeleteTopicsOptions

Returns

Task<DeleteTopicsResult>

DeleteTopicsAsync(IAdmin, IEnumerable<string>)

public static Task<DeleteTopicsResult> DeleteTopicsAsync(this IAdmin admin, IEnumerable<string> topics)

Parameters

admin IAdmin
topics IEnumerable<string>

Returns

Task<DeleteTopicsResult>

DeleteTopicsAsync(IAdmin, IEnumerable<string>, DeleteTopicsOptions)

public static Task<DeleteTopicsResult> DeleteTopicsAsync(this IAdmin admin, IEnumerable<string> topics, DeleteTopicsOptions options)

Parameters

admin IAdmin
topics IEnumerable<string>
options DeleteTopicsOptions

Returns

Task<DeleteTopicsResult>

DescribeAclsAsync(IAdmin, AclBindingFilter)

public static Task<DescribeAclsResult> DescribeAclsAsync(this IAdmin admin, AclBindingFilter filter)

Parameters

admin IAdmin
filter AclBindingFilter

Returns

Task<DescribeAclsResult>

DescribeAclsAsync(IAdmin, AclBindingFilter, DescribeAclsOptions)

public static Task<DescribeAclsResult> DescribeAclsAsync(this IAdmin admin, AclBindingFilter filter, DescribeAclsOptions options)

Parameters

admin IAdmin
filter AclBindingFilter
options DescribeAclsOptions

Returns

Task<DescribeAclsResult>

DescribeClientQuotasAsync(IAdmin, ClientQuotaFilter)

public static Task<DescribeClientQuotasResult> DescribeClientQuotasAsync(this IAdmin admin, ClientQuotaFilter filter)

Parameters

admin IAdmin
filter ClientQuotaFilter

Returns

Task<DescribeClientQuotasResult>

DescribeClientQuotasAsync(IAdmin, ClientQuotaFilter, DescribeClientQuotasOptions)

public static Task<DescribeClientQuotasResult> DescribeClientQuotasAsync(this IAdmin admin, ClientQuotaFilter filter, DescribeClientQuotasOptions options)

Parameters

admin IAdmin
filter ClientQuotaFilter
options DescribeClientQuotasOptions

Returns

Task<DescribeClientQuotasResult>

DescribeClusterAsync(IAdmin)

Async version of DescribeCluster()

public static Task<DescribeClusterResult> DescribeClusterAsync(this IAdmin admin)

Parameters

admin IAdmin

Returns

Task<DescribeClusterResult>

DescribeClusterAsync(IAdmin, DescribeClusterOptions)

public static Task<DescribeClusterResult> DescribeClusterAsync(this IAdmin admin, DescribeClusterOptions options)

Parameters

admin IAdmin
options DescribeClusterOptions

Returns

Task<DescribeClusterResult>

DescribeConfigsAsync(IAdmin, Collection<ConfigResource>)

public static Task<DescribeConfigsResult> DescribeConfigsAsync(this IAdmin admin, Collection<ConfigResource> resources)

Parameters

admin IAdmin
resources Collection<ConfigResource>

Returns

Task<DescribeConfigsResult>

DescribeConfigsAsync(IAdmin, Collection<ConfigResource>, DescribeConfigsOptions)

public static Task<DescribeConfigsResult> DescribeConfigsAsync(this IAdmin admin, Collection<ConfigResource> resources, DescribeConfigsOptions options)

Parameters

admin IAdmin
resources Collection<ConfigResource>
options DescribeConfigsOptions

Returns

Task<DescribeConfigsResult>

DescribeConsumerGroupsAsync(IAdmin, IEnumerable<string>)

public static Task<DescribeConsumerGroupsResult> DescribeConsumerGroupsAsync(this IAdmin admin, IEnumerable<string> groupIds)

Parameters

admin IAdmin
groupIds IEnumerable<string>

Returns

Task<DescribeConsumerGroupsResult>

DescribeConsumerGroupsAsync(IAdmin, IEnumerable<string>, DescribeConsumerGroupsOptions)

public static Task<DescribeConsumerGroupsResult> DescribeConsumerGroupsAsync(this IAdmin admin, IEnumerable<string> groupIds, DescribeConsumerGroupsOptions options)

Parameters

admin IAdmin
groupIds IEnumerable<string>
options DescribeConsumerGroupsOptions

Returns

Task<DescribeConsumerGroupsResult>

DescribeDelegationTokenAsync(IAdmin)

Async version of DescribeDelegationToken()

public static Task<DescribeDelegationTokenResult> DescribeDelegationTokenAsync(this IAdmin admin)

Parameters

admin IAdmin

Returns

Task<DescribeDelegationTokenResult>

DescribeDelegationTokenAsync(IAdmin, DescribeDelegationTokenOptions)

public static Task<DescribeDelegationTokenResult> DescribeDelegationTokenAsync(this IAdmin admin, DescribeDelegationTokenOptions options)

Parameters

admin IAdmin
options DescribeDelegationTokenOptions

Returns

Task<DescribeDelegationTokenResult>

DescribeFeaturesAsync(IAdmin)

Async version of DescribeFeatures()

public static Task<DescribeFeaturesResult> DescribeFeaturesAsync(this IAdmin admin)

Parameters

admin IAdmin

Returns

Task<DescribeFeaturesResult>

DescribeFeaturesAsync(IAdmin, DescribeFeaturesOptions)

public static Task<DescribeFeaturesResult> DescribeFeaturesAsync(this IAdmin admin, DescribeFeaturesOptions options)

Parameters

admin IAdmin
options DescribeFeaturesOptions

Returns

Task<DescribeFeaturesResult>

DescribeLogDirsAsync(IAdmin, Collection<Integer>)

public static Task<DescribeLogDirsResult> DescribeLogDirsAsync(this IAdmin admin, Collection<Integer> brokers)

Parameters

admin IAdmin
brokers Collection<Integer>

Returns

Task<DescribeLogDirsResult>

DescribeLogDirsAsync(IAdmin, Collection<Integer>, DescribeLogDirsOptions)

public static Task<DescribeLogDirsResult> DescribeLogDirsAsync(this IAdmin admin, Collection<Integer> brokers, DescribeLogDirsOptions options)

Parameters

admin IAdmin
brokers Collection<Integer>
options DescribeLogDirsOptions

Returns

Task<DescribeLogDirsResult>

DescribeProducersAsync(IAdmin, Collection<TopicPartition>)

public static Task<DescribeProducersResult> DescribeProducersAsync(this IAdmin admin, Collection<TopicPartition> partitions)

Parameters

admin IAdmin
partitions Collection<TopicPartition>

Returns

Task<DescribeProducersResult>

DescribeProducersAsync(IAdmin, Collection<TopicPartition>, DescribeProducersOptions)

public static Task<DescribeProducersResult> DescribeProducersAsync(this IAdmin admin, Collection<TopicPartition> partitions, DescribeProducersOptions options)

Parameters

admin IAdmin
partitions Collection<TopicPartition>
options DescribeProducersOptions

Returns

Task<DescribeProducersResult>

DescribeReplicaLogDirsAsync(IAdmin, Collection<TopicPartitionReplica>)

public static Task<DescribeReplicaLogDirsResult> DescribeReplicaLogDirsAsync(this IAdmin admin, Collection<TopicPartitionReplica> replicas)

Parameters

admin IAdmin
replicas Collection<TopicPartitionReplica>

Returns

Task<DescribeReplicaLogDirsResult>

DescribeReplicaLogDirsAsync(IAdmin, Collection<TopicPartitionReplica>, DescribeReplicaLogDirsOptions)

public static Task<DescribeReplicaLogDirsResult> DescribeReplicaLogDirsAsync(this IAdmin admin, Collection<TopicPartitionReplica> replicas, DescribeReplicaLogDirsOptions options)

Parameters

admin IAdmin
replicas Collection<TopicPartitionReplica>
options DescribeReplicaLogDirsOptions

Returns

Task<DescribeReplicaLogDirsResult>

DescribeTopicAsync(IAdmin, string)

public static Task<DescribeTopicsResult> DescribeTopicAsync(this IAdmin admin, string topicName)

Parameters

admin IAdmin
topicName string

Returns

Task<DescribeTopicsResult>

DescribeTopicsAsync(IAdmin, IEnumerable<string>)

public static Task<DescribeTopicsResult> DescribeTopicsAsync(this IAdmin admin, IEnumerable<string> topicNames)

Parameters

admin IAdmin
topicNames IEnumerable<string>

Returns

Task<DescribeTopicsResult>

DescribeTopicsAsync(IAdmin, IEnumerable<string>, DescribeTopicsOptions)

public static Task<DescribeTopicsResult> DescribeTopicsAsync(this IAdmin admin, IEnumerable<string> topicNames, DescribeTopicsOptions options)

Parameters

admin IAdmin
topicNames IEnumerable<string>
options DescribeTopicsOptions

Returns

Task<DescribeTopicsResult>

DescribeTransactionsAsync(IAdmin, IEnumerable<string>)

public static Task<DescribeTransactionsResult> DescribeTransactionsAsync(this IAdmin admin, IEnumerable<string> transactionalIds)

Parameters

admin IAdmin
transactionalIds IEnumerable<string>

Returns

Task<DescribeTransactionsResult>

DescribeTransactionsAsync(IAdmin, IEnumerable<string>, DescribeTransactionsOptions)

public static Task<DescribeTransactionsResult> DescribeTransactionsAsync(this IAdmin admin, IEnumerable<string> transactionalIds, DescribeTransactionsOptions options)

Parameters

admin IAdmin
transactionalIds IEnumerable<string>
options DescribeTransactionsOptions

Returns

Task<DescribeTransactionsResult>

DescribeUserScramCredentialsAsync(IAdmin)

public static Task<DescribeUserScramCredentialsResult> DescribeUserScramCredentialsAsync(this IAdmin admin)

Parameters

admin IAdmin

Returns

Task<DescribeUserScramCredentialsResult>

DescribeUserScramCredentialsAsync(IAdmin, List<String>)

public static Task<DescribeUserScramCredentialsResult> DescribeUserScramCredentialsAsync(this IAdmin admin, List<String> users)

Parameters

admin IAdmin
users List<String>

Returns

Task<DescribeUserScramCredentialsResult>

DescribeUserScramCredentialsAsync(IAdmin, List<String>, DescribeUserScramCredentialsOptions)

public static Task<DescribeUserScramCredentialsResult> DescribeUserScramCredentialsAsync(this IAdmin admin, List<String> users, DescribeUserScramCredentialsOptions options)

Parameters

admin IAdmin
users List<String>
options DescribeUserScramCredentialsOptions

Returns

Task<DescribeUserScramCredentialsResult>

ElectLeadersAsync(IAdmin, ElectionType, Set<TopicPartition>)

public static Task<ElectLeadersResult> ElectLeadersAsync(this IAdmin admin, ElectionType electionType, Set<TopicPartition> partitions)

Parameters

admin IAdmin
electionType ElectionType
partitions Set<TopicPartition>

Returns

Task<ElectLeadersResult>

ElectLeadersAsync(IAdmin, ElectionType, Set<TopicPartition>, ElectLeadersOptions)

public static Task<ElectLeadersResult> ElectLeadersAsync(this IAdmin admin, ElectionType electionType, Set<TopicPartition> partitions, ElectLeadersOptions options)

Parameters

admin IAdmin
electionType ElectionType
partitions Set<TopicPartition>
options ElectLeadersOptions

Returns

Task<ElectLeadersResult>

ExpireDelegationTokenAsync(IAdmin, byte[])

public static Task<ExpireDelegationTokenResult> ExpireDelegationTokenAsync(this IAdmin admin, byte[] hmac)

Parameters

admin IAdmin
hmac byte[]

Returns

Task<ExpireDelegationTokenResult>

ExpireDelegationTokenAsync(IAdmin, byte[], ExpireDelegationTokenOptions)

public static Task<ExpireDelegationTokenResult> ExpireDelegationTokenAsync(this IAdmin admin, byte[] hmac, ExpireDelegationTokenOptions options)

Parameters

admin IAdmin
hmac byte[]
options ExpireDelegationTokenOptions

Returns

Task<ExpireDelegationTokenResult>

IncrementalAlterConfigsAsync(IAdmin, Map<ConfigResource, Collection<AlterConfigOp>>)

public static Task<AlterConfigsResult> IncrementalAlterConfigsAsync(this IAdmin admin, Map<ConfigResource, Collection<AlterConfigOp>> configs)

Parameters

admin IAdmin
configs Map<ConfigResource, Collection<AlterConfigOp>>

Returns

Task<AlterConfigsResult>

IncrementalAlterConfigsAsync(IAdmin, Map<ConfigResource, Collection<AlterConfigOp>>, AlterConfigsOptions)

public static Task<AlterConfigsResult> IncrementalAlterConfigsAsync(this IAdmin admin, Map<ConfigResource, Collection<AlterConfigOp>> configs, AlterConfigsOptions options)

Parameters

admin IAdmin
configs Map<ConfigResource, Collection<AlterConfigOp>>
options AlterConfigsOptions

Returns

Task<AlterConfigsResult>

ListConsumerGroupOffsetsAsync(IAdmin, string)

public static Task<ListConsumerGroupOffsetsResult> ListConsumerGroupOffsetsAsync(this IAdmin admin, string groupId)

Parameters

admin IAdmin
groupId string

Returns

Task<ListConsumerGroupOffsetsResult>

ListConsumerGroupOffsetsAsync(IAdmin, string, ListConsumerGroupOffsetsOptions)

public static Task<ListConsumerGroupOffsetsResult> ListConsumerGroupOffsetsAsync(this IAdmin admin, string groupId, ListConsumerGroupOffsetsOptions options)

Parameters

admin IAdmin
groupId string
options ListConsumerGroupOffsetsOptions

Returns

Task<ListConsumerGroupOffsetsResult>

ListConsumerGroupsAsync(IAdmin)

Async version of ListConsumerGroups()

public static Task<ListConsumerGroupsResult> ListConsumerGroupsAsync(this IAdmin admin)

Parameters

admin IAdmin

Returns

Task<ListConsumerGroupsResult>

ListConsumerGroupsAsync(IAdmin, ListConsumerGroupsOptions)

public static Task<ListConsumerGroupsResult> ListConsumerGroupsAsync(this IAdmin admin, ListConsumerGroupsOptions options)

Parameters

admin IAdmin
options ListConsumerGroupsOptions

Returns

Task<ListConsumerGroupsResult>

ListOffsetsAsync(IAdmin, Map<TopicPartition, OffsetSpec>)

public static Task<ListOffsetsResult> ListOffsetsAsync(this IAdmin admin, Map<TopicPartition, OffsetSpec> topicPartitionOffsets)

Parameters

admin IAdmin
topicPartitionOffsets Map<TopicPartition, OffsetSpec>

Returns

Task<ListOffsetsResult>

ListOffsetsAsync(IAdmin, Map<TopicPartition, OffsetSpec>, ListOffsetsOptions)

public static Task<ListOffsetsResult> ListOffsetsAsync(this IAdmin admin, Map<TopicPartition, OffsetSpec> topicPartitionOffsets, ListOffsetsOptions options)

Parameters

admin IAdmin
topicPartitionOffsets Map<TopicPartition, OffsetSpec>
options ListOffsetsOptions

Returns

Task<ListOffsetsResult>

ListPartitionReassignmentsAsync(IAdmin)

public static Task<ListPartitionReassignmentsResult> ListPartitionReassignmentsAsync(this IAdmin admin)

Parameters

admin IAdmin

Returns

Task<ListPartitionReassignmentsResult>

ListPartitionReassignmentsAsync(IAdmin, Optional<Set<TopicPartition>>, ListPartitionReassignmentsOptions)

public static Task<ListPartitionReassignmentsResult> ListPartitionReassignmentsAsync(this IAdmin admin, Optional<Set<TopicPartition>> partitions, ListPartitionReassignmentsOptions options)

Parameters

admin IAdmin
partitions Optional<Set<TopicPartition>>
options ListPartitionReassignmentsOptions

Returns

Task<ListPartitionReassignmentsResult>

ListPartitionReassignmentsAsync(IAdmin, Set<TopicPartition>)

public static Task<ListPartitionReassignmentsResult> ListPartitionReassignmentsAsync(this IAdmin admin, Set<TopicPartition> partitions)

Parameters

admin IAdmin
partitions Set<TopicPartition>

Returns

Task<ListPartitionReassignmentsResult>

ListPartitionReassignmentsAsync(IAdmin, Set<TopicPartition>, ListPartitionReassignmentsOptions)

public static Task<ListPartitionReassignmentsResult> ListPartitionReassignmentsAsync(this IAdmin admin, Set<TopicPartition> partitions, ListPartitionReassignmentsOptions options)

Parameters

admin IAdmin
partitions Set<TopicPartition>
options ListPartitionReassignmentsOptions

Returns

Task<ListPartitionReassignmentsResult>

ListPartitionReassignmentsAsync(IAdmin, ListPartitionReassignmentsOptions)

public static Task<ListPartitionReassignmentsResult> ListPartitionReassignmentsAsync(this IAdmin admin, ListPartitionReassignmentsOptions options)

Parameters

admin IAdmin
options ListPartitionReassignmentsOptions

Returns

Task<ListPartitionReassignmentsResult>

ListTopicsAsync(IAdmin)

Async version of ListTopics()

public static Task<ListTopicsResult> ListTopicsAsync(this IAdmin admin)

Parameters

admin IAdmin

Returns

Task<ListTopicsResult>

ListTopicsAsync(IAdmin, ListTopicsOptions)

public static Task<ListTopicsResult> ListTopicsAsync(this IAdmin admin, ListTopicsOptions options)

Parameters

admin IAdmin
options ListTopicsOptions

Returns

Task<ListTopicsResult>

ListTransactionsAsync(IAdmin)

Async version of ListTransactions()

public static Task<ListTransactionsResult> ListTransactionsAsync(this IAdmin admin)

Parameters

admin IAdmin

Returns

Task<ListTransactionsResult>

ListTransactionsAsync(IAdmin, ListTransactionsOptions)

public static Task<ListTransactionsResult> ListTransactionsAsync(this IAdmin admin, ListTransactionsOptions options)

Parameters

admin IAdmin
options ListTransactionsOptions

Returns

Task<ListTransactionsResult>

RemoveMembersFromConsumerGroupAsync(IAdmin, string, RemoveMembersFromConsumerGroupOptions)

public static Task<RemoveMembersFromConsumerGroupResult> RemoveMembersFromConsumerGroupAsync(this IAdmin admin, string groupId, RemoveMembersFromConsumerGroupOptions options)

Parameters

admin IAdmin
groupId string
options RemoveMembersFromConsumerGroupOptions

Returns

Task<RemoveMembersFromConsumerGroupResult>

RenewDelegationTokenAsync(IAdmin, byte[])

public static Task<RenewDelegationTokenResult> RenewDelegationTokenAsync(this IAdmin admin, byte[] hmac)

Parameters

admin IAdmin
hmac byte[]

Returns

Task<RenewDelegationTokenResult>

RenewDelegationTokenAsync(IAdmin, byte[], RenewDelegationTokenOptions)

public static Task<RenewDelegationTokenResult> RenewDelegationTokenAsync(this IAdmin admin, byte[] hmac, RenewDelegationTokenOptions options)

Parameters

admin IAdmin
hmac byte[]
options RenewDelegationTokenOptions

Returns

Task<RenewDelegationTokenResult>

UnregisterBrokerAsync(IAdmin, int)

Async version of UnregisterBroker(int)

public static Task<UnregisterBrokerResult> UnregisterBrokerAsync(this IAdmin admin, int brokerId)

Parameters

admin IAdmin
brokerId int

Returns

Task<UnregisterBrokerResult>

UnregisterBrokerAsync(IAdmin, int, UnregisterBrokerOptions)

public static Task<UnregisterBrokerResult> UnregisterBrokerAsync(this IAdmin admin, int brokerId, UnregisterBrokerOptions options)

Parameters

admin IAdmin
brokerId int
options UnregisterBrokerOptions

Returns

Task<UnregisterBrokerResult>

UpdateFeaturesAsync(IAdmin, Map<String, FeatureUpdate>, UpdateFeaturesOptions)

public static Task<UpdateFeaturesResult> UpdateFeaturesAsync(this IAdmin admin, Map<String, FeatureUpdate> featureUpdates, UpdateFeaturesOptions options)

Parameters

admin IAdmin
featureUpdates Map<String, FeatureUpdate>
options UpdateFeaturesOptions

Returns

Task<UpdateFeaturesResult>