Package com.qtsurfer.api.sdk

Class SweepOptions.Builder

java.lang.Object
com.qtsurfer.api.sdk.SweepOptions.Builder
Enclosing class:
SweepOptions
public static final class SweepOptions.Builder extends Object
Fluent builder for SweepOptions.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • onProgress

      public SweepOptions.Builder onProgress(Consumer<SweepProgressEvent> onProgress)
      Parameters:
      onProgress - callback for stage transitions and poll updates
      Returns:
      this builder

    • pollInterval

      public SweepOptions.Builder pollInterval(Duration pollInterval)
      Parameters:
      pollInterval - initial interval between status polls
      Returns:
      this builder

    • maxPollInterval

      public SweepOptions.Builder maxPollInterval(Duration maxPollInterval)
      Parameters:
      maxPollInterval - upper bound of the exponential backoff
      Returns:
      this builder

    • timeout

      public SweepOptions.Builder timeout(Duration timeout)
      Parameters:
      timeout - per-stage timeout; null disables
      Returns:
      this builder

    • ranking

      public SweepOptions.Builder ranking(SweepRanking ranking)
      How to order the leaderboard; null takes the platform default. Has no effect at all alongside SweepOrder.NATURAL.
      Parameters:
      ranking - plateau or raw ordering of the ranked view
      Returns:
      this builder

    • order

      public SweepOptions.Builder order(SweepOrder order)
      Which view of the rows to read; null takes the platform default (SweepOrder.RANKED). Choose SweepOrder.NATURAL to receive every row untruncated — the only route to rows the ranked view dropped.
      Parameters:
      order - the ranked display view or the natural materialisation order
      Returns:
      this builder

    • build

      public SweepOptions build()
      Build the options.
      Returns:
      the immutable options