Package com.stackone.stackone_client_java

Class StackOne.Builder

  • Enclosing class:
    StackOne
    public static class StackOne.Builder
extends java.lang.Object
    The Builder class allows the configuration of a new instance of the SDK.

    • Method Detail

      • client

        public StackOne.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.

      • security

        public StackOne.Builder security​(Security security)
        Configures the SDK to use the provided security details.
        Parameters:
        security - The security details to use for all requests. Can be null.
        Returns:
        The builder instance.

      • securitySource

        public StackOne.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 StackOne.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 StackOne.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.

      • serverIndex

        public StackOne.Builder serverIndex​(int serverIdx)
        Overrides the default server by index.
        Parameters:
        serverIdx - The server to use for all requests.
        Returns:
        The builder instance.

      • retryConfig

        public StackOne.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 StackOne.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.
        Returns:
        The builder instance.

      • build

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