Package com.github.alexdlaird.ngrok.protocol

Class Tunnel

java.lang.Object

com.github.alexdlaird.ngrok.protocol.Tunnel

public class Tunnel
extends java.lang.Object

An object representing a Tunnel response from ngrok's API.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Tunnel.Metrics
static class	Tunnel.TunnelConfig

Constructor Summary

Constructors

Constructor	Description
Tunnel()

Method Summary

Modifier and Type	Method	Description
Tunnel.TunnelConfig	getConfig()	Get the tunnel config.
java.util.Map<java.lang.String,Tunnel.Metrics>	getMetrics()	Get the tunnel metrics.
java.lang.String	getName()	Get the name of the tunnel.
java.lang.String	getProto()	Get the proto of the tunnel.
java.lang.String	getPublicUrl()	Get the public URL of the tunnel.
java.lang.String	getUri()	Get the relative URI of the tunnel.
void	setMetrics(java.util.Map<java.lang.String,Tunnel.Metrics> metrics)	Set tunnel metrics.

Methods inherited from class java.lang.Object

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

Constructor Detail

Tunnel

public Tunnel()

Method Detail

getName

public java.lang.String getName()

Get the name of the tunnel.

getUri

public java.lang.String getUri()

Get the relative URI of the tunnel.

getPublicUrl

public java.lang.String getPublicUrl()

Get the public URL of the tunnel.

getProto

public java.lang.String getProto()

Get the proto of the tunnel.

getConfig

public Tunnel.TunnelConfig getConfig()

Get the tunnel config.

getMetrics

public java.util.Map<java.lang.String,Tunnel.Metrics> getMetrics()

Get the tunnel metrics.

setMetrics

public void setMetrics(java.util.Map<java.lang.String,Tunnel.Metrics> metrics)

Set tunnel metrics.

Parameters:

metrics - The updated metrics.