Interface TransactionBuilder


  • @Public
    @Evolving
    public interface TransactionBuilder
    The builder to build a transaction for Pulsar.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.concurrent.CompletableFuture<Transaction> build()
      Build the transaction with the configured settings.
      TransactionBuilder withTransactionTimeout​(long timeout, java.util.concurrent.TimeUnit timeoutUnit)
      Configure the maximum amount of time that the transaction coordinator will for a transaction to be completed by the client before proactively aborting the ongoing transaction.
    • Method Detail

      • withTransactionTimeout

        TransactionBuilder withTransactionTimeout​(long timeout,
                                                  java.util.concurrent.TimeUnit timeoutUnit)
        Configure the maximum amount of time that the transaction coordinator will for a transaction to be completed by the client before proactively aborting the ongoing transaction.

        The config value will be sent to the transaction coordinator along with the CommandNewTxn. Default is 60 seconds.

        Parameters:
        timeout - the transaction timeout value
        timeoutUnit - the transaction timeout unit
        Returns:
        the transaction builder itself
      • build

        java.util.concurrent.CompletableFuture<Transaction> build()
        Build the transaction with the configured settings.
        Returns:
        a future represents the result of starting a new transaction