Packages

final case class HttpsEdgeRoute(edgeId: String, id: String, createdAt: OffsetDateTime, matchType: String, match: String, uri: URI, description: String, metadata: String, backend: Option[EndpointBackend] = None, ipRestriction: Option[EndpointIpPolicy] = 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[EndpointSaml] = None, oidc: Option[EndpointOidc] = None, websocketTcpConverter: Option[EndpointWebsocketTcpConverter] = None) extends Product with Serializable

A class encapsulating the HttpsEdgeRoute resource.

edgeId

unique identifier of this edge

id

unique identifier of this edge route

createdAt

timestamp when the edge configuration was created, RFC 3339 format

matchType

Type of match to use for this route. Valid values are "exact_path" and "path_prefix".

uri

URI of the edge API resource

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

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HttpsEdgeRoute
  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 HttpsEdgeRoute(edgeId: String, id: String, createdAt: OffsetDateTime, matchType: String, match: String, uri: URI, description: String, metadata: String, backend: Option[EndpointBackend] = None, ipRestriction: Option[EndpointIpPolicy] = 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[EndpointSaml] = None, oidc: Option[EndpointOidc] = None, websocketTcpConverter: Option[EndpointWebsocketTcpConverter] = None)

    create a new HttpsEdgeRoute.

    create a new HttpsEdgeRoute.

    edgeId

    unique identifier of this edge

    id

    unique identifier of this edge route

    createdAt

    timestamp when the edge configuration was created, RFC 3339 format

    matchType

    Type of match to use for this route. Valid values are "exact_path" and "path_prefix".

    uri

    URI of the edge API resource

    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

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 HttpsEdgeRoute toany2stringadd[HttpsEdgeRoute] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (HttpsEdgeRoute, B)
    Implicit
    This member is added by an implicit conversion from HttpsEdgeRoute toArrowAssoc[HttpsEdgeRoute] 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 backend: Option[EndpointBackend]
  8. val circuitBreaker: Option[EndpointCircuitBreaker]
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. val compression: Option[EndpointCompression]
  11. val createdAt: OffsetDateTime
  12. val description: String
  13. val edgeId: String
  14. def ensuring(cond: (HttpsEdgeRoute) => Boolean, msg: => Any): HttpsEdgeRoute
    Implicit
    This member is added by an implicit conversion from HttpsEdgeRoute toEnsuring[HttpsEdgeRoute] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: (HttpsEdgeRoute) => Boolean): HttpsEdgeRoute
    Implicit
    This member is added by an implicit conversion from HttpsEdgeRoute toEnsuring[HttpsEdgeRoute] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean, msg: => Any): HttpsEdgeRoute
    Implicit
    This member is added by an implicit conversion from HttpsEdgeRoute toEnsuring[HttpsEdgeRoute] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean): HttpsEdgeRoute
    Implicit
    This member is added by an implicit conversion from HttpsEdgeRoute toEnsuring[HttpsEdgeRoute] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. val id: String
  22. val ipRestriction: Option[EndpointIpPolicy]
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. val match: String
  25. val matchType: String
  26. val metadata: String
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. val oauth: Option[EndpointOAuth]
  31. val oidc: Option[EndpointOidc]
  32. def productElementNames: Iterator[String]
    Definition Classes
    Product
  33. val requestHeaders: Option[EndpointRequestHeaders]
  34. val responseHeaders: Option[EndpointResponseHeaders]
  35. val saml: Option[EndpointSaml]
  36. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  37. val uri: URI
  38. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  39. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  40. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  41. val webhookVerification: Option[EndpointWebhookValidation]
  42. val websocketTcpConverter: Option[EndpointWebsocketTcpConverter]

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from HttpsEdgeRoute toStringFormat[HttpsEdgeRoute] 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): (HttpsEdgeRoute, B)
    Implicit
    This member is added by an implicit conversion from HttpsEdgeRoute toArrowAssoc[HttpsEdgeRoute] 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 fromHttpsEdgeRoute to any2stringadd[HttpsEdgeRoute]

Inherited by implicit conversion StringFormat fromHttpsEdgeRoute to StringFormat[HttpsEdgeRoute]

Inherited by implicit conversion Ensuring fromHttpsEdgeRoute to Ensuring[HttpsEdgeRoute]

Inherited by implicit conversion ArrowAssoc fromHttpsEdgeRoute to ArrowAssoc[HttpsEdgeRoute]

Ungrouped