+ -
+
+
pulsar
+ index.html
+ Package
+ Package
+ PUBLIC
+ The Pulsar Python client library is based on the existing C++ client library. All the same features are exposed through the Python interface.
+ -
+
+
pulsar.exceptions
+ pulsar.exceptions.html
+ Module
+ Module
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.functions
+ pulsar.functions.html
+ Package
+ Package
+ PUBLIC
+ No package docstring; 3/3 modules documented
+ -
+
+
pulsar.functions.context
+ pulsar.functions.context.html
+ Module
+ Module
+ PUBLIC
+ Context defines context information available during processing of a request.
+ -
+
+
pulsar.functions.function
+ pulsar.functions.function.html
+ Module
+ Module
+ PUBLIC
+ This is the core interface of the function api.
+ -
+
+
pulsar.functions.serde
+ pulsar.functions.serde.html
+ Module
+ Module
+ PUBLIC
+ SerDe defines the interface for serialization/deserialization.
+ -
+
+
pulsar.schema
+ pulsar.schema.html
+ Package
+ Package
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition
+ pulsar.schema.definition.html
+ Module
+ Module
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.schema
+ pulsar.schema.schema.html
+ Module
+ Module
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.schema_avro
+ pulsar.schema.schema_avro.html
+ Module
+ Module
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.functions.function.Function
+ pulsar.functions.function.Function.html
+ Class
+ Class
+ PUBLIC
+ Interface for Pulsar Function
+ -
+
+
pulsar.functions.function.Function.process
+ pulsar.functions.function.Function.html#process
+ Function
+ Method
+ PUBLIC
+ Process input message
+ -
+
+
pulsar.functions.context.Context
+ pulsar.functions.context.Context.html
+ Class
+ Class
+ PUBLIC
+ Interface defining information available at process time
+ -
+
+
pulsar.functions.context.Context.get_message_id
+ pulsar.functions.context.Context.html#get_message_id
+ Function
+ Method
+ PUBLIC
+ Return the messageid of the current message that we are processing
+ -
+
+
pulsar.functions.context.Context.get_message_key
+ pulsar.functions.context.Context.html#get_message_key
+ Function
+ Method
+ PUBLIC
+ Return the key of the current message that we are processing
+ -
+
+
pulsar.functions.context.Context.get_message_eventtime
+ pulsar.functions.context.Context.html#get_message_eventtime
+ Function
+ Method
+ PUBLIC
+ Return the event time of the current message that we are processing
+ -
+
+
pulsar.functions.context.Context.get_message_properties
+ pulsar.functions.context.Context.html#get_message_properties
+ Function
+ Method
+ PUBLIC
+ Return the message properties kv map of the current message that we are processing
+ -
+
+
pulsar.functions.context.Context.get_current_message_topic_name
+ pulsar.functions.context.Context.html#get_current_message_topic_name
+ Function
+ Method
+ PUBLIC
+ Returns the topic name of the message that we are processing
+ -
+
+
pulsar.functions.context.Context.get_function_tenant
+ pulsar.functions.context.Context.html#get_function_tenant
+ Function
+ Method
+ PUBLIC
+ Returns the tenant of the message that's being processed
+ -
+
+
pulsar.functions.context.Context.get_function_namespace
+ pulsar.functions.context.Context.html#get_function_namespace
+ Function
+ Method
+ PUBLIC
+ Returns the namespace of the message that's being processed
+ -
+
+
pulsar.functions.context.Context.get_function_name
+ pulsar.functions.context.Context.html#get_function_name
+ Function
+ Method
+ PUBLIC
+ Returns the function name that we are a part of
+ -
+
+
pulsar.functions.context.Context.get_function_id
+ pulsar.functions.context.Context.html#get_function_id
+ Function
+ Method
+ PUBLIC
+ Returns the function id that we are a part of
+ -
+
+
pulsar.functions.context.Context.get_instance_id
+ pulsar.functions.context.Context.html#get_instance_id
+ Function
+ Method
+ PUBLIC
+ Returns the instance id that is executing the function
+ -
+
+
pulsar.functions.context.Context.get_function_version
+ pulsar.functions.context.Context.html#get_function_version
+ Function
+ Method
+ PUBLIC
+ Returns the version of function that we are executing
+ -
+
+
pulsar.functions.context.Context.get_logger
+ pulsar.functions.context.Context.html#get_logger
+ Function
+ Method
+ PUBLIC
+ Returns the logger object that can be used to do logging
+ -
+
+
pulsar.functions.context.Context.get_user_config_value
+ pulsar.functions.context.Context.html#get_user_config_value
+ Function
+ Method
+ PUBLIC
+ Returns the value of the user-defined config. If the key doesn't exist, None is returned
+ -
+
+
pulsar.functions.context.Context.get_user_config_map
+ pulsar.functions.context.Context.html#get_user_config_map
+ Function
+ Method
+ PUBLIC
+ Returns the entire user-defined config as a dict (the dict will be empty if no user-defined config is supplied)
+ -
+
+
pulsar.functions.context.Context.get_secret
+ pulsar.functions.context.Context.html#get_secret
+ Function
+ Method
+ PUBLIC
+ Returns the secret value associated with the name. None if nothing was found
+ -
+
+
pulsar.functions.context.Context.get_partition_key
+ pulsar.functions.context.Context.html#get_partition_key
+ Function
+ Method
+ PUBLIC
+ Returns partition key of the input message is one exists
+ -
+
+
pulsar.functions.context.Context.record_metric
+ pulsar.functions.context.Context.html#record_metric
+ Function
+ Method
+ PUBLIC
+ Records the metric_value. metric_value has to satisfy isinstance(metric_value, numbers.Number)
+ -
+
+
pulsar.functions.context.Context.publish
+ pulsar.functions.context.Context.html#publish
+ Function
+ Method
+ PUBLIC
+ Publishes message to topic_name by first serializing the message using serde_class_name serde The message will have properties specified if any
+ -
+
+
pulsar.functions.context.Context.get_input_topics
+ pulsar.functions.context.Context.html#get_input_topics
+ Function
+ Method
+ PUBLIC
+ Returns the input topics of function
+ -
+
+
pulsar.functions.context.Context.get_output_topic
+ pulsar.functions.context.Context.html#get_output_topic
+ Function
+ Method
+ PUBLIC
+ Returns the output topic of function
+ -
+
+
pulsar.functions.context.Context.get_output_serde_class_name
+ pulsar.functions.context.Context.html#get_output_serde_class_name
+ Function
+ Method
+ PUBLIC
+ return output Serde class
+ -
+
+
pulsar.functions.context.Context.ack
+ pulsar.functions.context.Context.html#ack
+ Function
+ Method
+ PUBLIC
+ ack this message id
+ -
+
+
pulsar.functions.context.Context.incr_counter
+ pulsar.functions.context.Context.html#incr_counter
+ Function
+ Method
+ PUBLIC
+ incr the counter of a given key in the managed state
+ -
+
+
pulsar.functions.context.Context.get_counter
+ pulsar.functions.context.Context.html#get_counter
+ Function
+ Method
+ PUBLIC
+ get the counter of a given key in the managed state
+ -
+
+
pulsar.functions.context.Context.del_counter
+ pulsar.functions.context.Context.html#del_counter
+ Function
+ Method
+ PUBLIC
+ delete the counter of a given key in the managed state
+ -
+
+
pulsar.functions.context.Context.put_state
+ pulsar.functions.context.Context.html#put_state
+ Function
+ Method
+ PUBLIC
+ update the value of a given key in the managed state
+ -
+
+
pulsar.functions.context.Context.get_state
+ pulsar.functions.context.Context.html#get_state
+ Function
+ Method
+ PUBLIC
+ get the value of a given key in the managed state
+ -
+
+
pulsar.functions.serde.SerDe
+ pulsar.functions.serde.SerDe.html
+ Class
+ Class
+ PUBLIC
+ Interface for Serialization/Deserialization
+ -
+
+
pulsar.functions.serde.SerDe.serialize
+ pulsar.functions.serde.SerDe.html#serialize
+ Function
+ Method
+ PUBLIC
+ Serialize input message into bytes
+ -
+
+
pulsar.functions.serde.SerDe.deserialize
+ pulsar.functions.serde.SerDe.html#deserialize
+ Function
+ Method
+ PUBLIC
+ Serialize input_bytes into an object
+ -
+
+
pulsar.functions.serde.PickleSerDe
+ pulsar.functions.serde.PickleSerDe.html
+ Class
+ Class
+ PUBLIC
+ Pickle based serializer
+ -
+
+
pulsar.functions.serde.PickleSerDe.serialize
+ pulsar.functions.serde.PickleSerDe.html#serialize
+ Function
+ Method
+ PUBLIC
+ Serialize input message into bytes
+ -
+
+
pulsar.functions.serde.PickleSerDe.deserialize
+ pulsar.functions.serde.PickleSerDe.html#deserialize
+ Function
+ Method
+ PUBLIC
+ Serialize input_bytes into an object
+ -
+
+
pulsar.functions.serde.IdentitySerDe
+ pulsar.functions.serde.IdentitySerDe.html
+ Class
+ Class
+ PUBLIC
+ Simple Serde that just conversion to string and back
+ -
+
+
pulsar.functions.serde.IdentitySerDe.__init__
+ pulsar.functions.serde.IdentitySerDe.html#__init__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.functions.serde.IdentitySerDe._types
+ pulsar.functions.serde.IdentitySerDe.html#_types
+ Attribute
+ Instance Variable
+ PRIVATE
+ Undocumented
+ -
+
+
pulsar.functions.serde.IdentitySerDe.serialize
+ pulsar.functions.serde.IdentitySerDe.html#serialize
+ Function
+ Method
+ PUBLIC
+ Serialize input message into bytes
+ -
+
+
pulsar.functions.serde.IdentitySerDe.deserialize
+ pulsar.functions.serde.IdentitySerDe.html#deserialize
+ Function
+ Method
+ PUBLIC
+ Serialize input_bytes into an object
+ -
+
+
pulsar.schema.definition._check_record_or_field
+ pulsar.schema.definition.html#_check_record_or_field
+ Function
+ Function
+ PRIVATE
+ Undocumented
+ -
+
+
pulsar.schema.definition.RecordMeta
+ pulsar.schema.definition.RecordMeta.html
+ Class
+ Class
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.RecordMeta.__new__
+ pulsar.schema.definition.RecordMeta.html#__new__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.RecordMeta._get_fields
+ pulsar.schema.definition.RecordMeta.html#_get_fields
+ Function
+ Class Method
+ PRIVATE
+ Undocumented
+ -
+
+
pulsar.schema.definition.Record
+ pulsar.schema.definition.Record.html
+ Class
+ Class
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Record._avro_namespace
+ pulsar.schema.definition.Record.html#_avro_namespace
+ Attribute
+ Class Variable
+ PRIVATE
+ Undocumented
+ -
+
+
pulsar.schema.definition.Record._sorted_fields
+ pulsar.schema.definition.Record.html#_sorted_fields
+ Attribute
+ Class Variable
+ PRIVATE
+ Undocumented
+ -
+
+
pulsar.schema.definition.Record.__init__
+ pulsar.schema.definition.Record.html#__init__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Record._required_default
+ pulsar.schema.definition.Record.html#_required_default
+ Attribute
+ Instance Variable
+ PRIVATE
+ Undocumented
+ -
+
+
pulsar.schema.definition.Record._default
+ pulsar.schema.definition.Record.html#_default
+ Attribute
+ Instance Variable
+ PRIVATE
+ Undocumented
+ -
+
+
pulsar.schema.definition.Record._required
+ pulsar.schema.definition.Record.html#_required
+ Attribute
+ Instance Variable
+ PRIVATE
+ Undocumented
+ -
+
+
pulsar.schema.definition.Record.schema
+ pulsar.schema.definition.Record.html#schema
+ Function
+ Class Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Record.schema_info
+ pulsar.schema.definition.Record.html#schema_info
+ Function
+ Class Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Record.__setattr__
+ pulsar.schema.definition.Record.html#__setattr__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Record.__eq__
+ pulsar.schema.definition.Record.html#__eq__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Record.__ne__
+ pulsar.schema.definition.Record.html#__ne__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Record.__str__
+ pulsar.schema.definition.Record.html#__str__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Record.type
+ pulsar.schema.definition.Record.html#type
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Record.python_type
+ pulsar.schema.definition.Record.html#python_type
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Record.validate_type
+ pulsar.schema.definition.Record.html#validate_type
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Record.default
+ pulsar.schema.definition.Record.html#default
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Record.required_default
+ pulsar.schema.definition.Record.html#required_default
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Field
+ pulsar.schema.definition.Field.html
+ Class
+ Class
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Field.__init__
+ pulsar.schema.definition.Field.html#__init__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Field._default
+ pulsar.schema.definition.Field.html#_default
+ Attribute
+ Instance Variable
+ PRIVATE
+ Undocumented
+ -
+
+
pulsar.schema.definition.Field._required_default
+ pulsar.schema.definition.Field.html#_required_default
+ Attribute
+ Instance Variable
+ PRIVATE
+ Undocumented
+ -
+
+
pulsar.schema.definition.Field._required
+ pulsar.schema.definition.Field.html#_required
+ Attribute
+ Instance Variable
+ PRIVATE
+ Undocumented
+ -
+
+
pulsar.schema.definition.Field.type
+ pulsar.schema.definition.Field.html#type
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Field.python_type
+ pulsar.schema.definition.Field.html#python_type
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Field.validate_type
+ pulsar.schema.definition.Field.html#validate_type
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Field.schema
+ pulsar.schema.definition.Field.html#schema
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Field.schema_info
+ pulsar.schema.definition.Field.html#schema_info
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Field.default
+ pulsar.schema.definition.Field.html#default
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Field.required_default
+ pulsar.schema.definition.Field.html#required_default
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Null
+ pulsar.schema.definition.Null.html
+ Class
+ Class
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Null.type
+ pulsar.schema.definition.Null.html#type
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Null.python_type
+ pulsar.schema.definition.Null.html#python_type
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Null.validate_type
+ pulsar.schema.definition.Null.html#validate_type
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Boolean
+ pulsar.schema.definition.Boolean.html
+ Class
+ Class
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Boolean.type
+ pulsar.schema.definition.Boolean.html#type
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Boolean.python_type
+ pulsar.schema.definition.Boolean.html#python_type
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Boolean.default
+ pulsar.schema.definition.Boolean.html#default
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Integer
+ pulsar.schema.definition.Integer.html
+ Class
+ Class
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Integer.type
+ pulsar.schema.definition.Integer.html#type
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Integer.python_type
+ pulsar.schema.definition.Integer.html#python_type
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Integer.default
+ pulsar.schema.definition.Integer.html#default
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Long
+ pulsar.schema.definition.Long.html
+ Class
+ Class
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Long.type
+ pulsar.schema.definition.Long.html#type
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Long.python_type
+ pulsar.schema.definition.Long.html#python_type
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Long.default
+ pulsar.schema.definition.Long.html#default
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Float
+ pulsar.schema.definition.Float.html
+ Class
+ Class
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Float.type
+ pulsar.schema.definition.Float.html#type
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Float.python_type
+ pulsar.schema.definition.Float.html#python_type
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Float.default
+ pulsar.schema.definition.Float.html#default
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Double
+ pulsar.schema.definition.Double.html
+ Class
+ Class
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Double.type
+ pulsar.schema.definition.Double.html#type
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Double.python_type
+ pulsar.schema.definition.Double.html#python_type
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Double.default
+ pulsar.schema.definition.Double.html#default
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Bytes
+ pulsar.schema.definition.Bytes.html
+ Class
+ Class
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Bytes.type
+ pulsar.schema.definition.Bytes.html#type
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Bytes.python_type
+ pulsar.schema.definition.Bytes.html#python_type
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Bytes.default
+ pulsar.schema.definition.Bytes.html#default
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.String
+ pulsar.schema.definition.String.html
+ Class
+ Class
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.String.type
+ pulsar.schema.definition.String.html#type
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.String.python_type
+ pulsar.schema.definition.String.html#python_type
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.String.validate_type
+ pulsar.schema.definition.String.html#validate_type
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.String.default
+ pulsar.schema.definition.String.html#default
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Array
+ pulsar.schema.definition.Array.html
+ Class
+ Class
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Array.__init__
+ pulsar.schema.definition.Array.html#__init__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Array.array_type
+ pulsar.schema.definition.Array.html#array_type
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Array.type
+ pulsar.schema.definition.Array.html#type
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Array.python_type
+ pulsar.schema.definition.Array.html#python_type
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Array.validate_type
+ pulsar.schema.definition.Array.html#validate_type
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Array.schema
+ pulsar.schema.definition.Array.html#schema
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Array.schema_info
+ pulsar.schema.definition.Array.html#schema_info
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Array.default
+ pulsar.schema.definition.Array.html#default
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Map
+ pulsar.schema.definition.Map.html
+ Class
+ Class
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Map.__init__
+ pulsar.schema.definition.Map.html#__init__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Map.value_type
+ pulsar.schema.definition.Map.html#value_type
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Map.type
+ pulsar.schema.definition.Map.html#type
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Map.python_type
+ pulsar.schema.definition.Map.html#python_type
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Map.validate_type
+ pulsar.schema.definition.Map.html#validate_type
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Map.schema
+ pulsar.schema.definition.Map.html#schema
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Map.schema_info
+ pulsar.schema.definition.Map.html#schema_info
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.Map.default
+ pulsar.schema.definition.Map.html#default
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.definition.is_unicode
+ pulsar.schema.definition.html#is_unicode
+ Function
+ Function
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.schema.Schema
+ pulsar.schema.schema.Schema.html
+ Class
+ Class
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.schema.Schema.__init__
+ pulsar.schema.schema.Schema.html#__init__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.schema.Schema._record_cls
+ pulsar.schema.schema.Schema.html#_record_cls
+ Attribute
+ Instance Variable
+ PRIVATE
+ Undocumented
+ -
+
+
pulsar.schema.schema.Schema._schema_info
+ pulsar.schema.schema.Schema.html#_schema_info
+ Attribute
+ Instance Variable
+ PRIVATE
+ Undocumented
+ -
+
+
pulsar.schema.schema.Schema.encode
+ pulsar.schema.schema.Schema.html#encode
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.schema.Schema.decode
+ pulsar.schema.schema.Schema.html#decode
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.schema.Schema.schema_info
+ pulsar.schema.schema.Schema.html#schema_info
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.schema.Schema._validate_object_type
+ pulsar.schema.schema.Schema.html#_validate_object_type
+ Function
+ Method
+ PRIVATE
+ Undocumented
+ -
+
+
pulsar.schema.schema.BytesSchema
+ pulsar.schema.schema.BytesSchema.html
+ Class
+ Class
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.schema.BytesSchema.__init__
+ pulsar.schema.schema.BytesSchema.html#__init__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.schema.BytesSchema.encode
+ pulsar.schema.schema.BytesSchema.html#encode
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.schema.BytesSchema.decode
+ pulsar.schema.schema.BytesSchema.html#decode
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.schema.BytesSchema.__str__
+ pulsar.schema.schema.BytesSchema.html#__str__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.schema.StringSchema
+ pulsar.schema.schema.StringSchema.html
+ Class
+ Class
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.schema.StringSchema.__init__
+ pulsar.schema.schema.StringSchema.html#__init__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.schema.StringSchema.encode
+ pulsar.schema.schema.StringSchema.html#encode
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.schema.StringSchema.decode
+ pulsar.schema.schema.StringSchema.html#decode
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.schema.StringSchema.__str__
+ pulsar.schema.schema.StringSchema.html#__str__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.schema.remove_reserved_key
+ pulsar.schema.schema.html#remove_reserved_key
+ Function
+ Function
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.schema.JsonSchema
+ pulsar.schema.schema.JsonSchema.html
+ Class
+ Class
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.schema.JsonSchema.__init__
+ pulsar.schema.schema.JsonSchema.html#__init__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.schema.JsonSchema._get_serialized_value
+ pulsar.schema.schema.JsonSchema.html#_get_serialized_value
+ Function
+ Method
+ PRIVATE
+ Undocumented
+ -
+
+
pulsar.schema.schema.JsonSchema.encode
+ pulsar.schema.schema.JsonSchema.html#encode
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.schema.JsonSchema.decode
+ pulsar.schema.schema.JsonSchema.html#decode
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.schema_avro.HAS_AVRO
+ pulsar.schema.schema_avro.html#HAS_AVRO
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.schema_avro.AvroSchema
+ pulsar.schema.schema_avro.AvroSchema.html
+ Class
+ Class
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.schema_avro.AvroSchema.__init__
+ pulsar.schema.schema_avro.AvroSchema.html#__init__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.schema_avro.AvroSchema._schema
+ pulsar.schema.schema_avro.AvroSchema.html#_schema
+ Attribute
+ Instance Variable
+ PRIVATE
+ Undocumented
+ -
+
+
pulsar.schema.schema_avro.AvroSchema._get_serialized_value
+ pulsar.schema.schema_avro.AvroSchema.html#_get_serialized_value
+ Function
+ Method
+ PRIVATE
+ Undocumented
+ -
+
+
pulsar.schema.schema_avro.AvroSchema.encode
+ pulsar.schema.schema_avro.AvroSchema.html#encode
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.schema_avro.AvroSchema.encode_dict
+ pulsar.schema.schema_avro.AvroSchema.html#encode_dict
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.schema.schema_avro.AvroSchema.decode
+ pulsar.schema.schema_avro.AvroSchema.html#decode
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar._retype
+ index.html#_retype
+ Attribute
+ Variable
+ PRIVATE
+ Undocumented
+ -
+
+
pulsar.MessageId
+ pulsar.MessageId.html
+ Class
+ Class
+ PUBLIC
+ Represents a message id.
+ -
+
+
pulsar.MessageId.earliest
+ pulsar.MessageId.html#earliest
+ Attribute
+ Instance Variable
+ PUBLIC
+ Represents the earliest message stored in a topic
+ -
+
+
pulsar.MessageId.latest
+ pulsar.MessageId.html#latest
+ Attribute
+ Instance Variable
+ PUBLIC
+ Represents the latest message published on a topic
+ -
+
+
pulsar.MessageId.__init__
+ pulsar.MessageId.html#__init__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.MessageId._msg_id
+ pulsar.MessageId.html#_msg_id
+ Attribute
+ Instance Variable
+ PRIVATE
+ Undocumented
+ -
+
+
pulsar.MessageId.ledger_id
+ pulsar.MessageId.html#ledger_id
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.MessageId.entry_id
+ pulsar.MessageId.html#entry_id
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.MessageId.batch_index
+ pulsar.MessageId.html#batch_index
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.MessageId.partition
+ pulsar.MessageId.html#partition
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.MessageId.serialize
+ pulsar.MessageId.html#serialize
+ Function
+ Method
+ PUBLIC
+ Returns a bytes representation of the message id. This byte sequence can be stored and later deserialized.
+ -
+
+
pulsar.MessageId.deserialize
+ pulsar.MessageId.html#deserialize
+ Function
+ Static Method
+ PUBLIC
+ Deserialize a message id object from a previously serialized bytes sequence.
+ -
+
+
pulsar.Message
+ pulsar.Message.html
+ Class
+ Class
+ PUBLIC
+ Message objects are returned by a consumer, either by calling
receive
or through a listener.
+ -
+
+
pulsar.Message.data
+ pulsar.Message.html#data
+ Function
+ Method
+ PUBLIC
+ Returns object typed bytes with the payload of the message.
+ -
+
+
pulsar.Message.value
+ pulsar.Message.html#value
+ Function
+ Method
+ PUBLIC
+ Returns object with the de-serialized version of the message content
+ -
+
+
pulsar.Message.properties
+ pulsar.Message.html#properties
+ Function
+ Method
+ PUBLIC
+ Return the properties attached to the message. Properties are application-defined key/value pairs that will be attached to the message.
+ -
+
+
pulsar.Message.partition_key
+ pulsar.Message.html#partition_key
+ Function
+ Method
+ PUBLIC
+ Get the partitioning key for the message.
+ -
+
+
pulsar.Message.publish_timestamp
+ pulsar.Message.html#publish_timestamp
+ Function
+ Method
+ PUBLIC
+ Get the timestamp in milliseconds with the message publish time.
+ -
+
+
pulsar.Message.event_timestamp
+ pulsar.Message.html#event_timestamp
+ Function
+ Method
+ PUBLIC
+ Get the timestamp in milliseconds with the message event time.
+ -
+
+
pulsar.Message.message_id
+ pulsar.Message.html#message_id
+ Function
+ Method
+ PUBLIC
+ The message ID that can be used to refer to this particular message.
+ -
+
+
pulsar.Message.topic_name
+ pulsar.Message.html#topic_name
+ Function
+ Method
+ PUBLIC
+ Get the topic Name from which this message originated from
+ -
+
+
pulsar.Message.redelivery_count
+ pulsar.Message.html#redelivery_count
+ Function
+ Method
+ PUBLIC
+ Get the redelivery count for this message
+ -
+
+
pulsar.Message.schema_version
+ pulsar.Message.html#schema_version
+ Function
+ Method
+ PUBLIC
+ Get the schema version for this message
+ -
+
+
pulsar.Message._wrap
+ pulsar.Message.html#_wrap
+ Function
+ Static Method
+ PRIVATE
+ Undocumented
+ -
+
+
pulsar.Message._message
+ pulsar.Message.html#_message
+ Attribute
+ Instance Variable
+ PRIVATE
+ Undocumented
+ -
+
+
pulsar.MessageBatch
+ pulsar.MessageBatch.html
+ Class
+ Class
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.MessageBatch.__init__
+ pulsar.MessageBatch.html#__init__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.MessageBatch._msg_batch
+ pulsar.MessageBatch.html#_msg_batch
+ Attribute
+ Instance Variable
+ PRIVATE
+ Undocumented
+ -
+
+
pulsar.MessageBatch.with_message_id
+ pulsar.MessageBatch.html#with_message_id
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.MessageBatch.parse_from
+ pulsar.MessageBatch.html#parse_from
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.Authentication
+ pulsar.Authentication.html
+ Class
+ Class
+ PUBLIC
+ Authentication provider object. Used to load authentication from an external shared library.
+ -
+
+
pulsar.Authentication.__init__
+ pulsar.Authentication.html#__init__
+ Function
+ Method
+ PUBLIC
+ Create the authentication provider instance.
+ -
+
+
pulsar.Authentication.auth
+ pulsar.Authentication.html#auth
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.AuthenticationTLS
+ pulsar.AuthenticationTLS.html
+ Class
+ Class
+ PUBLIC
+ TLS Authentication implementation
+ -
+
+
pulsar.AuthenticationTLS.__init__
+ pulsar.AuthenticationTLS.html#__init__
+ Function
+ Method
+ PUBLIC
+ Create the TLS authentication provider instance.
+ -
+
+
pulsar.AuthenticationTLS.auth
+ pulsar.AuthenticationTLS.html#auth
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.AuthenticationToken
+ pulsar.AuthenticationToken.html
+ Class
+ Class
+ PUBLIC
+ Token based authentication implementation
+ -
+
+
pulsar.AuthenticationToken.__init__
+ pulsar.AuthenticationToken.html#__init__
+ Function
+ Method
+ PUBLIC
+ Create the token authentication provider instance.
+ -
+
+
pulsar.AuthenticationToken.auth
+ pulsar.AuthenticationToken.html#auth
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.AuthenticationAthenz
+ pulsar.AuthenticationAthenz.html
+ Class
+ Class
+ PUBLIC
+ Athenz Authentication implementation
+ -
+
+
pulsar.AuthenticationAthenz.__init__
+ pulsar.AuthenticationAthenz.html#__init__
+ Function
+ Method
+ PUBLIC
+ Create the Athenz authentication provider instance.
+ -
+
+
pulsar.AuthenticationAthenz.auth
+ pulsar.AuthenticationAthenz.html#auth
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.AuthenticationOauth2
+ pulsar.AuthenticationOauth2.html
+ Class
+ Class
+ PUBLIC
+ Oauth2 Authentication implementation
+ -
+
+
pulsar.AuthenticationOauth2.__init__
+ pulsar.AuthenticationOauth2.html#__init__
+ Function
+ Method
+ PUBLIC
+ Create the Oauth2 authentication provider instance.
+ -
+
+
pulsar.AuthenticationOauth2.auth
+ pulsar.AuthenticationOauth2.html#auth
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.AuthenticationBasic
+ pulsar.AuthenticationBasic.html
+ Class
+ Class
+ PUBLIC
+ Basic Authentication implementation
+ -
+
+
pulsar.AuthenticationBasic.__init__
+ pulsar.AuthenticationBasic.html#__init__
+ Function
+ Method
+ PUBLIC
+ Create the Basic authentication provider instance.
+ -
+
+
pulsar.AuthenticationBasic.auth
+ pulsar.AuthenticationBasic.html#auth
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.Client
+ pulsar.Client.html
+ Class
+ Class
+ PUBLIC
+ The Pulsar client. A single client instance can be used to create producers and consumers on multiple topics.
+ -
+
+
pulsar.Client.__init__
+ pulsar.Client.html#__init__
+ Function
+ Method
+ PUBLIC
+ Create a new Pulsar client instance.
+ -
+
+
pulsar.Client._client
+ pulsar.Client.html#_client
+ Attribute
+ Instance Variable
+ PRIVATE
+ Undocumented
+ -
+
+
pulsar.Client._consumers
+ pulsar.Client.html#_consumers
+ Attribute
+ Instance Variable
+ PRIVATE
+ Undocumented
+ -
+
+
pulsar.Client._prepare_logger
+ pulsar.Client.html#_prepare_logger
+ Function
+ Static Method
+ PRIVATE
+ Undocumented
+ -
+
+
pulsar.Client.create_producer
+ pulsar.Client.html#create_producer
+ Function
+ Method
+ PUBLIC
+ Create a new producer on a given topic.
+ -
+
+
pulsar.Client.subscribe
+ pulsar.Client.html#subscribe
+ Function
+ Method
+ PUBLIC
+ Subscribe to the given topic and subscription combination.
+ -
+
+
pulsar.Client.create_reader
+ pulsar.Client.html#create_reader
+ Function
+ Method
+ PUBLIC
+ Create a reader on a particular topic
+ -
+
+
pulsar.Client.get_topic_partitions
+ pulsar.Client.html#get_topic_partitions
+ Function
+ Method
+ PUBLIC
+ Get the list of partitions for a given topic.
+ -
+
+
pulsar.Client.shutdown
+ pulsar.Client.html#shutdown
+ Function
+ Method
+ PUBLIC
+ Perform immediate shutdown of Pulsar client.
+ -
+
+
pulsar.Client.close
+ pulsar.Client.html#close
+ Function
+ Method
+ PUBLIC
+ Close the client and all the associated producers and consumers
+ -
+
+
pulsar.Producer
+ pulsar.Producer.html
+ Class
+ Class
+ PUBLIC
+ The Pulsar message producer, used to publish messages on a topic.
+ -
+
+
pulsar.Producer.topic
+ pulsar.Producer.html#topic
+ Function
+ Method
+ PUBLIC
+ Return the topic which producer is publishing to
+ -
+
+
pulsar.Producer.producer_name
+ pulsar.Producer.html#producer_name
+ Function
+ Method
+ PUBLIC
+ Return the producer name which could have been assigned by the system or specified by the client
+ -
+
+
pulsar.Producer.last_sequence_id
+ pulsar.Producer.html#last_sequence_id
+ Function
+ Method
+ PUBLIC
+ Get the last sequence id that was published by this producer.
+ -
+
+
pulsar.Producer.send
+ pulsar.Producer.html#send
+ Function
+ Method
+ PUBLIC
+ Publish a message on the topic. Blocks until the message is acknowledged
+ -
+
+
pulsar.Producer.send_async
+ pulsar.Producer.html#send_async
+ Function
+ Method
+ PUBLIC
+ Send a message asynchronously.
+ -
+
+
pulsar.Producer.flush
+ pulsar.Producer.html#flush
+ Function
+ Method
+ PUBLIC
+ Flush all the messages buffered in the client and wait until all messages have been successfully persisted
+ -
+
+
pulsar.Producer.close
+ pulsar.Producer.html#close
+ Function
+ Method
+ PUBLIC
+ Close the producer.
+ -
+
+
pulsar.Producer._build_msg
+ pulsar.Producer.html#_build_msg
+ Function
+ Method
+ PRIVATE
+ Undocumented
+ -
+
+
pulsar.Producer.is_connected
+ pulsar.Producer.html#is_connected
+ Function
+ Method
+ PUBLIC
+ Check if the producer is connected or not.
+ -
+
+
pulsar.Consumer
+ pulsar.Consumer.html
+ Class
+ Class
+ PUBLIC
+ Pulsar consumer.
+ -
+
+
pulsar.Consumer.topic
+ pulsar.Consumer.html#topic
+ Function
+ Method
+ PUBLIC
+ Return the topic this consumer is subscribed to.
+ -
+
+
pulsar.Consumer.subscription_name
+ pulsar.Consumer.html#subscription_name
+ Function
+ Method
+ PUBLIC
+ Return the subscription name.
+ -
+
+
pulsar.Consumer.unsubscribe
+ pulsar.Consumer.html#unsubscribe
+ Function
+ Method
+ PUBLIC
+ Unsubscribe the current consumer from the topic.
+ -
+
+
pulsar.Consumer.receive
+ pulsar.Consumer.html#receive
+ Function
+ Method
+ PUBLIC
+ Receive a single message.
+ -
+
+
pulsar.Consumer.batch_receive
+ pulsar.Consumer.html#batch_receive
+ Function
+ Method
+ PUBLIC
+ Batch receiving messages.
+ -
+
+
pulsar.Consumer.acknowledge
+ pulsar.Consumer.html#acknowledge
+ Function
+ Method
+ PUBLIC
+ Acknowledge the reception of a single message.
+ -
+
+
pulsar.Consumer.acknowledge_cumulative
+ pulsar.Consumer.html#acknowledge_cumulative
+ Function
+ Method
+ PUBLIC
+ Acknowledge the reception of all the messages in the stream up to (and including) the provided message.
+ -
+
+
pulsar.Consumer.negative_acknowledge
+ pulsar.Consumer.html#negative_acknowledge
+ Function
+ Method
+ PUBLIC
+ Acknowledge the failure to process a single message.
+ -
+
+
pulsar.Consumer.pause_message_listener
+ pulsar.Consumer.html#pause_message_listener
+ Function
+ Method
+ PUBLIC
+
+ -
+
+
pulsar.Consumer.resume_message_listener
+ pulsar.Consumer.html#resume_message_listener
+ Function
+ Method
+ PUBLIC
+ Resume receiving the messages via the message listener. Asynchronously receive all the messages enqueued from the time
pause_message_listener()
was called.
+ -
+
+
pulsar.Consumer.redeliver_unacknowledged_messages
+ pulsar.Consumer.html#redeliver_unacknowledged_messages
+ Function
+ Method
+ PUBLIC
+ Redelivers all the unacknowledged messages. In failover mode, the request is ignored if the consumer is not active for the given topic. In shared mode, the consumer's messages to be redelivered are distributed across all the connected consumers...
+ -
+
+
pulsar.Consumer.seek
+ pulsar.Consumer.html#seek
+ Function
+ Method
+ PUBLIC
+ Reset the subscription associated with this consumer to a specific message id or publish timestamp. The message id can either be a specific message or represent the first or last messages in the topic. ...
+ -
+
+
pulsar.Consumer.close
+ pulsar.Consumer.html#close
+ Function
+ Method
+ PUBLIC
+ Close the consumer.
+ -
+
+
pulsar.Consumer.is_connected
+ pulsar.Consumer.html#is_connected
+ Function
+ Method
+ PUBLIC
+ Check if the consumer is connected or not.
+ -
+
+
pulsar.Consumer.get_last_message_id
+ pulsar.Consumer.html#get_last_message_id
+ Function
+ Method
+ PUBLIC
+ Get the last message id.
+ -
+
+
pulsar.ConsumerBatchReceivePolicy
+ pulsar.ConsumerBatchReceivePolicy.html
+ Class
+ Class
+ PUBLIC
+ Batch receive policy can limit the number and bytes of messages in a single batch, and can specify a timeout for waiting for enough messages for this batch.
+ -
+
+
pulsar.ConsumerBatchReceivePolicy.__init__
+ pulsar.ConsumerBatchReceivePolicy.html#__init__
+ Function
+ Method
+ PUBLIC
+ Wrapper BatchReceivePolicy.
+ -
+
+
pulsar.ConsumerBatchReceivePolicy._policy
+ pulsar.ConsumerBatchReceivePolicy.html#_policy
+ Attribute
+ Instance Variable
+ PRIVATE
+ Undocumented
+ -
+
+
pulsar.ConsumerBatchReceivePolicy.policy
+ pulsar.ConsumerBatchReceivePolicy.html#policy
+ Function
+ Method
+ PUBLIC
+ Returns the actual one BatchReceivePolicy.
+ -
+
+
pulsar.Reader
+ pulsar.Reader.html
+ Class
+ Class
+ PUBLIC
+ Pulsar topic reader.
+ -
+
+
pulsar.Reader.topic
+ pulsar.Reader.html#topic
+ Function
+ Method
+ PUBLIC
+ Return the topic this reader is reading from.
+ -
+
+
pulsar.Reader.read_next
+ pulsar.Reader.html#read_next
+ Function
+ Method
+ PUBLIC
+ Read a single message.
+ -
+
+
pulsar.Reader.has_message_available
+ pulsar.Reader.html#has_message_available
+ Function
+ Method
+ PUBLIC
+ Check if there is any message available to read from the current position.
+ -
+
+
pulsar.Reader.seek
+ pulsar.Reader.html#seek
+ Function
+ Method
+ PUBLIC
+ Reset this reader to a specific message id or publish timestamp. The message id can either be a specific message or represent the first or last messages in the topic. Note: this operation can only be done on non-partitioned topics...
+ -
+
+
pulsar.Reader.close
+ pulsar.Reader.html#close
+ Function
+ Method
+ PUBLIC
+ Close the reader.
+ -
+
+
pulsar.Reader.is_connected
+ pulsar.Reader.html#is_connected
+ Function
+ Method
+ PUBLIC
+ Check if the reader is connected or not.
+ -
+
+
pulsar.CryptoKeyReader
+ pulsar.CryptoKeyReader.html
+ Class
+ Class
+ PUBLIC
+ Default crypto key reader implementation
+ -
+
+
pulsar.CryptoKeyReader.__init__
+ pulsar.CryptoKeyReader.html#__init__
+ Function
+ Method
+ PUBLIC
+ Create crypto key reader.
+ -
+
+
pulsar.CryptoKeyReader.cryptoKeyReader
+ pulsar.CryptoKeyReader.html#cryptoKeyReader
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.ConsoleLogger
+ pulsar.ConsoleLogger.html
+ Class
+ Class
+ PUBLIC
+ Logger that writes on standard output
+ -
+
+
pulsar.ConsoleLogger.log_level
+ pulsar.ConsoleLogger.html#log_level
+ Attribute
+ Instance Variable
+ PUBLIC
+ The logging level, eg: pulsar.LoggerLevel.Info
+ -
+
+
pulsar.ConsoleLogger.__init__
+ pulsar.ConsoleLogger.html#__init__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar.FileLogger
+ pulsar.FileLogger.html
+ Class
+ Class
+ PUBLIC
+ Logger that writes into a file
+ -
+
+
pulsar.FileLogger.log_level
+ pulsar.FileLogger.html#log_level
+ Attribute
+ Instance Variable
+ PUBLIC
+ The logging level, eg: pulsar.LoggerLevel.Info
+ -
+
+
pulsar.FileLogger.log_file
+ pulsar.FileLogger.html#log_file
+ Attribute
+ Instance Variable
+ PUBLIC
+ The file where to write the logs
+ -
+
+
pulsar.FileLogger.__init__
+ pulsar.FileLogger.html#__init__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
pulsar._check_type
+ index.html#_check_type
+ Function
+ Function
+ PRIVATE
+ Undocumented
+ -
+
+
pulsar._check_type_or_none
+ index.html#_check_type_or_none
+ Function
+ Function
+ PRIVATE
+ Undocumented
+ -
+
+
pulsar._listener_wrapper
+ index.html#_listener_wrapper
+ Function
+ Function
+ PRIVATE
+ Undocumented
+
+