Package org.apache.beam.runners.fnexecution.state

Interface StateRequestHandler

public interface StateRequestHandler
Handler for StateRequests.

  • Method Summary

    Modifier and Type
    Method
    Description
    default Iterable<org.apache.beam.model.fnexecution.v1.BeamFnApi.ProcessBundleRequest.CacheToken>
    getCacheTokens()
    Retrieves a list of valid cache tokens.
    CompletionStage<org.apache.beam.model.fnexecution.v1.BeamFnApi.StateResponse.Builder>
    handle(org.apache.beam.model.fnexecution.v1.BeamFnApi.StateRequest request)
    Handle a BeamFnApi.StateRequest asynchronously.
    static StateRequestHandler
    unsupported()
     

  • Method Details

    • handle

      CompletionStage<org.apache.beam.model.fnexecution.v1.BeamFnApi.StateResponse.Builder> handle(org.apache.beam.model.fnexecution.v1.BeamFnApi.StateRequest request) throws Exception
      Handle a BeamFnApi.StateRequest asynchronously.

      The handler is allowed to complete the future within the callers thread if it can be completed without blocking. Otherwise the caller should delegate to another thread to perform any blocking work completing the future when able.

      Throwing an error during handling will complete the handler result CompletionStage exceptionally.

      Throws:
      Exception

    • getCacheTokens

      default Iterable<org.apache.beam.model.fnexecution.v1.BeamFnApi.ProcessBundleRequest.CacheToken> getCacheTokens()
      Retrieves a list of valid cache tokens.

    • unsupported

      static StateRequestHandler unsupported()