Packages

final case class TunnelSession(agentVersion: String, credential: Ref, id: String, ip: String, metadata: String, os: String, region: String, startedAt: OffsetDateTime, transport: String, uri: URI) extends Product with Serializable

A class encapsulating the TunnelSession resource.

agentVersion

version of the ngrok agent that started this ngrok tunnel session

credential

reference to the tunnel credential or ssh credential used by the ngrok agent to start this tunnel session

id

unique tunnel session resource identifier

ip

source ip address of the tunnel session

metadata

arbitrary user-defined data specified in the metadata property in the ngrok configuration file. See the metadata configuration option

os

operating system of the host the ngrok agent is running on

region

the ngrok region identifier in which this tunnel session was started

startedAt

time when the tunnel session first connected to the ngrok servers

transport

the transport protocol used to start the tunnel session. Either ngrok/v2 or ssh

uri

URI to the API resource of the tunnel session

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TunnelSession
  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 TunnelSession(agentVersion: String, credential: Ref, id: String, ip: String, metadata: String, os: String, region: String, startedAt: OffsetDateTime, transport: String, uri: URI)

    create a new TunnelSession.

    create a new TunnelSession.

    agentVersion

    version of the ngrok agent that started this ngrok tunnel session

    credential

    reference to the tunnel credential or ssh credential used by the ngrok agent to start this tunnel session

    id

    unique tunnel session resource identifier

    ip

    source ip address of the tunnel session

    metadata

    arbitrary user-defined data specified in the metadata property in the ngrok configuration file. See the metadata configuration option

    os

    operating system of the host the ngrok agent is running on

    region

    the ngrok region identifier in which this tunnel session was started

    startedAt

    time when the tunnel session first connected to the ngrok servers

    transport

    the transport protocol used to start the tunnel session. Either ngrok/v2 or ssh

    uri

    URI to the API resource of the tunnel session

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 TunnelSession toany2stringadd[TunnelSession] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (TunnelSession, B)
    Implicit
    This member is added by an implicit conversion from TunnelSession toArrowAssoc[TunnelSession] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. val agentVersion: String
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  9. val credential: Ref
  10. def ensuring(cond: (TunnelSession) => Boolean, msg: => Any): TunnelSession
    Implicit
    This member is added by an implicit conversion from TunnelSession toEnsuring[TunnelSession] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (TunnelSession) => Boolean): TunnelSession
    Implicit
    This member is added by an implicit conversion from TunnelSession toEnsuring[TunnelSession] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: => Any): TunnelSession
    Implicit
    This member is added by an implicit conversion from TunnelSession toEnsuring[TunnelSession] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): TunnelSession
    Implicit
    This member is added by an implicit conversion from TunnelSession toEnsuring[TunnelSession] 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. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. val id: String
  18. val ip: String
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. val metadata: String
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. val os: String
  25. def productElementNames: Iterator[String]
    Definition Classes
    Product
  26. val region: String
  27. val startedAt: OffsetDateTime
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. val transport: String
  30. val uri: URI
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. 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 TunnelSession toStringFormat[TunnelSession] 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): (TunnelSession, B)
    Implicit
    This member is added by an implicit conversion from TunnelSession toArrowAssoc[TunnelSession] 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 fromTunnelSession to any2stringadd[TunnelSession]

Inherited by implicit conversion StringFormat fromTunnelSession to StringFormat[TunnelSession]

Inherited by implicit conversion Ensuring fromTunnelSession to Ensuring[TunnelSession]

Inherited by implicit conversion ArrowAssoc fromTunnelSession to ArrowAssoc[TunnelSession]

Ungrouped