org.apache.pulsar.functions.api

Interface Context

All Superinterfaces:

BaseContext

@InterfaceAudience.Public
 @InterfaceStability.Stable
public interface Context
extends BaseContext

Context provides contextual information to the executing function. Features like which message id we are handling, whats the topic name of the message, what are our operating constraints, etc can be accessed by the executing function

Method Summary

Modifier and Type	Method and Description
Record<?>	getCurrentRecord() Access the record associated with the current input value.
String	getFunctionId() The id of the function that we are executing
String	getFunctionName() The name of the function that we are executing.
String	getFunctionVersion() The version of the function that we are executing.
Collection<String>	getInputTopics() Get a list of all input topics.
String	getOutputSchemaType() Get output schema builtin type or custom class name.
String	getOutputTopic() Get the output topic of the source.
PulsarAdmin	getPulsarAdmin() Get the pulsar admin client.
Map<String,Object>	getUserConfigMap() Get a map of all user-defined key/value configs for the function.
Optional<Object>	getUserConfigValue(String key) Get any user-defined key/value.
Object	getUserConfigValueOrDefault(String key, Object defaultValue) Get any user-defined key/value or a default value if none is present.
<O> ConsumerBuilder<O>	newConsumerBuilder(Schema<O> schema) Create a ConsumerBuilder with the schema.
<O> TypedMessageBuilder<O>	newOutputMessage(String topicName, Schema<O> schema) New output message using schema for serializing to the topic
<O> CompletableFuture<Void>	publish(String topicName, O object) Deprecated. in favor of using newOutputMessage(String, Schema)
<O> CompletableFuture<Void>	publish(String topicName, O object, String schemaOrSerdeClassName) Deprecated. in favor of using newOutputMessage(String, Schema)

Methods inherited from interface org.apache.pulsar.functions.api.BaseContext

deleteState, deleteStateAsync, getCounter, getCounterAsync, getInstanceId, getLogger, getNamespace, getNumInstances, getPulsarClient, getSecret, getState, getStateAsync, getStateStore, getStateStore, getTenant, incrCounter, incrCounterAsync, putState, putStateAsync, recordMetric

Method Detail

getInputTopics

Collection<String> getInputTopics()

Get a list of all input topics.

Returns:

a list of all input topics

getOutputTopic

String getOutputTopic()

Get the output topic of the source.

Returns:

output topic name

getCurrentRecord

Record<?> getCurrentRecord()

Access the record associated with the current input value.

Returns:

getOutputSchemaType

String getOutputSchemaType()

Get output schema builtin type or custom class name.

Returns:

output schema builtin type or custom class name

getFunctionName

String getFunctionName()

The name of the function that we are executing.

Returns:

The Function name

getFunctionId

String getFunctionId()

The id of the function that we are executing

Returns:

The function id

getFunctionVersion

String getFunctionVersion()

The version of the function that we are executing.

Returns:

The version id

getUserConfigMap

Map<String,Object> getUserConfigMap()

Get a map of all user-defined key/value configs for the function.

Returns:

The full map of user-defined config values

getUserConfigValue

Optional<Object> getUserConfigValue(String key)

Get any user-defined key/value.

Parameters:

key - The key

Returns:

The Optional value specified by the user for that key.

getUserConfigValueOrDefault

Object getUserConfigValueOrDefault(String key,
                                   Object defaultValue)

Get any user-defined key/value or a default value if none is present.

Parameters:

key -

defaultValue -

Returns:

Either the user config value associated with a given key or a supplied default value

getPulsarAdmin

PulsarAdmin getPulsarAdmin()

Get the pulsar admin client.

Returns:

The instance of pulsar admin client

publish

<O> CompletableFuture<Void> publish(String topicName,
                                    O object,
                                    String schemaOrSerdeClassName)

Deprecated. in favor of using newOutputMessage(String, Schema)

Publish an object using serDe or schema class for serializing to the topic.

Parameters:

topicName - The name of the topic for publishing

object - The object that needs to be published

schemaOrSerdeClassName - Either a builtin schema type (eg: "avro", "json", "protobuf") or the class name of the custom schema class

Returns:

A future that completes when the framework is done publishing the message

publish

<O> CompletableFuture<Void> publish(String topicName,
                                    O object)

Deprecated. in favor of using newOutputMessage(String, Schema)

Publish an object to the topic using default schemas.

Parameters:

topicName - The name of the topic for publishing

object - The object that needs to be published

Returns:

A future that completes when the framework is done publishing the message

newOutputMessage

<O> TypedMessageBuilder<O> newOutputMessage(String topicName,
                                            Schema<O> schema)
                                     throws PulsarClientException

New output message using schema for serializing to the topic

Type Parameters:

O -

Parameters:

topicName - The name of the topic for output message

schema - provide a way to convert between serialized data and domain objects

Returns:

the message builder instance

Throws:

PulsarClientException

newConsumerBuilder

<O> ConsumerBuilder<O> newConsumerBuilder(Schema<O> schema)
                                   throws PulsarClientException

Create a ConsumerBuilder with the schema.

Type Parameters:

O -

Parameters:

schema - provide a way to convert between serialized data and domain objects

Returns:

the consumer builder instance

Throws:

PulsarClientException