confluent-kafka-dotnet
Show / Hide Table of Contents

Namespace Confluent.Kafka.Admin

Classes

AccessControlEntry

Represents an access control entry. ACEs are a tuple of Principal, Host, Operation, and PermissionType.

AccessControlEntryFilter

Represents a filter which matches access control entries.

AclBinding

Represents an ACL binding that specify the operation and permission type for a specific principal over one or more resources of the same type. Used by "IAdminClient.CreateAclsAsync", returned by "IAdminClient.DescribeAclsAsync" and "IAdminClient.DeleteAclsAsync".

AclBindingFilter

Represents a filter used to return a list of ACL bindings matching some or all of its attributes. Used by "IAdminClient.DescribeAclsAsync" and "IAdminClient.DeleteAclsAsync".

AlterConfigsException

Represents an error that occured during an alter configs request.

AlterConfigsOptions

Options for the AlterConfigs method.

AlterConfigsReport

The result of an alter config request for a specific resource.

AlterConsumerGroupOffsetsException

Represents an error that occured during altering consumer group offsets.

AlterConsumerGroupOffsetsOptions

Options for the "AdminClient.AlterConsumerGroupOffsetsAsync" method.

AlterConsumerGroupOffsetsReport

The per-group result for an alter consumer group offsets request including errors.

AlterConsumerGroupOffsetsResult

The per-group result for an alter consumer group offsets request.

AlterUserScramCredentialsException

Represents an error that occurred during an alter user scram credentials operation.

AlterUserScramCredentialsOptions

Options for the AlterUserScramCredentials method.

AlterUserScramCredentialsReport

The per-user result for an alter user scram credentials request, including errors.

ConfigEntry

Encapsulates a config property name / value pair.

ConfigEntryResult

A config property entry, as reported by the Kafka admin api.

ConfigResource

A class representing resources that have configs.

ConfigSynonym

Describes a synonym of a config entry.

ConsumerGroupDescription

Represents a single consumer group's description in the result of a describe consumer group operation.

ConsumerGroupListing

Represents a single consumer group in the result of a list consumer groups operation.

CreateAclReport

Provides create ACL error information.

CreateAclsException

Represents an error that occurred during a create ACLs request.

CreateAclsOptions

Options for the "AdminClient.CreateAclsAsync" method.

CreatePartitionsException

Represents an error that occured during a create partitions request.

CreatePartitionsOptions

Options for the CreatePartitions method.

CreatePartitionsReport

The result of a create partitions request for a specific topic.

CreateTopicReport

The result of a request to create a specific topic.

CreateTopicsException

Represents an error that occured during a create topics request.

CreateTopicsOptions

Options for the CreateTopics method.

DeleteAclsException

Represents an error that occurred during a delete ACLs request.

DeleteAclsOptions

Options for the "AdminClient.DeleteAclsAsync" method.

DeleteAclsReport

Report for a delete ACLs operation with an Error and a list of AclBinding

DeleteAclsResult

Result for a delete ACLs operation with a list of AclBinding

DeleteConsumerGroupOffsetsException

Represents an error that occured during a delete consumer group offset request.

DeleteConsumerGroupOffsetsOptions

Options for the DeleteGroups method.

DeleteConsumerGroupOffsetsReport

The result of delete consumer group offset request (including error status).

DeleteConsumerGroupOffsetsResult

The result of delete consumer group offset request (including error status).

DeleteGroupReport

The result of a DeleteGroup request.

DeleteGroupsException

Represents an error that occured during a delete groups request.

DeleteGroupsOptions

Options for the DeleteGroups method.

DeleteRecordsException

Represents an error that occured during a delete records request.

DeleteRecordsOptions

Options for the DeleteRecordsAsync method.

DeleteRecordsReport

The per-partition result of delete records request (including error status).

DeleteRecordsResult

The per-partition result of delete records request.

DeleteTopicReport

The result of a request to delete a specific topic.

DeleteTopicsException

Represents an error that occured during a delete topics request.

DeleteTopicsOptions

Options for the DeleteTopics method.

DescribeAclsException

Represents an error that occurred during a describe ACLs request.

DescribeAclsOptions

Options for the DescribeAcls method.

DescribeAclsReport

Report for a describe ACLs operation with an Error and a list of AclBinding

DescribeAclsResult

Result for a describe ACLs operation with an Error and a list of AclBinding

DescribeClusterOptions

Options for the "IAdminClient.DescribeCluster" method.

DescribeClusterResult

Represents the result of a describe cluster operation.

DescribeConfigsException

Represents an error that occured during a describe configs request.

DescribeConfigsOptions

Options for the DescribeConfigs method.

DescribeConfigsReport

The result of a request to describe the configs of a specific resource.

DescribeConfigsResult

The result of a request to describe the configs of a specific resource.

DescribeConsumerGroupsException

Represents an error that occured during a describe consumer group operation.

DescribeConsumerGroupsOptions

Options for the "AdminClient.DescribeConsumerGroupsOptions" method.

DescribeConsumerGroupsReport

Represents the result of a describe consumer group operation, where one or more of the results has an error.

DescribeConsumerGroupsResult

Represents the result of a describe consumer group operation.

DescribeTopicsException

Represents an error that occured during a describe topic operation.

DescribeTopicsOptions

Options for the "AdminClient.DescribeTopics" method.

DescribeTopicsReport

Represents the result of a describe topic operation, where one or more of the results has an error.

DescribeTopicsResult

Represents the result of a describe topic operation.

DescribeUserScramCredentialsException

Represents an error that occurred during a describe user SCRAM credentials operation.

DescribeUserScramCredentialsOptions

Options for the "AdminClient.DescribeUserScramCredentialsOptions" method.

DescribeUserScramCredentialsReport

Represents the result of a DescribeUserScramCredentials operation. (including error status).

DescribeUserScramCredentialsResult

Represents the result of a DescribeUserScramCredentials operation.

ElectLeadersException

Represents an error that occured during the ElectLeaders operation.

ElectLeadersOptions

Options for the "AdminClient.ElectLeaders" method.

ElectLeadersReport

Represents the result of an elect leaders request (including error status).

ElectLeadersResult

Result information for all Partitions queried in an ElectLeaderRequest.

IncrementalAlterConfigsException

Represents an error that occured during an incremental alter configs request.

IncrementalAlterConfigsOptions

Options for the IncrementalAlterConfigs method.

IncrementalAlterConfigsReport

The result of incremental alter config request for a specific resource, when an error occurred.

IncrementalAlterConfigsResult

The result of incremental alter config request for a specific resource.

ListConsumerGroupOffsetsException

Represents an error that occured during listing consumer group offsets.

ListConsumerGroupOffsetsOptions

Options for the "AdminClient.ListConsumerGroupOffsetsAsync" method.

ListConsumerGroupOffsetsReport

The per-group result for a list consumer group offsets request, and an error.

ListConsumerGroupOffsetsResult

The per-group result for a list consumer group offsets request.

ListConsumerGroupsException

Represents an error that occured during a list consumer group operation.

ListConsumerGroupsOptions

Options for the "AdminClient.ListConsumerGroupsAsync" method.

ListConsumerGroupsReport

Represents the result of a list consumer group operation with an error.

ListConsumerGroupsResult

Represents the result of a list consumer group operation.

ListOffsetsException

Represents an error occurred while listing offsets.

ListOffsetsOptions

Options for the "AdminClient.ListOffsetsAsync" method.

ListOffsetsReport

Represents the result of a ListOffsets request (including error status).

ListOffsetsResult

Represents the result of a ListOffsets request.

ListOffsetsResultInfo

Represents the result of a list offset request for a single topic partition.

MemberAssignment

MemberAssignment represents the assignment of a consumer group member.

MemberDescription

MemberDescription represents the description of a consumer group member

OffsetSpec

Used in ListOffsets to specify the desired offsets of the partition being queried.

OffsetSpec.EarliestSpec

Used to retrieve the earliest offset available.

OffsetSpec.LatestSpec

Used to retrieve the latest offset available.

OffsetSpec.MaxTimestampSpec

Used to retrieve the offset with the largest timestamp, that could not correspond to the latest one as timestamps can be specified client-side.

OffsetSpec.TimestampSpec

Used to retrieve the earliest offset whose timestamp is greater than or equal to the given timestamp in the corresponding partition.

PartitionsSpecification

Specification for new partitions to be added to a topic.

ResourcePattern

Represents a pattern that is used by ACLs to match zero or more resources.

ResourcePatternFilter

Represents a filter that can match ResourcePattern.

ScramCredentialInfo

Specification of a ScramCredential corresponding to a user.

TopicDescription

Represents a single topic's description in the result of a describe topic operation.

TopicPartitionOffsetSpec

Represents a (TopicPartition, OffsetSpec) tuple. Used by ListOffsets.

TopicSpecification

Specification of a new topic to be created via the CreateTopics method. This class is used for the same purpose as NewTopic in the Java API.

UserScramCredentialAlteration

The UserScramCredentialAlteration for both Upsertion and Deletion Operation

UserScramCredentialDeletion

Deletion for the UserScramCredentialAlteration Used to delete existing Scram Credential for a user.

UserScramCredentialUpsertion

Upsertion for the UserScramCredentialAlteration Used to upsert new Scram Credential for a user.

UserScramCredentialsDescription

UserScramCredentials Description: Describe SCRAM credentials of a single user.

Enums

AclOperation

Enumerates the different types of ACL operation.

AclPermissionType

Enumerates the different types of ACL permission types.

AlterConfigOpType

Enum of allowed AlterConfigOpType.

ConfigSource

Enumerates the different config sources.

ResourcePatternType

Enumerates the different types of Kafka resource patterns.

ResourceType

Enumerates the set of configuration resource types.

ScramMechanism

Enumerates the different types of ScramMechanism types.

In this article