Module com.github.alexdlaird.ngrok

Package com.github.alexdlaird.ngrok

Class NgrokClient.Builder

java.lang.Object

com.github.alexdlaird.ngrok.NgrokClient.Builder

Enclosing class:

NgrokClient

public static class NgrokClient.Builder
extends java.lang.Object

Builder for a NgrokClient, see docs for that class for example usage.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
NgrokClient	build()
NgrokClient.Builder	withHttpClient(HttpClient httpClient)	The class used to make HTTP requests to ngrok's APIs.
NgrokClient.Builder	withJavaNgrokConfig(JavaNgrokConfig javaNgrokConfig)	The java-ngrok to use when interacting with the ngrok binary.
NgrokClient.Builder	withNgrokInstaller(NgrokInstaller ngrokInstaller)	The class used to download and install ngrok.
NgrokClient.Builder	withNgrokProcess(NgrokProcess ngrokProcess)	The class used to manage the ngrok binary.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

withJavaNgrokConfig

public NgrokClient.Builder withJavaNgrokConfig(JavaNgrokConfig javaNgrokConfig)

The java-ngrok to use when interacting with the ngrok binary.

withNgrokInstaller

public NgrokClient.Builder withNgrokInstaller(NgrokInstaller ngrokInstaller)

The class used to download and install ngrok. Only needed if withNgrokProcess(NgrokProcess) is not called.

withNgrokProcess

public NgrokClient.Builder withNgrokProcess(NgrokProcess ngrokProcess)

The class used to manage the ngrok binary.

withHttpClient

public NgrokClient.Builder withHttpClient(HttpClient httpClient)

The class used to make HTTP requests to ngrok's APIs.

build

public NgrokClient build()