Packages

final case class AgentIngress(id: String, uri: URI, description: String, metadata: String, domain: String, nsTargets: List[String], regionDomains: List[String], createdAt: OffsetDateTime) extends Product with Serializable

A class encapsulating the AgentIngress resource.

id

unique Agent Ingress resource identifier

uri

URI to the API resource of this Agent ingress

description

human-readable description of the use of this Agent Ingress. optional, max 255 bytes.

metadata

arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes

domain

the domain that you own to be used as the base domain name to generate regional agent ingress domains.

nsTargets

a list of target values to use as the values of NS records for the domain property these values will delegate control over the domain to ngrok

regionDomains

a list of regional agent ingress domains that are subdomains of the value of domain this value may increase over time as ngrok adds more regions

createdAt

timestamp when the Agent Ingress was created, RFC 3339 format

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AgentIngress
  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 AgentIngress(id: String, uri: URI, description: String, metadata: String, domain: String, nsTargets: List[String], regionDomains: List[String], createdAt: OffsetDateTime)

    create a new AgentIngress.

    create a new AgentIngress.

    id

    unique Agent Ingress resource identifier

    uri

    URI to the API resource of this Agent ingress

    description

    human-readable description of the use of this Agent Ingress. optional, max 255 bytes.

    metadata

    arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes

    domain

    the domain that you own to be used as the base domain name to generate regional agent ingress domains.

    nsTargets

    a list of target values to use as the values of NS records for the domain property these values will delegate control over the domain to ngrok

    regionDomains

    a list of regional agent ingress domains that are subdomains of the value of domain this value may increase over time as ngrok adds more regions

    createdAt

    timestamp when the Agent Ingress was created, RFC 3339 format

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 AgentIngress toany2stringadd[AgentIngress] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (AgentIngress, B)
    Implicit
    This member is added by an implicit conversion from AgentIngress toArrowAssoc[AgentIngress] 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 createdAt: OffsetDateTime
  9. val description: String
  10. val domain: String
  11. def ensuring(cond: (AgentIngress) => Boolean, msg: => Any): AgentIngress
    Implicit
    This member is added by an implicit conversion from AgentIngress toEnsuring[AgentIngress] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (AgentIngress) => Boolean): AgentIngress
    Implicit
    This member is added by an implicit conversion from AgentIngress toEnsuring[AgentIngress] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: => Any): AgentIngress
    Implicit
    This member is added by an implicit conversion from AgentIngress toEnsuring[AgentIngress] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): AgentIngress
    Implicit
    This member is added by an implicit conversion from AgentIngress toEnsuring[AgentIngress] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  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 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 nsTargets: List[String]
  25. def productElementNames: Iterator[String]
    Definition Classes
    Product
  26. val regionDomains: List[String]
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. val uri: URI
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. 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 AgentIngress toStringFormat[AgentIngress] 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): (AgentIngress, B)
    Implicit
    This member is added by an implicit conversion from AgentIngress toArrowAssoc[AgentIngress] 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 fromAgentIngress to any2stringadd[AgentIngress]

Inherited by implicit conversion StringFormat fromAgentIngress to StringFormat[AgentIngress]

Inherited by implicit conversion Ensuring fromAgentIngress to Ensuring[AgentIngress]

Inherited by implicit conversion ArrowAssoc fromAgentIngress to ArrowAssoc[AgentIngress]

Ungrouped