All Classes
-
All Classes Interface Summary Class Summary Enum Summary Exception Summary Class Description BindTls CapturedRequest An object representing a CapturedRequest response fromngrok
's API.CapturedRequest.Request CapturedRequest.Response CapturedRequests An object representing CapturedRequests response fromngrok
's API.CreateTunnel An object that represents angrok
Tunnel creation request.CreateTunnel.Builder Builder for aCreateTunnel
, which can be used to construct a request that conforms tongrok
's tunnel definition.DefaultHttpClient A default client for executing JSON-based HTTP requests.DefaultHttpClient.Builder Builder for aDefaultHttpClient
, see docs for that class for example usage.HttpClient A simple interface for executing HTTP requests.HttpClientException Root exception forDefaultHttpClient
interactions.JavaNgrokConfig An object for managingjava-ngrok
's configuration to interact thengrok
binary.JavaNgrokConfig.Builder Builder for aJavaNgrokConfig
, see docs for that class for example usage.JavaNgrokException Root exception for theNgrokClient
and thejava-ngrok
library.JavaNgrokHTTPException Thrown fromNgrokClient
when an error occurs making a request to thengrok
web interface.JavaNgrokInstallerException Thrown fromNgrokInstaller
when an error occurs while downloading and installing thengrok
binary.JavaNgrokSecurityException Thrown fromNgrokProcess
when a security error occurs.NgrokCDNUrl NgrokClient A client for interacting with ngrok, its binary, and its APIs.NgrokClient.Builder Builder for aNgrokClient
, see docs for that class for example usage.NgrokException Thrown fromNgrokProcess
when an error occurs interacting directly with thengrok
binary.NgrokInstaller A helper for downloading and installing thengrok
for the current system.NgrokLog An object containing a parsed log from thengrok
process.NgrokProcess An object containing information about thengrok
process.NgrokProcess.ProcessMonitor NgrokV2CDNUrl An enum that maps systems and architectures to their corresponding legacyngrok
V2 download URLs.NgrokV3CDNUrl An enum that maps systems and architectures to their correspondingngrok
download URLs.NgrokVersion An enum for the list of supported majorngrok
versions.Parameter A parameter for theHttpClient
.Proto An enum representingngrok
's valid protos, as defined inngrok
's docs.Region An enum representingngrok
's valid regions, as defined inngrok
's docs.Response<T> A response from theHttpClient
.StringUtils Convenience methods for String manipulation.Tunnel An object representing a Tunnel response fromngrok
's API.Tunnel.Metrics Tunnel.TunnelConfig TunnelHeader An object that represents header configuration for aCreateTunnel
.TunnelHeader.Builder TunnelIPRestrictions An object that represents IP restrictions for aCreateTunnel
.TunnelIPRestrictions.Builder TunnelOAuth An object that represents the OAuth configuration for aCreateTunnel
.TunnelOAuth.Builder Builder for OAuth configuration that conforms tongrok
's tunnel definition.Tunnels An object representing a Tunnels response fromngrok
's API.TunnelVerifyWebhook An object that represents webhook signature verification for aCreateTunnel
.TunnelVerifyWebhook.Builder Version An object representingngrok
's version andjava-ngrok
's version.