confluent-kafka-python API reference

52 public APIs from confluent-kafka-python (confluentinc/confluent-kafka-python) — 32 classes, 7 functions, 13 methods. Signatures extracted by static analysis of the actual source.

Repository: confluentinc/confluent-kafka-python

Kind	Count
Classes	32
Functions	7
Methods	13

API list

classsrc.confluent_kafka._model.ElectionType

Enumerates the different types of leader elections.

classsrc.confluent_kafka._model.IsolationLevel

Enum for Kafka isolation levels.

methodsrc.confluent_kafka._model.Messages.count() -> int

Number of messages in this batch.

methodsrc.confluent_kafka._model.Messages.is_empty() -> bool

Whether this batch contains no messages.

methodsrc.confluent_kafka._model.Messages.records() -> List[Message]

Copy of the messages in this batch.

classsrc.confluent_kafka._model.Node

Represents node information.

classsrc.confluent_kafka._model.TopicPartitionInfo

Represents partition information.

funcsrc.confluent_kafka._oauthbearer.aws.jwt_extractor.extract_sub(jwt:str) -> str

Return the ``sub`` claim from the JWT payload.

classsrc.confluent_kafka.admin._acl.AclOperation

Enumerates the different types of ACL operation.

classsrc.confluent_kafka.admin._config.ConfigEntry

Represents a configuration property.

methodsrc.confluent_kafka.admin._config.ConfigResource.set_config(name:str, value:str, overwrite:bool=True) -> None

Set/overwrite a configuration value.

classsrc.confluent_kafka.admin._group.MemberAssignment

Represents member assignment information.

classsrc.confluent_kafka.admin._group.MemberDescription

Represents member information.

classsrc.confluent_kafka.admin._metadata.BrokerMetadata

Provides information about a Kafka broker.

classsrc.confluent_kafka.admin._metadata.GroupMember

Provides information about a group member.

classsrc.confluent_kafka.admin._metadata.PartitionMetadata

Provides information about a Kafka partition.

classsrc.confluent_kafka.admin._metadata.TopicMetadata

Provides information about a Kafka topic.

classsrc.confluent_kafka.admin._scram.ScramMechanism

Enumerates SASL/SCRAM mechanisms.

classsrc.confluent_kafka.admin._scram.UserScramCredentialAlteration

Base class for SCRAM credential alterations.

classsrc.confluent_kafka.avro.AvroConsumer

classsrc.confluent_kafka.avro.AvroProducer

classsrc.confluent_kafka.avro.error.ClientError

Error thrown by Schema Registry clients

funcsrc.confluent_kafka.avro.load.load(fp)

Parse a schema from a file path

classsrc.confluent_kafka.avro.serializer.SerializerError

Generic error from serializer package

method

src.confluent_kafka.schema_registry._async.schema_registry_client.AsyncSchemaRegistryClient.get_config(subject_name:Optional[str]=None) -> 'ServerConfig'

Get the current config.

method

src.confluent_kafka.schema_registry._async.schema_registry_client.AsyncSchemaRegistryClient.get_contexts(offset:int=0, limit:int=-1) -> List[str]

Retrieves a list of contexts.

method

src.confluent_kafka.schema_registry._async.schema_registry_client.AsyncSchemaRegistryClient.get_mode(subject_name:str) -> str

Get the mode for a subject.

method

src.confluent_kafka.schema_registry._async.schema_registry_client.AsyncSchemaRegistryClient.update_mode(subject_name:str, mode:str, force:bool=False) -> str

Update the mode for a subject.

classsrc.confluent_kafka.schema_registry._sync.schema_registry_client.SchemaRegistryClient

A Confluent Schema Registry client.

method

src.confluent_kafka.schema_registry._sync.schema_registry_client.SchemaRegistryClient.get_config(subject_name:Optional[str]=None) -> 'ServerConfig'

Get the current config.

method

src.confluent_kafka.schema_registry._sync.schema_registry_client.SchemaRegistryClient.get_contexts(offset:int=0, limit:int=-1) -> List[str]

Retrieves a list of contexts.

methodsrc.confluent_kafka.schema_registry._sync.schema_registry_client.SchemaRegistryClient.get_mode(subject_name:str) -> str

Get the mode for a subject.

method

src.confluent_kafka.schema_registry._sync.schema_registry_client.SchemaRegistryClient.update_mode(subject_name:str, mode:str, force:bool=False) -> str

Update the mode for a subject.

funcsrc.confluent_kafka.schema_registry.common.protobuf.decimal_to_protobuf(value:Decimal, scale:int) -> decimal_pb2.Decimal

Converts a Decimal to a Protobuf value.

funcsrc.confluent_kafka.schema_registry.common.protobuf.protobuf_to_decimal(value:decimal_pb2.Decimal) -> Decimal

Converts a Protobuf value to Decimal.

classsrc.confluent_kafka.schema_registry.common.schema_registry_client.RegisteredSchema

An registered schema.

classsrc.confluent_kafka.schema_registry.common.schema_registry_client.Schema

An unregistered schema.

classsrc.confluent_kafka.schema_registry.common.serde.ParsedSchemaCache

Thread-safe cache for parsed schemas

methodsrc.confluent_kafka.schema_registry.common.serde.ParsedSchemaCache.clear()

Clear the cache.

funcsrc.confluent_kafka.schema_registry.prefix_schema_id_serializer(payload:bytes, ctx, schema_id) -> bytes

Serializes the schema id into the payload prefix.

classsrc.confluent_kafka.schema_registry.rules.encryption.azurekms.azure_client.AzureKmsClient

Basic Azure client for AEAD.

classsrc.confluent_kafka.schema_registry.rules.encryption.dek_registry.dek_registry_client.DekRegistryClient

A Confluent DEK Registry client.

classsrc.confluent_kafka.schema_registry.rules.encryption.dek_registry.mock_dek_registry_client.MockDekRegistryClient

A Mock DEK Registry client.

funcsrc.confluent_kafka.schema_registry.rules.encryption.kms_driver_registry.register_kms_driver(driver:KmsDriver) -> None

Adds a KMS driver to a global list.

funcsrc.confluent_kafka.schema_registry.rules.encryption.kms_driver_registry.reset_kms_drivers() -> None

Removes all registered clients.

classsrc.confluent_kafka.serialization.DoubleDeserializer

Deserializes float to IEEE 764 binary64.

classsrc.confluent_kafka.serialization.DoubleSerializer

Serializes float to IEEE 764 binary64.

classsrc.confluent_kafka.serialization.IntegerDeserializer

Deserializes int to int32 bytes.

classsrc.confluent_kafka.serialization.IntegerSerializer

Serializes int to int32 bytes.

classsrc.confluent_kafka.serialization.MessageField

Enum like object for identifying Message fields.

classsrc.confluent_kafka.serialization.SerializationError

Generic error from serializer package

classsrc.confluent_kafka.serialization.StringDeserializer

Deserializes a str(py2:unicode) from bytes.

About this data

These signatures were extracted from the public source of confluentinc/confluent-kafka-python using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries