final case class ApiKey(id: String, uri: URI, description: String, metadata: String, createdAt: OffsetDateTime, token: Option[String] = None) extends Product with Serializable
A class encapsulating the ApiKey resource.
- id
unique API key resource identifier
- uri
URI to the API resource of this API key
- description
human-readable description of what uses the API key to authenticate. optional, max 255 bytes.
- metadata
arbitrary user-defined data of this API key. optional, max 4096 bytes
- createdAt
timestamp when the api key was created, RFC 3339 format
- token
the bearer token that can be placed into the Authorization header to authenticate request to the ngrok API. This value is only available one time, on the API response from key creation. Otherwise it is null.
- Alphabetic
- By Inheritance
- ApiKey
- Serializable
- Product
- Equals
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ApiKey(id: String, uri: URI, description: String, metadata: String, createdAt: OffsetDateTime, token: Option[String] = None)
create a new ApiKey.
create a new ApiKey.
- id
unique API key resource identifier
- uri
URI to the API resource of this API key
- description
human-readable description of what uses the API key to authenticate. optional, max 255 bytes.
- metadata
arbitrary user-defined data of this API key. optional, max 4096 bytes
- createdAt
timestamp when the api key was created, RFC 3339 format
- token
the bearer token that can be placed into the Authorization header to authenticate request to the ngrok API. This value is only available one time, on the API response from key creation. Otherwise it is null.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (ApiKey, B)
- 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()
- val createdAt: OffsetDateTime
- val description: String
- def ensuring(cond: (ApiKey) => Boolean, msg: => Any): ApiKey
- def ensuring(cond: (ApiKey) => Boolean): ApiKey
- def ensuring(cond: Boolean, msg: => Any): ApiKey
- def ensuring(cond: Boolean): ApiKey
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- val id: String
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val metadata: String
- 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()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val token: Option[String]
- val uri: URI
- 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 ApiKey toStringFormat[ApiKey] 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): (ApiKey, B)
- Implicit
- This member is added by an implicit conversion from ApiKey toArrowAssoc[ApiKey] 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.