Module com.github.alexdlaird.ngrok

Package com.github.alexdlaird.ngrok.protocol

Class TunnelOAuth.Builder

java.lang.Object

com.github.alexdlaird.ngrok.protocol.TunnelOAuth.Builder

Enclosing class:

TunnelOAuth

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

Builder for OAuth configuration that conforms to ngrok's tunnel definition. See docs for that class for example usage.

Constructor Summary

Constructors

Constructor	Description
Builder()
Builder(java.util.Map<java.lang.String,java.lang.Object> tunnelDefinitions)

Method Summary

Modifier and Type	Method	Description
TunnelOAuth	build()
TunnelOAuth.Builder	withAllowDomains(java.util.List<java.lang.String> domains)	The list of allowed OAuth domains.
TunnelOAuth.Builder	withAllowEmails(java.util.List<java.lang.String> emails)	The list of allowed OAuth emails.
TunnelOAuth.Builder	withProvider(java.lang.String provider)	The OAuth provider.
TunnelOAuth.Builder	withScopes(java.util.List<java.lang.String> scopes)	The list of OAuth scopes.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Builder

public Builder(java.util.Map<java.lang.String,java.lang.Object> tunnelDefinitions)

Method Detail

withProvider

public TunnelOAuth.Builder withProvider(java.lang.String provider)

The OAuth provider. This setting is required. For a list of valid providers, see ngrok's docs.

withScopes

public TunnelOAuth.Builder withScopes(java.util.List<java.lang.String> scopes)

The list of OAuth scopes.

withAllowEmails

public TunnelOAuth.Builder withAllowEmails(java.util.List<java.lang.String> emails)

The list of allowed OAuth emails.

withAllowDomains

public TunnelOAuth.Builder withAllowDomains(java.util.List<java.lang.String> domains)

The list of allowed OAuth domains.

build

public TunnelOAuth build()