object JwtClaimInclude extends GeneratedEnumCompanion[JwtClaimInclude]
- Source
- JwtFieldOptions.scala
- Alphabetic
- By Inheritance
- JwtClaimInclude
- GeneratedEnumCompanion
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- sealed trait Recognized extends JwtClaimInclude
- final case class Unrecognized(unrecognizedValue: Int) extends JwtClaimInclude with UnrecognizedEnum with Product with Serializable
- Annotations
- @SerialVersionUID()
- type ValueType = JwtClaimInclude
- Definition Classes
- GeneratedEnumCompanion
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- 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()
- implicit def enumCompanion: GeneratedEnumCompanion[JwtClaimInclude]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def fromName(name: String): Option[JwtClaimInclude]
- Definition Classes
- GeneratedEnumCompanion
- def fromValue(__value: Int): JwtClaimInclude
- Definition Classes
- JwtClaimInclude → GeneratedEnumCompanion
- 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
- def javaDescriptor: EnumDescriptor
- Definition Classes
- JwtClaimInclude → GeneratedEnumCompanion
- 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 scalaDescriptor: EnumDescriptor
- Definition Classes
- JwtClaimInclude → GeneratedEnumCompanion
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- lazy val values: Seq[ValueType]
- Definition Classes
- JwtClaimInclude → GeneratedEnumCompanion
- 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()
- case object DESCEND extends JwtClaimInclude with Recognized with Product with Serializable
Descend into this field, including the claims in the child message as claims in this message.
Descend into this field, including the claims in the child message as claims in this message. Only valid for non repeated message fields.
- Annotations
- @SerialVersionUID()
- case object EXTRACT extends JwtClaimInclude with Recognized with Product with Serializable
Extract the value for this field from the JWT.
Extract the value for this field from the JWT. When validating messages, if this field is empty, the value for it will be replaced with the value from the JWT, otherwise, it will be validated against the claim in the JWT. When signing messages, this has exactly the same operation as INCLUDE.
- Annotations
- @SerialVersionUID()
- case object INCLUDE extends JwtClaimInclude with Recognized with Product with Serializable
Include this field in the JWT.
Include this field in the JWT. The field will be converted to JSON. If it is a message or repeated field, it will not be descended into, but will be included in its JSON form.
- Annotations
- @SerialVersionUID()
- case object NEST extends JwtClaimInclude with Recognized with Product with Serializable
Nest the claims in this field inside an object or array in this claim.
Nest the claims in this field inside an object or array in this claim. Only valid on message fields. If repeated, the claim will contain an array of the claims extracted from each message.
- Annotations
- @SerialVersionUID()
- case object RAW extends JwtClaimInclude with Recognized with Product with Serializable
Indicates that this field contains a raw set of claims.
Indicates that this field contains a raw set of claims. The type of the field must be a map of strings to json serializable values.
When deserializing, whatever value is contained in this field is overwritten - the value is not validated to ensure it matches the incoming claims. Any claims that can't be deserialized to the value type of the map will be ignored. Multiple fields in a message with different value types can be used to capture raw claims of different types.
When serializing, the value in this message is used as the claims for the JWT (plus any other claim or raw annotated fields), and the value of the field will be blanked to zero before serialising to protobuf.
- Annotations
- @SerialVersionUID()
- case object UNSPECIFIED extends JwtClaimInclude with Recognized with Product with Serializable
Don't include this field in the JWT.
Don't include this field in the JWT.
- Annotations
- @SerialVersionUID()