Class TransportConfig.Builder

java.lang.Object
codes.grow.packages.betterstack.core.TransportConfig.Builder
Enclosing class:
TransportConfig

public static final class TransportConfig.Builder extends Object
Builder for TransportConfig.
  • Method Details

    • connectTimeout

      public TransportConfig.Builder connectTimeout(Duration d)
      Sets the connect timeout.
      Parameters:
      d - positive duration
      Returns:
      this builder
    • requestTimeout

      public TransportConfig.Builder requestTimeout(Duration d)
      Sets the per-attempt timeout.
      Parameters:
      d - positive duration
      Returns:
      this builder
    • totalTimeout

      public TransportConfig.Builder totalTimeout(Duration d)
      Sets the total budget per call.
      Parameters:
      d - positive duration
      Returns:
      this builder
    • retry

      public TransportConfig.Builder retry(RetryPolicy retry)
      Sets the retry policy.
      Parameters:
      retry - policy
      Returns:
      this builder
    • tls

      Sets the TLS options.
      Parameters:
      tls - options
      Returns:
      this builder
    • proxy

      public TransportConfig.Builder proxy(String proxy)
      Sets an explicit HTTP proxy URL, e.g. http://user:pass@proxy:3128.
      Parameters:
      proxy - proxy URL, or null for a direct connection
      Returns:
      this builder
    • headers

      public TransportConfig.Builder headers(Map<String,String> headers)
      Adds headers sent with every request.
      Parameters:
      headers - header map
      Returns:
      this builder
    • userAgentSuffix

      public TransportConfig.Builder userAgentSuffix(String suffix)
      Sets the text appended to the standard user agent.
      Parameters:
      suffix - suffix, or null
      Returns:
      this builder
    • hooks

      public TransportConfig.Builder hooks(Hooks hooks)
      Sets the hooks.
      Parameters:
      hooks - hooks, null for none
      Returns:
      this builder
    • logger

      public TransportConfig.Builder logger(Logger logger)
      Sets the logger.
      Parameters:
      logger - logger, null for silent
      Returns:
      this builder
    • knownSecrets

      public TransportConfig.Builder knownSecrets(Supplier<Collection<String>> knownSecrets)
      Sets the supplier of secret values to redact from errors, hooks and logs.
      Parameters:
      knownSecrets - supplier evaluated when an error message is built
      Returns:
      this builder
    • clock

      public TransportConfig.Builder clock(Clock clock)
      Sets the clock (tests).
      Parameters:
      clock - clock
      Returns:
      this builder
    • retryAfterHeaders

      public TransportConfig.Builder retryAfterHeaders(String... names)
      Adds vendor headers read as a retry hint when a 429 or 503 response has no Retry-After (for example X-RateLimit-Reset). Values are delay seconds, Unix epoch seconds or an HTTP-date (RetryPolicy.parseRateLimitReset(java.lang.String, java.time.Instant)).
      Parameters:
      names - header names (case-insensitive), in lookup order
      Returns:
      this builder
    • errorMapper

      public TransportConfig.Builder errorMapper(ErrorMapper errorMapper)
      Sets the service error mapper (see ErrorMapper).
      Parameters:
      errorMapper - the mapper, or null for none
      Returns:
      this builder
    • build

      public TransportConfig build()
      Builds the configuration.
      Returns:
      the configuration