Packages

final case class JsonSchema(jsonBodyInputField: String = "", input: String = "", output: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[JsonSchema] with Product with Serializable

Additional metadata for views accepting JSON events in, as query request parameters and as responses from queries

jsonBodyInputField

Indicates the field in a incoming message that is expected to contain the json payload The field should be of type google.protobuf.Any and messages must have type_url 'json.kalix.io' and the value encoded accordingly (WIRETYPE_LENGTH_DELIMITED + UTF8 bytes)

input

Indicates the proto message describing the schema of the json_body_input_field payload, incoming message JSON will be parsed using this schema, only by queries to allow mixing parameters in a generated input type with fields from a JSON payload (updates are always expected to have Any as their input parameter and does not use this)

output

Indicates a proto message type describing the schema of the output json payload, used for view update methods to specify the schema used extract index values from the stored view entries and also the schema for the returned type from a query (either the same as the view message type or a custom projected message type)

Annotations
@SerialVersionUID()
Source
JsonSchema.scala
Linear Supertypes
Updatable[JsonSchema], GeneratedMessage, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JsonSchema
  2. Updatable
  3. GeneratedMessage
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. 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 JsonSchema(jsonBodyInputField: String = "", input: String = "", output: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

    jsonBodyInputField

    Indicates the field in a incoming message that is expected to contain the json payload The field should be of type google.protobuf.Any and messages must have type_url 'json.kalix.io' and the value encoded accordingly (WIRETYPE_LENGTH_DELIMITED + UTF8 bytes)

    input

    Indicates the proto message describing the schema of the json_body_input_field payload, incoming message JSON will be parsed using this schema, only by queries to allow mixing parameters in a generated input type with fields from a JSON payload (updates are always expected to have Any as their input parameter and does not use this)

    output

    Indicates a proto message type describing the schema of the output json payload, used for view update methods to specify the schema used extract index values from the stored view entries and also the schema for the returned type from a query (either the same as the view message type or a custom projected message type)

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 JsonSchema toany2stringadd[JsonSchema] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (JsonSchema, B)
    Implicit
    This member is added by an implicit conversion from JsonSchema toArrowAssoc[JsonSchema] 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. def companion: JsonSchema.type
    Definition Classes
    JsonSchema → GeneratedMessage
  9. def discardUnknownFields: JsonSchema
  10. def ensuring(cond: (JsonSchema) => Boolean, msg: => Any): JsonSchema
    Implicit
    This member is added by an implicit conversion from JsonSchema toEnsuring[JsonSchema] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (JsonSchema) => Boolean): JsonSchema
    Implicit
    This member is added by an implicit conversion from JsonSchema toEnsuring[JsonSchema] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: => Any): JsonSchema
    Implicit
    This member is added by an implicit conversion from JsonSchema toEnsuring[JsonSchema] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): JsonSchema
    Implicit
    This member is added by an implicit conversion from JsonSchema toEnsuring[JsonSchema] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    JsonSchema → GeneratedMessage
  17. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    JsonSchema → GeneratedMessage
  18. val input: String
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. val jsonBodyInputField: 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 output: String
  25. def productElementNames: Iterator[String]
    Definition Classes
    Product
  26. def serializedSize: Int
    Definition Classes
    JsonSchema → GeneratedMessage
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  29. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  30. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  31. def toProtoString: String
    Definition Classes
    JsonSchema → GeneratedMessage
  32. val unknownFields: UnknownFieldSet
  33. def update(ms: (Lens[JsonSchema, JsonSchema]) => Mutation[JsonSchema]*): JsonSchema
    Definition Classes
    Updatable
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  37. def withInput(__v: String): JsonSchema
  38. def withJsonBodyInputField(__v: String): JsonSchema
  39. def withOutput(__v: String): JsonSchema
  40. def withUnknownFields(__v: UnknownFieldSet): JsonSchema
  41. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  42. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    JsonSchema → GeneratedMessage
  43. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from JsonSchema toStringFormat[JsonSchema] 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.

  3. def →[B](y: B): (JsonSchema, B)
    Implicit
    This member is added by an implicit conversion from JsonSchema toArrowAssoc[JsonSchema] 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 Updatable[JsonSchema]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromJsonSchema to any2stringadd[JsonSchema]

Inherited by implicit conversion StringFormat fromJsonSchema to StringFormat[JsonSchema]

Inherited by implicit conversion Ensuring fromJsonSchema to Ensuring[JsonSchema]

Inherited by implicit conversion ArrowAssoc fromJsonSchema to ArrowAssoc[JsonSchema]

Ungrouped