class EdgesHttpsRoutes extends AnyRef
An API client for EdgesHttpsRoutes.
- Alphabetic
- By Inheritance
- EdgesHttpsRoutes
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from EdgesHttpsRoutes toany2stringadd[EdgesHttpsRoutes] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (EdgesHttpsRoutes, B)
- Implicit
- This member is added by an implicit conversion from EdgesHttpsRoutes toArrowAssoc[EdgesHttpsRoutes] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def create(edgeId: String, matchType: String, match: String, description: Option[String] = None, metadata: Option[String] = None, backend: Option[EndpointBackendMutate] = None, ipRestriction: Option[EndpointIpPolicyMutate] = None, circuitBreaker: Option[EndpointCircuitBreaker] = None, compression: Option[EndpointCompression] = None, requestHeaders: Option[EndpointRequestHeaders] = None, responseHeaders: Option[EndpointResponseHeaders] = None, webhookVerification: Option[EndpointWebhookValidation] = None, oauth: Option[EndpointOAuth] = None, saml: Option[EndpointSamlMutate] = None, oidc: Option[EndpointOidc] = None, websocketTcpConverter: Option[EndpointWebsocketTcpConverter] = None): Future[HttpsEdgeRoute]
Create an HTTPS Edge Route
Create an HTTPS Edge Route
See also https://ngrok.com/docs/api#api-edges-https-routes-create.
- edgeId
unique identifier of this edge
- matchType
Type of match to use for this route. Valid values are "exact_path" and "path_prefix".
- description
human-readable description of what this edge will be used for; optional, max 255 bytes.
- metadata
arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
- backend
backend module configuration or
null- ipRestriction
ip restriction module configuration or
null- circuitBreaker
circuit breaker module configuration or
null- compression
compression module configuration or
null- requestHeaders
request headers module configuration or
null- responseHeaders
response headers module configuration or
null- webhookVerification
webhook verification module configuration or
null- oauth
oauth module configuration or
null- saml
saml module configuration or
null- oidc
oidc module configuration or
null- websocketTcpConverter
websocket to tcp adapter configuration or
null- returns
a scala.concurrent.Future encapsulating the API call's result
- def delete(edgeId: String, id: String): Future[Unit]
Delete an HTTPS Edge Route by ID
Delete an HTTPS Edge Route by ID
See also https://ngrok.com/docs/api#api-edges-https-routes-delete.
- edgeId
unique identifier of this edge
- id
unique identifier of this edge route
- returns
a scala.concurrent.Future encapsulating the API call's result
- def ensuring(cond: (EdgesHttpsRoutes) => Boolean, msg: => Any): EdgesHttpsRoutes
- Implicit
- This member is added by an implicit conversion from EdgesHttpsRoutes toEnsuring[EdgesHttpsRoutes] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (EdgesHttpsRoutes) => Boolean): EdgesHttpsRoutes
- Implicit
- This member is added by an implicit conversion from EdgesHttpsRoutes toEnsuring[EdgesHttpsRoutes] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): EdgesHttpsRoutes
- Implicit
- This member is added by an implicit conversion from EdgesHttpsRoutes toEnsuring[EdgesHttpsRoutes] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): EdgesHttpsRoutes
- Implicit
- This member is added by an implicit conversion from EdgesHttpsRoutes toEnsuring[EdgesHttpsRoutes] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def get(edgeId: String, id: String): Future[HttpsEdgeRoute]
Get an HTTPS Edge Route by ID
Get an HTTPS Edge Route by ID
See also https://ngrok.com/docs/api#api-edges-https-routes-get.
- edgeId
unique identifier of this edge
- id
unique identifier of this edge route
- returns
a scala.concurrent.Future encapsulating the API call's result
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def update(edgeId: String, id: String, matchType: Option[String] = None, match: Option[String] = None, description: Option[String] = None, metadata: Option[String] = None, backend: Option[EndpointBackendMutate] = None, ipRestriction: Option[EndpointIpPolicyMutate] = None, circuitBreaker: Option[EndpointCircuitBreaker] = None, compression: Option[EndpointCompression] = None, requestHeaders: Option[EndpointRequestHeaders] = None, responseHeaders: Option[EndpointResponseHeaders] = None, webhookVerification: Option[EndpointWebhookValidation] = None, oauth: Option[EndpointOAuth] = None, saml: Option[EndpointSamlMutate] = None, oidc: Option[EndpointOidc] = None, websocketTcpConverter: Option[EndpointWebsocketTcpConverter] = None): Future[HttpsEdgeRoute]
Updates an HTTPS Edge Route by ID.
Updates an HTTPS Edge Route by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.
See also https://ngrok.com/docs/api#api-edges-https-routes-update.
- edgeId
unique identifier of this edge
- id
unique identifier of this edge route
- matchType
Type of match to use for this route. Valid values are "exact_path" and "path_prefix".
- description
human-readable description of what this edge will be used for; optional, max 255 bytes.
- metadata
arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
- backend
backend module configuration or
null- ipRestriction
ip restriction module configuration or
null- circuitBreaker
circuit breaker module configuration or
null- compression
compression module configuration or
null- requestHeaders
request headers module configuration or
null- responseHeaders
response headers module configuration or
null- webhookVerification
webhook verification module configuration or
null- oauth
oauth module configuration or
null- saml
saml module configuration or
null- oidc
oidc module configuration or
null- websocketTcpConverter
websocket to tcp adapter configuration or
null- returns
a scala.concurrent.Future encapsulating the API call's result
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from EdgesHttpsRoutes toStringFormat[EdgesHttpsRoutes] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (EdgesHttpsRoutes, B)
- Implicit
- This member is added by an implicit conversion from EdgesHttpsRoutes toArrowAssoc[EdgesHttpsRoutes] 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.