Index (Pulsar IO :: IO 2.4.1 API)

C F G I K O P R S V W

C

Connector - Annotation Type in org.apache.pulsar.io.core.annotations: Annotation for documenting connectors.
consume(Record<T>) - Method in class org.apache.pulsar.io.core.PushSource: Attach a consumer function to this Source.

F

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

G

getCounter(String) - Method in interface org.apache.pulsar.io.core.SinkContext: Retrieve the counter value for the key.
getCounter(String) - Method in interface org.apache.pulsar.io.core.SourceContext: Retrieve the counter value for the key.
getCounterAsync(String) - Method in interface org.apache.pulsar.io.core.SinkContext: Retrieve the counter value for the key, but don't wait for the operation to be completed
getCounterAsync(String) - Method in interface org.apache.pulsar.io.core.SourceContext: Retrieve the counter value for the key, but don't wait for the operation to be completed
getInputTopics() - Method in interface org.apache.pulsar.io.core.SinkContext: Get a list of all input topics
getInstanceId() - Method in interface org.apache.pulsar.io.core.SinkContext: The id of the instance that invokes this sink.
getInstanceId() - Method in interface org.apache.pulsar.io.core.SourceContext: The id of the instance that invokes this source.
getKey() - Method in class org.apache.pulsar.io.core.KeyValue
getLogger() - Method in interface org.apache.pulsar.io.core.SinkContext: The logger object that can be used to log in a sink
getLogger() - Method in interface org.apache.pulsar.io.core.SourceContext: The logger object that can be used to log in a source
getNamespace() - Method in interface org.apache.pulsar.io.core.SinkContext: The namespace this sink belongs to
getNamespace() - Method in interface org.apache.pulsar.io.core.SourceContext: The namespace this source belongs to
getNumInstances() - Method in interface org.apache.pulsar.io.core.SinkContext: Get the number of instances that invoke this sink.
getNumInstances() - Method in interface org.apache.pulsar.io.core.SourceContext: Get the number of instances that invoke this source.
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.PushSource: Get length of the queue that records are push onto Users can override this method to customize the queue length
getSecret(String) - Method in interface org.apache.pulsar.io.core.SinkContext: Get the secret associated with this key
getSecret(String) - Method in interface org.apache.pulsar.io.core.SourceContext: Get the secret associated with this key
getSinkName() - Method in interface org.apache.pulsar.io.core.SinkContext: The name of the sink that we are executing
getSourceName() - Method in interface org.apache.pulsar.io.core.SourceContext: The name of the source that we are executing
getState(String) - Method in interface org.apache.pulsar.io.core.SinkContext: Retrieve the state value for the key.
getState(String) - Method in interface org.apache.pulsar.io.core.SourceContext: Retrieve the state value for the key.
getStateAsync(String) - Method in interface org.apache.pulsar.io.core.SinkContext: Retrieve the state value for the key, but don't wait for the operation to be completed
getStateAsync(String) - Method in interface org.apache.pulsar.io.core.SourceContext: Retrieve the state value for the key, but don't wait for the operation to be completed
getTenant() - Method in interface org.apache.pulsar.io.core.SinkContext: The tenant this sink belongs to
getTenant() - Method in interface org.apache.pulsar.io.core.SourceContext: The tenant this source belongs to
getValue() - Method in class org.apache.pulsar.io.core.KeyValue

I

incrCounter(String, long) - Method in interface org.apache.pulsar.io.core.SinkContext: Increment the builtin distributed counter referred by key.
incrCounter(String, long) - Method in interface org.apache.pulsar.io.core.SourceContext: Increment the builtin distributed counter referred by key.
incrCounterAsync(String, long) - Method in interface org.apache.pulsar.io.core.SinkContext: Increment the builtin distributed counter referred by key but dont wait for the completion of the increment operation
incrCounterAsync(String, long) - Method in interface org.apache.pulsar.io.core.SourceContext: Increment the builtin distributed counter referred by key but dont wait for the completion of the increment operation
IOType - Enum in org.apache.pulsar.io.core.annotations: Type of the io connector.

K

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

O

open(Map<String, Object>, SourceContext) - Method in class org.apache.pulsar.io.core.PushSource: Open connector with configuration
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.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

P

PushSource<T> - Class in org.apache.pulsar.io.core: Pulsar's Push Source interface.
PushSource() - Constructor for class org.apache.pulsar.io.core.PushSource
putState(String, ByteBuffer) - Method in interface org.apache.pulsar.io.core.SinkContext: Update the state value for the key.
putState(String, ByteBuffer) - Method in interface org.apache.pulsar.io.core.SourceContext: Update the state value for the key.
putStateAsync(String, ByteBuffer) - Method in interface org.apache.pulsar.io.core.SinkContext: Update the state value for the key, but don't wait for the operation to be completed
putStateAsync(String, ByteBuffer) - Method in interface org.apache.pulsar.io.core.SourceContext: Update the state value for the key, but don't wait for the operation to be completed

R

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.
recordMetric(String, double) - Method in interface org.apache.pulsar.io.core.SinkContext: Record a user defined metric
recordMetric(String, double) - Method in interface org.apache.pulsar.io.core.SourceContext: Record a user defined metric

S

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
SinkContext - Interface in org.apache.pulsar.io.core
Source<T> - Interface in org.apache.pulsar.io.core
SourceContext - Interface in org.apache.pulsar.io.core

V

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

W

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

C F G I K O P R S V W