Class BaseClientJava.Builder

java.lang.Object
com.here.platform.data.client.base.javadsl.BaseClientJava.Builder
Enclosing class:
BaseClientJava

public static class BaseClientJava.Builder extends Object
Builder for BaseClientJava instance.
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • build

      public BaseClient build()
      Creates the BaseClient from the Builder.
    • withCredentials

      public BaseClientJava.Builder withCredentials(Credentials credentials)
      Applies credentials to the BaseClientJava Builder.

      Parameters:
      credentials - optional credentials; default is None
    • withExecutorService

      public BaseClientJava.Builder withExecutorService(ExecutorService executorService)
      Applies an execution context to the BaseClientJava Builder.

      Parameters:
      executorService - the executor service which should be used for execution of internal Futures of Data Client Base library; default is java.util.concurrent.ForkJoinPool.commonPool()
    • withIOExecutorService

      public BaseClientJava.Builder withIOExecutorService(ExecutorService ioExecutorService)
      Applies an IO execution service to the BaseClientJava Builder.

      Parameters:
      ioExecutorService - the Java executor service which is used by underlying OkHttp stack; default is an internal thread pool which is created by OkHttp's Dispatcher()
    • withId

      public BaseClientJava.Builder withId(String baseClientId)
      Applies a client ID to the BaseClientJava Builder.

      Parameters:
      baseClientId - the client ID; default is "here-data-client-base-someRandomUUID"
    • withLocalConfig

      public BaseClientJava.Builder withLocalConfig(com.typesafe.config.Config config)
      Applies a TypeSafe configuration to the BaseClientJava Builder.

      Parameters:
      config - the TypeSafe configuration; default is ConfigFactory.load()
    • withProxySetting

      public BaseClientJava.Builder withProxySetting(ProxySettings proxySettings)
      Applies proxy settings to the BaseClientJava Builder.

      Parameters:
      proxySettings - optional proxy settings; default is None