Class Client.Builder

  • Enclosing class:
    Client

    public static class Client.Builder
    extends java.lang.Object
    The Builder class allows the configuration of a new instance of the SDK.
    • Method Detail

      • client

        public Client.Builder client​(HTTPClient client)
        Allows the default HTTP client to be overridden with a custom implementation.
        Parameters:
        client - The HTTP client to use for all requests.
        Returns:
        The builder instance.
      • bearer

        public Client.Builder bearer​(java.lang.String bearer)
        Configures the SDK security to use the provided secret.
        Parameters:
        bearer - The secret to use for all requests.
        Returns:
        The builder instance.
      • securitySource

        public Client.Builder securitySource​(SecuritySource securitySource)
        Configures the SDK to use a custom security source.
        Parameters:
        securitySource - The security source to use for all requests.
        Returns:
        The builder instance.
      • serverURL

        public Client.Builder serverURL​(java.lang.String serverUrl)
        Overrides the default server URL.
        Parameters:
        serverUrl - The server URL to use for all requests.
        Returns:
        The builder instance.
      • serverURL

        public Client.Builder serverURL​(java.lang.String serverUrl,
                                        java.util.Map<java.lang.String,​java.lang.String> params)
        Overrides the default server URL with a templated URL populated with the provided parameters.
        Parameters:
        serverUrl - The server URL to use for all requests.
        params - The parameters to use when templating the URL.
        Returns:
        The builder instance.
      • server

        public Client.Builder server​(Client.AvailableServers server)
        Overrides the default server by name.
        Parameters:
        server - The server to use for all requests.
        Returns:
        The builder instance.
      • retryConfig

        public Client.Builder retryConfig​(RetryConfig retryConfig)
        Overrides the default configuration for retries
        Parameters:
        retryConfig - The retry configuration to use for all requests.
        Returns:
        The builder instance.
      • enableHTTPDebugLogging

        public Client.Builder enableHTTPDebugLogging​(boolean enabled)
        Enables debug logging for HTTP requests and responses, including JSON body content.

        Convenience method that calls HTTPClient.enableDebugLogging(boolean). SpeakeasyHTTPClient honors this setting. If you are using a custom HTTP client, it is up to the custom client to honor this setting.

        Parameters:
        enabled - Whether to enable debug logging.
        Returns:
        The builder instance.
      • build

        public Client build()
        Builds a new instance of the SDK.
        Returns:
        The SDK instance.