org.apache.pulsar.functions.api

Interface BaseContext

All Known Subinterfaces:

Context

@InterfaceAudience.Public
 @InterfaceStability.Stable
public interface BaseContext

BaseContext provides base contextual information to the executing function/source/sink. It allows to propagate information, such as pulsar environment, logs, metrics, states etc.

Method Summary

Modifier and Type	Method and Description
void	deleteState(String key) Delete the state value for the key.
CompletableFuture<Void>	deleteStateAsync(String key) Delete the state value for the key, but don't wait for the operation to be completed
long	getCounter(String key) Retrieve the counter value for the key.
CompletableFuture<Long>	getCounterAsync(String key) Retrieve the counter value for the key, but don't wait for the operation to be completed
int	getInstanceId() The id of the instance that invokes this component.
org.slf4j.Logger	getLogger() The logger object that can be used to log in a component.
String	getNamespace() The namespace this component belongs to.
int	getNumInstances() Get the number of instances that invoke this component.
default PulsarClient	getPulsarClient() Get the pulsar client.
String	getSecret(String secretName) Get the secret associated with this key.
ByteBuffer	getState(String key) Retrieve the state value for the key.
CompletableFuture<ByteBuffer>	getStateAsync(String key) Retrieve the state value for the key, but don't wait for the operation to be completed
default <S extends StateStore> S	getStateStore(String name) Get the state store with the provided store name in the tenant & namespace.
default <S extends StateStore> S	getStateStore(String tenant, String ns, String name) Get the state store with the provided store name.
String	getTenant() The tenant this component belongs to.
void	incrCounter(String key, long amount) Increment the builtin distributed counter referred by key.
CompletableFuture<Void>	incrCounterAsync(String key, long amount) Increment the builtin distributed counter referred by key but dont wait for the completion of the increment operation
void	putState(String key, ByteBuffer value) Update the state value for the key.
CompletableFuture<Void>	putStateAsync(String key, ByteBuffer value) Update the state value for the key, but don't wait for the operation to be completed
void	recordMetric(String metricName, double value) Record a user defined metric

Method Detail

getTenant

String getTenant()

The tenant this component belongs to.

Returns:

the tenant this component belongs to

getNamespace

String getNamespace()

The namespace this component belongs to.

Returns:

the namespace this component belongs to

getInstanceId

int getInstanceId()

The id of the instance that invokes this component.

Returns:

the instance id

getNumInstances

int getNumInstances()

Get the number of instances that invoke this component.

Returns:

the number of instances that invoke this component.

getLogger

org.slf4j.Logger getLogger()

The logger object that can be used to log in a component.

Returns:

the logger object

getSecret

String getSecret(String secretName)

Get the secret associated with this key.

Parameters:

secretName - The name of the secret

Returns:

The secret if anything was found or null

getStateStore

default <S extends StateStore> S getStateStore(String name)

Get the state store with the provided store name in the tenant & namespace.

Type Parameters:

S - the type of interface of the store to return

Parameters:

name - the state store name

Returns:

the state store instance.

Throws:

ClassCastException - if the return type isn't a type or interface of the actual returned store.

getStateStore

default <S extends StateStore> S getStateStore(String tenant,
                                               String ns,
                                               String name)

Get the state store with the provided store name.

Type Parameters:

S - the type of interface of the store to return

Parameters:

tenant - the state tenant name

ns - the state namespace name

name - the state store name

Returns:

the state store instance.

Throws:

ClassCastException - if the return type isn't a type or interface of the actual returned store.

putState

void putState(String key,
              ByteBuffer value)

Update the state value for the key.

Parameters:

key - name of the key

value - state value of the key

putStateAsync

CompletableFuture<Void> putStateAsync(String key,
                                      ByteBuffer value)

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

Parameters:

key - name of the key

value - state value of the key

getState

ByteBuffer getState(String key)

Retrieve the state value for the key.

Parameters:

key - name of the key

Returns:

the state value for the key.

getStateAsync

CompletableFuture<ByteBuffer> getStateAsync(String key)

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

Parameters:

key - name of the key

Returns:

the state value for the key.

deleteState

void deleteState(String key)

Delete the state value for the key.

Parameters:

key - name of the key

deleteStateAsync

CompletableFuture<Void> deleteStateAsync(String key)

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

Parameters:

key - name of the key

incrCounter

void incrCounter(String key,
                 long amount)

Increment the builtin distributed counter referred by key.

Parameters:

key - The name of the key

amount - The amount to be incremented

incrCounterAsync

CompletableFuture<Void> incrCounterAsync(String key,
                                         long amount)

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

Parameters:

key - The name of the key

amount - The amount to be incremented

getCounter

long getCounter(String key)

Retrieve the counter value for the key.

Parameters:

key - name of the key

Returns:

the amount of the counter value for this key

getCounterAsync

CompletableFuture<Long> getCounterAsync(String key)

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

Parameters:

key - name of the key

Returns:

the amount of the counter value for this key

recordMetric

void recordMetric(String metricName,
                  double value)

Record a user defined metric

Parameters:

metricName - The name of the metric

value - The value of the metric

getPulsarClient

default PulsarClient getPulsarClient()

Get the pulsar client.

Returns:

the instance of pulsar client