Package io.deephaven.uri

Interface PersistentQueryURI.Builder

Enclosing class:
PersistentQueryURI
public static interface PersistentQueryURI.Builder
A Builder for a PersistentQueryURI

  • Method Details

    • pqIdentifier

      @NotNull @NotNull PersistentQueryURI.Builder pqIdentifier(@NotNull @NotNull String identifier)
      Set the identifier of the Persistent Query. This may be its serial, or its name.
      Parameters:
      identifier - the id
      Returns:
      this builder

    • variableName

      @NotNull @NotNull PersistentQueryURI.Builder variableName(@NotNull @NotNull String name)
      Set the name of the variable to fetch.
      Parameters:
      name - the variable name
      Returns:
      this builder

    • isSnapshot

      @NotNull @NotNull PersistentQueryURI.Builder isSnapshot(boolean isSnapshot)
      Set if the fetched result should be a static snapshot (defaults to false).
      Parameters:
      isSnapshot - if the result should be a static snapshot
      Returns:
      this builder

    • clearOnDisconnect

      @NotNull @NotNull PersistentQueryURI.Builder clearOnDisconnect(boolean clearOnDisconnect)
      Set if the table should clear its rows on a disconnect (defaults to true).
      Parameters:
      clearOnDisconnect - if the table should clear its rows when disconnected
      Returns:
      this builder

    • retryWindowMillis

      @NotNull @NotNull PersistentQueryURI.Builder retryWindowMillis(long windowMillis)
      Set timeout for reconnection in milliseconds (defaults to 5 minutes)
      Parameters:
      windowMillis - the window in milliseconds
      Returns:
      this builder

    • maxRetriesInWindow

      @NotNull @NotNull PersistentQueryURI.Builder maxRetriesInWindow(int maxRetries)
      Set the maximum number of retries allowed in the retryWindowMillis(long). (defaults to 0, unlimited)
      Parameters:
      maxRetries - the maximum number of retries allowed (0 is unlimited)
      Returns:
      this builder

    • addIncludedColumns

      @NotNull @NotNull PersistentQueryURI.Builder addIncludedColumns(@NotNull @NotNull String... includedColumns)
      Set the columns to include from the upstream table.
      Parameters:
      includedColumns - the columns to include.
      Returns:
      this PersistentQueryURI.Builder

    • addAllIncludedColumns

      @NotNull @NotNull PersistentQueryURI.Builder addAllIncludedColumns(@NotNull @NotNull Iterable<String> includedColumns)
      Set the columns to include from the upstream table.
      Parameters:
      includedColumns - the columns to include.
      Returns:
      this PersistentQueryURI.Builder

    • isBlink

      @NotNull @NotNull PersistentQueryURI.Builder isBlink(boolean isBlink)
      Set if the table should be a blink table. When this option is set the remote table must also be a blink table, or the subscription will fail. If the remote table is a blink table and this is not set, the subscription will work and will appear as a normal ticking table that is empty unless data arrived in the current cycle.
      Parameters:
      isBlink - if the table should be a blink table.
      Returns:
      this PersistentQueryURI.Builder

    • waitTimeout

      @NotNull @NotNull PersistentQueryURI.Builder waitTimeout(@NotNull @NotNull Duration waitTimeout)
      Set the timeout to wait for the initial snapshot.
      Parameters:
      waitTimeout - the timeout duration
      Returns:
      this PersistentQueryURI.Builder

    • build

      @NotNull @NotNull PersistentQueryURI build()
      Construct a new PersistentQueryURI from this builder's state.
      Returns:
      a new URI