final case class MessageOptions(messageSetWireFormat: scala.Option[Boolean] = _root_.scala.None, noStandardDescriptorAccessor: scala.Option[Boolean] = _root_.scala.None, deprecated: scala.Option[Boolean] = _root_.scala.None, mapEntry: scala.Option[Boolean] = _root_.scala.None, uninterpretedOption: Seq[UninterpretedOption] = _root_.scala.Seq.empty, unknownFields: scalapb.UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends scalapb.GeneratedMessage with Updatable[MessageOptions] with ExtendableMessage[MessageOptions] with Product with Serializable

messageSetWireFormat

Set true to use the old proto1 MessageSet wire format for extensions. This is provided for backwards-compatibility with the MessageSet wire format. You should not use this for any other reason: It's less efficient, has fewer features, and is more complicated. The message must be defined exactly as follows: message Foo { option message_set_wire_format = true; extensions 4 to max; } Note that the message cannot have any defined fields; MessageSets only have extensions. All extensions of your type must be singular messages; e.g. they cannot be int32s, enums, or repeated messages. Because this is an option, the above two restrictions are not enforced by the protocol compiler.

noStandardDescriptorAccessor

Disables the generation of the standard "descriptor()" accessor, which can conflict with a field of the same name. This is meant to make migration from proto1 easier; new code should avoid fields named "descriptor".

deprecated

Is this message deprecated? Depending on the target platform, this can emit Deprecated annotations for the message, or it will be completely ignored; in the very least, this is a formalization for deprecating messages.

mapEntry

Whether the message is an automatically generated map entry type for the maps field. For maps fields: map<KeyType, ValueType> map_field = 1; The parsed descriptor looks like: message MapFieldEntry { option map_entry = true; optional KeyType key = 1; optional ValueType value = 2; } repeated MapFieldEntry map_field = 1; Implementations may choose not to generate the map_entry=true message, but use a native map in the target language to hold the keys and values. The reflection APIs in such implementations still need to work as if the field is a repeated message field. NOTE: Do not set the option in .proto files. Always use the maps syntax instead. The option should only be implicitly set by the proto compiler parser.

uninterpretedOption

The parser stores options it doesn't recognize here. See above.

Annotations
@SerialVersionUID()
Linear Supertypes
ExtendableMessage[MessageOptions], Updatable[MessageOptions], scalapb.GeneratedMessage, Serializable, Product, Equals, AnyRef, scala.Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MessageOptions
  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 MessageOptions(messageSetWireFormat: scala.Option[Boolean] = _root_.scala.None, noStandardDescriptorAccessor: scala.Option[Boolean] = _root_.scala.None, deprecated: scala.Option[Boolean] = _root_.scala.None, mapEntry: scala.Option[Boolean] = _root_.scala.None, uninterpretedOption: Seq[UninterpretedOption] = _root_.scala.Seq.empty, unknownFields: scalapb.UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

    messageSetWireFormat

    Set true to use the old proto1 MessageSet wire format for extensions. This is provided for backwards-compatibility with the MessageSet wire format. You should not use this for any other reason: It's less efficient, has fewer features, and is more complicated. The message must be defined exactly as follows: message Foo { option message_set_wire_format = true; extensions 4 to max; } Note that the message cannot have any defined fields; MessageSets only have extensions. All extensions of your type must be singular messages; e.g. they cannot be int32s, enums, or repeated messages. Because this is an option, the above two restrictions are not enforced by the protocol compiler.

    noStandardDescriptorAccessor

    Disables the generation of the standard "descriptor()" accessor, which can conflict with a field of the same name. This is meant to make migration from proto1 easier; new code should avoid fields named "descriptor".

    deprecated

    Is this message deprecated? Depending on the target platform, this can emit Deprecated annotations for the message, or it will be completely ignored; in the very least, this is a formalization for deprecating messages.

    mapEntry

    Whether the message is an automatically generated map entry type for the maps field. For maps fields: map<KeyType, ValueType> map_field = 1; The parsed descriptor looks like: message MapFieldEntry { option map_entry = true; optional KeyType key = 1; optional ValueType value = 2; } repeated MapFieldEntry map_field = 1; Implementations may choose not to generate the map_entry=true message, but use a native map in the target language to hold the keys and values. The reflection APIs in such implementations still need to work as if the field is a repeated message field. NOTE: Do not set the option in .proto files. Always use the maps syntax instead. The option should only be implicitly set by the proto compiler parser.

    uninterpretedOption

    The parser stores options it doesn't recognize here. See above.

Value Members

  1. final def !=(arg0: scala.Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: scala.Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAllUninterpretedOption(__vs: Iterable[UninterpretedOption]): MessageOptions
  5. def addUninterpretedOption(__vs: UninterpretedOption*): MessageOptions
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clearDeprecated: MessageOptions
  8. def clearMapEntry: MessageOptions
  9. def clearMessageSetWireFormat: MessageOptions
  10. def clearNoStandardDescriptorAccessor: MessageOptions
  11. def clearUninterpretedOption: MessageOptions
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  13. def companion: MessageOptions
    Definition Classes
    MessageOptions → GeneratedMessage
  14. val deprecated: scala.Option[Boolean]
  15. def discardUnknownFields: MessageOptions
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def extension[T](generatedExtension: GeneratedExtension[MessageOptions, T]): T
    Definition Classes
    ExtendableMessage
  18. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. def getDeprecated: Boolean
  21. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    MessageOptions → GeneratedMessage
  22. def getFieldByNumber(__fieldNumber: Int): scala.Any
    Definition Classes
    MessageOptions → GeneratedMessage
  23. def getMapEntry: Boolean
  24. def getMessageSetWireFormat: Boolean
  25. def getNoStandardDescriptorAccessor: Boolean
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. val mapEntry: scala.Option[Boolean]
  28. val messageSetWireFormat: scala.Option[Boolean]
  29. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. val noStandardDescriptorAccessor: scala.Option[Boolean]
  31. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  33. def productElementNames: Iterator[String]
    Definition Classes
    Product
  34. def serializedSize: Int
    Definition Classes
    MessageOptions → GeneratedMessage
  35. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  36. 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
  37. 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
  38. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  39. 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
    MessageOptions → GeneratedMessage
  40. val uninterpretedOption: Seq[UninterpretedOption]
  41. val unknownFields: scalapb.UnknownFieldSet
    Definition Classes
    MessageOptions → ExtendableMessage
  42. def update(ms: (Lens[MessageOptions, MessageOptions]) => Mutation[MessageOptions]*): MessageOptions
    Definition Classes
    Updatable
  43. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  45. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  46. def withDeprecated(__v: Boolean): MessageOptions
  47. def withExtension[T](generatedExtension: GeneratedExtension[MessageOptions, T])(value: T): MessageOptions
    Definition Classes
    ExtendableMessage
  48. def withMapEntry(__v: Boolean): MessageOptions
  49. def withMessageSetWireFormat(__v: Boolean): MessageOptions
  50. def withNoStandardDescriptorAccessor(__v: Boolean): MessageOptions
  51. def withUninterpretedOption(__v: Seq[UninterpretedOption]): MessageOptions
  52. def withUnknownFields(__v: scalapb.UnknownFieldSet): MessageOptions
    Definition Classes
    MessageOptions → ExtendableMessage
  53. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  54. 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
    MessageOptions → GeneratedMessage
  55. 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[MessageOptions]

Inherited from Updatable[MessageOptions]

Inherited from scalapb.GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from scala.Any

Ungrouped