org.apache.pulsar.functions.api.state

Interface ByteBufferStateStore

All Superinterfaces:

AutoCloseable, StateStore

public interface ByteBufferStateStore
extends StateStore

A key-value state store that stores values in ByteBuffer.

Method Summary

Modifier and Type	Method and Description
void	delete(String key) Delete the state value for the key.
CompletableFuture<Void>	deleteAsync(String key) Delete the state value for the key, but don't wait for the operation to be completed
ByteBuffer	get(String key) Retrieve the state value for the key.
CompletableFuture<ByteBuffer>	getAsync(String key) Retrieve the state value for the key, but don't wait for the operation to be completed
void	put(String key, ByteBuffer value) Update the state value for the key.
CompletableFuture<Void>	putAsync(String key, ByteBuffer value) Update the state value for the key, but don't wait for the operation to be completed

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

close, fqsn, init, name, namespace, tenant

Method Detail

put

void put(String key,
         ByteBuffer value)

Update the state value for the key.

Parameters:

key - name of the key

value - state value of the key

putAsync

CompletableFuture<Void> putAsync(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

delete

void delete(String key)

Delete the state value for the key.

Parameters:

key - name of the key

deleteAsync

CompletableFuture<Void> deleteAsync(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

get

ByteBuffer get(String key)

Retrieve the state value for the key.

Parameters:

key - name of the key

Returns:

the state value for the key.

getAsync

CompletableFuture<ByteBuffer> getAsync(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.