Index (Pulsar Functions :: API 3.1.0 API)

A B C D F G I J K N O P R S T W
All Classes and Interfaces|All Packages

A

ack() - Method in interface org.apache.pulsar.functions.api.Record: Acknowledge that this record is fully processed.
apply(Object) - Method in class org.apache.pulsar.functions.api.utils.IdentityFunction

B

BaseContext - Interface in org.apache.pulsar.functions.api: BaseContext provides base contextual information to the executing function/source/sink.
ByteBufferStateStore - Interface in org.apache.pulsar.functions.api.state: A key-value state store that stores values in ByteBuffer.

C

close() - Method in interface org.apache.pulsar.functions.api.Function: Called once to properly close resources when function instance is stopped.
close() - Method in interface org.apache.pulsar.functions.api.StateStore
Context - Interface in org.apache.pulsar.functions.api: Context provides contextual information to the executing function.
CounterStateStore - Interface in org.apache.pulsar.functions.api.state: The state store supports counters.

D

delete(String) - Method in interface org.apache.pulsar.functions.api.state.ByteBufferStateStore: Delete the state value for the key.
deleteAsync(String) - Method in interface org.apache.pulsar.functions.api.state.ByteBufferStateStore: Delete the state value for the key, but don't wait for the operation to be completed.
deleteState(String) - Method in interface org.apache.pulsar.functions.api.BaseContext: Delete the state value for the key.
deleteStateAsync(String) - Method in interface org.apache.pulsar.functions.api.BaseContext: Delete the state value for the key, but don't wait for the operation to be completed.
deserialize(byte[]) - Method in interface org.apache.pulsar.functions.api.SerDe
deserialize(byte[]) - Method in class org.apache.pulsar.functions.api.utils.JavaSerDe

F

fail() - Method in interface org.apache.pulsar.functions.api.Record: To indicate that this record has failed to be processed.
fqsn() - Method in interface org.apache.pulsar.functions.api.StateStore: The fully qualified state store name.
from(Context, Schema<T>) - Static method in class org.apache.pulsar.functions.api.utils.FunctionRecord: Creates a builder for a Record from a Function Context.
Function<X,T> - Interface in org.apache.pulsar.functions.api: This is the core interface of the function api.
FunctionRecord<T> - Class in org.apache.pulsar.functions.api.utils
FunctionRecord() - Constructor for class org.apache.pulsar.functions.api.utils.FunctionRecord
FunctionRecord.FunctionRecordBuilder<T> - Class in org.apache.pulsar.functions.api.utils

G

get(String) - Method in interface org.apache.pulsar.functions.api.state.ByteBufferStateStore: Retrieve the state value for the key.
getAsync(String) - Method in interface org.apache.pulsar.functions.api.state.ByteBufferStateStore: Retrieve the state value for the key, but don't wait for the operation to be completed.
getCounter(String) - Method in interface org.apache.pulsar.functions.api.BaseContext: Retrieve the counter value for the key.
getCounter(String) - Method in interface org.apache.pulsar.functions.api.state.CounterStateStore: Retrieve the counter value for the key.
getCounter(String) - Method in interface org.apache.pulsar.functions.api.WindowContext: Retrieve the counter value for the key.
getCounterAsync(String) - Method in interface org.apache.pulsar.functions.api.BaseContext: 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.functions.api.state.CounterStateStore: Retrieve the counter value for the key, but don't wait for the operation to be completed.
getCurrentRecord() - Method in interface org.apache.pulsar.functions.api.Context: Access the record associated with the current input value.
getDestinationTopic() - Method in interface org.apache.pulsar.functions.api.Record: To support message routing on a per message basis.
getDestinationTopic() - Method in class org.apache.pulsar.functions.api.utils.FunctionRecord
getEventTime() - Method in interface org.apache.pulsar.functions.api.Record: Retrieves the event time of the record from the source.
getEventTime() - Method in class org.apache.pulsar.functions.api.utils.FunctionRecord
getFunctionId() - Method in interface org.apache.pulsar.functions.api.Context: The id of the function that we are executing.
getFunctionId() - Method in interface org.apache.pulsar.functions.api.WindowContext: The id of the function that we are executing.
getFunctionName() - Method in interface org.apache.pulsar.functions.api.Context: The name of the function that we are executing.
getFunctionName() - Method in interface org.apache.pulsar.functions.api.WindowContext: The name of the function that we are executing.
getFunctionVersion() - Method in interface org.apache.pulsar.functions.api.Context: The version of the function that we are executing.
getFunctionVersion() - Method in interface org.apache.pulsar.functions.api.WindowContext: The version of the function that we are executing.
getInputTopics() - Method in interface org.apache.pulsar.functions.api.Context: Get a list of all input topics.
getInputTopics() - Method in interface org.apache.pulsar.functions.api.WindowContext: Get a list of all input topics.
getInstanceId() - Method in interface org.apache.pulsar.functions.api.BaseContext: The id of the instance that invokes this component.
getInstanceId() - Method in interface org.apache.pulsar.functions.api.WindowContext: The id of the instance that invokes this function.
getKey() - Method in interface org.apache.pulsar.functions.api.Record: Return a key if the key has one associated.
getKey() - Method in class org.apache.pulsar.functions.api.utils.FunctionRecord
getKeySchema() - Method in interface org.apache.pulsar.functions.api.KVRecord
getKeyValueEncodingType() - Method in interface org.apache.pulsar.functions.api.KVRecord
getLogger() - Method in interface org.apache.pulsar.functions.api.BaseContext: The logger object that can be used to log in a component.
getLogger() - Method in interface org.apache.pulsar.functions.api.WindowContext: The logger object that can be used to log in a function.
getMessage() - Method in interface org.apache.pulsar.functions.api.Record
getNamespace() - Method in interface org.apache.pulsar.functions.api.BaseContext: The namespace this component belongs to.
getNamespace() - Method in interface org.apache.pulsar.functions.api.WindowContext: The namespace this function belongs to.
getNumInstances() - Method in interface org.apache.pulsar.functions.api.BaseContext: Get the number of instances that invoke this component.
getNumInstances() - Method in interface org.apache.pulsar.functions.api.WindowContext: Get the number of instances that invoke this function.
getOutputSchemaType() - Method in interface org.apache.pulsar.functions.api.Context: Get output schema builtin type or custom class name.
getOutputSchemaType() - Method in interface org.apache.pulsar.functions.api.WindowContext: Get output schema builtin type or custom class name.
getOutputTopic() - Method in interface org.apache.pulsar.functions.api.Context: Get the output topic of the source.
getOutputTopic() - Method in interface org.apache.pulsar.functions.api.WindowContext: Get the output topic of the function.
getPartitionId() - Method in interface org.apache.pulsar.functions.api.Record: Retrieves the partition information if any of the record.
getPartitionId() - Method in class org.apache.pulsar.functions.api.utils.FunctionRecord
getPartitionIndex() - Method in interface org.apache.pulsar.functions.api.Record: Retrieves the partition index if any of the record.
getPartitionIndex() - Method in class org.apache.pulsar.functions.api.utils.FunctionRecord
getProperties() - Method in interface org.apache.pulsar.functions.api.Record: Retrieves user-defined properties attached to record.
getProperties() - Method in class org.apache.pulsar.functions.api.utils.FunctionRecord
getPulsarAdmin() - Method in interface org.apache.pulsar.functions.api.Context: Get the pulsar admin client.
getPulsarClient() - Method in interface org.apache.pulsar.functions.api.BaseContext: Get the pre-configured pulsar client.
getPulsarClientBuilder() - Method in interface org.apache.pulsar.functions.api.BaseContext: Get the pre-configured pulsar client builder.
getRecordSequence() - Method in interface org.apache.pulsar.functions.api.Record: Retrieves the sequence of the record from a source partition.
getRecordSequence() - Method in class org.apache.pulsar.functions.api.utils.FunctionRecord
getSchema() - Method in interface org.apache.pulsar.functions.api.Record
getSchema() - Method in class org.apache.pulsar.functions.api.utils.FunctionRecord
getSecret(String) - Method in interface org.apache.pulsar.functions.api.BaseContext: Get the secret associated with this key.
getState(String) - Method in interface org.apache.pulsar.functions.api.BaseContext: Retrieve the state value for the key.
getState(String) - Method in interface org.apache.pulsar.functions.api.WindowContext: Retrieve the state value for the key.
getStateAsync(String) - Method in interface org.apache.pulsar.functions.api.BaseContext: 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.functions.api.BaseContext: Get the state store with the provided store name in the tenant & namespace.
getStateStore(String, String, String) - Method in interface org.apache.pulsar.functions.api.BaseContext: Get the state store with the provided store name.
getTenant() - Method in interface org.apache.pulsar.functions.api.BaseContext: The tenant this component belongs to.
getTenant() - Method in interface org.apache.pulsar.functions.api.WindowContext: The tenant this function belongs to.
getTopicName() - Method in interface org.apache.pulsar.functions.api.Record: If the record originated from a topic, report the topic name.
getTopicName() - Method in class org.apache.pulsar.functions.api.utils.FunctionRecord
getUserConfigMap() - Method in interface org.apache.pulsar.functions.api.Context: Get a map of all user-defined key/value configs for the function.
getUserConfigMap() - Method in interface org.apache.pulsar.functions.api.WindowContext: Get a map of all user-defined key/value configs for the function.
getUserConfigValue(String) - Method in interface org.apache.pulsar.functions.api.Context: Get any user-defined key/value.
getUserConfigValue(String) - Method in interface org.apache.pulsar.functions.api.WindowContext: Get any user-defined key/value.
getUserConfigValueOrDefault(String, Object) - Method in interface org.apache.pulsar.functions.api.Context: Get any user-defined key/value or a default value if none is present.
getUserConfigValueOrDefault(String, Object) - Method in interface org.apache.pulsar.functions.api.WindowContext: Get any user-defined key/value or a default value if none is present.
getValue() - Method in interface org.apache.pulsar.functions.api.Record: Retrieves the actual data of the record.
getValue() - Method in class org.apache.pulsar.functions.api.utils.FunctionRecord
getValueSchema() - Method in interface org.apache.pulsar.functions.api.KVRecord

I

IdentityFunction - Class in org.apache.pulsar.functions.api.utils
IdentityFunction() - Constructor for class org.apache.pulsar.functions.api.utils.IdentityFunction
incrCounter(String, long) - Method in interface org.apache.pulsar.functions.api.BaseContext: Increment the builtin distributed counter referred by key.
incrCounter(String, long) - Method in interface org.apache.pulsar.functions.api.state.CounterStateStore: Increment the builtin distributed counter referred by key.
incrCounter(String, long) - Method in interface org.apache.pulsar.functions.api.WindowContext: Increment the builtin distributed counter referred by key.
incrCounterAsync(String, long) - Method in interface org.apache.pulsar.functions.api.BaseContext: 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.functions.api.state.CounterStateStore: Increment the builtin distributed counter referred by key but dont wait for the completion of the increment operation.
init(StateStoreContext) - Method in interface org.apache.pulsar.functions.api.StateStore: Initialize the state store.
initialize(Context) - Method in interface org.apache.pulsar.functions.api.Function: Called once to initialize resources when function instance is started.

J

JavaSerDe - Class in org.apache.pulsar.functions.api.utils: Java Serialization based SerDe.
JavaSerDe() - Constructor for class org.apache.pulsar.functions.api.utils.JavaSerDe

K

KVRecord<K,V> - Interface in org.apache.pulsar.functions.api: key value schema record.

N

name() - Method in interface org.apache.pulsar.functions.api.StateStore: The name of this store.
namespace() - Method in interface org.apache.pulsar.functions.api.StateStore: The namespace of this store.
newConsumerBuilder(Schema<X>) - Method in interface org.apache.pulsar.functions.api.Context: Create a ConsumerBuilder with the schema.
newOutputMessage(String, Schema<X>) - Method in interface org.apache.pulsar.functions.api.Context: New output message using schema for serializing to the topic.
newOutputRecordBuilder(Schema<X>) - Method in interface org.apache.pulsar.functions.api.Context: Creates a FunctionRecordBuilder initialized with values from this Context.

O

of() - Static method in class org.apache.pulsar.functions.api.utils.JavaSerDe
org.apache.pulsar.functions.api - package org.apache.pulsar.functions.api: Provides a simple model for enabling lightweight computation on Apache Pulsar.
org.apache.pulsar.functions.api.state - package org.apache.pulsar.functions.api.state: State Store API.
org.apache.pulsar.functions.api.utils - package org.apache.pulsar.functions.api.utils: State Store API.

P

process(Collection<Record<X>>, WindowContext) - Method in interface org.apache.pulsar.functions.api.WindowFunction: Process the input.
process(X, Context) - Method in interface org.apache.pulsar.functions.api.Function: Process the input.
publish(String, T) - Method in interface org.apache.pulsar.functions.api.WindowContext: Publish an object to the topic using default schemas.
publish(String, T, String) - Method in interface org.apache.pulsar.functions.api.WindowContext: Publish an object using serDe for serializing to the topic.
publish(String, X) - Method in interface org.apache.pulsar.functions.api.Context: Deprecated.
in favor of using Context.newOutputMessage(String, Schema)
publish(String, X, String) - Method in interface org.apache.pulsar.functions.api.Context: Deprecated.
in favor of using Context.newOutputMessage(String, Schema)
put(String, ByteBuffer) - Method in interface org.apache.pulsar.functions.api.state.ByteBufferStateStore: Update the state value for the key.
putAsync(String, ByteBuffer) - Method in interface org.apache.pulsar.functions.api.state.ByteBufferStateStore: Update the state value for the key, but don't wait for the operation to be completed.
putState(String, ByteBuffer) - Method in interface org.apache.pulsar.functions.api.BaseContext: Update the state value for the key.
putState(String, ByteBuffer) - Method in interface org.apache.pulsar.functions.api.WindowContext: Update the state value for the key.
putStateAsync(String, ByteBuffer) - Method in interface org.apache.pulsar.functions.api.BaseContext: Update the state value for the key, but don't wait for the operation to be completed.

R

Record<T> - Interface in org.apache.pulsar.functions.api: Pulsar IO's Record interface.
recordMetric(String, double) - Method in interface org.apache.pulsar.functions.api.BaseContext: Record a user defined metric.
recordMetric(String, double) - Method in interface org.apache.pulsar.functions.api.WindowContext: Record a user defined metric.

S

SerDe<T> - Interface in org.apache.pulsar.functions.api: An interface for serializer/deserializer.
serialize(Object) - Method in class org.apache.pulsar.functions.api.utils.JavaSerDe
serialize(T) - Method in interface org.apache.pulsar.functions.api.SerDe
StateStore - Interface in org.apache.pulsar.functions.api
StateStoreContext - Interface in org.apache.pulsar.functions.api: State Store Context Interface.

T

tenant() - Method in interface org.apache.pulsar.functions.api.StateStore: The tenant of this store.

W

WindowContext - Interface in org.apache.pulsar.functions.api
WindowFunction<X,T> - Interface in org.apache.pulsar.functions.api: This is the interface of the windowed function api.

A B C D F G I J K N O P R S T W
All Classes and Interfaces|All Packages