Packages

final case class Tunnel(id: String, publicUrl: URI, startedAt: OffsetDateTime, metadata: String, proto: String, region: String, tunnelSession: Ref, endpoint: Option[Ref] = None, labels: Map[String, String], backends: Option[List[Ref]] = None, forwardsTo: String) extends Product with Serializable

A class encapsulating the Tunnel resource.

id

unique tunnel resource identifier

publicUrl

URL of the ephemeral tunnel's public endpoint

startedAt

timestamp when the tunnel was initiated in RFC 3339 format

metadata

user-supplied metadata for the tunnel defined in the ngrok configuration file. See the tunnel metadata configuration option In API version 0, this value was instead pulled from the top-level metadata configuration option.

proto

tunnel protocol for ephemeral tunnels. one of http, https, tcp or tls

region

identifier of tune region where the tunnel is running

tunnelSession

reference object pointing to the tunnel session on which this tunnel was started

endpoint

the ephemeral endpoint this tunnel is associated with, if this is an agent-initiated tunnel

labels

the labels the tunnel group backends will match against, if this is a backend tunnel

backends

tunnel group backends served by this backend tunnel

forwardsTo

upstream address the ngrok agent forwards traffic over this tunnel to. this may be expressed as a URL or a network address.

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Tunnel
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Tunnel(id: String, publicUrl: URI, startedAt: OffsetDateTime, metadata: String, proto: String, region: String, tunnelSession: Ref, endpoint: Option[Ref] = None, labels: Map[String, String], backends: Option[List[Ref]] = None, forwardsTo: String)

    create a new Tunnel.

    create a new Tunnel.

    id

    unique tunnel resource identifier

    publicUrl

    URL of the ephemeral tunnel's public endpoint

    startedAt

    timestamp when the tunnel was initiated in RFC 3339 format

    metadata

    user-supplied metadata for the tunnel defined in the ngrok configuration file. See the tunnel metadata configuration option In API version 0, this value was instead pulled from the top-level metadata configuration option.

    proto

    tunnel protocol for ephemeral tunnels. one of http, https, tcp or tls

    region

    identifier of tune region where the tunnel is running

    tunnelSession

    reference object pointing to the tunnel session on which this tunnel was started

    endpoint

    the ephemeral endpoint this tunnel is associated with, if this is an agent-initiated tunnel

    labels

    the labels the tunnel group backends will match against, if this is a backend tunnel

    backends

    tunnel group backends served by this backend tunnel

    forwardsTo

    upstream address the ngrok agent forwards traffic over this tunnel to. this may be expressed as a URL or a network address.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Tunnel toany2stringadd[Tunnel] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Tunnel, B)
    Implicit
    This member is added by an implicit conversion from Tunnel toArrowAssoc[Tunnel] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val backends: Option[List[Ref]]
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  9. val endpoint: Option[Ref]
  10. def ensuring(cond: (Tunnel) => Boolean, msg: => Any): Tunnel
    Implicit
    This member is added by an implicit conversion from Tunnel toEnsuring[Tunnel] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (Tunnel) => Boolean): Tunnel
    Implicit
    This member is added by an implicit conversion from Tunnel toEnsuring[Tunnel] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: => Any): Tunnel
    Implicit
    This member is added by an implicit conversion from Tunnel toEnsuring[Tunnel] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): Tunnel
    Implicit
    This member is added by an implicit conversion from Tunnel toEnsuring[Tunnel] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  16. val forwardsTo: String
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. val id: String
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. val labels: Map[String, String]
  21. val metadata: String
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. def productElementNames: Iterator[String]
    Definition Classes
    Product
  26. val proto: String
  27. val publicUrl: URI
  28. val region: String
  29. val startedAt: OffsetDateTime
  30. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  31. val tunnelSession: Ref
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Tunnel toStringFormat[Tunnel] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def →[B](y: B): (Tunnel, B)
    Implicit
    This member is added by an implicit conversion from Tunnel toArrowAssoc[Tunnel] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromTunnel to any2stringadd[Tunnel]

Inherited by implicit conversion StringFormat fromTunnel to StringFormat[Tunnel]

Inherited by implicit conversion Ensuring fromTunnel to Ensuring[Tunnel]

Inherited by implicit conversion ArrowAssoc fromTunnel to ArrowAssoc[Tunnel]

Ungrouped