Index (Pulsar IO :: IO 3.1.1 API)

A

AbstractPushSource<T> - Class in org.apache.pulsar.io.core: Pulsar's Push Source Abstract.
AbstractPushSource() - Constructor for class org.apache.pulsar.io.core.AbstractPushSource

BatchPushSource<T> - Class in org.apache.pulsar.io.core: Pulsar's Batch Push Source interface.
BatchPushSource() - Constructor for class org.apache.pulsar.io.core.BatchPushSource
BatchSource<T> - Interface in org.apache.pulsar.io.core: Interface for writing Batch sources The lifecycle of the BatchSource is as follows 1.
BatchSourceTriggerer - Interface in org.apache.pulsar.io.core: This is an interface for defining BatchSource triggerers.

configClass() - Element in annotation interface org.apache.pulsar.io.core.annotations.Connector: Config class used by this connector.
Connector - Annotation Interface in org.apache.pulsar.io.core.annotations: Annotation for documenting connectors.
consume(Record<T>) - Method in class org.apache.pulsar.io.core.AbstractPushSource: Send this message to be written to Pulsar.

defaultValue() - Element in annotation interface org.apache.pulsar.io.core.annotations.FieldDoc: Return the value of this field.
discover(Consumer<byte[]>) - Method in interface org.apache.pulsar.io.core.BatchSource: Discovery phase of a connector.

FieldDoc - Annotation Interface in org.apache.pulsar.io.core.annotations: Annotation for documenting fields in a config.

getInputTopics() - Method in interface org.apache.pulsar.io.core.SinkContext: Get a list of all input topics.
getKey() - Method in class org.apache.pulsar.io.core.KeyValue
getOutputTopic() - Method in interface org.apache.pulsar.io.core.SourceContext: Get the output topic of the source.
getQueueLength() - Method in class org.apache.pulsar.io.core.AbstractPushSource: Get length of the queue that records are push onto.
getSinkConfig() - Method in interface org.apache.pulsar.io.core.SinkContext: Get sink config at startup.
getSinkName() - Method in interface org.apache.pulsar.io.core.SinkContext: The name of the sink that we are executing.
getSourceConfig() - Method in interface org.apache.pulsar.io.core.SourceContext: Get the source config.
getSourceName() - Method in interface org.apache.pulsar.io.core.SourceContext: The name of the source that we are executing.
getSubscriptionType() - Method in interface org.apache.pulsar.io.core.SinkContext: Get subscription type used by the source providing data for the sink.
getValue() - Method in class org.apache.pulsar.io.core.KeyValue

help() - Element in annotation interface org.apache.pulsar.io.core.annotations.Connector: Description of this connector.
help() - Element in annotation interface org.apache.pulsar.io.core.annotations.FieldDoc: Return the description of this field.

init(Map<String, Object>, SourceContext) - Method in interface org.apache.pulsar.io.core.BatchSourceTriggerer: initializes the Triggerer with given config.
IOType - Enum Class in org.apache.pulsar.io.core.annotations: Type of the io connector.

KeyValue<K,V> - Class in org.apache.pulsar.io.core: A simple KeyValue class.
KeyValue(K, V) - Constructor for class org.apache.pulsar.io.core.KeyValue

name() - Element in annotation interface org.apache.pulsar.io.core.annotations.Connector: Name of the connector.
newConsumerBuilder(Schema<T>) - Method in interface org.apache.pulsar.io.core.SourceContext: Create a ConsumerBuilder with the schema.
newOutputMessage(String, Schema<T>) - Method in interface org.apache.pulsar.io.core.SourceContext: New output message using schema for serializing to the topic.
notifyError(Exception) - Method in class org.apache.pulsar.io.core.AbstractPushSource: Allows the source to notify errors asynchronously.

open(Map<String, Object>, SinkContext) - Method in interface org.apache.pulsar.io.core.Sink: Open connector with configuration.
open(Map<String, Object>, SourceContext) - Method in interface org.apache.pulsar.io.core.BatchSource: Open connector with configuration.
open(Map<String, Object>, SourceContext) - Method in interface org.apache.pulsar.io.core.Source: Open connector with configuration.
org.apache.pulsar.io.core - package org.apache.pulsar.io.core
org.apache.pulsar.io.core.annotations - package org.apache.pulsar.io.core.annotations

pause(String, int) - Method in interface org.apache.pulsar.io.core.SinkContext: Stop requesting new messages for given topic and partition until SinkContext.resume(String topic, int partition) is called.
prepare(byte[]) - Method in interface org.apache.pulsar.io.core.BatchSource: Called when a new task appears for this connector instance.
PushSource<T> - Class in org.apache.pulsar.io.core: Pulsar's Push Source interface.
PushSource() - Constructor for class org.apache.pulsar.io.core.PushSource

read() - Method in class org.apache.pulsar.io.core.PushSource
read() - Method in interface org.apache.pulsar.io.core.Source: Reads the next message from source.
readNext() - Method in class org.apache.pulsar.io.core.AbstractPushSource
readNext() - Method in class org.apache.pulsar.io.core.BatchPushSource
readNext() - Method in interface org.apache.pulsar.io.core.BatchSource: Read data and return a record.
required() - Element in annotation interface org.apache.pulsar.io.core.annotations.FieldDoc: Return if the field is required or not.
resume(String, int) - Method in interface org.apache.pulsar.io.core.SinkContext: Resume requesting messages.

seek(String, int, MessageId) - Method in interface org.apache.pulsar.io.core.SinkContext: Reset the subscription associated with this topic and partition to a specific message id.
sensitive() - Element in annotation interface org.apache.pulsar.io.core.annotations.FieldDoc: Return if the field is a sensitive type or not.
setKey(K) - Method in class org.apache.pulsar.io.core.KeyValue
setValue(V) - Method in class org.apache.pulsar.io.core.KeyValue
Sink<T> - Interface in org.apache.pulsar.io.core: Generic sink interface users can implement to run Sink on top of Pulsar Functions.
SINK - Enum constant in enum class org.apache.pulsar.io.core.annotations.IOType: Sink connector.
SinkContext - Interface in org.apache.pulsar.io.core: Interface for a sink connector providing information about environment where it is running.
Source<T> - Interface in org.apache.pulsar.io.core
SOURCE - Enum constant in enum class org.apache.pulsar.io.core.annotations.IOType: Source connector.
SourceContext - Interface in org.apache.pulsar.io.core: Interface for a source connector providing information about environment where it is running.
start(Consumer<String>) - Method in interface org.apache.pulsar.io.core.BatchSourceTriggerer: Triggerer should actually start looking out for trigger conditions.
stop() - Method in interface org.apache.pulsar.io.core.BatchSourceTriggerer: Triggerer should stop triggering.

type() - Element in annotation interface org.apache.pulsar.io.core.annotations.Connector: Type of the connector.

valueOf(String) - Static method in enum class org.apache.pulsar.io.core.annotations.IOType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.apache.pulsar.io.core.annotations.IOType: Returns an array containing the constants of this enum class, in the order they are declared.

write(Record<T>) - Method in interface org.apache.pulsar.io.core.Sink: Write a message to Sink.