Module com.github.alexdlaird.ngrok

Package com.github.alexdlaird.ngrok.conf

Class JavaNgrokConfig.Builder

java.lang.Object

com.github.alexdlaird.ngrok.conf.JavaNgrokConfig.Builder

Enclosing class:

JavaNgrokConfig

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

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

Constructor Summary

Constructors

Constructor	Description
Builder()	Construct a JavaNgrokConfig Builder.
Builder(JavaNgrokConfig javaNgrokConfig)	Copy a JavaNgrokConfig in to a new Builder.

Method Summary

Modifier and Type	Method	Description
JavaNgrokConfig	build()	Build the JavaNgrokConfig.
JavaNgrokConfig.Builder	withApiKey(java.lang.String apiKey)	A ngrok API key.
JavaNgrokConfig.Builder	withAuthToken(java.lang.String authToken)	A ngrok authtoken to pass to commands (overrides what is in the config).
JavaNgrokConfig.Builder	withConfigPath(java.nio.file.Path configPath)	The path to the ngrok config file, defaults to ngrok's default config location.
JavaNgrokConfig.Builder	withConfigVersion(ConfigVersion configVersion)	The ngrok config version.
JavaNgrokConfig.Builder	withLogEventCallback(java.util.function.Function<NgrokLog,java.lang.Void> logEventCallback)	A callback that will be invoked each time ngrok emits a log.
JavaNgrokConfig.Builder	withMaxLogs(int maxLogs)	The maximum number of ngrok logs to retain in the monitoring thread.
JavaNgrokConfig.Builder	withNgrokPath(java.nio.file.Path ngrokPath)	The path to the ngrok binary, defaults to being placed in the same directory as ngrok's configs.
JavaNgrokConfig.Builder	withNgrokVersion(NgrokVersion ngrokVersion)	The major version of ngrok to be used.
JavaNgrokConfig.Builder	withoutMonitoring()	Don't keep monitoring ngrok (for logs, etc.) after startup is complete.
JavaNgrokConfig.Builder	withRegion(Region region)	The region in which ngrok should start.
JavaNgrokConfig.Builder	withStartupTimeout(int startupTimeout)	The max timeout, in seconds, to wait for ngrok to start.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Construct a JavaNgrokConfig Builder.

Builder

public Builder(JavaNgrokConfig javaNgrokConfig)

Copy a JavaNgrokConfig in to a new Builder.

Parameters:

javaNgrokConfig - The JavaNgrokConfig to copy.

Method Detail

withNgrokVersion

public JavaNgrokConfig.Builder withNgrokVersion(NgrokVersion ngrokVersion)

The major version of ngrok to be used.

withMaxLogs

public JavaNgrokConfig.Builder withMaxLogs(int maxLogs)

The maximum number of ngrok logs to retain in the monitoring thread.

Throws:

java.lang.IllegalArgumentException - The argument was invalid.

withStartupTimeout

public JavaNgrokConfig.Builder withStartupTimeout(int startupTimeout)

The max timeout, in seconds, to wait for ngrok to start.

Throws:

java.lang.IllegalArgumentException - The argument was invalid.

withoutMonitoring

public JavaNgrokConfig.Builder withoutMonitoring()

Don't keep monitoring ngrok (for logs, etc.) after startup is complete.

withNgrokPath

public JavaNgrokConfig.Builder withNgrokPath(java.nio.file.Path ngrokPath)

The path to the ngrok binary, defaults to being placed in the same directory as ngrok's configs.

withConfigPath

public JavaNgrokConfig.Builder withConfigPath(java.nio.file.Path configPath)

The path to the ngrok config file, defaults to ngrok's default config location.

withAuthToken

public JavaNgrokConfig.Builder withAuthToken(java.lang.String authToken)

A ngrok authtoken to pass to commands (overrides what is in the config). If not set here, the JavaNgrokConfig.Builder will attempt to use the environment variable NGROK_AUTHTOKEN if it is set.

withRegion

public JavaNgrokConfig.Builder withRegion(Region region)

The region in which ngrok should start.

withLogEventCallback

public JavaNgrokConfig.Builder withLogEventCallback(java.util.function.Function<NgrokLog,java.lang.Void> logEventCallback)

A callback that will be invoked each time ngrok emits a log. keepMonitoring must be set to true or the function will stop being called after ngrok finishes starting. See JavaNgrokConfig for example usage.

withApiKey

public JavaNgrokConfig.Builder withApiKey(java.lang.String apiKey)

A ngrok API key. If not set here, the JavaNgrokConfig.Builder will attempt to use the environment variable NGROK_API_KEY if it is set.

withConfigVersion

public JavaNgrokConfig.Builder withConfigVersion(ConfigVersion configVersion)

The ngrok config version.

build

public JavaNgrokConfig build()

Build the JavaNgrokConfig.