Package com.dnsimple

Class Client.Builder

java.lang.Object
com.dnsimple.Client.Builder
Enclosing class:
Client
public static class Client.Builder extends Object
Builder class to obtain Client instances. By default, builders will provide a Client instance pointing to the production environment, a default user agent header, no access token, and using the default Java11 native HTTP client implementation of HttpRequestFactory.
See Also:

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • sandbox

      public Client.Builder sandbox()
      Use DNSimple API's sandbox environment
      Returns:
      this Builder object

    • apiBase

      public Client.Builder apiBase(String url)
      Use a custom API base URL
      Parameters:
      url - the base URL of the API to be used
      Returns:
      this Builder object

    • apiBase

      public Client.Builder apiBase(URL url)
      Use a custom API base URL
      Parameters:
      url - the base URL of the API to be used
      Returns:
      this Builder object

    • httpRequestFactory

      public Client.Builder httpRequestFactory(HttpRequestFactory factory)
      Use a custom HTTP request factory object
      Parameters:
      factory - factory of HTTP requests to be used
      Returns:
      this Builder object

    • extraUserAgent

      public Client.Builder extraUserAgent(String userAgent)
      Set an extra user agent that will be prefixed to the default
      Parameters:
      userAgent - userAgent string to be prefixed
      Returns:
      this Builder object

    • accessToken

      public Client.Builder accessToken(String accessToken)
      Set a the access token for all API requests. You can set it later directly on the Client object as well.
      Parameters:
      accessToken - the access token to be used
      Returns:
      this Builder object

    • build

      public Client build()
      Builds a Client object with the configured values and returns it.
      Returns:
      the Client object