Package org.apache.pulsar.functions.api.state

Interface ByteBufferStateStore

  • All Superinterfaces:
    java.lang.AutoCloseable, StateStore
    public interface ByteBufferStateStore
extends StateStore
    A key-value state store that stores values in ByteBuffer.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void delete​(java.lang.String key)
      Delete the state value for the key.
      java.util.concurrent.CompletableFuture<java.lang.Void> deleteAsync​(java.lang.String key)
      Delete the state value for the key, but don't wait for the operation to be completed
      java.nio.ByteBuffer get​(java.lang.String key)
      Retrieve the state value for the key.
      java.util.concurrent.CompletableFuture<java.nio.ByteBuffer> getAsync​(java.lang.String key)
      Retrieve the state value for the key, but don't wait for the operation to be completed
      void put​(java.lang.String key, java.nio.ByteBuffer value)
      Update the state value for the key.
      java.util.concurrent.CompletableFuture<java.lang.Void> putAsync​(java.lang.String key, java.nio.ByteBuffer value)
      Update the state value for the key, but don't wait for the operation to be completed

    • Method Detail

      • put

        void put​(java.lang.String key,
         java.nio.ByteBuffer value)
        Update the state value for the key.
        Parameters:
        key - name of the key
        value - state value of the key

      • putAsync

        java.util.concurrent.CompletableFuture<java.lang.Void> putAsync​(java.lang.String key,
                                                                java.nio.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​(java.lang.String key)
        Delete the state value for the key.
        Parameters:
        key - name of the key

      • deleteAsync

        java.util.concurrent.CompletableFuture<java.lang.Void> deleteAsync​(java.lang.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

        java.nio.ByteBuffer get​(java.lang.String key)
        Retrieve the state value for the key.
        Parameters:
        key - name of the key
        Returns:
        the state value for the key.

      • getAsync

        java.util.concurrent.CompletableFuture<java.nio.ByteBuffer> getAsync​(java.lang.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.