B C D F G I K N O P R S V W

B

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.

C

Connector - Annotation Type in org.apache.pulsar.io.core.annotations

Annotation for documenting connectors.

ConnectorContext - Interface in org.apache.pulsar.io.core

Interface for a connector providing information about environment where it is running.

consume(Record<T>) - Method in class org.apache.pulsar.io.core.BatchPushSource

Send this message to be written to Pulsar.

consume(Record<T>) - Method in class org.apache.pulsar.io.core.PushSource

Attach a consumer function to this Source.

D

deleteState(String) - Method in interface org.apache.pulsar.io.core.ConnectorContext

Delete the state value for the key.

deleteStateAsync(String) - Method in interface org.apache.pulsar.io.core.ConnectorContext

Delete the state value for the key, but don't wait for the operation to be completed

discover(Consumer<byte[]>) - Method in interface org.apache.pulsar.io.core.BatchSource

Discovery phase of a connector.

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.ConnectorContext

Retrieve the counter value for the key.

getCounterAsync(String) - Method in interface org.apache.pulsar.io.core.ConnectorContext

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.ConnectorContext

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.ConnectorContext

The logger object that can be used to log in a sink

getNamespace() - Method in interface org.apache.pulsar.io.core.ConnectorContext

The namespace this source belongs to.

getNumInstances() - Method in interface org.apache.pulsar.io.core.ConnectorContext

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.BatchPushSource

Get length of the queue that records are push onto Users can override this method to customize the queue length

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.ConnectorContext

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.ConnectorContext

Retrieve the state value for the key.

getStateAsync(String) - Method in interface org.apache.pulsar.io.core.ConnectorContext

Retrieve the state value for the key, but don't wait for the operation to be completed

getStateStore(String) - Method in interface org.apache.pulsar.io.core.ConnectorContext

Get the state store with the provided store name.

getSubscriptionType() - Method in interface org.apache.pulsar.io.core.SinkContext

Get subscription type used by the source providing data for the sink

getTenant() - Method in interface org.apache.pulsar.io.core.ConnectorContext

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.ConnectorContext

Increment the builtin distributed counter referred by key.

incrCounterAsync(String, long) - Method in interface org.apache.pulsar.io.core.ConnectorContext

Increment the builtin distributed counter referred by key but dont wait for the completion of the increment operation

init(Map<String, Object>, SourceContext) - Method in interface org.apache.pulsar.io.core.BatchSourceTriggerer

initializes the Triggerer with given config.

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

N

newConsumerBuilder(Schema<O>) - Method in interface org.apache.pulsar.io.core.SourceContext

Create a ConsumerBuilder with the schema.

newOutputMessage(String, Schema<O>) - 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.BatchPushSource

Allows the source to notify errors asynchronously

O

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 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

pause(String, int) - Method in interface org.apache.pulsar.io.core.SinkContext

Stop requesting new messages for given topic and partition until #resume(String topic) 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

putState(String, ByteBuffer) - Method in interface org.apache.pulsar.io.core.ConnectorContext

Update the state value for the key.

putStateAsync(String, ByteBuffer) - Method in interface org.apache.pulsar.io.core.ConnectorContext

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.

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 Return null if no more records are present for this task

recordMetric(String, double) - Method in interface org.apache.pulsar.io.core.ConnectorContext

Record a user defined metric

resume(String, int) - Method in interface org.apache.pulsar.io.core.SinkContext

Resume requesting messages.

S

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.

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

Interface for a sink connector providing information about environment where it is running.

Source<T> - Interface in org.apache.pulsar.io.core

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.

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.

B C D F G I K N O P R S V W