Packages

final case class EndpointTlsTermination(enabled: Option[Boolean] = None, terminateAt: String, minVersion: Option[String] = None) extends Product with Serializable

A class encapsulating the EndpointTlsTermination resource.

enabled

true if the module will be applied to traffic, false to disable. default true if unspecified

terminateAt

edge if the ngrok edge should terminate TLS traffic, upstream if TLS traffic should be passed through to the upstream ngrok agent / application server for termination. if upstream is chosen, most other modules will be disallowed because they rely on the ngrok edge being able to access the underlying traffic.

minVersion

The minimum TLS version used for termination and advertised to the client during the TLS handshake. if unspecified, ngrok will choose an industry-safe default. This value must be null if terminate_at is set to upstream.

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EndpointTlsTermination
  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 EndpointTlsTermination(enabled: Option[Boolean] = None, terminateAt: String, minVersion: Option[String] = None)

    create a new EndpointTlsTermination.

    create a new EndpointTlsTermination.

    enabled

    true if the module will be applied to traffic, false to disable. default true if unspecified

    terminateAt

    edge if the ngrok edge should terminate TLS traffic, upstream if TLS traffic should be passed through to the upstream ngrok agent / application server for termination. if upstream is chosen, most other modules will be disallowed because they rely on the ngrok edge being able to access the underlying traffic.

    minVersion

    The minimum TLS version used for termination and advertised to the client during the TLS handshake. if unspecified, ngrok will choose an industry-safe default. This value must be null if terminate_at is set to upstream.

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 EndpointTlsTermination toany2stringadd[EndpointTlsTermination] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (EndpointTlsTermination, B)
    Implicit
    This member is added by an implicit conversion from EndpointTlsTermination toArrowAssoc[EndpointTlsTermination] 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. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. val enabled: Option[Boolean]
  9. def ensuring(cond: (EndpointTlsTermination) => Boolean, msg: => Any): EndpointTlsTermination
    Implicit
    This member is added by an implicit conversion from EndpointTlsTermination toEnsuring[EndpointTlsTermination] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (EndpointTlsTermination) => Boolean): EndpointTlsTermination
    Implicit
    This member is added by an implicit conversion from EndpointTlsTermination toEnsuring[EndpointTlsTermination] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): EndpointTlsTermination
    Implicit
    This member is added by an implicit conversion from EndpointTlsTermination toEnsuring[EndpointTlsTermination] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): EndpointTlsTermination
    Implicit
    This member is added by an implicit conversion from EndpointTlsTermination toEnsuring[EndpointTlsTermination] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. val minVersion: Option[String]
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. def productElementNames: Iterator[String]
    Definition Classes
    Product
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. val terminateAt: String
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. 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 EndpointTlsTermination toStringFormat[EndpointTlsTermination] 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): (EndpointTlsTermination, B)
    Implicit
    This member is added by an implicit conversion from EndpointTlsTermination toArrowAssoc[EndpointTlsTermination] 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 fromEndpointTlsTermination to any2stringadd[EndpointTlsTermination]

Inherited by implicit conversion StringFormat fromEndpointTlsTermination to StringFormat[EndpointTlsTermination]

Inherited by implicit conversion Ensuring fromEndpointTlsTermination to Ensuring[EndpointTlsTermination]

Inherited by implicit conversion ArrowAssoc fromEndpointTlsTermination to ArrowAssoc[EndpointTlsTermination]

Ungrouped