final case class FieldOptions(type: Option[String] = _root_.scala.None, scalaName: Option[String] = _root_.scala.None, collectionType: Option[String] = _root_.scala.None, collection: Option[Collection] = _root_.scala.None, keyType: Option[String] = _root_.scala.None, valueType: Option[String] = _root_.scala.None, annotations: Seq[String] = _root_.scala.Seq.empty, mapType: Option[String] = _root_.scala.None, noBox: Option[Boolean] = _root_.scala.None, required: Option[Boolean] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[FieldOptions] with ExtendableMessage[FieldOptions] with Product with Serializable

collectionType

Can be specified only if this field is repeated. If unspecified, it falls back to the file option named collection_type, which defaults to scala.collection.Seq.

keyType

If the field is a map, you can specify custom Scala types for the key or value.

annotations

Custom annotations to add to the field.

mapType

Can be specified only if this field is a map. If unspecified, it falls back to the file option named map_type which defaults to scala.collection.immutable.Map

noBox

Do not box this value in Option[T]. If set, this overrides MessageOptions.no_box

required

Like no_box it does not box a value in Option[T], but also fails parsing when a value is not provided. This enables to emulate required fields in proto3.

Annotations
@SerialVersionUID()
Linear Supertypes
ExtendableMessage[FieldOptions], Updatable[FieldOptions], GeneratedMessage, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FieldOptions
  2. ExtendableMessage
  3. Updatable
  4. GeneratedMessage
  5. Serializable
  6. Product
  7. Equals
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new FieldOptions(type: Option[String] = _root_.scala.None, scalaName: Option[String] = _root_.scala.None, collectionType: Option[String] = _root_.scala.None, collection: Option[Collection] = _root_.scala.None, keyType: Option[String] = _root_.scala.None, valueType: Option[String] = _root_.scala.None, annotations: Seq[String] = _root_.scala.Seq.empty, mapType: Option[String] = _root_.scala.None, noBox: Option[Boolean] = _root_.scala.None, required: Option[Boolean] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

    collectionType

    Can be specified only if this field is repeated. If unspecified, it falls back to the file option named collection_type, which defaults to scala.collection.Seq.

    keyType

    If the field is a map, you can specify custom Scala types for the key or value.

    annotations

    Custom annotations to add to the field.

    mapType

    Can be specified only if this field is a map. If unspecified, it falls back to the file option named map_type which defaults to scala.collection.immutable.Map

    noBox

    Do not box this value in Option[T]. If set, this overrides MessageOptions.no_box

    required

    Like no_box it does not box a value in Option[T], but also fails parsing when a value is not provided. This enables to emulate required fields in proto3.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAllAnnotations(__vs: Iterable[String]): FieldOptions
  5. def addAnnotations(__vs: String*): FieldOptions
  6. val annotations: Seq[String]
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clearAnnotations: FieldOptions
  9. def clearCollection: FieldOptions
  10. def clearCollectionType: FieldOptions
  11. def clearKeyType: FieldOptions
  12. def clearMapType: FieldOptions
  13. def clearNoBox: FieldOptions
  14. def clearRequired: FieldOptions
  15. def clearScalaName: FieldOptions
  16. def clearType: FieldOptions
  17. def clearValueType: FieldOptions
  18. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  19. val collection: Option[Collection]
  20. val collectionType: Option[String]
  21. def companion: FieldOptions
    Definition Classes
    FieldOptions → GeneratedMessage
  22. def discardUnknownFields: FieldOptions
  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def extension[T](generatedExtension: GeneratedExtension[FieldOptions, T]): T
    Definition Classes
    ExtendableMessage
  25. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  26. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  27. def getCollection: Collection
  28. def getCollectionType: String
  29. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    FieldOptions → GeneratedMessage
  30. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    FieldOptions → GeneratedMessage
  31. def getKeyType: String
  32. def getMapType: String
  33. def getNoBox: Boolean
  34. def getRequired: Boolean
  35. def getScalaName: String
  36. def getType: String
  37. def getValueType: String
  38. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  39. val keyType: Option[String]
  40. val mapType: Option[String]
  41. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  42. val noBox: Option[Boolean]
  43. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  44. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  45. def productElementNames: Iterator[String]
    Definition Classes
    Product
  46. val required: Option[Boolean]
  47. val scalaName: Option[String]
  48. def serializedSize: Int
    Definition Classes
    FieldOptions → GeneratedMessage
  49. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  50. final def toByteArray: Array[Byte]

    Serializes the messgae and returns a byte array containing its raw bytes

    Serializes the messgae and returns a byte array containing its raw bytes

    Definition Classes
    GeneratedMessage
  51. final def toByteString: ByteString

    Serializes the messgae and returns a ByteString containing its raw bytes

    Serializes the messgae and returns a ByteString containing its raw bytes

    Definition Classes
    GeneratedMessage
  52. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  53. def toProtoString: String

    Returns a human-readable ASCII format representation of this message.

    Returns a human-readable ASCII format representation of this message.

    The original message can be decoded from this format by using fromAscii on the companion object.

    returns

    human-readable representation of this message.

    Definition Classes
    FieldOptions → GeneratedMessage
  54. val type: Option[String]
  55. val unknownFields: UnknownFieldSet
    Definition Classes
    FieldOptions → ExtendableMessage
  56. def update(ms: (Lens[FieldOptions, FieldOptions]) => Mutation[FieldOptions]*): FieldOptions
    Definition Classes
    Updatable
  57. val valueType: Option[String]
  58. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  59. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  60. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  61. def withAnnotations(__v: Seq[String]): FieldOptions
  62. def withCollection(__v: Collection): FieldOptions
  63. def withCollectionType(__v: String): FieldOptions
  64. def withExtension[T](generatedExtension: GeneratedExtension[FieldOptions, T])(value: T): FieldOptions
    Definition Classes
    ExtendableMessage
  65. def withKeyType(__v: String): FieldOptions
  66. def withMapType(__v: String): FieldOptions
  67. def withNoBox(__v: Boolean): FieldOptions
  68. def withRequired(__v: Boolean): FieldOptions
  69. def withScalaName(__v: String): FieldOptions
  70. def withType(__v: String): FieldOptions
  71. def withUnknownFields(__v: UnknownFieldSet): FieldOptions
    Definition Classes
    FieldOptions → ExtendableMessage
  72. def withValueType(__v: String): FieldOptions
  73. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  74. def writeTo(_output__: CodedOutputStream): Unit

    Serializes the message into the given coded output stream

    Serializes the message into the given coded output stream

    Definition Classes
    FieldOptions → GeneratedMessage
  75. final def writeTo(output: OutputStream): Unit

    Serializes the message into the given output stream

    Serializes the message into the given output stream

    Definition Classes
    GeneratedMessage

Inherited from ExtendableMessage[FieldOptions]

Inherited from Updatable[FieldOptions]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped