com.github.alexdlaird.ngrok.protocol

Class CreateTunnel.Builder

java.lang.Object

com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder

Enclosing class:

CreateTunnel

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

Builder for a CreateTunnel, which can be used to construct a request that conforms to ngrok's tunnel definition. See docs for that class for example usage.

Constructor Summary

Constructors

Constructor and Description
Builder() Use this constructor if default values should not be populated in required attributes when build() is called.
Builder(boolean setDefaults) Use this constructor if default values should be populated in required attributes when build() is called.
Builder(CreateTunnel createTunnel) Copy a CreateTunnel in to a new Builder.

Method Summary

Modifier and Type	Method and Description
CreateTunnel	build() Build the CreateTunnel.
CreateTunnel.Builder	withAddr(int addr) See withAddr(String).
CreateTunnel.Builder	withAddr(java.lang.String addr) The local port to which the tunnel will forward traffic, or a local directory or network address, defaults to "80".
CreateTunnel.Builder	withAuth(java.lang.String auth) HTTP basic authentication credentials to enforce on tunneled requests.
CreateTunnel.Builder	withBasicAuth(java.util.List<java.lang.String> basicAuth) List of HTTP basic authentication credentials to enforce on tunneled requests.
CreateTunnel.Builder	withBindTls(BindTls bindTls) Bind an HTTPS (BindTls.TRUE or HTTP (BindTls.FALSE) endpoint, defaults to BindTls.BOTH.
CreateTunnel.Builder	withBindTls(boolean bindTls) See withBindTls(BindTls).
CreateTunnel.Builder	withCircuitBreaker(java.lang.Float circuitBreaker) The circuit breaker trigger.
CreateTunnel.Builder	withCompression(java.lang.Boolean compression) Whether compression is enabled on this tunnel.
CreateTunnel.Builder	withCrt(java.lang.String crt) PEM TLS certificate at this path to terminate TLS traffic before forwarding locally.
CreateTunnel.Builder	withDomain(java.lang.String domain) The tunnel domain.
CreateTunnel.Builder	withHostHeader(java.lang.String hostHeader) Rewrite the HTTP Host header to this value, or preserve to leave it unchanged.
CreateTunnel.Builder	withIpRestriction(TunnelIPRestriction ipRestriction) The IP restrictions for the tunnel.
CreateTunnel.Builder	withKey(java.lang.String key) PEM TLS private key at this path to terminate TLS traffic before forwarding locally.
CreateTunnel.Builder	withMetadata(java.lang.String metadata) Arbitrary user-defined metadata that will appear in the ngrok service API when listing tunnels.
CreateTunnel.Builder	withMutualTlsCas(java.lang.String mutualTlsCas) The path to the TLS certificate authority to verify client certs.
CreateTunnel.Builder	withName(java.lang.String name) A friendly name for the tunnel, or the name of a ngrok tunnel definition defined in ngrok's config file.
CreateTunnel.Builder	withNgrokVersion(NgrokVersion ngrokVersion) The major version of ngrok for which the tunnel will be created.
CreateTunnel.Builder	withOAuth(TunnelOAuth oauth) Set of OAuth settings to enable OAuth authentication on the tunnel endpoint.
CreateTunnel.Builder	withoutInspect() Disable HTTP request inspection on tunnels.
CreateTunnel.Builder	withPolicyInbound(TunnelPolicy policyInbound) The inbound policy for the tunnel.
CreateTunnel.Builder	withPolicyOutbound(TunnelPolicy policyOutbound) The outbound policy for the tunnel.
CreateTunnel.Builder	withPoolingEnabled(java.lang.Boolean poolingEnabled) Whether pooling is enabled on this tunnel.
CreateTunnel.Builder	withProto(Proto proto) The tunnel protocol, defaults to Proto.HTTP.
CreateTunnel.Builder	withProxyProto(java.lang.String proxyProto) The proxy proto.
CreateTunnel.Builder	withRemoteAddr(java.lang.String remoteAddr) Bind the remote TCP port on the given address.
CreateTunnel.Builder	withRequestHeader(TunnelHeader requestHeader) The Headers to be added or removed from requests.
CreateTunnel.Builder	withResponseHeader(TunnelHeader responseHeader) The Headers to be added or removed from responses.
CreateTunnel.Builder	withSchemes(java.util.List<java.lang.String> schemes) The schemes to be bound.
CreateTunnel.Builder	withSubdomain(java.lang.String subdomain) Subdomain name to request.
CreateTunnel.Builder	withTerminateAt(java.lang.String terminateAt) The termination point.
CreateTunnel.Builder	withTunnelDefinition(java.util.Map<java.lang.String,java.lang.Object> tunnelDefinition) Populate any null attributes (except for name) in this Builder with values from the given tunnelDefinition.
CreateTunnel.Builder	withUserAgentFilter(TunnelUserAgentFilter userAgentFilter) The UserAgent filter for the tunnel.
CreateTunnel.Builder	withVerifyWebhook(TunnelVerifyWebhook verifyWebhook) The signature for webhooks.
CreateTunnel.Builder	withWebsocketTcpConverter(java.lang.Boolean websocketTcpConverter) Whether ingress connections are converted to TCP upstream.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Use this constructor if default values should not be populated in required attributes when build() is called.

If required attributes are not set in the built CreateTunnel, default values will be used in methods like NgrokClient.connect(CreateTunnel).

Builder

public Builder(boolean setDefaults)

Use this constructor if default values should be populated in required attributes when build() is called.

Parameters:

setDefaults - true to populate defaults.

Builder

public Builder(CreateTunnel createTunnel)

Copy a CreateTunnel in to a new Builder. Using this constructor will also set default attributes when build() is called.

Parameters:

createTunnel - The CreateTunnel to copy.

Method Detail

withNgrokVersion

public CreateTunnel.Builder withNgrokVersion(NgrokVersion ngrokVersion)

The major version of ngrok for which the tunnel will be created.

withName

public CreateTunnel.Builder withName(java.lang.String name)

A friendly name for the tunnel, or the name of a ngrok tunnel definition defined in ngrok's config file.

withProto

public CreateTunnel.Builder withProto(Proto proto)

The tunnel protocol, defaults to Proto.HTTP.

withDomain

public CreateTunnel.Builder withDomain(java.lang.String domain)

The tunnel domain.

withAddr

public CreateTunnel.Builder withAddr(java.lang.String addr)

The local port to which the tunnel will forward traffic, or a local directory or network address, defaults to "80".

withAddr

public CreateTunnel.Builder withAddr(int addr)

See withAddr(String).

withoutInspect

public CreateTunnel.Builder withoutInspect()

Disable HTTP request inspection on tunnels.

withAuth

public CreateTunnel.Builder withAuth(java.lang.String auth)

HTTP basic authentication credentials to enforce on tunneled requests.

Throws:

java.lang.IllegalArgumentException - The argument was invalid.

withHostHeader

public CreateTunnel.Builder withHostHeader(java.lang.String hostHeader)

Rewrite the HTTP Host header to this value, or preserve to leave it unchanged.

withBindTls

public CreateTunnel.Builder withBindTls(BindTls bindTls)

Bind an HTTPS (BindTls.TRUE or HTTP (BindTls.FALSE) endpoint, defaults to BindTls.BOTH.

Throws:

java.lang.IllegalArgumentException - The argument was invalid.

withBindTls

public CreateTunnel.Builder withBindTls(boolean bindTls)

See withBindTls(BindTls).

withSubdomain

public CreateTunnel.Builder withSubdomain(java.lang.String subdomain)

Subdomain name to request. If unspecified, uses the tunnel name.

withCrt

public CreateTunnel.Builder withCrt(java.lang.String crt)

PEM TLS certificate at this path to terminate TLS traffic before forwarding locally.

withKey

public CreateTunnel.Builder withKey(java.lang.String key)

PEM TLS private key at this path to terminate TLS traffic before forwarding locally.

withRemoteAddr

public CreateTunnel.Builder withRemoteAddr(java.lang.String remoteAddr)

Bind the remote TCP port on the given address.

withMetadata

public CreateTunnel.Builder withMetadata(java.lang.String metadata)

Arbitrary user-defined metadata that will appear in the ngrok service API when listing tunnels.

withSchemes

public CreateTunnel.Builder withSchemes(java.util.List<java.lang.String> schemes)

The schemes to be bound.

Throws:

java.lang.IllegalArgumentException - The argument was invalid.

withBasicAuth

public CreateTunnel.Builder withBasicAuth(java.util.List<java.lang.String> basicAuth)

List of HTTP basic authentication credentials to enforce on tunneled requests.

Throws:

java.lang.IllegalArgumentException - The argument was invalid.

withOAuth

public CreateTunnel.Builder withOAuth(TunnelOAuth oauth)

Set of OAuth settings to enable OAuth authentication on the tunnel endpoint.

withCircuitBreaker

public CreateTunnel.Builder withCircuitBreaker(java.lang.Float circuitBreaker)

The circuit breaker trigger.

withCompression

public CreateTunnel.Builder withCompression(java.lang.Boolean compression)

Whether compression is enabled on this tunnel.

withMutualTlsCas

public CreateTunnel.Builder withMutualTlsCas(java.lang.String mutualTlsCas)

The path to the TLS certificate authority to verify client certs.

withProxyProto

public CreateTunnel.Builder withProxyProto(java.lang.String proxyProto)

The proxy proto.

withWebsocketTcpConverter

public CreateTunnel.Builder withWebsocketTcpConverter(java.lang.Boolean websocketTcpConverter)

Whether ingress connections are converted to TCP upstream.

withTerminateAt

public CreateTunnel.Builder withTerminateAt(java.lang.String terminateAt)

The termination point.

withRequestHeader

public CreateTunnel.Builder withRequestHeader(TunnelHeader requestHeader)

The Headers to be added or removed from requests.

withResponseHeader

public CreateTunnel.Builder withResponseHeader(TunnelHeader responseHeader)

The Headers to be added or removed from responses.

withIpRestriction

public CreateTunnel.Builder withIpRestriction(TunnelIPRestriction ipRestriction)

The IP restrictions for the tunnel.

withVerifyWebhook

public CreateTunnel.Builder withVerifyWebhook(TunnelVerifyWebhook verifyWebhook)

The signature for webhooks.

withUserAgentFilter

public CreateTunnel.Builder withUserAgentFilter(TunnelUserAgentFilter userAgentFilter)

The UserAgent filter for the tunnel.

withPolicyInbound

public CreateTunnel.Builder withPolicyInbound(TunnelPolicy policyInbound)

The inbound policy for the tunnel.

withPolicyOutbound

public CreateTunnel.Builder withPolicyOutbound(TunnelPolicy policyOutbound)

The outbound policy for the tunnel.

withPoolingEnabled

public CreateTunnel.Builder withPoolingEnabled(java.lang.Boolean poolingEnabled)

Whether pooling is enabled on this tunnel.

withTunnelDefinition

public CreateTunnel.Builder withTunnelDefinition(java.util.Map<java.lang.String,java.lang.Object> tunnelDefinition)

Populate any null attributes (except for name) in this Builder with values from the given tunnelDefinition.

Parameters:

tunnelDefinition - The map from which null attributes will be populated.

Throws:

java.lang.IllegalArgumentException - The argument was invalid.

build

public CreateTunnel build()

Build the CreateTunnel.